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