blob: d3a45adef022d5eba427e32b4d016e91d40de9f5 (
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
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
|
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef __FRAMEWORK_DISPATCH_WINDOWCOMMANDDISPATCH_HXX_
#define __FRAMEWORK_DISPATCH_WINDOWCOMMANDDISPATCH_HXX_
//_______________________________________________
// my own includes
#include <threadhelp/threadhelpbase.hxx>
//_______________________________________________
// interface includes
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
//_______________________________________________
// other includes
#include <cppuhelper/implbase1.hxx>
#include <tools/link.hxx>
//_______________________________________________
// namespace
namespace framework{
namespace css = ::com::sun::star;
//_______________________________________________
// exported const
//_______________________________________________
// exported definitions
/** @short internal helper to bind e.g. MAC-Menu events to our internal dispatch API.
@descr On e.g. MAC platform system menus are merged together with some fix entries as
e.g. "Pereferences" or "About". These menu entries trigger hard coded commands.
Here we map these commands to the right URLs and dispatch them.
This helper knows a frame and it's container window (where VCL provide the hard coded
commands). We hold those objects weak ... so there is no need to react for complex dispose/ing()
scenarios. On the other side VCL does not hold us alive (because it doesn't know our UNO reference).
So we register us at the XWindow as event listener also to be sure to live as long the XWindow/VCLWindow lives.
*/
class WindowCommandDispatch : private ThreadHelpBase
, public ::cppu::WeakImplHelper1< css::lang::XEventListener >
{
//___________________________________________
// const
private:
/// dispatch URL to trigger our "Tools->Options" dialog
static const ::rtl::OUString COMMAND_PREFERENCES;
/// dispatch URL to trigger our About box
static const ::rtl::OUString COMMAND_ABOUTBOX;
//___________________________________________
// member
private:
/// can be used to create own needed services on demand.
css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
/// knows the frame, where we dispatch our commands as weak reference
css::uno::WeakReference< css::frame::XFrame > m_xFrame;
/// knows the VCL window (where the hard coded commands occurred) as weak XWindow reference
css::uno::WeakReference< css::awt::XWindow > m_xWindow;
//___________________________________________
// native interface
public:
//_______________________________________
/** @short creates a new instance and initialize it with all necessary parameters.
@descr Every instance of such MACDispatch can be used for the specified context only.
Means: 1 MACDispatch object is bound to 1 Frame/Window pair in which context
the detected commands will be executed.
@param xSMGR
will be used to create own needed services on demand.
@param xFrame
used as for new detected commands.
*/
WindowCommandDispatch(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ,
const css::uno::Reference< css::frame::XFrame >& xFrame);
//_______________________________________
/** @short used to free internal resources.
*/
virtual ~WindowCommandDispatch();
//___________________________________________
// uno interface
public:
// XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& aSource)
throw (css::uno::RuntimeException);
//___________________________________________
// implementation
private:
//_______________________________________
/** @short establish all listener connections we need.
@descr Those listener connections will be created one times only (see ctor).
Afterwards we listen for incoming events till our referred frame/window pair
will be closed. All objects die by refcount automatically. Because we hold
it weak ...
*/
void impl_startListening();
//_______________________________________
/** @short callback from VCL to notify new commands
*/
DECL_LINK( impl_notifyCommand, void* );
//_______________________________________
/** @short dispatch right command URLs into our frame context.
@param sCommand
the command for dispatch
*/
void impl_dispatchCommand(const ::rtl::OUString& sCommand);
}; // class MACDispatch
} // namespace framework
#endif // #ifndef __FRAMEWORK_DISPATCH_MACDISPATCH_HXX_
|
