• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Applets

AbstractTaskItem Class Reference

A baseclass for a task. More...

#include <abstracttaskitem.h>

Inheritance diagram for AbstractTaskItem:

Inheritance graph
[legend]

List of all members.


Public Types

enum  TaskFlag { TaskWantsAttention = 1, TaskHasFocus = 2, TaskIsMinimized = 4 }

Public Slots

virtual void activate ()=0
void toolTipAboutToShow ()
void toolTipHidden ()

Signals

void activated (AbstractTaskItem *)

Public Member Functions

TaskManager::AbstractItemPtr abstractItem ()
 AbstractTaskItem (QGraphicsWidget *parent, Tasks *applet, const bool showTooltip)
QSize basicPreferredSize () const
virtual void close ()=0
QIcon icon () const
QRect iconGeometry () const
virtual bool isActive () const =0
bool isGrouped () const
bool isGroupMember (const TaskGroupItem *group) const
virtual bool isWindowItem () const =0
TaskGroupItem * parentGroup () const
virtual void publishIconGeometry (const QRect &rect) const
virtual void publishIconGeometry () const
virtual void setAdditionalMimeData (QMimeData *mimeData)=0
void setGeometry (const QRectF &geometry)
void setIcon (const QIcon &icon)
void setLayoutWidget (LayoutWidget *widget)
void setShowTooltip (const bool showit)
void setTaskFlags (const TaskFlags flags)
void setText (const QString &text)
TaskFlags taskFlags () const
QString text () const
 ~AbstractTaskItem ()

Protected Slots

void animationUpdate (qreal progress)
void checkSettings ()
void queueUpdate ()
void syncActiveRect ()

Protected Member Functions

void dragEnterEvent (QGraphicsSceneDragDropEvent *event)
void dragLeaveEvent (QGraphicsSceneDragDropEvent *event)
void dragMoveEvent (QGraphicsSceneDragDropEvent *event)
virtual void drawBackground (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
virtual void drawTask (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
void drawTextLayout (QPainter *painter, const QTextLayout &layout, const QRect &rect) const
QString expanderElement () const
QRectF expanderRect (const QRectF &b) const
void fadeBackground (const QString &newBackground, int duration, bool fadeIn)
void hoverEnterEvent (QGraphicsSceneHoverEvent *event)
void hoverLeaveEvent (QGraphicsSceneHoverEvent *event)
QRectF iconRect (const QRectF &bounds) const
QSize layoutText (QTextLayout &layout, const QString &text, const QSize &constraints) const
void mouseMoveEvent (QGraphicsSceneMouseEvent *event)
void mousePressEvent (QGraphicsSceneMouseEvent *event)
void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
QColor textColor () const
QTextOption textOption () const
QRectF textRect (const QRectF &bounds) const
void timerEvent (QTimerEvent *event)
virtual void updateTask (::TaskManager::TaskChanges changes)=0
virtual void updateToolTip ()=0

Protected Attributes

QPointF _dragOffset
TaskManager::AbstractItemPtr m_abstractItem
QTimer * m_activateTimer
QRectF m_activeRect
qreal m_alpha
int m_animId
Tasks * m_applet
int m_attentionTicks
int m_attentionTimerId
QString m_backgroundPrefix
bool m_fadeIn: 1
TaskFlags m_flags
QIcon m_icon
QTime m_lastUpdate
LayoutWidget * m_layoutWidget
QString m_oldBackgroundPrefix
LayoutWidget * m_parentWidget
bool m_showingTooltip: 1
bool m_showTooltip: 1
QString m_text
int m_updateTimerId

Static Protected Attributes

static const int IconTextSpacing = 4
static const int TaskItemHorizontalMargin = 4
static const int TaskItemVerticalMargin = 4

Detailed Description

A baseclass for a task.

Definition at line 51 of file abstracttaskitem.h.


Member Enumeration Documentation

enum AbstractTaskItem::TaskFlag

This enum describes the generic flags which are currently set by the task.

Enumerator:
TaskWantsAttention  This flag is set by the task to indicate that it wants the user's attention.
TaskHasFocus  Indicates that the task's window has the focus.
TaskIsMinimized  Indicates that the task is iconified.

Definition at line 75 of file abstracttaskitem.h.


Constructor & Destructor Documentation

AbstractTaskItem::AbstractTaskItem ( QGraphicsWidget *  parent,
Tasks *  applet,
const bool  showTooltip 
)

Constructs a new representation for an abstract task.

Definition at line 57 of file abstracttaskitem.cpp.

AbstractTaskItem::~AbstractTaskItem (  ) 

Destruct the representation for an abstract task.

Definition at line 105 of file abstracttaskitem.cpp.


Member Function Documentation

TaskManager::AbstractItemPtr AbstractTaskItem::abstractItem (  ) 

Definition at line 848 of file abstracttaskitem.cpp.

virtual void AbstractTaskItem::activate (  )  [pure virtual, slot]

Implemented in TaskGroupItem, and WindowTaskItem.

void AbstractTaskItem::activated ( AbstractTaskItem *   )  [signal]

void AbstractTaskItem::animationUpdate ( qreal  progress  )  [protected, slot]

Definition at line 617 of file abstracttaskitem.cpp.

QSize AbstractTaskItem::basicPreferredSize (  )  const

Returns the preferred size calculated on base of the fontsize and the iconsize.

Definition at line 84 of file abstracttaskitem.cpp.

void AbstractTaskItem::checkSettings (  )  [protected, slot]

Definition at line 114 of file abstracttaskitem.cpp.

virtual void AbstractTaskItem::close (  )  [pure virtual]

Reimplemented from QGraphicsWidget.

Implemented in TaskGroupItem, and WindowTaskItem.

void AbstractTaskItem::dragEnterEvent ( QGraphicsSceneDragDropEvent *  event  )  [protected]

Reimplemented in TaskGroupItem.

Definition at line 630 of file abstracttaskitem.cpp.

void AbstractTaskItem::dragLeaveEvent ( QGraphicsSceneDragDropEvent *  event  )  [protected]

Definition at line 660 of file abstracttaskitem.cpp.

void AbstractTaskItem::dragMoveEvent ( QGraphicsSceneDragDropEvent *  event  )  [protected]

Definition at line 649 of file abstracttaskitem.cpp.

void AbstractTaskItem::drawBackground ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget 
) [protected, virtual]

Draws the background for the task item.

Definition at line 357 of file abstracttaskitem.cpp.

void AbstractTaskItem::drawTask ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget 
) [protected, virtual]

Draws the icon and text which represent the task item.

Definition at line 429 of file abstracttaskitem.cpp.

void AbstractTaskItem::drawTextLayout ( QPainter *  painter,
const QTextLayout &  layout,
const QRect &  rect 
) const [protected]

Draws the text layout (which must already have the text laid out) in the rect using the supplied painter.

If the layout contains text lines that are longer than the rect is wide, they will be elided by fading the text out.

Definition at line 539 of file abstracttaskitem.cpp.

QString AbstractTaskItem::expanderElement (  )  const [protected]

Definition at line 807 of file abstracttaskitem.cpp.

QRectF AbstractTaskItem::expanderRect ( const QRectF &  b  )  const [protected]

Definition at line 736 of file abstracttaskitem.cpp.

void AbstractTaskItem::fadeBackground ( const QString &  newBackground,
int  duration,
bool  fadeIn 
) [protected]

Definition at line 182 of file abstracttaskitem.cpp.

void AbstractTaskItem::hoverEnterEvent ( QGraphicsSceneHoverEvent *  event  )  [protected]

Definition at line 232 of file abstracttaskitem.cpp.

void AbstractTaskItem::hoverLeaveEvent ( QGraphicsSceneHoverEvent *  event  )  [protected]

Definition at line 239 of file abstracttaskitem.cpp.

QIcon AbstractTaskItem::icon (  )  const

Returns the current icon for this task.

Definition at line 140 of file abstracttaskitem.cpp.

QRect AbstractTaskItem::iconGeometry (  )  const

Definition at line 670 of file abstracttaskitem.cpp.

QRectF AbstractTaskItem::iconRect ( const QRectF &  bounds  )  const [protected]

Definition at line 718 of file abstracttaskitem.cpp.

virtual bool AbstractTaskItem::isActive (  )  const [pure virtual]

Implemented in TaskGroupItem, and WindowTaskItem.

bool AbstractTaskItem::isGrouped (  )  const

Convenience Functions to get information about Grouping.

Only true if the task is not only member of rootGroup

Definition at line 834 of file abstracttaskitem.cpp.

bool AbstractTaskItem::isGroupMember ( const TaskGroupItem *  group  )  const

Definition at line 823 of file abstracttaskitem.cpp.

virtual bool AbstractTaskItem::isWindowItem (  )  const [pure virtual]

Implemented in TaskGroupItem, and WindowTaskItem.

QSize AbstractTaskItem::layoutText ( QTextLayout &  layout,
const QString &  text,
const QSize &  constraints 
) const [protected]

Lays the text out in the text layout using the constraints, and returns the actual size required.

The returned size may be wider than the constraints if the text contains a non-breakable word that is wider than the maximum width. If more height is needed than what's available, the last line that will fit will be extended to hold the remainder of the text.

Definition at line 503 of file abstracttaskitem.cpp.

void AbstractTaskItem::mouseMoveEvent ( QGraphicsSceneMouseEvent *  event  )  [protected]

Reimplemented in TaskGroupItem.

Definition at line 270 of file abstracttaskitem.cpp.

void AbstractTaskItem::mousePressEvent ( QGraphicsSceneMouseEvent *  event  )  [protected]

Reimplemented in TaskGroupItem, and WindowTaskItem.

Definition at line 265 of file abstracttaskitem.cpp.

void AbstractTaskItem::mouseReleaseEvent ( QGraphicsSceneMouseEvent *  event  )  [protected]

Reimplemented in TaskGroupItem.

Definition at line 258 of file abstracttaskitem.cpp.

void AbstractTaskItem::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget 
) [protected]

Reimplemented in TaskGroupItem.

Definition at line 320 of file abstracttaskitem.cpp.

TaskGroupItem * AbstractTaskItem::parentGroup (  )  const

Definition at line 843 of file abstracttaskitem.cpp.

void AbstractTaskItem::publishIconGeometry ( const QRect &  rect  )  const [virtual]

Reimplemented in TaskGroupItem, and WindowTaskItem.

Definition at line 708 of file abstracttaskitem.cpp.

void AbstractTaskItem::publishIconGeometry (  )  const [virtual]

Tells the window manager the minimized task's geometry.

Reimplemented in TaskGroupItem, and WindowTaskItem.

Definition at line 704 of file abstracttaskitem.cpp.

void AbstractTaskItem::queueUpdate (  )  [protected, slot]

Event compression.

Definition at line 217 of file abstracttaskitem.cpp.

virtual void AbstractTaskItem::setAdditionalMimeData ( QMimeData *  mimeData  )  [pure virtual]

Implemented in TaskGroupItem, and WindowTaskItem.

void AbstractTaskItem::setGeometry ( const QRectF &  geometry  ) 

Overridden from LayoutItem.

Reimplemented from QGraphicsWidget.

Definition at line 712 of file abstracttaskitem.cpp.

void AbstractTaskItem::setIcon ( const QIcon &  icon  ) 

Sets the icon for this task item.

Definition at line 135 of file abstracttaskitem.cpp.

void AbstractTaskItem::setLayoutWidget ( LayoutWidget *  widget  ) 

void AbstractTaskItem::setShowTooltip ( const bool  showit  ) 

Switch on/off tooltips above tasks.

Definition at line 125 of file abstracttaskitem.cpp.

void AbstractTaskItem::setTaskFlags ( const TaskFlags  flags  ) 

Sets the task flags for this item.

Definition at line 150 of file abstracttaskitem.cpp.

void AbstractTaskItem::setText ( const QString &  text  ) 

Sets the text for this task item.

Definition at line 130 of file abstracttaskitem.cpp.

void AbstractTaskItem::syncActiveRect (  )  [protected, slot]

Definition at line 333 of file abstracttaskitem.cpp.

AbstractTaskItem::TaskFlags AbstractTaskItem::taskFlags (  )  const

Returns the task's current flags.

Definition at line 196 of file abstracttaskitem.cpp.

QString AbstractTaskItem::text (  )  const

Returns current text for this task.

Definition at line 145 of file abstracttaskitem.cpp.

QColor AbstractTaskItem::textColor (  )  const [protected]

Definition at line 774 of file abstracttaskitem.cpp.

QTextOption AbstractTaskItem::textOption (  )  const [protected]

Returns a QTextOption object for the icon label QTtextLayout.

Definition at line 491 of file abstracttaskitem.cpp.

QRectF AbstractTaskItem::textRect ( const QRectF &  bounds  )  const [protected]

Definition at line 754 of file abstracttaskitem.cpp.

void AbstractTaskItem::timerEvent ( QTimerEvent *  event  )  [protected]

Definition at line 296 of file abstracttaskitem.cpp.

void AbstractTaskItem::toolTipAboutToShow (  )  [slot]

Definition at line 201 of file abstracttaskitem.cpp.

void AbstractTaskItem::toolTipHidden (  )  [slot]

Definition at line 211 of file abstracttaskitem.cpp.

virtual void AbstractTaskItem::updateTask ( ::TaskManager::TaskChanges  changes  )  [protected, pure virtual]

virtual void AbstractTaskItem::updateToolTip (  )  [protected, pure virtual]

Implemented in TaskGroupItem, and WindowTaskItem.


Member Data Documentation

QPointF AbstractTaskItem::_dragOffset [protected]

Definition at line 223 of file abstracttaskitem.h.

const int AbstractTaskItem::IconTextSpacing = 4 [static, protected]

Definition at line 233 of file abstracttaskitem.h.

TaskManager::AbstractItemPtr AbstractTaskItem::m_abstractItem [protected]

Definition at line 204 of file abstracttaskitem.h.

QTimer* AbstractTaskItem::m_activateTimer [protected]

Definition at line 209 of file abstracttaskitem.h.

QRectF AbstractTaskItem::m_activeRect [protected]

Definition at line 221 of file abstracttaskitem.h.

qreal AbstractTaskItem::m_alpha [protected]

Definition at line 218 of file abstracttaskitem.h.

int AbstractTaskItem::m_animId [protected]

Definition at line 217 of file abstracttaskitem.h.

Tasks* AbstractTaskItem::m_applet [protected]

Definition at line 207 of file abstracttaskitem.h.

int AbstractTaskItem::m_attentionTicks [protected]

Definition at line 227 of file abstracttaskitem.h.

int AbstractTaskItem::m_attentionTimerId [protected]

Definition at line 226 of file abstracttaskitem.h.

QString AbstractTaskItem::m_backgroundPrefix [protected]

Definition at line 220 of file abstracttaskitem.h.

bool AbstractTaskItem::m_fadeIn [protected]

Definition at line 229 of file abstracttaskitem.h.

TaskFlags AbstractTaskItem::m_flags [protected]

Definition at line 212 of file abstracttaskitem.h.

QIcon AbstractTaskItem::m_icon [protected]

Definition at line 214 of file abstracttaskitem.h.

QTime AbstractTaskItem::m_lastUpdate [protected]

Definition at line 224 of file abstracttaskitem.h.

LayoutWidget* AbstractTaskItem::m_layoutWidget [protected]

Definition at line 205 of file abstracttaskitem.h.

QString AbstractTaskItem::m_oldBackgroundPrefix [protected]

Definition at line 219 of file abstracttaskitem.h.

LayoutWidget* AbstractTaskItem::m_parentWidget [protected]

Definition at line 208 of file abstracttaskitem.h.

bool AbstractTaskItem::m_showingTooltip [protected]

Definition at line 231 of file abstracttaskitem.h.

bool AbstractTaskItem::m_showTooltip [protected]

Definition at line 230 of file abstracttaskitem.h.

QString AbstractTaskItem::m_text [protected]

Definition at line 215 of file abstracttaskitem.h.

int AbstractTaskItem::m_updateTimerId [protected]

Definition at line 225 of file abstracttaskitem.h.

const int AbstractTaskItem::TaskItemHorizontalMargin = 4 [static, protected]

Definition at line 235 of file abstracttaskitem.h.

const int AbstractTaskItem::TaskItemVerticalMargin = 4 [static, protected]

Definition at line 236 of file abstracttaskitem.h.


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

Applets

Skip menu "Applets"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal