offapi/com/sun/star/ucb/XCommandInfo.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: XCommandInfo.idl,v $
  10  * $Revision: 1.8 $
  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_ucb_XCommandInfo_idl__
  31 #define __com_sun_star_ucb_XCommandInfo_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_ucb_CommandInfo_idl__
  38 #include <com/sun/star/ucb/CommandInfo.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_UnsupportedCommandException_idl__
  42 #include <com/sun/star/ucb/UnsupportedCommandException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** provides access to information on a set of commands.
  52
  53     @version  1.0
  54     @author   Kai Sommerfeld
  55 */
  56 published interface XCommandInfo: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59     /** obtains information for all supported commands.
  60
  61         @returns
  62         a sequence with information for all supported commands.
  63     */
  64     sequence<com::sun::star::ucb::CommandInfo> getCommands();
  65
  66     //-------------------------------------------------------------------------
  67     /** returns information for a specific command.
  68
  69         @returns
  70         the information for the requested command.
  71
  72         @param Name
  73         specifies the name of the requested command.
  74
  75         @throws UnsupportedCommandException
  76         if the command is not supported.
  77     */
  78     com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name )
  79             raises( com::sun::star::ucb::UnsupportedCommandException );
  80
  81     //-------------------------------------------------------------------------
  82     /** returns information for a specific command.
  83
  84         @returns
  85         the information for the requested command.
  86
  87         @param Handle
  88         specifies the handle of the requested command.
  89
  90         @throws UnsupportedCommandException
  91         if the command is not supported.
  92     */
  93     com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle )
  94             raises( com::sun::star::ucb::UnsupportedCommandException );
  95
  96     //-------------------------------------------------------------------------
  97     /** checks whether a command specific is supported.
  98
  99         @returns
 100         <TRUE/> if a command with the specified name is supported;
 101         otherwise <FALSE/> is returned.
 102
 103         @param Name
 104         specifies the name of the requested command.
 105     */
 106     boolean hasCommandByName( [in] string Name );
 107
 108     //-------------------------------------------------------------------------
 109     /** checks whether a apecific command is supported.
 110
 111         @returns
 112         <TRUE/> if a command with the specified handle is supported;
 113         otherwise <FALSE/> is returned.
 114
 115         @param Name
 116         specifies the handle of the requested command.
 117     */
 118     boolean hasCommandByHandle( [in] long Handle );
 119
 120 };
 121
 122 //=============================================================================
 123
 124 }; }; }; };
 125
 126 #endif