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
|
/**************************************************************
*
* 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 SVX_FMDISPATCH_HXX
#define SVX_FMDISPATCH_HXX
/** === begin UNO includes === **/
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/form/runtime/XFormOperations.hpp>
/** === end UNO includes === **/
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/interfacecontainer.hxx>
//........................................................................
namespace svx
{
//........................................................................
//====================================================================
//= OSingleFeatureDispatcher
//====================================================================
typedef ::cppu::WeakImplHelper1 < ::com::sun::star::frame::XDispatch
> OSingleFeatureDispatcher_Base;
class OSingleFeatureDispatcher : public OSingleFeatureDispatcher_Base
{
private:
::osl::Mutex& m_rMutex;
::cppu::OInterfaceContainerHelper m_aStatusListeners;
::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >
m_xFormOperations;
const ::com::sun::star::util::URL m_aFeatureURL;
::com::sun::star::uno::Any m_aLastKnownState;
const sal_Int16 m_nFormFeature;
sal_Bool m_bLastKnownEnabled;
sal_Bool m_bDisposed;
public:
/** constructs the dispatcher
@param _rFeatureURL
the URL of the feature which this instance is responsible for
@param _nFeatureId
the feature which this instance is responsible for
@param _rController
the controller which is responsible for providing the state of feature of this instance,
and for executing it. After disposing the dispatcher instance, the controller will
not be accessed anymore
@see dispose
*/
OSingleFeatureDispatcher(
const ::com::sun::star::util::URL& _rFeatureURL,
const sal_Int16 _nFormFeature,
const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >& _rxFormOperations,
::osl::Mutex& _rMutex
);
/** disposes the dispatcher instance
All status listeners will, after receiving an <member scope="com::sun::star::lang">XEventListener::disposing</member>
call, be released.
The controller provided in the in constructor will not be used anymore after returning from this call.
No further requests to dispatch slots will be accepted.
Multiple calls are allowed: if the object already was disposed, then subsequent calls are
silently ignored.
*/
void dispose();
/** notifies all our listeners of the current state
*/
void updateAllListeners();
protected:
// XDispatch
virtual void SAL_CALL dispatch( const ::com::sun::star::util::URL& _rURL, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArguments ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxControl, const ::com::sun::star::util::URL& _rURL ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxControl, const ::com::sun::star::util::URL& _rURL ) throw (::com::sun::star::uno::RuntimeException);
protected:
/** notifies our current state to one or all listeners
@param _rxListener
the listener to notify. May be NULL, in this case all our listeners will be
notified with the current state
@param _rFreeForNotification
a guard which currently locks our mutex, and which is to be cleared
for actually doing the notification(s)
*/
void notifyStatus(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxListener,
::osl::ClearableMutexGuard& _rFreeForNotification
);
private:
/** checks whether our instance is alive
If the instance already received a <member>dispose</member> call, then a
<type scope="com::sun::star::lang">DisposedException</type> is thrown.
@precond
our Mutex is locked - else calling the method would not make sense, since
it's result could be out-of-date as soon as it's returned to the caller.
*/
void checkAlive() const SAL_THROW((::com::sun::star::lang::DisposedException));
/** retrieves the current status of our feature, in a format which can be used
for UNO notifications
@precond
our mutex is locked
*/
void getUnoState( ::com::sun::star::frame::FeatureStateEvent& /* [out] */ _rState ) const;
private:
OSingleFeatureDispatcher(); // never implemented
OSingleFeatureDispatcher( const OSingleFeatureDispatcher& ); // never implemented
OSingleFeatureDispatcher& operator=( const OSingleFeatureDispatcher& ); // never implemented
};
//........................................................................
} // namespace svx
//........................................................................
#endif
|
