offapi/com/sun/star/frame/theUICommandDescription.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
  21 module com { module sun { module star { module frame {
  22
  23
  24 /** a singleton which provides information about user interface commands of modules.
  25
  26     <p>
  27     OpenOffice.org has an amount of commands that can be used by user interface
  28     elements. This singleton provides access to the user interface commands that
  29     are part of OpenOffice.org modules, like Writer or Calc.
  30     </p>
  31
  32     Provides access to user interface commands of the installed modules.
  33
  34     <p>
  35     To access the user interface command description of a module, a unique module specifier
  36     must be provided to com::sun::star::container::XNameAccess::getByName() function.
  37     The module specifier can be retrieved from the com::sun::star::frame::ModuleManager
  38     service. The interface provides references to com::sun:star::ui::ModuleUICommandDescription.
  39     </p>
  40
  41     @see com::sun::star::frame::ModuleManager
  42
  43     Prior to LibreOffice 4.3, this singleton was only available as a
  44     (single-instance) UICommandDescription service.
  45
  46     @since LibreOffice 4.3
  47
  48 */
  49 singleton theUICommandDescription : com::sun::star::container::XNameAccess;
  50
  51 }; }; }; };
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */