| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_inspection_ObjectInspector_idl__ |
| #define __com_sun_star_inspection_ObjectInspector_idl__ |
| |
| #ifndef __com_sun_star_inspection_XObjectInspector_idl__ |
| #include <com/sun/star/inspection/XObjectInspector.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| |
| //============================================================================= |
| module com { module sun { module star { module inspection { |
| |
| //----------------------------------------------------------------------------- |
| /** describes an <type scope="com::sun::star::frame">Controller</type> which can be used to |
| browse and modify properties of components. |
| |
| <p>The controller can be plugged into an <type scope="com::sun::star::frame">XFrame</type>, and will |
| provide a visual component for inspecting and modifying component properties.<br/> |
| Note that "property" here is a generic term - any aspect of a component can be considered a property, |
| as long as some property handler is able to describe this aspect in a property-like way.</p> |
| |
| <p>The basic idea is that one facet of the inspected component is represented by a single line |
| of controls: A label, an input control, and optionally one or two buttons which, when pressed, |
| trigger additional user interaction (e.g. a more sophisticated dialog to enter a property value).</p> |
| |
| <p>Additionally, property lines can be grouped into different categories. A usual implementation |
| of such categories would be tab pages, but other implementations are possible, too.</p> |
| |
| <p>Even more, the inspector can optionally display a help section at the bottom of its |
| window, which can display arbitrary (context-sensitive) help texts.</p> |
| |
| <p>An <type>ObjectInspector</type> needs one or more property handlers which describe |
| the facets of an inspected component - without such handlers, the inspector window will simply |
| stay empty.</p> |
| |
| <p>The property handlers, as well as more information about the layout of the inspector, |
| are provided by a inspector model, which has to be implemented by the user of the inspector.</p> |
| <p/> |
| |
| <p>Since property handlers might have the need to raise UI, they will be created with a context |
| value named "DialogParentWindow", which contains an XWindow which should be used as parent of |
| any windows to raise.<br/> |
| If the <type scope="com::sun::star::uno">XComponentContext</type> in which the <type>ObjectInspector</type> |
| was created already contains such a value, it is not overwritten. Only if it doesn't, the inspector |
| will add an own value - which contains the inspector's main window - to the context when creating |
| handlers.</p> |
| |
| @see XPropertyHandler |
| @see LineDescriptor |
| @see PropertyControlType |
| @see ObjectInspectorModel |
| @see com::sun::star::uno::XComponentContext |
| @see com::sun::star::lang::XMultiComponentFactory |
| |
| @since OpenOffice 2.0.3 |
| */ |
| published service ObjectInspector : XObjectInspector |
| { |
| /** creates a default instance of the ObjectInspector |
| |
| @since OpenOffice 2.2 |
| */ |
| createDefault(); |
| |
| /** creates an instance of the ObjectInspector, using a given <type>ObjectInspectorModel</type> |
| |
| @throws ::com::sun::star::lang::IllegalArgumentException |
| if <arg>Model</arg> is <NULL/>. |
| |
| @since OpenOffice 2.2 |
| */ |
| createWithModel( [in] XObjectInspectorModel Model ) |
| raises ( ::com::sun::star::lang::IllegalArgumentException ); |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |
| |
| |
| |