blob: d47b7f9da4020ddbdc3ca98ca5d8f82a4d587664 (
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
127
128
129
130
131
132
133
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_PopupMenuController_idl__
#define __com_sun_star_frame_PopupMenuController_idl__
#include <com/sun/star/frame/XPopupMenuController.idl>
#include <com/sun/star/lang/XInitialization.idl>
#include <com/sun/star/frame/XStatusListener.idl>
#include <com/sun/star/frame/XDispatchProvider.idl>
#include <com/sun/star/lang/XComponent.idl>
module com { module sun { module star { module frame {
/** provides access to a pop-up menu controller.
<p>
A pop-up menu controller is used to make special functions available to
users, which depend on runtime or context specific conditions.<br/>
A typical example for a pop-up menu controller can be a recent file list
implementation which provides a list of latest files that a user has
worked on. This list gets changes consistently during a work session.
</p>
@since OOo 2.0
*/
service PopupMenuController
{
/** supports functions to initialize and update a pop-up menu controller
implementation.
<p>
A pop-up menu controller implementation gets initialized with a
<type scope="com::sun::star::awt">XPopupMenu</type> object. This assures
that a pop-up menu controller can be implemented with any UNO based
language.
</p>
*/
interface com::sun::star::frame::XPopupMenuController;
/** provides functions to initialize a pop-up menu controller with
specific data which are needed.
<p>
This interface should not directly used. A factory service is responsible to
initialize every controller correctly.<br/>
A pop-up menu controller needs at least two additional arguments
provided as <type scope="com::sun::star::beans">PropertyValue</type>:
<ul>
<li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type>
instance to which the pop-up menu controller belongs to.</li>
<li><b>CommandURL</b><br>specifies which pop-up menu controller should be created.</li>
</ul>
</p>
@see PopupMenuControllerFactory
*/
interface com::sun::star::lang::XInitialization;
/** used to brief the pop-up menu controller with new status information.
<p>
A pop-up menu controller makes special functions available to users which
normally depend on the state of other data. This interface is used to
send this data to a controller implementation.
</p>
*/
interface com::sun::star::frame::XStatusListener;
/** used to query for commands supported by the pop-up menu controller to
execute them directly.
<p>
A pop-up menu controller provides special functions which should be
available by the normal dispatch API. This optional interface enables
pop-up menu controller to be normal dispatch providers.<br/>
<b>Attention:</b><br/>
Po-pup menu controller functions must be specified using the following
the dispatch URL scheme: "vnd.sun.star.popup:" opaque_part [ "?" query ].
</p>
@since OOo 2.2
*/
[optional] interface com::sun::star::frame::XDispatchProvider;
/** used to dispose pop-up menu controller by the owner instance.
<p>
A pop-up menu controller resides in a menu which has a limited
life-time. For correct life-time handling a pop-up menu
controller should support this interface.
</p>
@since OOo 2.2
*/
[optional] interface com::sun::star::lang::XComponent;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
