blob: 1837996cc4ddbf7569f1868205ce6b343a5ebb62 (
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
|
/* -*- 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_SD_SOURCE_UI_INC_TOOLS_SLOTSTATELISTENER_HXX
#define INCLUDED_SD_SOURCE_UI_INC_TOOLS_SLOTSTATELISTENER_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>
#include <com/sun/star/lang/DisposedException.hpp>
#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:
/** 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 OUString& rSlotName);
/** The constructor de-registers all remaining listeners. Usually a prior
dispose() call should have done that already.
*/
virtual ~SlotStateListener();
/** 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 OUString& rSlotName);
//===== 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, std::exception) SAL_OVERRIDE;
//===== lang::XEventListener ============================================
virtual void SAL_CALL
disposing(const com::sun::star::lang::EventObject& rEvent)
throw(com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
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() SAL_OVERRIDE;
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();
/** This method throws a DisposedException when the object has already been
disposed.
*/
void ThrowIfDisposed()
throw (::com::sun::star::lang::DisposedException);
/** Transform the given string into a URL object.
*/
::com::sun::star::util::URL MakeURL (const 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
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
