INTEGRATION: CWS components1 (1.1.2); FILE ADDED

2007/01/22 12:38:22 af 1.1.2.3: #i68075 Introduction of XResourceId interface.
2006/09/07 13:22:45 af 1.1.2.2: #i68075# Transition from URL to ResourceId.
2006/08/23 08:25:31 af 1.1.2.1: #i68075# Initial revision.

1 files changed, 144 insertions, 0 deletions

diff --git a/offapi/com/sun/star/drawing/framework/XConfiguration.idl b/offapi/com/sun/star/drawing/framework/XConfiguration.idl
new file mode 100644
index 000000000000..31ad8ee7fd8c
--- /dev/null
+++ b/offapi/com/sun/star/drawing/framework/XConfiguration.idl
@@ -0,0 +1,144 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XConfiguration.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-04-03 16:43:35 $
+ *
+ *  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_drawing_framework_XConfiguration_idl__
+#define __com_sun_star_drawing_framework_XConfiguration_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+#ifndef __com_sun_star_util_XCloneable_idl__
+#include <com/sun/star/util/XCloneable.idl>
+#endif
+#ifndef __com_sun_star_drawing_framework_AnchorBindingMode_idl__
+#include <com/sun/star/drawing/framework/AnchorBindingMode.idl>
+#endif
+
+module com { module sun { module star { module drawing { module framework {
+
+interface XResourceId;
+
+/** A configuration describes the resources of an application like panes,
+    views, and tool bars and their relationships that are currently active
+    or are requested to be activated.  Resources are specified by ResourceId
+    structures rather than references so that not only the current
+    configuration but also a requested configuration can be represented.
+
+    <p>Direct manipulation of a configuration object is not advised with the
+    exception of the <type>ConfigurationController</type> and objects that
+    implement the <type>XConfigurationChangeRequest</type> interface.</p>
+
+    @see XConfigurationController
+*/
+interface XConfiguration
+    : ::com::sun::star::util::XCloneable
+{
+    /** Returns the list of resources that are bound directly and/or
+        indirectly to the given anchor.  A URL filter can reduce the set of
+        returned resource ids.
+        @param xAnchorId
+            This anchor typically is either a pane or an empty
+            <type>XResourceId</type> object.  An
+            empty reference is treated like an <type>XResourceId</type> object.
+        @param sURLPrefix
+            When a non-empty string is given then resource ids are returned
+            only when their resource URL matches this prefix, i.e. when it
+            begins with this prefix or is equal to it.  Characters with
+            special meaning to URLs are not interpreted.  In the typical
+            usage the prefix specifies the type of a resource.  A typical
+            value is "private:resource/floater/", which is the prefix for
+            pane URLs.  In a recursive search, only resource ids at the top
+            level are matched against this prefix.
+            <p>Use an empty string to prevent filtering out resource ids.</p>
+        @param eSearchMode
+            This flag defines whether to return only resources that are
+            directly bound to the given anchor or a recursive search is to
+            be made.  Note that for the recursive search and an empty anchor
+            all resource ids are returned that belong to the configuration.
+        @return
+            The set of returned resource ids may be empty when there are no
+            resource ids that match all conditions.
+    */
+    sequence<XResourceId> getResources (
+        [in] XResourceId xAnchorId,
+        [in] string sTargetURLPrefix,
+        [in] AnchorBindingMode eSearchMode);
+
+    /** <p>Returns wether the specified resource is part of the
+        configuration.</p>
+        This is independent of whether the resource does really exist and is
+        active, i.e. has a visible representation in the GUI.
+        @param xResourceId
+            The id of a resource.  May be empty (empty reference or empty
+            <type>XResourceId</type> object) in which case <FALSE/> is
+            returned.
+        @return
+            Returns <TRUE/> when the resource is part of the configuration
+            and <FALSE/> when it is not.
+    */
+    boolean hasResource ([in] XResourceId xResourceId);
+
+    /** Add a resource to the configuration.
+        <p>This method should be used only by objects that implement the
+        <type>XConfigurationRequest</type> interface or by the configuration
+        controller.</p>
+        @param xResourceId
+            The resource to add to the configuration.  When the specified
+            resource is already part of the configuration then this call is
+            silently ignored.
+        @throws IllegalArgumentException
+            When an empty resource id is given then an
+            IllegalArgumentException is thrown.
+    */
+    void addResource ([in] XResourceId xResourceId);
+
+    /** Remove a resource from the configuration.
+        <p>This method should be used only by objects that implement the
+        <type>XConfigurationRequest</type> interface or by the configuration
+        controller.</p>
+        @param xResourceId
+            The resource to remove from the configuration. When the
+            specified resource is not part of the configuration then this
+            call is silently ignored.
+        @throws IllegalArgumentException
+            When an empty resource id is given then an
+            IllegalArgumentException is thrown.
+    */
+    void removeResource ([in] XResourceId xResource);
+};
+
+}; }; }; }; }; // ::com::sun::star::drawing::framework
+
+#endif