1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XCommandInfo_idl__
24cdf0e10cSrcweir#define __com_sun_star_ucb_XCommandInfo_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_ucb_CommandInfo_idl__
31cdf0e10cSrcweir#include <com/sun/star/ucb/CommandInfo.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_ucb_UnsupportedCommandException_idl__
35cdf0e10cSrcweir#include <com/sun/star/ucb/UnsupportedCommandException.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
42cdf0e10cSrcweir
43cdf0e10cSrcweir//=============================================================================
44cdf0e10cSrcweir/** provides access to information on a set of commands.
45cdf0e10cSrcweir
46cdf0e10cSrcweir	@version  1.0
47cdf0e10cSrcweir	@author   Kai Sommerfeld
48cdf0e10cSrcweir*/
49cdf0e10cSrcweirpublished interface XCommandInfo: com::sun::star::uno::XInterface
50cdf0e10cSrcweir{
51cdf0e10cSrcweir	//-------------------------------------------------------------------------
52cdf0e10cSrcweir	/** obtains information for all supported commands.
53cdf0e10cSrcweir
54cdf0e10cSrcweir		@returns
55cdf0e10cSrcweir		a sequence with information for all supported commands.
56cdf0e10cSrcweir	*/
57cdf0e10cSrcweir	sequence<com::sun::star::ucb::CommandInfo> getCommands();
58cdf0e10cSrcweir
59cdf0e10cSrcweir	//-------------------------------------------------------------------------
60cdf0e10cSrcweir	/** returns information for a specific command.
61cdf0e10cSrcweir
62cdf0e10cSrcweir		@returns
63cdf0e10cSrcweir		the information for the requested command.
64cdf0e10cSrcweir
65cdf0e10cSrcweir		@param Name
66cdf0e10cSrcweir		specifies the name of the requested command.
67cdf0e10cSrcweir
68cdf0e10cSrcweir		@throws UnsupportedCommandException
69cdf0e10cSrcweir		if the command is not supported.
70cdf0e10cSrcweir	*/
71cdf0e10cSrcweir	com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name )
72cdf0e10cSrcweir			raises( com::sun::star::ucb::UnsupportedCommandException );
73cdf0e10cSrcweir
74cdf0e10cSrcweir	//-------------------------------------------------------------------------
75cdf0e10cSrcweir	/** returns information for a specific command.
76cdf0e10cSrcweir
77cdf0e10cSrcweir		@returns
78cdf0e10cSrcweir		the information for the requested command.
79cdf0e10cSrcweir
80cdf0e10cSrcweir		@param Handle
81cdf0e10cSrcweir		specifies the handle of the requested command.
82cdf0e10cSrcweir
83cdf0e10cSrcweir		@throws UnsupportedCommandException
84cdf0e10cSrcweir		if the command is not supported.
85cdf0e10cSrcweir	*/
86cdf0e10cSrcweir	com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle )
87cdf0e10cSrcweir			raises( com::sun::star::ucb::UnsupportedCommandException );
88cdf0e10cSrcweir
89cdf0e10cSrcweir	//-------------------------------------------------------------------------
90cdf0e10cSrcweir	/** checks whether a command specific is supported.
91cdf0e10cSrcweir
92cdf0e10cSrcweir		@returns
93cdf0e10cSrcweir		<TRUE/> if a command with the specified name is supported;
94cdf0e10cSrcweir		otherwise <FALSE/> is returned.
95cdf0e10cSrcweir
96cdf0e10cSrcweir		@param Name
97cdf0e10cSrcweir		specifies the name of the requested command.
98cdf0e10cSrcweir	*/
99cdf0e10cSrcweir	boolean hasCommandByName( [in] string Name );
100cdf0e10cSrcweir
101cdf0e10cSrcweir	//-------------------------------------------------------------------------
102cdf0e10cSrcweir	/** checks whether a apecific command is supported.
103cdf0e10cSrcweir
104cdf0e10cSrcweir		@returns
105cdf0e10cSrcweir		<TRUE/> if a command with the specified handle is supported;
106cdf0e10cSrcweir		otherwise <FALSE/> is returned.
107cdf0e10cSrcweir
108cdf0e10cSrcweir		@param Name
109cdf0e10cSrcweir		specifies the handle of the requested command.
110cdf0e10cSrcweir	*/
111cdf0e10cSrcweir	boolean hasCommandByHandle( [in] long Handle );
112cdf0e10cSrcweir
113cdf0e10cSrcweir};
114cdf0e10cSrcweir
115cdf0e10cSrcweir//=============================================================================
116cdf0e10cSrcweir
117cdf0e10cSrcweir}; }; }; };
118cdf0e10cSrcweir
119cdf0e10cSrcweir#endif
120