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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_FRAMEWORK_INC_DISPATCH_MENUDISPATCHER_HXX
#define INCLUDED_FRAMEWORK_INC_DISPATCH_MENUDISPATCHER_HXX
#include <classes/taskcreator.hxx>
#include <macros/generic.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <classes/menumanager.hxx>
#include <general.h>
#include <stdtypes.h>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/util/URL.hpp>
#include <com/sun/star/frame/DispatchDescriptor.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/frame/XStatusListener.hpp>
#include <com/sun/star/frame/XFrameLoader.hpp>
#include <com/sun/star/frame/XLoadEventListener.hpp>
#include <com/sun/star/frame/XDesktop.hpp>
#include <com/sun/star/frame/FeatureStateEvent.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XFrameActionListener.hpp>
#include <cppuhelper/implbase2.hxx>
#include <cppuhelper/weakref.hxx>
#include <cppuhelper/interfacecontainer.h>
namespace framework{
/*-************************************************************************************************************
We must save information about our listener and URL for listening.
We implement this as a hashtable for strings.
*//*-*************************************************************************************************************/
typedef ::cppu::OMultiTypeInterfaceContainerHelperVar< OUString ,
OUStringHash > IMPL_ListenerHashContainer;
/*-************************************************************************************************************
@short helper for desktop only(!) to create new tasks on demand for dispatches
@descr Use this class as member only! Never use it as baseclass.
XInterface will be ambigous and we hold a weakcss::uno::Reference to ouer OWNER - not to ouer SUPERCLASS!
@implements XInterface
XDispatch
XLoadEventListener
XFrameActionListener
XEventListener
@base OWeakObject
@devstatus ready to use
*//*-*************************************************************************************************************/
class MenuDispatcher : public ::cppu::WeakImplHelper2<
css::frame::XDispatch ,
css::frame::XFrameActionListener >
{
// public methods
public:
// constructor / destructor
/*-****************************************************************************************************
@short standard ctor
@descr These initialize a new instance of ths class with needed information for work.
@seealso using at owner
@param "rxContext" , css::uno::Reference to servicemanager for creation of new services
@param "xOwner" , css::uno::Reference to our owner, the Desktop!!!
@return -
@onerror -
*//*-*****************************************************************************************************/
MenuDispatcher( const css::uno::Reference< css::uno::XComponentContext >& rxContext ,
const css::uno::Reference< css::frame::XFrame >& xOwner );
// XDispatch
/*-****************************************************************************************************
@short dispatch URL with arguments
@descr Every dispatch create a new task. If load of URL failed task will deleted automaticly!
@seealso -
@param "aURL" , URL to dispatch.
@param "seqArguments" , list of optional arguments.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void SAL_CALL dispatch( const css::util::URL& aURL ,
const css::uno::Sequence< css::beans::PropertyValue >& seqProperties ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/*-****************************************************************************************************
@short add listener for state events
@descr You can add a listener to get information about status of dispatch: OK or Failed.
@seealso method loadFinished()
@seealso method loadCancelled()
@param "xControl" , css::uno::Reference to a valid listener for state events.
@param "aURL" , URL about listener will be informed, if something occurred.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void SAL_CALL addStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xControl,
const css::util::URL& aURL ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
/*-****************************************************************************************************
@short remove listener for state events
@descr You can remove a listener if information of dispatch isn't important for you any longer.
@seealso method loadFinished()
@seealso method loadCancelled()
@param "xControl" , css::uno::Reference to a valid listener.
@param "aURL" , URL on which listener has registered.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xControl,
const css::util::URL& aURL ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XFrameActionListener
virtual void SAL_CALL frameAction( const css::frame::FrameActionEvent& aEvent ) throw ( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XEventListener
/*-****************************************************************************************************
@short dispose current instance
@descr If service helper isn't required any longer call this method to release all used resources.
@seealso -
@param "aEvent", information about source of this event.
@return -
@onerror -
*//*-*****************************************************************************************************/
void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// protected methods
protected:
/*-****************************************************************************************************
@short standard destructor
@descr This method destruct an instance of this class and clear some member.
This method is protected, because its not allowed to use an instance of this class as a member!
You MUST use a pointer.
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual ~MenuDispatcher();
// private methods
private:
/*-****************************************************************************************************
@short -
@descr -
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
sal_Bool impl_setMenuBar( MenuBar* pMenuBar, sal_Bool bMenuFromResource = sal_False );
/*-****************************************************************************************************
@short -
@descr -
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
void impl_setAccelerators( Menu* pMenu, const Accelerator& aAccel );
// variables
// (should be private everyway!)
private:
css::uno::WeakReference< css::frame::XFrame > m_xOwnerWeak ; /// css::uno::WeakReference to owner (Don't use a hard css::uno::Reference. Owner can't delete us then!)
css::uno::Reference< css::uno::XComponentContext > m_xContext ; /// factory shared with our owner to create new services!
osl::Mutex m_mutex;
IMPL_ListenerHashContainer m_aListenerContainer; /// hash table for listener at specified URLs
sal_Bool m_bAlreadyDisposed ; /// Protection against multiple disposing calls.
sal_Bool m_bActivateListener ; /// dispatcher is listener for frame activation
MenuManager* m_pMenuManager ; /// menu manager controlling menu dispatches
}; // class MenuDispatcher
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_DISPATCH_MENUDISPATCHER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
