INTEGRATION: CWS pbrwuno (1.1.2); FILE ADDED

2006/03/09 14:07:12 fs 1.1.2.8: #i62967# no UnknownPropertyExceptions anymore
2005/12/21 14:19:17 fs 1.1.2.7: corrected typos found by juergen.schmidt@sun.com - thanks
2005/12/21 14:17:04 fs 1.1.2.6: proper licence header
2005/10/31 13:46:27 fs 1.1.2.5: UnknownPropertyException also for getPropertyControl
2005/10/25 11:51:49 fs 1.1.2.4: #i53095# some exception specifications, and some conceptual changes for multiple handlers supporting the same property
2005/10/17 08:15:37 fs 1.1.2.3: +XObjectInspectorUI::getPropertyControl
2005/10/14 08:40:50 fs 1.1.2.2: #i53095# let the XObjectInspectorModel provide category meta information part
2005/10/11 13:20:12 fs 1.1.2.1: #i53095#

1 files changed, 157 insertions, 0 deletions

diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl
new file mode 100644
index 000000000000..21221c4d4af5
--- /dev/null
+++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl
@@ -0,0 +1,157 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XObjectInspectorUI.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2006-03-14 11:07:32 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_inspection_XObjectInspectorUI_idl__
+#define __com_sun_star_inspection_XObjectInspectorUI_idl__
+
+#ifndef __com_sun_star_inspection_XPropertyControl_idl__
+#include <com/sun/star/inspection/XPropertyControl.idl>
+#endif
+#ifndef __com_sun_star_beans_Optional_idl__
+#include <com/sun/star/beans/Optional.idl>
+#endif
+#ifndef __com_sun_star_container_NoSuchElementException_idl__
+#include <com/sun/star/container/NoSuchElementException.idl>
+#endif
+
+//=============================================================================
+module com {  module sun {  module star {  module inspection {
+
+//-----------------------------------------------------------------------------
+/** grants access to certain aspects of the user interface of an object
+    inspector
+
+    <p>This interface is used as callback for <type>XPropertyHandler</type>s.</p>
+
+    <p>As a consequence, methods operating on the UI for a property, and taking the name of this property,
+    are tolerant against properties which do not exist. For instance, if a property handler tries to
+    disable the UI for property <code>Foo</code>, but another handler has superseded this property, then
+    the <type>ObjectInspector</type> will not <em>have</em> any UI for it. In this case, the call to
+    <code>enablePropertyUI( "Foo" )</code> will simply be ignored.</p>
+*/
+interface XObjectInspectorUI
+{
+    /** enables or disables all components belonging to the UI representation of a property
+
+        <p>This is usually used by an <type>XPropertyHandler</type> if it handles properties,
+        where one does only make sense if another one has a certain value.</p>
+
+        @param  PropertyName
+            denotes the name of the property whose UI is to be enabled or disabled.
+        @param  Enable
+            <TRUE/> if and only if the UI should be disabled, <FALSE/> otherwise.
+    */
+    void    enablePropertyUI( [in] string PropertyName, [in] boolean Enable );
+
+    /** enables or disables the single elements which can be part of the UI representation of a property
+
+        <p>Note that the complete UI for the property must be enabled in order for these settings to
+        be evaluated. That is, <member>enablePropertyUIElements</member> does not have any effect if
+        somebody previously disabled the complete UI for this property with <member>enablePropertyUI</member>.</p>
+
+        @param  PropertyName
+            the name of the property whose user interface elements are to be enabled or disabled
+
+        @param  Elements
+            a combination of <type>PropertyLineElement</type> flags specifying which elements are to be
+            enabled or disabled.<br/>
+            Note that if you don't set a particular bit here (say, <member>PropertyLineElement::PrimaryButton</member>),
+            this does mean that this element's state is not affected by the call - it does
+            <em>not</em> mean that it is disabled.
+        @param  Enable
+            <TRUE/> if the elements denoted by <arg>_nElements</arg> should be enabled, <FALSE/> if
+            they should be disabled.
+    */
+    void    enablePropertyUIElements(
+                        [in] string PropertyName,
+                        [in] short Elements,
+                        [in] boolean Enable
+                    );
+
+    /** completely rebuilds the UI for the given property.
+
+        <p>This method might be used by an <type>XPropertyHandler</type> if it wants to change the type
+        of control (see <type>PropertyControlType</type>) used to display a certain property.</p>
+
+        <p>The object inspector will then call describePropertyLine again, and update its UI accordingly.</p>
+
+        <p>Note that the property whose UI should be rebuilt must not necessarily be (though usually <em>is</em>)
+        in the responsibility of the handler which calls this method. The object inspector will look up the
+        handler with the responsibility for <arg>PropertyName</arg> and call its
+        <member>XPropertyHandler::describePropertyLine</member></p>
+
+        @param PropertyName
+            the name of the property whose UI is to be completely rebuilt.
+    */
+    void    rebuildPropertyUI( [in] string PropertyName );
+
+    /** shows the UI for a given property
+
+        @param  PropertyName
+            the name of the property whose UI is to be shown
+    */
+    void    showPropertyUI( [in] string PropertyName );
+
+    /** hides the UI for a given property
+
+        @param  PropertyName
+            the name of the property whose UI is to be hidden
+    */
+    void    hidePropertyUI( [in] string PropertyName );
+
+    /** shows or hides all properties belonging to a given category
+        @see LineDescriptor::Category
+        @see XObjectInspectorModel::describeCategories
+    */
+    void    showCategory( [in] string Category, [in] boolean Show );
+
+    /** retrieves the control currently used to display a given property
+
+        @param PropertyName
+            the name of the property whose control should be retrieved
+
+        @return
+            the <type>XPropertyControl</type> representing the given property, or <NULL/>
+            if there is no such property control.
+    */
+    XPropertyControl
+            getPropertyControl( [in] string PropertyName );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+