blob: a72a6480fff888f52681233c5a8ff3b34deb6e2b (
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
171
172
173
174
175
176
177
178
|
/*************************************************************************
*
* 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: SlotStateListener.hxx,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 SD_TOOLS_SLOT_STATE_LISTENER_HXX
#define SD_TOOLS_SLOT_STATE_LISTENER_HXX
#include "MutexOwner.hxx"
#include <com/sun/star/frame/XStatusListener.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/FeatureStateEvent.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#ifndef _COM_SUN_STAR_LANG_DISPOSEDEXCEPTIOIN_HPP_
#include <com/sun/star/lang/DisposedException.hpp>
#endif
#include <com/sun/star/lang/XComponent.hpp>
#include <cppuhelper/compbase1.hxx>
#include <tools/link.hxx>
namespace sd { namespace tools {
typedef cppu::WeakComponentImplHelper1<
::com::sun::star::frame::XStatusListener
> SlotStateListenerInterfaceBase;
/** Listen for state changes of slots. This class has been created in order
to be informed when the support for vertical writing changes but it can
be used to relay state changes of other slots as well.
*/
class SlotStateListener
: protected MutexOwner,
public SlotStateListenerInterfaceBase
{
public:
/** Create a new object that has yet to be told about the the frame and
slots to listen to and the callback that state changes are relayed
to. When you want to listen to one single slot then you can use the
three argument variant of this constructor.
*/
SlotStateListener (void);
/** This convenience version of the constructor takes all parameters
that are necessary to observe a single slot. See descriptions of
the SetCallback(), ConnectToFrame(), and ObserveSlot() methods for
explanations about the parameters.
*/
SlotStateListener (
Link& rCallback,
const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XDispatchProvider>& rxDispatchProvider,
const ::rtl::OUString& rSlotName);
/** The constructor de-registers all remaining listeners. Usually a prior
dispose() call should have done that already.
*/
virtual ~SlotStateListener (void);
/** Set the callback to the given value. Whenever one of the observed
slots changes its state this callback is informed about it.
Changing the callback does not release the listeners.
@throws DisposedException
*/
void SetCallback (const Link& rCallback);
/** Set the frame whose slots shall be observed. When an object of this
class is already observing slots of another frame then these
listeners are released first.
@throws DisposedException
*/
void ConnectToDispatchProvider (
const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XDispatchProvider>& rxDispatchProvider);
/** Observe the slot specified by the given name. Note that
ConnectToFrame() has to have been called earlier.
@param rSlotName
The name of the slot to observe. An example is
".uno:VerticalTextState".
@throws DisposedException
*/
void ObserveSlot (const ::rtl::OUString& rSlotName);
/** Return whether the called SlotStateListener is connected to a slot.
One reason for returning <FALSE/> is that the SlotStateListener has
been created before the controller and frame have been properly
initialized.
*/
bool IsValid (void) const;
//===== frame::XStatusListener ==========================================
/** Called by slot state change broadcasters. In turn the callback is
informed about the state chage.
@throws DisposedException
*/
virtual void SAL_CALL
statusChanged (
const ::com::sun::star::frame::FeatureStateEvent& rState)
throw (::com::sun::star::uno::RuntimeException);
//===== lang::XEventListener ============================================
virtual void SAL_CALL
disposing(const com::sun::star::lang::EventObject& rEvent)
throw(com::sun::star::uno::RuntimeException);
protected:
/** This method is called by the WeakComponentImplHelper base class in
reaction to a XComponent::dispose() call. It releases all currently
active listeners.
*/
virtual void SAL_CALL disposing (void);
private:
Link maCallback;
/** Remember the URLs that describe slots whose state changes we are
listening to.
*/
typedef ::std::vector<com::sun::star::util::URL> RegisteredURLList;
RegisteredURLList maRegisteredURLList;
::com::sun::star::uno::WeakReference<
::com::sun::star::frame::XDispatchProvider> mxDispatchProviderWeak;
/** Deregister all currently active state change listeners.
*/
void ReleaseListeners (void);
/** This method throws a DisposedException when the object has already been
disposed.
*/
void ThrowIfDisposed (void)
throw (::com::sun::star::lang::DisposedException);
/** Transform the given string into a URL object.
*/
::com::sun::star::util::URL MakeURL (const ::rtl::OUString& rSlotName) const;
/** Return an XDispatch object for the given URL.
*/
::com::sun::star::uno::Reference<com::sun::star::frame::XDispatch>
GetDispatch (
const ::com::sun::star::util::URL& rURL) const;
};
} } // end of namespace ::sd::tools
#endif
|
