• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • superkaramba
 

superkaramba

Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | List of all members
Task Class Reference

#include <taskmanager.h>

Inherits TQObject.

Public Slots

void maximize ()
 
void restore ()
 
void iconify ()
 
void close ()
 
void raise ()
 
void lower ()
 
void activate ()
 
void activateRaiseOrIconify ()
 
void setAlwaysOnTop (bool)
 
void toggleAlwaysOnTop ()
 
void setShaded (bool)
 
void toggleShaded ()
 
void toDesktop (int)
 
void toCurrentDesktop ()
 
void publishIconGeometry (TQRect)
 
void updateThumbnail ()
 

Signals

void changed ()
 
void iconChanged ()
 
void activated ()
 
void deactivated ()
 
void thumbnailChanged ()
 

Public Member Functions

 Task (WId win, TaskManager *parent, const char *name=0)
 
TaskManager * taskManager () const
 
WId window () const
 
TQString name () const
 
TQString visibleName () const
 
int desktop () const
 
TQString visibleNameWithState () const
 
TQString iconName () const
 
TQString visibleIconName () const
 
TQString className ()
 
TQString classClass ()
 
TQValueList< WId > transients () const
 
TQPixmap pixmap () const
 
TQPixmap bestIcon (int size, bool &isStaticIcon)
 
TQPixmap icon (int width, int height, bool allowResize=false)
 
bool isMaximized () const
 
bool isIconified () const
 
bool isShaded () const
 
bool isActive () const
 
bool isOnTop () const
 
bool isOnCurrentDesktop () const
 
bool isOnAllDesktops () const
 
bool isAlwaysOnTop () const
 
bool isModified () const
 
void refresh (bool icon=false)
 
void addTransient (WId w)
 
void removeTransient (WId w)
 
bool hasTransient (WId w) const
 
void setActive (bool a)
 
double thumbnailSize () const
 
void setThumbnailSize (double size)
 
bool hasThumbnail () const
 
const TQPixmap & thumbnail () const
 

Static Public Member Functions

static bool idMatch (const TQString &, const TQString &)
 

Protected Slots

void generateThumbnail ()
 

Detailed Description

A dynamic interface to a task (main window).

See also
TaskManager
KWinModule

Definition at line 49 of file taskmanager.h.

Constructor & Destructor Documentation

◆ Task()

Task::Task ( WId  win,
TaskManager *  parent,
const char *  name = 0 
)

Definition at line 331 of file taskmanager.cpp.

◆ ~Task()

Task::~Task ( )
virtual

Definition at line 356 of file taskmanager.cpp.

Member Function Documentation

◆ activate

void Task::activate ( )
slot

Activate the task's window.

Definition at line 669 of file taskmanager.cpp.

◆ activated

void Task::activated ( )
signal

Indicates that this task is now the active task.

◆ activateRaiseOrIconify

void 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 676 of file taskmanager.cpp.

◆ addTransient()

void Task::addTransient ( WId  w)
inline

Definition at line 203 of file taskmanager.h.

◆ bestIcon()

TQPixmap Task::bestIcon ( int  size,
bool &  isStaticIcon 
)

Returns the best icon for any of the TDEIcon::StdSizes.

If there is no icon of the specified size specified in the WM hints, it will try to get one using TDEIconLoader.

  bool gotStaticIcon;
  TQPixmap icon = myTask->icon( TDEIcon::SizeMedium, gotStaticIcon );
Parameters
sizeAny of the constants in TDEIcon::StdSizes.
isStaticIconSet to true if TDEIconLoader was used, false otherwise.
See also
TDEIcon

Definition at line 529 of file taskmanager.cpp.

◆ changed

void Task::changed ( )
signal

Indicates that this task has changed in some way.

◆ classClass()

TQString Task::classClass ( )

Definition at line 498 of file taskmanager.cpp.

◆ className()

TQString Task::className ( )

Definition at line 486 of file taskmanager.cpp.

◆ close

void Task::close ( )
slot

Activate the task's window.

Definition at line 651 of file taskmanager.cpp.

◆ deactivated

void Task::deactivated ( )
signal

Indicates that this task is no longer the active task.

◆ desktop()

int Task::desktop ( ) const
inline

Returns the desktop on which this task's window resides.

Definition at line 92 of file taskmanager.h.

◆ generateThumbnail

void Task::generateThumbnail ( )
protectedslot

Definition at line 786 of file taskmanager.cpp.

◆ hasThumbnail()

bool Task::hasThumbnail ( ) const
inline

Returns true if this task has a thumbnail.

Note that this method can only ever return true after a call to updateThumbnail().

Definition at line 229 of file taskmanager.h.

◆ hasTransient()

bool Task::hasTransient ( WId  w) const
inline

Definition at line 207 of file taskmanager.h.

◆ icon()

TQPixmap 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 510 of file taskmanager.cpp.

◆ iconChanged

void Task::iconChanged ( )
signal

Indicates that the icon for this task has changed.

◆ iconify

void Task::iconify ( )
slot

Iconify the task.

Definition at line 646 of file taskmanager.cpp.

◆ iconName()

TQString Task::iconName ( ) const

Definition at line 475 of file taskmanager.cpp.

◆ idMatch()

bool Task::idMatch ( const TQString &  id1,
const TQString &  id2 
)
static

Returns true iff the windows with the specified ids should be grouped together in the task list.

Definition at line 606 of file taskmanager.cpp.

◆ isActive()

bool Task::isActive ( ) const

Returns true if the task's window is the active window.

Definition at line 453 of file taskmanager.cpp.

◆ isAlwaysOnTop()

bool Task::isAlwaysOnTop ( ) const

Returns true if the task's window will remain at the top of the stacking order.

Definition at line 417 of file taskmanager.cpp.

◆ isIconified()

bool Task::isIconified ( ) const

Returns true if the task's window is iconified.

Definition at line 408 of file taskmanager.cpp.

◆ isMaximized()

bool Task::isMaximized ( ) const

Returns true if the task's window is maximized.

Definition at line 399 of file taskmanager.cpp.

◆ isModified()

bool 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 463 of file taskmanager.cpp.

◆ isOnAllDesktops()

bool Task::isOnAllDesktops ( ) const

Returns true if the task's window is on all virtual desktops.

Definition at line 444 of file taskmanager.cpp.

◆ isOnCurrentDesktop()

bool Task::isOnCurrentDesktop ( ) const

Returns true if the task's window is on the current virtual desktop.

Definition at line 435 of file taskmanager.cpp.

◆ isOnTop()

bool Task::isOnTop ( ) const

Returns true if the task's window is the topmost non-iconified, non-always-on-top window.

Definition at line 458 of file taskmanager.cpp.

◆ isShaded()

bool Task::isShaded ( ) const

Returns true if the task's window is shaded.

Definition at line 426 of file taskmanager.cpp.

◆ lower

void Task::lower ( )
slot

Lower the task's window.

Definition at line 663 of file taskmanager.cpp.

◆ maximize

void Task::maximize ( )
slot

Maximise the main window of this task.

Definition at line 621 of file taskmanager.cpp.

◆ name()

TQString Task::name ( ) const
inline

Definition at line 87 of file taskmanager.h.

◆ pixmap()

TQPixmap Task::pixmap ( ) const
inline

Returns a 16x16 (TDEIcon::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.

Definition at line 111 of file taskmanager.h.

◆ publishIconGeometry

void Task::publishIconGeometry ( TQRect  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 751 of file taskmanager.cpp.

◆ raise

void Task::raise ( )
slot

Raise the task's window.

Definition at line 657 of file taskmanager.cpp.

◆ refresh()

void Task::refresh ( bool  icon = false)

Definition at line 360 of file taskmanager.cpp.

◆ removeTransient()

void Task::removeTransient ( WId  w)
inline

Definition at line 205 of file taskmanager.h.

◆ restore

void Task::restore ( )
slot

Restore the main window of the task (if it was iconified).

Definition at line 634 of file taskmanager.cpp.

◆ setActive()

void Task::setActive ( bool  a)

Definition at line 389 of file taskmanager.cpp.

◆ setAlwaysOnTop

void Task::setAlwaysOnTop ( bool  stay)
slot

If true, the task's window will remain at the top of the stacking order.

Definition at line 723 of file taskmanager.cpp.

◆ setShaded

void 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 737 of file taskmanager.cpp.

◆ setThumbnailSize()

void Task::setThumbnailSize ( double  size)
inline

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 taskmanager.h.

◆ taskManager()

TaskManager * Task::taskManager ( ) const
inline

Definition at line 76 of file taskmanager.h.

◆ thumbnail()

const TQPixmap & Task::thumbnail ( ) const
inline

Returns the thumbnail for this task (or a null image if there is none).

Definition at line 235 of file taskmanager.h.

◆ thumbnailChanged

void Task::thumbnailChanged ( )
signal

Indicates that the thumbnail for this task has changed.

◆ thumbnailSize()

double Task::thumbnailSize ( ) const
inline

Returns the current thumbnail size.

Definition at line 216 of file taskmanager.h.

◆ toCurrentDesktop

void Task::toCurrentDesktop ( )
slot

Moves the task's window to the current virtual desktop.

Definition at line 718 of file taskmanager.cpp.

◆ toDesktop

void Task::toDesktop ( int  desk)
slot

Moves the task's window to the specified virtual desktop.

Definition at line 687 of file taskmanager.cpp.

◆ toggleAlwaysOnTop

void Task::toggleAlwaysOnTop ( )
slot

Definition at line 732 of file taskmanager.cpp.

◆ toggleShaded

void Task::toggleShaded ( )
slot

Definition at line 746 of file taskmanager.cpp.

◆ transients()

TQValueList< WId > Task::transients ( ) const
inline

A list of the window ids of all transient windows (dialogs) associated with this task.

Definition at line 104 of file taskmanager.h.

◆ updateThumbnail

void 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 762 of file taskmanager.cpp.

◆ visibleIconName()

TQString Task::visibleIconName ( ) const

Definition at line 480 of file taskmanager.cpp.

◆ visibleName()

TQString Task::visibleName ( ) const
inline

Definition at line 88 of file taskmanager.h.

◆ visibleNameWithState()

TQString Task::visibleNameWithState ( ) const
inline

Definition at line 94 of file taskmanager.h.

◆ window()

WId Task::window ( ) const
inline

Definition at line 78 of file taskmanager.h.


The documentation for this class was generated from the following files:
  • taskmanager.h
  • taskmanager.cpp

superkaramba

Skip menu "superkaramba"
  • Main Page
  • Alphabetical List
  • Class List
  • File List
  • Class Members

superkaramba

Skip menu "superkaramba"
  • kcalc
  •   knumber
  • superkaramba
Generated for superkaramba by doxygen 1.9.4
This website is maintained by Timothy Pearson.