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 module com { module sun { module star { module ui {
  21
  22 /** specifies specific functions of a module based user interface
  23     configuration manager interface.
  24
  25     <p>
  26     A module user interface configuration manager supports, unlike a
  27     document based ui configuration manager, two layers of configuration
  28     settings data:<br>
  29     1. Layer: A module default user interface configuration which
  30               describe all user interface elements settings that are
  31               used by OpenOffice. It is not possible to insert, remove
  32               or change elements settings in this layer through the
  33               interfaces.<br>
  34     2. Layer: A module user interface configuration which only contains
  35               customized user interface elements and user-defined ones.
  36               All changes on user interface element settings are done on
  37               this layer. This layer is the same as the document ui
  38               configuration manager uses.
  39     </p>
  40
  41     @since OOo 2.0
  42 */
  43
  44 interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface
  45 {
  46     /** determine if the settings of a user interface element is part
  47         of the default layer of the user interface configuration manager.
  48
  49         @param ResourceURL
  50             a resource URL which identifies the user interface element. A
  51             resource URL must meet the following syntax:
  52             "private:resource/$type/$name. It is only allowed to use ASCII
  53             characters for type and name.
  54
  55         @return
  56             `TRUE` if settings have been found in the default layer,
  57             otherwise `FALSE`.
  58     */
  59     boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException );
  60
  61     /** retrieves the settings from the default layer of the user interface
  62         configuration manager if it has a default layer.
  63
  64         @param ResourceURL
  65             a resource URL which identifies the user interface element. A
  66             resource URL must meet the following syntax:
  67             "private:resource/$type/$name. It is only allowed to use ASCII
  68             characters for type and name.
  69
  70         @return
  71             `TRUE` if default settings have been found in the default layer,
  72             otherwise `FALSE`.
  73     */
  74     ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException );
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */