kdgantt

KDGanttViewTaskLinkGroup Class Reference

#include <KDGanttViewTaskLinkGroup.h>

List of all members.


Detailed Description

A group of task links.

This class groups a number of task links together in order to manipulate them uniformly.

Definition at line 45 of file KDGanttViewTaskLinkGroup.h.


Public Member Functions

 KDGanttViewTaskLinkGroup (const QString &name)
 KDGanttViewTaskLinkGroup ()
 ~KDGanttViewTaskLinkGroup ()
void insert (KDGanttViewTaskLink *)
bool remove (KDGanttViewTaskLink *)
void setVisible (bool show)
bool visible () const
void setHighlight (bool highlight)
bool highlight () const
void setColor (const QColor &color)
QColor color () const
void setHighlightColor (const QColor &color)
QColor highlightColor () const
void createNode (QDomDocument &doc, QDomElement &parentElement)
void generateAndInsertName (const QString &name)

Static Public Member Functions

static KDGanttViewTaskLinkGroupfind (const QString &name)
static KDGanttViewTaskLinkGroupcreateFromDomElement (QDomElement &)

Friends

class KDTimeTableWidget
class KDGanttViewTaskLink

Constructor & Destructor Documentation

KDGanttViewTaskLinkGroup::KDGanttViewTaskLinkGroup ( const QString &  name  ) 

Constructs an empty task link group and records it under the name name so that it can later be found again with KDGanttViewTaskLinkGroup::find().

Parameters:
name the search name of this task link group

Definition at line 77 of file KDGanttViewTaskLinkGroup.cpp.

KDGanttViewTaskLinkGroup::KDGanttViewTaskLinkGroup (  ) 

Constructs an empty task link group

Definition at line 51 of file KDGanttViewTaskLinkGroup.cpp.

KDGanttViewTaskLinkGroup::~KDGanttViewTaskLinkGroup (  ) 

Destructor Removes this task link group from the list of task link groups in the KDGanttView class.

Definition at line 61 of file KDGanttViewTaskLinkGroup.cpp.


Member Function Documentation

void KDGanttViewTaskLinkGroup::insert ( KDGanttViewTaskLink link  ) 

Adds a task link LINK to this group. If the task link is already a member of another group, it will be removed from it. This function is equivalent to LINK->setGroup(this), where this is a pointer to this TaskLinkGroup.

Parameters:
link a pointer to the task link to add to this task link group visible, and false to hide them
See also:
remove()

Definition at line 91 of file KDGanttViewTaskLinkGroup.cpp.

bool KDGanttViewTaskLinkGroup::remove ( KDGanttViewTaskLink link  ) 

Removes a task link LINK from this group. You may remove a tasklink LINK from its group with LINK->setGroup(0).

Parameters:
link a pointer to the task link to remove from this task link group
Returns:
true if the task link was a member of this group
See also:
insert()

Definition at line 105 of file KDGanttViewTaskLinkGroup.cpp.

void KDGanttViewTaskLinkGroup::setVisible ( bool  show  ) 

Specifies whether the task links of this group should be visible or not.

Parameters:
show visible pass true to make the task links of this group visible, and false to hide them
See also:
isVisible()

Definition at line 121 of file KDGanttViewTaskLinkGroup.cpp.

bool KDGanttViewTaskLinkGroup::visible (  )  const

Returns whether the task links of this group should be visible or not.

Returns:
true if the task links of this group are visible
See also:
setVisible()

Definition at line 137 of file KDGanttViewTaskLinkGroup.cpp.

void KDGanttViewTaskLinkGroup::setHighlight ( bool  highlight  ) 

Specifies whether the task links of this group should be shown highlighted. The user can also highlight a task link with the mouse.

Parameters:
highlight pass true in order to highlight the task links in this group
See also:
highlight()

Definition at line 151 of file KDGanttViewTaskLinkGroup.cpp.

bool KDGanttViewTaskLinkGroup::highlight (  )  const

Returns whether all task links in this group are highlighted, either programmatically by setHighlight() or by the user with the mouse. This method is not particularly useful and is mainly provided for API uniformity reasons.

Returns:
true if all the task links in this group are highlighted
See also:
setHighlight()

Definition at line 170 of file KDGanttViewTaskLinkGroup.cpp.

void KDGanttViewTaskLinkGroup::setColor ( const QColor &  color  ) 

Specifies the color to draw the task links in this group in.

Parameters:
color the color to draw the task links in this group in
See also:
color()

Definition at line 182 of file KDGanttViewTaskLinkGroup.cpp.

QColor KDGanttViewTaskLinkGroup::color (  )  const

Returns the color in which the task links in this group are drawn. If task links have been assigned individual colors, the return value of this method is undefined. This method is not particularly useful and is mainly provided for API uniformity reasons.

Returns:
the color in which the task links in this group are drawn
See also:
setColor()

Definition at line 201 of file KDGanttViewTaskLinkGroup.cpp.

void KDGanttViewTaskLinkGroup::setHighlightColor ( const QColor &  color  ) 

Specifies the highlight color to draw the task links in this group in.

Parameters:
color the highlight color to draw the task links in this group in
See also:
color()

Definition at line 213 of file KDGanttViewTaskLinkGroup.cpp.

QColor KDGanttViewTaskLinkGroup::highlightColor (  )  const

Returns the highlight color in which the task links in this group are drawn. If task links have been assigned individual highlight colors, the return value of this method is undefined. This method is not particularly useful and is mainly provided for API uniformity reasons.

Returns:
the highlight color in which the task links in this group are drawn
See also:
setColor()

Definition at line 233 of file KDGanttViewTaskLinkGroup.cpp.

KDGanttViewTaskLinkGroup * KDGanttViewTaskLinkGroup::find ( const QString &  name  )  [static]

Returns the task link group with the specified name.

Parameters:
name the name to search for
Returns:
the task link group with the specified name; 0 if no group with that name exists

Definition at line 271 of file KDGanttViewTaskLinkGroup.cpp.

void KDGanttViewTaskLinkGroup::createNode ( QDomDocument &  doc,
QDomElement &  parentElement 
)

Creates a DOM node that describes this task link group.

Parameters:
doc the DOM document to which the node belongs
parentElement the element into which to insert this node

Definition at line 285 of file KDGanttViewTaskLinkGroup.cpp.

KDGanttViewTaskLinkGroup * KDGanttViewTaskLinkGroup::createFromDomElement ( QDomElement &  element  )  [static]

Creates a KDGanttViewTaskLinkGroup according to the specification in a DOM element.

Parameters:
element the DOM element from which to read the specification
Returns:
the newly created task link group

Definition at line 309 of file KDGanttViewTaskLinkGroup.cpp.

void KDGanttViewTaskLinkGroup::generateAndInsertName ( const QString &  name  ) 

Generates a unique name if necessary and inserts it into the group dictionary.

Definition at line 365 of file KDGanttViewTaskLinkGroup.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys