1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_inspection_ObjectInspector_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_inspection_ObjectInspector_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_inspection_XObjectInspector_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/inspection/XObjectInspector.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweirmodule com { module sun { module star { module inspection { 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir//----------------------------------------------------------------------------- 42*cdf0e10cSrcweir/** describes an <type scope="com::sun::star::frame">Controller</type> which can be used to 43*cdf0e10cSrcweir browse and modify properties of components. 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir <p>The controller can be plugged into an <type scope="com::sun::star::frame">XFrame</type>, and will 46*cdf0e10cSrcweir provide a visual component for inspecting and modifying component properties.<br/> 47*cdf0e10cSrcweir Note that "property" here is a generic term - any aspect of a component can be considered a property, 48*cdf0e10cSrcweir as long as some property handler is able to describe this aspect in a property-like way.</p> 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir <p>The basic idea is that one facet of the inspected component is represented by a single line 51*cdf0e10cSrcweir of controls: A label, an input control, and optionally one or two buttons which, when pressed, 52*cdf0e10cSrcweir trigger additional user interaction (e.g. a more sophisticated dialog to enter a property value).</p> 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir <p>Additionally, property lines can be grouped into different categories. A usual implementation 55*cdf0e10cSrcweir of such categories would be tab pages, but other implementations are possible, too.</p> 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir <p>Even more, the inspector can optionally display a help section at the bottom of its 58*cdf0e10cSrcweir window, which can display arbitrary (context-sensitive) help texts.</p> 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir <p>An <type>ObjectInspector</type> needs one or more property handlers which describe 61*cdf0e10cSrcweir the facets of an inspected component - without such handlers, the inspector window will simply 62*cdf0e10cSrcweir stay empty.</p> 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir <p>The property handlers, as well as more information about the layout of the inspector, 65*cdf0e10cSrcweir are provided by a inspector model, which has to be implemented by the user of the inspector.</p> 66*cdf0e10cSrcweir <p/> 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir <p>Since property handlers might have the need to raise UI, they will be created with a context 69*cdf0e10cSrcweir value named "DialogParentWindow", which contains an XWindow which should be used as parent of 70*cdf0e10cSrcweir any windows to raise.<br/> 71*cdf0e10cSrcweir If the <type scope="com::sun::star::uno">XComponentContext</type> in which the <type>ObjectInspector</type> 72*cdf0e10cSrcweir was created already contains such a value, it is not overwritten. Only if it doesn't, the inspector 73*cdf0e10cSrcweir will add an own value - which contains the inspector's main window - to the context when creating 74*cdf0e10cSrcweir handlers.</p> 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir @see XPropertyHandler 77*cdf0e10cSrcweir @see LineDescriptor 78*cdf0e10cSrcweir @see PropertyControlType 79*cdf0e10cSrcweir @see ObjectInspectorModel 80*cdf0e10cSrcweir @see com::sun::star::uno::XComponentContext 81*cdf0e10cSrcweir @see com::sun::star::lang::XMultiComponentFactory 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir @since OOo 2.0.3 84*cdf0e10cSrcweir*/ 85*cdf0e10cSrcweirpublished service ObjectInspector : XObjectInspector 86*cdf0e10cSrcweir{ 87*cdf0e10cSrcweir /** creates a default instance of the ObjectInspector 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir @since OOo 2.2 90*cdf0e10cSrcweir */ 91*cdf0e10cSrcweir createDefault(); 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir /** creates an instance of the ObjectInspector, using a given <type>ObjectInspectorModel</type> 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 96*cdf0e10cSrcweir if <arg>Model</arg> is <NULL/>. 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir @since OOo 2.2 99*cdf0e10cSrcweir */ 100*cdf0e10cSrcweir createWithModel( [in] XObjectInspectorModel Model ) 101*cdf0e10cSrcweir raises ( ::com::sun::star::lang::IllegalArgumentException ); 102*cdf0e10cSrcweir}; 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir//============================================================================= 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir}; }; }; }; 107*cdf0e10cSrcweir 108*cdf0e10cSrcweir#endif 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir 112