Update ooo320-m1
[ooovba.git] / offapi / com / sun / star / inspection / XPropertyControl.idl
bloba2a0f5e72c8e00005f99a14966fea828c7e8275c
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XPropertyControl.idl,v $
10 * $Revision: 1.6 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_inspection_XPropertyControl_idl__
32 #define __com_sun_star_inspection_XPropertyControl_idl__
34 #ifndef __com_sun_star_beans_IllegalTypeException_idl__
35 #include <com/sun/star/beans/IllegalTypeException.idl>
36 #endif
37 #ifndef __com_sun_star_awt_XWindow_idl__
38 #include <com/sun/star/awt/XWindow.idl>
39 #endif
41 //=============================================================================
42 module com { module sun { module star { module inspection {
44 interface XPropertyControlContext;
46 //-----------------------------------------------------------------------------
47 /** defines the interface for a single control in an <type>ObjectInspector</type>
49 @since OOo 2.0.3
51 interface XPropertyControl
53 /** denotes the type of the control, as one of the <type>PropertyControlType</type>
54 constants
56 [attribute, readonly] short ControlType;
58 /** denotes the current content of the control.
60 <p>At every point in time, this value is either <void/>, or of the type
61 described by <member>ValueType</member>.</p>
63 @throws com::sun::star::beans::IllegalTypeException
64 if an attempt is made to set a value which is not <void/> and whose
65 type does not equal <member>ValueType</member>.
67 [attribute] any Value
69 set raises ( com::sun::star::beans::IllegalTypeException );
72 /** denotes the value type of the control.
74 @see Value
76 [attribute, readonly] type ValueType;
78 /** specifies the context of the control within the <type>ObjectInspector</type>.
80 <p>The property control should actively notify its state changes to the context.
81 In particular, changes in the focus and the value of the control must be notified.
83 [attribute] XPropertyControlContext ControlContext;
85 /** determines whether the control content is currently modified
87 <p>An <type>XPropertyControl</type> internally manages a flag indicating whether
88 its content is modified. This flag is reset to <FALSE/> every time our
89 <member>ControlContext</member> is notified of our current value. Also, the control
90 implementation must set this flag to <TRUE/> if and only if the user changed the
91 control content.</p>
93 @see notifyModifiedValue
94 @see ControlContext
95 @see XPropertyControlContext::valueChanged
97 boolean isModified();
99 /** notifies the context in which the control lives of the current control value,
100 if this value is currently modified
102 @see isModified
103 @see ControlContext
104 @see XPropertyControlListener::valueChanged
106 void notifyModifiedValue();
108 /** denotes the window which is the real UI representation of the property control.
110 <p>The <type>ObjectInspector</type> will automatically position and size this control
111 as needed, care for its Z-order, and so on.</p>
113 <p>This Window must not be <NULL/>, else the whole control is not usable.</p>
115 [attribute, readonly] com::sun::star::awt::XWindow ControlWindow;
118 //=============================================================================
120 }; }; }; };
122 #endif