offapi/com/sun/star/frame/XDispatchInformationProvider.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 /** provides information about supported commands
  24
  25     <p>
  26     This interface can be used to retrieve additional information about
  27     supported commands. This interface is normally used by configuration
  28     implementations to retrieve all supported commands.
  29     A dispatch information provider is normally supported by a
  30     Frame service.
  31     </p>
  32
  33     @see Frame
  34
  35     @since OOo 2.0
  36  */
  37 published interface XDispatchInformationProvider: com::sun::star::uno::XInterface
  38 {
  39     /** returns all supported command groups.
  40
  41         @returns
  42             a sequence of supported command groups.
  43
  44         @see CommandGroup
  45     */
  46     sequence < short > getSupportedCommandGroups();
  47
  48     /** returns additional information about supported commands of a
  49         given command group.
  50
  51         @param CommandGroup
  52             specifies a command group.
  53
  54         @returns
  55             name and group name of every command supported. A group ID which is
  56             not supported returns an empty com::sun::star::uno::Sequence.
  57     */
  58     sequence < DispatchInformation > getConfigurableDispatchInformation( [in] short CommandGroup );
  59 };
  60
  61
  62 }; }; }; };
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */