offapi/com/sun/star/ui/ModuleUICategoryDescription.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 ui {
  22
  23
  24 /** a service which provides information about the user interface command
  25     categories of a single module.
  26
  27     <p>
  28     Every OpenOffice.org module has an amount of commands that can be used by
  29     user interface elements. This service provides access to the user interface
  30     commands that are part of a single OpenOffice.org module, like Writer
  31     or Calc.
  32     </p>
  33
  34     @since OOo 2.0
  35 */
  36
  37 service ModuleUICategoryDescription
  38 {
  39     /** provides access to user interface command categories of an installed
  40         module.
  41
  42         <p>
  43         An implementation must provide a language dependent string which
  44         can be used by a UI to display the category name.
  45         The key to a user interface command category depends on the specific
  46         implementation. OpenOffice.org uses a pre-defined number of
  47         identifiers defined in ::com::sun::star::frame::CommandGroup.
  48         </p>
  49
  50         @see ::com::sun::star::frame::ModuleManager
  51         @see ::com::sun::star::frame::CommandGroup
  52     */
  53
  54     interface com::sun::star::container::XNameAccess;
  55 };
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */