libtaskmanager
TaskManager::Task Class Reference
#include <task.h>
List of all members.
Detailed Description
A dynamic interface to a task (main window).
- See also:
- TaskManager
Definition at line 53 of file task.h.
Constructor & Destructor Documentation
TaskManager::Task::Task |
( |
WId |
win, |
|
|
QObject * |
parent, |
|
|
const char * |
name = 0 | |
|
) |
| | |
TaskManager::Task::~Task |
( |
|
) |
[virtual] |
Member Function Documentation
void TaskManager::Task::activate |
( |
|
) |
[slot] |
Activate the task's window.
Definition at line 699 of file task.cpp.
void TaskManager::Task::activated |
( |
|
) |
[signal] |
Indicates that this task is now the active task.
void TaskManager::Task::activateRaiseOrIconify |
( |
|
) |
[slot] |
Perform the action that is most appropriate for this task.
If it is not active, activate it. Else if it is not the top window, raise it. Otherwise, iconify it.
Definition at line 710 of file task.cpp.
void TaskManager::Task::addTransient |
( |
WId |
w, |
|
|
const NETWinInfo & |
info | |
|
) |
| | |
QPixmap TaskManager::Task::bestIcon |
( |
int |
size, |
|
|
bool & |
isStaticIcon | |
|
) |
| | |
Returns the best icon for any of the KIconLoader::StdSizes.
If there is no icon of the specified size specified in the WM hints, it will try to get one using KIconLoader.
bool gotStaticIcon;
QPixmap icon = myTask->icon( KIconLoader::SizeMedium, gotStaticIcon );
- Parameters:
-
| size | Any of the constants in KIconLoader::StdSizes. |
| isStaticIcon | Set to true if KIconLoader was used, false otherwise. |
Definition at line 453 of file task.cpp.
void TaskManager::Task::changed |
( |
|
) |
[signal] |
Indicates that this task has changed in some way.
QString TaskManager::Task::classClass |
( |
|
) |
|
QString TaskManager::Task::className |
( |
|
) |
|
void TaskManager::Task::close |
( |
|
) |
[slot] |
Close the task's window.
Definition at line 681 of file task.cpp.
void TaskManager::Task::deactivated |
( |
|
) |
[signal] |
Indicates that this task is no longer the active task.
bool TaskManager::Task::demandsAttention |
( |
|
) |
const |
Returns true if the task is not active but demands user's attention.
int TaskManager::Task::desktop |
( |
|
) |
const |
Returns the desktop on which this task's window resides.
void TaskManager::Task::findWindowFrameId |
( |
|
) |
[protected] |
void TaskManager::Task::generateThumbnail |
( |
|
) |
[protected, slot] |
QRect TaskManager::Task::geometry |
( |
|
) |
const |
Returns the geometry for this window.
Definition at line 329 of file task.cpp.
bool TaskManager::Task::hasThumbnail |
( |
|
) |
const |
Returns true if this task has a thumbnail.
Note that this method can only ever return true after a call to updateThumbnail().
bool TaskManager::Task::hasTransient |
( |
WId |
w |
) |
const |
QPixmap TaskManager::Task::icon |
( |
int |
width, |
|
|
int |
height, |
|
|
bool |
allowResize = false | |
|
) |
| | |
Tries to find an icon for the task with the specified size.
If there is no icon that matches then it will either resize the closest available icon or return a null pixmap depending on the value of allowResize.
Note that the last icon is cached, so a sequence of calls with the same parameters will only query the NET properties if the icon has changed or none was found.
Definition at line 424 of file task.cpp.
void TaskManager::Task::iconChanged |
( |
|
) |
[signal] |
Indicates that the icon for this task has changed.
bool TaskManager::Task::idMatch |
( |
const QString & |
id1, |
|
|
const QString & |
id2 | |
|
) |
| | [static] |
Returns true iff the windows with the specified ids should be grouped together in the task list.
Definition at line 530 of file task.cpp.
KWindowInfo TaskManager::Task::info |
( |
|
) |
const |
bool TaskManager::Task::isActive |
( |
|
) |
const |
Returns true if the task's window is the active window.
Definition at line 283 of file task.cpp.
bool TaskManager::Task::isAlwaysOnTop |
( |
|
) |
const |
Returns true if the task's window will remain at the top of the stacking order.
Definition at line 253 of file task.cpp.
bool TaskManager::Task::isFullScreen |
( |
|
) |
const |
Returns true if the task's window is in full screen mode.
Definition at line 263 of file task.cpp.
bool TaskManager::Task::isIconified |
( |
|
) |
const |
- Deprecated:
- Returns true if the task's window is minimized(iconified).
Definition at line 248 of file task.cpp.
bool TaskManager::Task::isKeptBelowOthers |
( |
|
) |
const |
Returns true if the task's window will remain at the bottom of the stacking order.
Definition at line 258 of file task.cpp.
bool TaskManager::Task::isMaximized |
( |
|
) |
const |
Returns true if the task's window is maximized.
Definition at line 238 of file task.cpp.
bool TaskManager::Task::isMinimized |
( |
|
) |
const |
Returns true if the task's window is minimized.
Definition at line 243 of file task.cpp.
bool TaskManager::Task::isModified |
( |
|
) |
const |
Returns true if the document the task is editing has been modified.
This is currently handled heuristically by looking for the string '[i18n_modified]' in the window title where i18n_modified is the word 'modified' in the current language.
Definition at line 293 of file task.cpp.
bool TaskManager::Task::isOnAllDesktops |
( |
|
) |
const |
Returns true if the task's window is on all virtual desktops.
Definition at line 278 of file task.cpp.
bool TaskManager::Task::isOnCurrentDesktop |
( |
|
) |
const |
Returns true if the task's window is on the current virtual desktop.
Definition at line 273 of file task.cpp.
bool TaskManager::Task::isOnScreen |
( |
int |
screen |
) |
const |
Returns true if the window is on the specified screen of a multihead configuration.
Definition at line 314 of file task.cpp.
bool TaskManager::Task::isOnTop |
( |
|
) |
const |
Returns true if the task's window is the topmost non-iconified, non-always-on-top window.
Definition at line 288 of file task.cpp.
bool TaskManager::Task::isShaded |
( |
|
) |
const |
Returns true if the task's window is shaded.
Definition at line 268 of file task.cpp.
void TaskManager::Task::lower |
( |
|
) |
[slot] |
Lower the task's window.
Definition at line 693 of file task.cpp.
void TaskManager::Task::move |
( |
|
) |
[slot] |
Move the window of this task.
Definition at line 544 of file task.cpp.
QString TaskManager::Task::name |
( |
|
) |
const |
QPixmap TaskManager::Task::pixmap |
( |
|
) |
const |
Returns a 16x16 (KIconLoader::Small) icon for the task.
This method will only fall back to a static icon if there is no icon of any size in the WM hints.
void TaskManager::Task::publishIconGeometry |
( |
QRect |
rect |
) |
[slot] |
This method informs the window manager of the location at which this task will be displayed when iconised.
It is used, for example by the KWin inconify animation.
Definition at line 819 of file task.cpp.
void TaskManager::Task::raise |
( |
|
) |
[slot] |
Raise the task's window.
Definition at line 687 of file task.cpp.
void TaskManager::Task::refresh |
( |
unsigned int |
dirty |
) |
|
void TaskManager::Task::refreshIcon |
( |
|
) |
|
void TaskManager::Task::removeTransient |
( |
WId |
w |
) |
|
void TaskManager::Task::resize |
( |
|
) |
[slot] |
Resize the window of this task.
Definition at line 567 of file task.cpp.
void TaskManager::Task::restore |
( |
|
) |
[slot] |
Restore the main window of the task (if it was iconified).
Definition at line 627 of file task.cpp.
void TaskManager::Task::setActive |
( |
bool |
a |
) |
|
void TaskManager::Task::setAlwaysOnTop |
( |
bool |
stay |
) |
[slot] |
If true, the task's window will remain at the top of the stacking order.
Definition at line 753 of file task.cpp.
void TaskManager::Task::setFullScreen |
( |
bool |
fullscreen |
) |
[slot] |
If true, the task's window will enter full screen mode.
Definition at line 786 of file task.cpp.
void TaskManager::Task::setIconified |
( |
bool |
iconify |
) |
[slot] |
Iconify the task.
Definition at line 651 of file task.cpp.
void TaskManager::Task::setKeptBelowOthers |
( |
bool |
below |
) |
[slot] |
If true, the task's window will remain at the bottom of the stacking order.
Definition at line 767 of file task.cpp.
void TaskManager::Task::setMaximized |
( |
bool |
maximize |
) |
[slot] |
Maximise the main window of this task.
Definition at line 590 of file task.cpp.
void TaskManager::Task::setShaded |
( |
bool |
shade |
) |
[slot] |
If true then the task's window will be shaded.
Most window managers represent this state by displaying on the window's title bar.
Definition at line 805 of file task.cpp.
void TaskManager::Task::setThumbnailSize |
( |
double |
size |
) |
|
Sets the size for the window thumbnail.
For example a size of 0.2 indicates the thumbnail will be 20% of the original window size.
Definition at line 223 of file task.cpp.
bool TaskManager::Task::showInPager |
( |
|
) |
const |
Returns true if the task should be shown in pager-like apps.
Definition at line 324 of file task.cpp.
bool TaskManager::Task::showInTaskbar |
( |
|
) |
const |
Returns true if the task should be shown in taskbar-like apps.
Definition at line 319 of file task.cpp.
QPixmap TaskManager::Task::thumbnail |
( |
int |
maxDimension |
) |
|
QPixmap TaskManager::Task::thumbnail |
( |
|
) |
const |
Returns the thumbnail for this task (or a null image if there is none).
void TaskManager::Task::thumbnailChanged |
( |
|
) |
[signal] |
Indicates that the thumbnail for this task has changed.
double TaskManager::Task::thumbnailSize |
( |
|
) |
const |
Returns the current thumbnail size.
void TaskManager::Task::toCurrentDesktop |
( |
|
) |
[slot] |
Moves the task's window to the current virtual desktop.
Definition at line 748 of file task.cpp.
void TaskManager::Task::toDesktop |
( |
int |
desk |
) |
[slot] |
Moves the task's window to the specified virtual desktop.
Definition at line 726 of file task.cpp.
void TaskManager::Task::toggleAlwaysOnTop |
( |
|
) |
[slot] |
void TaskManager::Task::toggleFullScreen |
( |
|
) |
[slot] |
void TaskManager::Task::toggleIconified |
( |
|
) |
[slot] |
void TaskManager::Task::toggleKeptBelowOthers |
( |
|
) |
[slot] |
void TaskManager::Task::toggleMaximized |
( |
|
) |
[slot] |
void TaskManager::Task::toggleShaded |
( |
|
) |
[slot] |
WindowList TaskManager::Task::transients |
( |
|
) |
const |
A list of the window ids of all transient windows (dialogs) associated with this task.
Definition at line 443 of file task.cpp.
void TaskManager::Task::updateDemandsAttentionState |
( |
WId |
w |
) |
|
void TaskManager::Task::updateThumbnail |
( |
|
) |
[slot] |
Tells the task to generate a new thumbnail.
When the thumbnail is ready the thumbnailChanged() signal will be emitted.
Definition at line 840 of file task.cpp.
void TaskManager::Task::updateWindowPixmap |
( |
|
) |
|
QString TaskManager::Task::visibleName |
( |
|
) |
const |
QString TaskManager::Task::visibleNameWithState |
( |
|
) |
const |
WId TaskManager::Task::window |
( |
|
) |
const |
Property Documentation
bool TaskManager::Task::active [read] |
bool TaskManager::Task::alwaysOnTop [read, write] |
QString TaskManager::Task::className [read] |
bool TaskManager::Task::demandsAttention [read] |
int TaskManager::Task::desktop [read] |
bool TaskManager::Task::hasThumbnail [read] |
bool TaskManager::Task::iconified [read] |
bool TaskManager::Task::maximized [read] |
bool TaskManager::Task::minimized [read] |
bool TaskManager::Task::modified [read] |
QString TaskManager::Task::name [read] |
bool TaskManager::Task::onAllDesktops [read] |
bool TaskManager::Task::onCurrentDesktop [read] |
QPixmap TaskManager::Task::pixmap [read] |
bool TaskManager::Task::shaded [read, write] |
QPixmap TaskManager::Task::thumbnail [read] |
double TaskManager::Task::thumbnailSize [read, write] |
QString TaskManager::Task::visibleName [read] |
QString TaskManager::Task::visibleNameWithState [read] |
The documentation for this class was generated from the following files: