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
|
/* This file is part of the KDE project
Copyright (C) 2003-2004 Jaroslaw Staniek <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KEXIACTIONPROXY_H
#define KEXIACTIONPROXY_H
#include <tqguardedptr.h>
#include <tqasciidict.h>
#include <tqobject.h>
#include <tqpair.h>
#include <tqptrlist.h>
#include <tdeaction.h>
#include "kexiproject.h"
#include "kexisharedactionhost.h"
class TQSignal;
class TDEAction;
class KXMLGUIClient;
class TDEAction_setEnabled_Helper;
class KexiActionProxy;
//! Abstract helper class used to connect shared actions from outside of shared-action-aware object.
/*! Methods like KexiActionProxy::plugSharedAction() are not public, but
sometimes there's need for plugging an object that implements KexiActionProxy interface
from outside.
Reimplement KexiSharedActionConnector: do all needed connections in the constructor.
For example, with KexiQueryDesignerSQLEditor class we're using KTextEdit
(or KTextEditor::View) that's not shared-action-aware. So it's needed to conenct
e.g. "edit_undo" shared action to undo() slot, and so on. It is impelmented in more
generic way by implementing KTextEdit_SharedActionConnector class,
so the conenction can be reused many times by just allocating KTextEdit_SharedActionConnector
object for any KTextEditor when required (not only within KexiQueryDesignerSQLEditor).
*/
//TODO add method for setAvailable()
class KEXICORE_EXPORT KexiSharedActionConnector
{
public:
/* Connects shared actions offered by \a proxy to \a obj. */
KexiSharedActionConnector(KexiActionProxy* proxy, TQObject *obj);
~KexiSharedActionConnector();
protected:
void plugSharedAction(const char *action_name, const char *slot);
void plugSharedActionToExternalGUI(const char *action_name, KXMLGUIClient *client);
void plugSharedActionsToExternalGUI(
const TQValueList<TQCString>& action_names, KXMLGUIClient *client);
KexiActionProxy* m_proxy;
TQObject *m_object;
};
//! An interface that acts as proxy for shared actions within the application.
/*!
For example, edit->copy action can be reused to copy different types of items.
Availability and meaning of given action depends on the context, while
the context changes e.g. when another window is activated.
This class is mostly used by subclassing in KexiDialogBase or KexiDockBase
- you can subclass in a similar way.
*/
class KEXICORE_EXPORT KexiActionProxy
{
public:
/*! Constructs action proxy for object \a receiver, using \a host.
If \a host is NULL, KexiSharedActionHost::defaultHost() is used.
(you must be sure that it's true) -- it is casted to TQObject and assigned as the receiver.*/
KexiActionProxy(TQObject *receiver , KexiSharedActionHost *host = 0 );
virtual ~KexiActionProxy();
/*! Activates action named \a action_name for this proxy. If the action is executed
(accepted), true is returned. */
bool activateSharedAction(const char *action_name, bool alsoCheckInChildren = true);
/*! Sets host to \a host; rerely used. */
void setSharedActionHost(KexiSharedActionHost& host) { m_host = &host; }
/*! \return true, if action named \a action_name is enabled within the proxy.
False is returned either if the action is not available or is not supported.
\ sa isSupported() */
bool isAvailable(const char* action_name, bool alsoCheckInChildren = true) const;
/*! \return true, if action named \a action_name is supported by the proxy. */
bool isSupported(const char* action_name) const;
protected:
/*! Plugs shared action named \a action_name to slot \a slot in \a receiver.
\a Receiver is usually a child of _this_ widget. */
void plugSharedAction(const char *action_name, TQObject* receiver, const char *slot);
void unplugSharedAction(const char *action_name);
/*! Typical version of plugAction() method -- plugs action named \a action_name
to slot \a slot in _this_ widget. */
inline void plugSharedAction(const char *action_name, const char *slot) {
plugSharedAction(action_name, m_receiver, slot);
}
/*! Plugs action named \a action_name to a widget \a w, so the action is visible on this widget
as an item. \a w will typically be a menu, popup menu or a toolbar.
Does nothing if no action found, so generally this is safer than just caling e.g.
<code> action("myaction")->plug(myPopup); </code>
\return index of inserted item, or -1 if there is not action with name \a action_name.
\sa action(), TDEAction::plug(TQWidget*, int) */
int plugSharedAction(const char *action_name, TQWidget* w);
void plugSharedActionToExternalGUI(const char *action_name, KXMLGUIClient *client);
void plugSharedActionsToExternalGUI(
const TQValueList<TQCString>& action_names, KXMLGUIClient *client);
/*! Unplugs action named \a action_name from a widget \a w.
\sa plugSharedAction(const char *action_name, TQWidget* w) */
void unplugSharedAction(const char *action_name, TQWidget* w);
/*! Like above, but creates alternative action as a copy of \a action_name,
with \a alternativeText set. When this action is activated, just original action
specified by \a action_name is activated. The aternative action has autmatically set name as:
action_name + "_alt".
\return newly created action or 0 if \a action_name not found. */
TDEAction* plugSharedAction(const char *action_name, const TQString& alternativeText, TQWidget* w);
/*! \return action named with \a name or NULL if there is no such action. */
virtual TDEAction* sharedAction(const char* action_name);
inline TQObject *receiver() const { return m_receiver; }
virtual void setAvailable(const char* action_name, bool set);
/*! Adds \a child of this proxy. Children will receive activateSharedAction() event,
If activateSharedAction() "event" is not consumed by the main proxy,
we start to iterate over proxy children (in unspecified order) to and call
activateSharedAction() on every child until one of them accept the "event".
If proxy child is destroyed, it is automatically detached from its parent proxy.
Parent proxy is 0 by default. This pointer is properly cleared when parent proxy is destroyed. */
void addActionProxyChild( KexiActionProxy* child );
void takeActionProxyChild( KexiActionProxy* child );
KexiSharedActionHost *m_host;
TQGuardedPtr<TQObject> m_receiver;
TQAsciiDict< TQPair<TQSignal*,bool> > m_signals;
TQPtrList<KexiActionProxy> m_sharedActionChildren;
TQPtrList<TDEAction> m_alternativeActions;
KexiActionProxy* m_actionProxyParent;
TQObject m_signal_parent; //!< it's just to have common parent for owned signals
//! For internal use by plugSharedActionToExternalGUI()
TDEAction_setEnabled_Helper *m_TDEAction_setEnabled_helper;
public:
//! For internal use by addActionProxyChild(). \a parent can be 0.
void setActionProxyParent_internal( KexiActionProxy* parent );
//! @internal
KexiActionProxy *m_focusedChild;
friend class KexiSharedActionHost;
friend class TDEAction_setEnabled_Helper;
friend class KexiSharedActionConnector;
};
#endif
|
