offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XResourceFactoryManager.idl,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef __com_sun_star_drawing_framework_XResourceFactoryManager_idl__
  33 #define __com_sun_star_drawing_framework_XResourceFactoryManager_idl__
  34
  35 #ifndef __com_sun_star_uno_XInterface_idl__
  36 #include <com/sun/star/uno/XInterface.idl>
  37 #endif
  38
  39 module com { module sun { module star { module drawing { module framework {
  40
  41 interface XResourceId;
  42 interface XResourceFactory;
  43
  44 /** The XResourceFactoryManager is part of the configuration controller and
  45     manages the set of registered resource factories.
  46
  47     @see XConfigurationController
  48     @see XResourceFactory
  49 */
  50 interface XResourceFactoryManager
  51 {
  52     /** Register a new resource factory for the given URL.
  53         <p>When one factory is responsible for more than one type of resource
  54         then this method has to be called for each type.  If this method is
  55         called multiple times for the same URL then a previously registered
  56         factory is removed for the URL.</p>
  57         @param sResourceURL
  58             The URL of the resource that the factory can create.
  59         @param xResourceFactory
  60             The resource factory object.
  61     */
  62     void addResourceFactory (
  63         [in] string sResourceURL,
  64         [in] XResourceFactory xResourceFactory);
  65
  66     /** Remove a resource factory for one type of resource.  When the
  67         factory has been registered for other URLs as well then it remains
  68         registered for them.  Use the
  69         <member>removeResourceFactoryForReference()</member> to remove a
  70         factory completely.
  71         @param sResourceURL
  72             The URL for which to remove the resource factory.
  73     */
  74     void removeResourceFactoryForURL (
  75         [in] string sResourceURL);
  76
  77     /** Remove a resource factory for all resource types it has been registered for.  Use
  78         <member>removeResourceFactoryForURL</member> to remove a factory
  79         just for one resource type and to leave it registered for others.
  80         @param xResourceFactory
  81             The resource factory object to remove.
  82     */
  83     void removeResourceFactoryForReference (
  84         [in] XResourceFactory xResourceFactory);
  85
  86     /** Return the resource factory that was previously registered for the
  87         given resource type.  This method is typically called by one of the
  88         resource controllers.
  89         @param sResourceURL
  90             The URL of the resource type for which to return the resource
  91             factory.
  92         @return
  93             When no resource factory was registered for the given resource
  94             type then an empty reference is returned.
  95     */
  96     XResourceFactory getResourceFactory (
  97         [in] string sResourceURL);
  98 };
  99
 100 }; }; }; }; }; // ::com::sun::star::drawing::framework
 101
 102 #endif