xref: /trunk/main/offapi/com/sun/star/ucb/CommandInfo.idl (revision cdf0e10c)
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_CommandInfo_idl__
28#define __com_sun_star_ucb_CommandInfo_idl__
29
30#ifndef __com_sun_star_reflection_XIdlClass_idl__
31#include <com/sun/star/reflection/XIdlClass.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module ucb {
38
39//=============================================================================
40/** describes a command.
41
42	@see XCommandProcessor
43*/
44published struct CommandInfo
45{
46	//-------------------------------------------------------------------------
47	/** contains the name of a command.
48	*/
49	string Name;
50
51	//-------------------------------------------------------------------------
52	/** contains an implementation specific handle for the command.
53
54		<p>It may be <code>-1</code> if the implementation has no handle.
55	*/
56	long Handle;
57
58	//-------------------------------------------------------------------------
59	/** contains the type of the command's argument.
60	*/
61	type ArgType;
62};
63
64//=============================================================================
65
66}; }; }; };
67
68#endif
69