offapi/com/sun/star/ui/XModuleUIConfigurationManager.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_ui_XModuleUIConfigurationManager_idl__
  21 #define __com_sun_star_ui_XModuleUIConfigurationManager_idl__
  22
  23 #include <com/sun/star/container/XIndexContainer.idl>
  24 #include <com/sun/star/container/XIndexAccess.idl>
  25 #include <com/sun/star/container/NoSuchElementException.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27 #include <com/sun/star/lang/IllegalAccessException.idl>
  28
  29 module com { module sun { module star { module ui {
  30
  31 /** specifies specific functions of a module based user interface
  32     configuration manager interface.
  33
  34     <p>
  35     A module user interface configuration manager supports, unlike a
  36     document based ui configuration manager, two layers of configuration
  37     settings data:<br/>
  38     1. Layer: A module default user interface configuration which
  39               describe all user interface elements settings that are
  40               used by OpenOffice. It is not possible to insert, remove
  41               or change elements settings in this layer through the
  42               interfaces.</br>
  43     2. Layer: A module user interface configuration which only contains
  44               customized user interface elements and user-defined ones.
  45               All changes on user interface element settings are done on
  46               this layer. This layer is the same as the document ui
  47               configuration manager uses.</br>
  48     </p>
  49
  50     @since OOo 2.0
  51 */
  52
  53 interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface
  54 {
  55     /** determine if the settings of a user interface element is part
  56         of the default layer of the user interface configuration manager.
  57
  58         @param ResourceURL
  59             a resource URL which identifies the user interface element. A
  60             resource URL must meet the following syntax:
  61             "private:resource/$type/$name. It is only allowed to use ASCII
  62             characters for type and name.
  63
  64         @return
  65             <TRUE/> if settings have been found in the default layer,
  66             otherwise <FALSE/>.
  67     */
  68     boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException );
  69
  70     /** retrieves the settings from the default layer of the user interface
  71         configuration manager if it has a default layer.
  72
  73         @param ResourceURL
  74             a resource URL which identifies the user interface element. A
  75             resource URL must meet the following syntax:
  76             "private:resource/$type/$name. It is only allowed to use ASCII
  77             characters for type and name.
  78
  79         @return
  80             <TRUE/> if default settings have been found in the default layer,
  81             otherwise <FALSE/>.
  82     */
  83     ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException );
  84
  85 };
  86
  87
  88 }; }; }; };
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */