diff options
Diffstat (limited to 'offapi/com/sun/star/inspection/XPropertyControl.idl')
-rw-r--r-- | offapi/com/sun/star/inspection/XPropertyControl.idl | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/offapi/com/sun/star/inspection/XPropertyControl.idl b/offapi/com/sun/star/inspection/XPropertyControl.idl new file mode 100644 index 000000000000..b48f730fa7d9 --- /dev/null +++ b/offapi/com/sun/star/inspection/XPropertyControl.idl @@ -0,0 +1,120 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_inspection_XPropertyControl_idl__ +#define __com_sun_star_inspection_XPropertyControl_idl__ + +#ifndef __com_sun_star_beans_IllegalTypeException_idl__ +#include <com/sun/star/beans/IllegalTypeException.idl> +#endif +#ifndef __com_sun_star_awt_XWindow_idl__ +#include <com/sun/star/awt/XWindow.idl> +#endif + +//============================================================================= +module com { module sun { module star { module inspection { + +interface XPropertyControlContext; + +//----------------------------------------------------------------------------- +/** defines the interface for a single control in an <type>ObjectInspector</type> + + @since OOo 2.0.3 +*/ +interface XPropertyControl +{ + /** denotes the type of the control, as one of the <type>PropertyControlType</type> + constants + */ + [attribute, readonly] short ControlType; + + /** denotes the current content of the control. + + <p>At every point in time, this value is either <void/>, or of the type + described by <member>ValueType</member>.</p> + + @throws com::sun::star::beans::IllegalTypeException + if an attempt is made to set a value which is not <void/> and whose + type does not equal <member>ValueType</member>. + */ + [attribute] any Value + { + set raises ( com::sun::star::beans::IllegalTypeException ); + }; + + /** denotes the value type of the control. + + @see Value + */ + [attribute, readonly] type ValueType; + + /** specifies the context of the control within the <type>ObjectInspector</type>. + + <p>The property control should actively notify its state changes to the context. + In particular, changes in the focus and the value of the control must be notified. + */ + [attribute] XPropertyControlContext ControlContext; + + /** determines whether the control content is currently modified + + <p>An <type>XPropertyControl</type> internally manages a flag indicating whether + its content is modified. This flag is reset to <FALSE/> every time our + <member>ControlContext</member> is notified of our current value. Also, the control + implementation must set this flag to <TRUE/> if and only if the user changed the + control content.</p> + + @see notifyModifiedValue + @see ControlContext + @see XPropertyControlContext::valueChanged + */ + boolean isModified(); + + /** notifies the context in which the control lives of the current control value, + if this value is currently modified + + @see isModified + @see ControlContext + @see XPropertyControlListener::valueChanged + */ + void notifyModifiedValue(); + + /** denotes the window which is the real UI representation of the property control. + + <p>The <type>ObjectInspector</type> will automatically position and size this control + as needed, care for its Z-order, and so on.</p> + + <p>This Window must not be <NULL/>, else the whole control is not usable.</p> + */ + [attribute, readonly] com::sun::star::awt::XWindow ControlWindow; +}; + +//============================================================================= + +}; }; }; }; + +#endif + |