1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_inspection_ObjectInspector_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_inspection_ObjectInspector_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_inspection_XObjectInspector_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/inspection/XObjectInspector.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module inspection { 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski//----------------------------------------------------------------------------- 38*b1cdbd2cSJim Jagielski/** describes an <type scope="com::sun::star::frame">Controller</type> which can be used to 39*b1cdbd2cSJim Jagielski browse and modify properties of components. 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski <p>The controller can be plugged into an <type scope="com::sun::star::frame">XFrame</type>, and will 42*b1cdbd2cSJim Jagielski provide a visual component for inspecting and modifying component properties.<br/> 43*b1cdbd2cSJim Jagielski Note that "property" here is a generic term - any aspect of a component can be considered a property, 44*b1cdbd2cSJim Jagielski as long as some property handler is able to describe this aspect in a property-like way.</p> 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski <p>The basic idea is that one facet of the inspected component is represented by a single line 47*b1cdbd2cSJim Jagielski of controls: A label, an input control, and optionally one or two buttons which, when pressed, 48*b1cdbd2cSJim Jagielski trigger additional user interaction (e.g. a more sophisticated dialog to enter a property value).</p> 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <p>Additionally, property lines can be grouped into different categories. A usual implementation 51*b1cdbd2cSJim Jagielski of such categories would be tab pages, but other implementations are possible, too.</p> 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski <p>Even more, the inspector can optionally display a help section at the bottom of its 54*b1cdbd2cSJim Jagielski window, which can display arbitrary (context-sensitive) help texts.</p> 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski <p>An <type>ObjectInspector</type> needs one or more property handlers which describe 57*b1cdbd2cSJim Jagielski the facets of an inspected component - without such handlers, the inspector window will simply 58*b1cdbd2cSJim Jagielski stay empty.</p> 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski <p>The property handlers, as well as more information about the layout of the inspector, 61*b1cdbd2cSJim Jagielski are provided by a inspector model, which has to be implemented by the user of the inspector.</p> 62*b1cdbd2cSJim Jagielski <p/> 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p>Since property handlers might have the need to raise UI, they will be created with a context 65*b1cdbd2cSJim Jagielski value named "DialogParentWindow", which contains an XWindow which should be used as parent of 66*b1cdbd2cSJim Jagielski any windows to raise.<br/> 67*b1cdbd2cSJim Jagielski If the <type scope="com::sun::star::uno">XComponentContext</type> in which the <type>ObjectInspector</type> 68*b1cdbd2cSJim Jagielski was created already contains such a value, it is not overwritten. Only if it doesn't, the inspector 69*b1cdbd2cSJim Jagielski will add an own value - which contains the inspector's main window - to the context when creating 70*b1cdbd2cSJim Jagielski handlers.</p> 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @see XPropertyHandler 73*b1cdbd2cSJim Jagielski @see LineDescriptor 74*b1cdbd2cSJim Jagielski @see PropertyControlType 75*b1cdbd2cSJim Jagielski @see ObjectInspectorModel 76*b1cdbd2cSJim Jagielski @see com::sun::star::uno::XComponentContext 77*b1cdbd2cSJim Jagielski @see com::sun::star::lang::XMultiComponentFactory 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @since OpenOffice 2.0.3 80*b1cdbd2cSJim Jagielski*/ 81*b1cdbd2cSJim Jagielskipublished service ObjectInspector : XObjectInspector 82*b1cdbd2cSJim Jagielski{ 83*b1cdbd2cSJim Jagielski /** creates a default instance of the ObjectInspector 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @since OpenOffice 2.2 86*b1cdbd2cSJim Jagielski */ 87*b1cdbd2cSJim Jagielski createDefault(); 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** creates an instance of the ObjectInspector, using a given <type>ObjectInspectorModel</type> 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IllegalArgumentException 92*b1cdbd2cSJim Jagielski if <arg>Model</arg> is <NULL/>. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @since OpenOffice 2.2 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielski createWithModel( [in] XObjectInspectorModel Model ) 97*b1cdbd2cSJim Jagielski raises ( ::com::sun::star::lang::IllegalArgumentException ); 98*b1cdbd2cSJim Jagielski}; 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski//============================================================================= 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski}; }; }; }; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski#endif 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski 108