blob: 072ef5fd90664988d5dd8b823cb928698fd8fc78 (
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
|
/*************************************************************************
*
* 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: XUIControllerRegistration.idl,v $
* $Revision: 1.5 $
*
* 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_frame_XUIControllerRegistration_idl__
#define __com_sun_star_frame_XUIControllerRegistration_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
//=============================================================================
module com { module sun { module star { module frame {
//=============================================================================
/** is used to query, register and unregister user interface controller.
<p>
A user interface controller can be registered for a command URL. A certain user
interface controller will be created when a user interface element contains a
registered command URL.
@see PopupMenuControllerFactory
</p>
@since OOo 2.0
*/
published interface XUIControllerRegistration : com::sun::star::uno::XInterface
{
/** function to check if an user interface controller is registered
for a command URL and optional module.
@returns
true if a controller was registered for the combination of command URL
and model name.
@param aCommandURL
a command URL which specifies an action.
@param aModelName
an optional name of an OpenOffice model service. This value can remain empty if
no model service name was specified.
*/
boolean hasController( [in] string aCommandURL, [in] string aModelName );
/** function to create an association between a user interface controller implementation
and a command URL and optional module.
@param aCommandURL
a command URL which specifies an action which shoudl be associated with a user
interface controller.
@param aModelName
an optional name of an OpenOffice model service. This value can remain empty if
no model service name was specified.
@param aControllerImplementationName
a UNO implementation name that can be used to create a user interface controller
with the OpenOffice service manager.
*/
void registerController( [in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName );
/** function to remove a previously defined association between a user interface controller
implementation and a command URL and optional module.
@param aCommandURL
a command URL which specifies an action which shoudl be associated with a user
interface controller.
@param aModelName
an optional name of an OpenOffice model service. This value can remain empty if
no model service name was specified.
*/
void deregisterController( [in] string aCommandURL, [in] string aModelName );
};
}; }; }; };
//=============================================================================
#endif
|
