offapi/com/sun/star/frame/XDispatchInformationProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDispatchInformationProvider.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_frame_XDispatchInformationProvider_idl__
  31 #define __com_sun_star_frame_XDispatchInformationProvider_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_frame_DispatchInformation_idl__
  38 #include <com/sun/star/frame/DispatchInformation.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  42 #include <com/sun/star/container/NoSuchElementException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module frame {
  48
  49 //=============================================================================
  50 /** provides information about supported commands
  51
  52     <p>
  53     This interface can be used to retrieve additional information about
  54     supported commands. This interface is normally used by configuration
  55     implementations to retrieve all supported commands.
  56     A dispatch information provider is normally supported by a
  57     <type>Frame</type> service.
  58     </p>
  59
  60     @see Frame
  61
  62     @since OOo 2.0.0
  63  */
  64 published interface XDispatchInformationProvider: com::sun::star::uno::XInterface
  65 {
  66     //-------------------------------------------------------------------------
  67     /** returns all supported command groups.
  68
  69         @returns
  70             a sequence of supported command groups.
  71
  72         @see CommandGroup
  73     */
  74     sequence < short > getSupportedCommandGroups();
  75
  76     //-------------------------------------------------------------------------
  77     /** returns additional information about supported commands of a
  78         given command group.
  79
  80         @param CommandGroup
  81             specifies a command group.
  82
  83         @returns
  84             name and group name of every command supported. A group ID which is
  85             not supported returns an empty <type scope="com::sun::star::uno">Sequence</type>.
  86     */
  87     sequence < DispatchInformation > getConfigurableDispatchInformation( [in] short CommandGroup );
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif