summaryrefslogtreecommitdiffstats
path: root/kicker/extensions/kasbar/kastasker.h
blob: 1379c8d8c9c5ddb85f1c1a67a7172b0452057e52 (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
// -*- c++ -*-

/* kastasker.h
**
** Copyright (C) 2001-2004 Richard Moore <rich@kde.org>
** Contributor: Mosfet
**     All rights reserved.
**
** KasBar is dual-licensed: you can choose the GPL or the BSD license.
** Short forms of both licenses are included below.
*/

/*
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU 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 General Public License
** along with this program in a file called COPYING; if not, write to
** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA 02110-1301, USA.
*/

/*
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions
** are met:
** 1. Redistributions of source code must retain the above copyright
**    notice, this list of conditions and the following disclaimer.
** 2. Redistributions in binary form must reproduce the above copyright
**    notice, this list of conditions and the following disclaimer in the
**    documentation and/or other materials provided with the distribution.
**
** THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
** ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
** SUCH DAMAGE.
*/

/*
** Bug reports and questions can be sent to kde-devel@kde.org
*/

#ifndef KASTASKER_H
#define KASTASKER_H

#include "kasbar.h"

#include <kdemacros.h>
#include <taskmanager.h>

class KConfig;
class KPixmap;
class KPopupMenu;
class KAction;
class KToggleAction;

class Task;
class Startup;

class KasTaskItem;
class KasStartupItem;
class KasGroupItem;
class KasTasker;
class KasGrouper;

/**
 * A KasBar that provides a taskbar using the TaskManager API.
 *
 * @author Richard Moore, rich@kde.org
 */
class KDE_EXPORT KasTasker : public KasBar
{
    Q_OBJECT
    Q_PROPERTY( bool isTopLevel READ isTopLevel )
    Q_PROPERTY( bool showClock READ showClock )
    Q_PROPERTY( bool showLoad READ showLoad )

public:
    /** Create a KasTasker widget. */
    KasTasker( Orientation o, QWidget* parent = 0, const char* name = 0, WFlags f = 0 );

    /**
     * Create a KasTasker widget that is slaved to another KasTasker. The
     * created widget will inherit the settings of the parent, but will
     * not connect to the signals of the TaskManager.
     */
    KasTasker( Orientation o, KasTasker *master,
	       QWidget *parent=0, const char *name=0, WFlags f=0 );

    /** Cleans up. */
    virtual ~KasTasker();

    /** Factory method that returns the default menu for items in the bar. */
    virtual KPopupMenu *contextMenu();

    virtual KasTasker *createChildBar( Orientation o, QWidget *parent, const char *name=0 );

    /**
     * Returns true if this is the top KasTasker. Note that it is possible for
     * the top KasTasker to be a child of another KasBar derived class, so
     * this can return a different result to KasBar::isTopLevel().
     */
    bool isTopLevel() const { return dynamic_cast<KasTasker *>( KasBar::master() ) ? true : false; }
    KasTasker *master() const { return dynamic_cast<KasTasker *>( KasBar::master() ); }

    /** Finds the item representing a task (if there is one). */
    KasTaskItem *findItem( Task::Ptr  );

    /** Finds the item representing a startup (if there is one). */
    KasStartupItem *findItem( Startup::Ptr s );

    /** Returns true iff thumbnails are enabled. */
    bool thumbnailsEnabled() const { return enableThumbs_; }

    /** Returns true iff thumbnails should be shown in the boxes instead of icons. */
    bool embedThumbnails() const { return embedThumbs_; }

    bool showClock() const { return showClock_; }
    bool showLoad() const { return showLoad_; }

    /** Returns the proportions of the window thumbnails. */
    double thumbnailSize() const { return thumbnailSize_; }

    /** Returns true iff the startup notifier is enabled. */
    bool notifierEnabled() const { return enableNotifier_; }

    /** Returns true iff the modified flag should be shown. */
    bool showModified() const { return showModified_; }

    /** Returns true iff a progress bar should be shown for progress windows. */
    bool showProgress() const { return showProgress_; }

    /** Returns true iff we should indicate when a window demands attention. */
    bool showAttention() const { return showAttention_; }

    /** Returns true iff windows from all desktops should be displayed. */
    bool showAllWindows() const { return showAllWindows_; }

    /** Returns the delay between thumbnail updates (in seconds). */
    int thumbnailUpdateDelay() const { return thumbUpdateDelay_; }

    /** Returns true iff windows should be grouped together. */
    bool groupWindows() const { return groupWindows_; }

    /** Returns true iff windows on inactive desktops should be grouped together. */
    bool groupInactiveDesktops() const { return groupInactiveDesktops_; }

    /** Returns true iff we should only show windows that are minimized. */
    bool onlyShowMinimized() const { return onlyShowMinimized_; }

    /** Returns true if this bar is floating. */
    bool isStandAlone() const { return standalone_; }

    //
    // Internal stuff
    //

    /**
     * Converts the item for a task into a group item to which additional
     * tasks can be added.
     */
    KasGroupItem *convertToGroup( Task::Ptr t );

    /** Moves an item from a group into the main bar. */
    void moveToMain( KasGroupItem *gi, Task::Ptr t );

    /** Moves all the items from a group into the main bar and removes the group. */
    void moveToMain( KasGroupItem *gi );

public slots:
    /** Adds a task to the bar. */
    void addTask( Task::Ptr  );

    /** Removes a task from the bar. */
    void removeTask( Task::Ptr  );

    /** Adds a startup item to the bar. */
    void addStartup( Startup::Ptr  );

    /** Removes a startup item from the bar. */
    void removeStartup( Startup::Ptr  );

    void refreshAll();
    void refreshAllLater();
    void refreshIconGeometry();

    void setNotifierEnabled( bool enable );
    void setShowModified( bool enable );
    void setShowProgress( bool enable );
    void setShowAttention( bool enable );

    void setShowAllWindows( bool enable );
    void setGroupWindows( bool enable );
    void setGroupInactiveDesktops( bool enable );
    void setOnlyShowMinimized( bool enable );

    void setThumbnailSize( double size );
    void setThumbnailSize( int percent );
    void setThumbnailsEnabled( bool enable );
    void setThumbnailUpdateDelay( int secs );
    void setEmbedThumbnails( bool enable );

    void setShowClock( bool enable );
    void setShowLoad( bool enable );

    void showPreferences();
    void showAbout();

    /** Sets the current KConfig object. */
    void setConfig( KConfig *config );
    KConfig *config() const { return conf; }

    /** Reads the settings from the current KConfig. */
    void readConfig();
    void writeConfig();
    void writeConfigLater();
    void writeLayout();

    /** Writes the settings of this bar to the specified KConfig. */
    void writeConfig( KConfig *conf );

    void setStandAlone( bool enable );

signals:
    void showAllWindowsChanged( bool );
    void groupWindowsChanged( bool );
    void showClockChanged( bool );
    void showLoadChanged( bool );

protected slots:
    /** Load settings from the specified configuration. */
    void readConfig( KConfig *conf );

private:
    KPopupMenu *menu;
    KConfig *conf;
    KasGrouper *grouper;
    KToggleAction *toggleDetachedAction;
    KToggleAction *showAllWindowsAction;
    KToggleAction *groupWindowsAction;
    KToggleAction *showClockAction;
    KToggleAction *showLoadAction;
    KAction *rotateBarAction;
    bool standalone_;

    bool passive_;
    bool enableThumbs_;
    bool embedThumbs_;
    double thumbnailSize_;
    bool enableNotifier_;
    bool showModified_;
    bool showProgress_;
    bool showAllWindows_;
    int thumbUpdateDelay_;
    bool groupWindows_;
    bool groupInactiveDesktops_;
    bool showAttention_;
    bool onlyShowMinimized_;
    bool showClock_;
    KasItem *clockItem;
    bool showLoad_;
    KasItem *loadItem;
};

#endif // KASTASKER_H