summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl')
-rw-r--r--offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl98
1 files changed, 98 insertions, 0 deletions
diff --git a/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl b/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl
new file mode 100644
index 000000000000..1926c38c2774
--- /dev/null
+++ b/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl
@@ -0,0 +1,98 @@
+/*************************************************************************
+ *
+ * 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_drawing_framework_XResourceFactoryManager_idl__
+#define __com_sun_star_drawing_framework_XResourceFactoryManager_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+module com { module sun { module star { module drawing { module framework {
+
+interface XResourceId;
+interface XResourceFactory;
+
+/** The XResourceFactoryManager is part of the configuration controller and
+ manages the set of registered resource factories.
+
+ @see XConfigurationController
+ @see XResourceFactory
+*/
+interface XResourceFactoryManager
+{
+ /** Register a new resource factory for the given URL.
+ <p>When one factory is responsible for more than one type of resource
+ then this method has to be called for each type. If this method is
+ called multiple times for the same URL then a previously registered
+ factory is removed for the URL.</p>
+ @param sResourceURL
+ The URL of the resource that the factory can create.
+ @param xResourceFactory
+ The resource factory object.
+ */
+ void addResourceFactory (
+ [in] string sResourceURL,
+ [in] XResourceFactory xResourceFactory);
+
+ /** Remove a resource factory for one type of resource. When the
+ factory has been registered for other URLs as well then it remains
+ registered for them. Use the
+ <member>removeResourceFactoryForReference()</member> to remove a
+ factory completely.
+ @param sResourceURL
+ The URL for which to remove the resource factory.
+ */
+ void removeResourceFactoryForURL (
+ [in] string sResourceURL);
+
+ /** Remove a resource factory for all resource types it has been registered for. Use
+ <member>removeResourceFactoryForURL</member> to remove a factory
+ just for one resource type and to leave it registered for others.
+ @param xResourceFactory
+ The resource factory object to remove.
+ */
+ void removeResourceFactoryForReference (
+ [in] XResourceFactory xResourceFactory);
+
+ /** Return the resource factory that was previously registered for the
+ given resource type. This method is typically called by one of the
+ resource controllers.
+ @param sResourceURL
+ The URL of the resource type for which to return the resource
+ factory.
+ @return
+ When no resource factory was registered for the given resource
+ type then an empty reference is returned.
+ */
+ XResourceFactory getResourceFactory (
+ [in] string sResourceURL);
+};
+
+}; }; }; }; }; // ::com::sun::star::drawing::framework
+
+#endif