1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_ucb_XCommandInfo_idl__ 28#define __com_sun_star_ucb_XCommandInfo_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_ucb_CommandInfo_idl__ 35#include <com/sun/star/ucb/CommandInfo.idl> 36#endif 37 38#ifndef __com_sun_star_ucb_UnsupportedCommandException_idl__ 39#include <com/sun/star/ucb/UnsupportedCommandException.idl> 40#endif 41 42 43//============================================================================= 44 45module com { module sun { module star { module ucb { 46 47//============================================================================= 48/** provides access to information on a set of commands. 49 50 @version 1.0 51 @author Kai Sommerfeld 52*/ 53published interface XCommandInfo: com::sun::star::uno::XInterface 54{ 55 //------------------------------------------------------------------------- 56 /** obtains information for all supported commands. 57 58 @returns 59 a sequence with information for all supported commands. 60 */ 61 sequence<com::sun::star::ucb::CommandInfo> getCommands(); 62 63 //------------------------------------------------------------------------- 64 /** returns information for a specific command. 65 66 @returns 67 the information for the requested command. 68 69 @param Name 70 specifies the name of the requested command. 71 72 @throws UnsupportedCommandException 73 if the command is not supported. 74 */ 75 com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name ) 76 raises( com::sun::star::ucb::UnsupportedCommandException ); 77 78 //------------------------------------------------------------------------- 79 /** returns information for a specific command. 80 81 @returns 82 the information for the requested command. 83 84 @param Handle 85 specifies the handle of the requested command. 86 87 @throws UnsupportedCommandException 88 if the command is not supported. 89 */ 90 com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle ) 91 raises( com::sun::star::ucb::UnsupportedCommandException ); 92 93 //------------------------------------------------------------------------- 94 /** checks whether a command specific is supported. 95 96 @returns 97 <TRUE/> if a command with the specified name is supported; 98 otherwise <FALSE/> is returned. 99 100 @param Name 101 specifies the name of the requested command. 102 */ 103 boolean hasCommandByName( [in] string Name ); 104 105 //------------------------------------------------------------------------- 106 /** checks whether a apecific command is supported. 107 108 @returns 109 <TRUE/> if a command with the specified handle is supported; 110 otherwise <FALSE/> is returned. 111 112 @param Name 113 specifies the handle of the requested command. 114 */ 115 boolean hasCommandByHandle( [in] long Handle ); 116 117}; 118 119//============================================================================= 120 121}; }; }; }; 122 123#endif 124