offapi/com/sun/star/ui/theUICategoryDescription.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
  23 /** a singleton which provides information about user interface command
  24     categories.
  25
  26     <p>
  27     OpenOffice.org has an amount of commands that can be used by user
  28     interface elements. Every command is member of a single category.
  29     Categories makes it easier to handle to huge amount of commands
  30     provided by OpenOffice.org. This singleton is normally used by UI
  31     implementations which provides all commands to a user.
  32     </p>
  33
  34     Provides access to user interface command categories of the installed
  35     modules.
  36
  37     <p>
  38     To access the user interface command categories of a module, a unique
  39     module specifier must be provided to
  40     com::sun::star::container::XNameAccess::getByName()
  41     function. The module specifier can be retrieved from the
  42     com::sun::star::frame::ModuleManager
  43     service. The interface provides references to
  44     com::sun:star::ui::ModuleUICommandDescription.
  45     </p>
  46
  47     @see com::sun::star::frame::ModuleManager
  48
  49     Prior to LibreOffice 4.3, this singleton was only available as a
  50     (single-instance) UICategoryDescription service.
  51
  52     @since LibreOffice 4.3
  53 */
  54 singleton theUICategoryDescription : com::sun::star::container::XNameAccess;
  55
  56 }; }; }; }; // com.sun.star.ui
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */