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
|
/* This file is part of the KDE project
Copyright (C) 2001 Ian Reinhart Geiser <[email protected]>
This program 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 program 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
General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this program; see the file COPYING. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KWINDOW_INTERFACE_H
#define KWINDOW_INTERFACE_H
#include <dcopobject.h>
#include <qstringlist.h>
#include <qcstring.h>
#include <dcopref.h>
class KDCOPActionProxy;
class KDCOPPropertyProxy;
class KMainWindow;
/**
* @short DCOP interface to KMainWindow.
*
* This is the main interface to the KMainWindow. This will provide a consistent
* DCOP interface to all KDE applications that use it.
*
* @author Ian Reinhart Geiser <[email protected]>
*/
class KDEUI_EXPORT KMainWindowInterface : virtual public DCOPObject
{
K_DCOP
public:
/**
Construct a new interface object.
@param mainWindow - The parent KMainWindow object
that will provide us with the KAction objects.
*/
KMainWindowInterface( KMainWindow * mainWindow );
/**
Destructor
Cleans up the dcop action proxy object.
**/
~KMainWindowInterface();
QCStringList functionsDynamic();
bool processDynamic(const QCString &fun, const QByteArray &data, QCString& replyType, QByteArray &replyData);
k_dcop:
/**
Return a list of actions available to the application's window.
@return A QCStringList containing valid names actions.
*/
QCStringList actions();
/**
Activates the requested action.
@param action The name of the action to activate. The names of valid
actions can be found by calling actions().
@return The success of the operation.
*/
bool activateAction( QCString action);
/**
Disables the requested action.
@param action The name of the action to disable. The names of valid
actions can be found by calling actions().
@return The success of the operation.
*/
bool disableAction( QCString action);
/**
Enables the requested action.
@param action The name of the action to enable. The names of valid
actions can be found by calling actions().
@return The success of the operation.
*/
bool enableAction( QCString action);
/**
Returns the status of the requested action.
@param action The name of the action. The names of valid
actions can be found by calling actions().
@returns The state of the action, true - enabled, false - disabled.
*/
bool actionIsEnabled( QCString action);
/**
Returns the tool tip text of the requested action.
@param action The name of the action to activate. The names of valid
actions can be found by calling actions().
@return A QCString containing the text of the action's tool tip.
*/
QCString actionToolTip( QCString action);
/**
Returns a dcop reference to the selected KAction
@param name The name of the action. The names of valid
actions can be found by calling actions().
@return A DCOPRef for the kaction.
**/
DCOPRef action( const QCString &name );
/**
Returns and action map
**/
QMap<QCString,DCOPRef> actionMap();
/**
Returns the ID of the current main window.
This is useful for automated screen captures or other evil
widget fun.
@return A integer value of the main window's ID.
**/
int getWinID();
/**
Copies a pixmap representation of the current main window to
the clipboard.
**/
void grabWindowToClipBoard();
// bool isHidden();
void hide();
// bool isMaximized();
void maximize();
// bool isMinimized();
void minimize();
// int width();
// int height();
void resize(int newWidth, int newHeight);
// int Xpos();
// int Ypos();
void move(int newX, int newY);
void setGeometry(int newX, int newY, int newWidth, int newHeight);
void raise();
void lower();
void restore();
void show();
void close();
// QCStringList getQTProperties();
private:
KMainWindow *m_MainWindow;
KDCOPActionProxy *m_dcopActionProxy;
KDCOPPropertyProxy *m_dcopPropertyProxy;
};
#endif
|
