offapi/com/sun/star/ui/XModuleUIConfigurationManagerSupplier.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 /** allows to retrieve user interface configuration managers related to
  23     OpenOffice.org modules.
  24
  25     @since OOo 2.0
  26 */
  27
  28 interface XModuleUIConfigurationManagerSupplier : ::com::sun::star::uno::XInterface
  29 {
  30     /** returns the requested module based user interface configuration manager.
  31
  32         @param ModuleIdentifier
  33             a module identifier which identifies an OpenOffice.org module. The
  34             module identifier can be retrieved from the
  35             com::sun::star::frame::ModuleManager service.
  36
  37         @returns
  38             an object implementing
  39             ::com::sun::star::ui::ModuleUIConfigurationManager
  40             service. If the provided module identifier is unknown a
  41             com::sun::star::container::NoSuchElementException
  42             is thrown.
  43     */
  44     XUIConfigurationManager getUIConfigurationManager( [in] string ModuleIdentifier ) raises ( com::sun::star::container::NoSuchElementException );
  45 };
  46
  47
  48 }; }; }; };
  49
  50 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */