offapi/com/sun/star/ui/XModuleUIConfigurationManager.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: XModuleUIConfigurationManager.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_XModuleUIConfigurationManager_idl__
  32 #define __com_sun_star_ui_XModuleUIConfigurationManager_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexContainer_idl__
  35 #include <com/sun/star/container/XIndexContainer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XIndexAccess_idl__
  39 #include <com/sun/star/container/XIndexAccess.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  43 #include <com/sun/star/container/NoSuchElementException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  47 #include <com/sun/star/lang/IllegalArgumentException.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_lang_IllegalAccessException_idl__
  51 #include <com/sun/star/lang/IllegalAccessException.idl>
  52 #endif
  53
  54 module com { module sun { module star { module ui {
  55
  56 /** specifies specific functions of a module based user interface
  57     configuration manager interface.
  58
  59     <p>
  60     A module user interface configuration manager supports, unlike a
  61     document based ui configration manager, two layers of configuration
  62     settings data:<br/>
  63     1. Layer: A module default user interface configuration which
  64               describe all user interface elements settings that are
  65               used by OpenOffice. It is not possible to insert, remove
  66               or changeelements settings in this layer through the
  67               interfaces.</br>
  68     2. Layer: A module user interface configuration which only contains
  69               customized user interface elements and user-defined ones.
  70               All changes on user interface element settings are done on
  71               this layer. This layer is the same as the document ui
  72               configuration manager uses.</br>
  73     </p>
  74
  75     @since OOo 2.0.0
  76 */
  77
  78 interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface
  79 {
  80     /** determine if the settings of a user interface element is part
  81         of the default layer of the user interface configuration manager.
  82
  83         @param ResourceURL
  84             a resource URL which identifies the user interface element. A
  85             resourcce URL must meet the following syntax:
  86             "private:resource/$type/$name. It is only allowed to use ascii
  87             characters for type and name.
  88
  89         @return
  90             <TRUE/> if settings have been found in the default layer,
  91             otherwise <FALSE/>.
  92     */
  93     boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException );
  94
  95     /** retrieves the settings from the default layer of the user interface
  96         configuration manager if it has a default layer.
  97
  98         @param ResourceURL
  99             a resource URL which identifies the user interface element. A
 100             resourcce URL must meet the following syntax:
 101             "private:resource/$type/$name. It is only allowed to use ascii
 102             characters for type and name.
 103
 104         @return
 105             <TRUE/> if default settings have been found in the default layer,
 106             otherwise <FALSE/>.
 107     */
 108     ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException );
 109
 110 };
 111
 112 //=============================================================================
 113
 114 }; }; }; };
 115
 116 #endif