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

kdgantt1

KDGanttViewTaskLinkGroup Class Reference

#include <KDGanttViewTaskLinkGroup.h>

Inheritance diagram for KDGanttViewTaskLinkGroup:

Inheritance graph
[legend]

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

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

Static Public Member Functions

static KDGanttViewTaskLinkGroup * createFromDomElement (QDomElement &)
static KDGanttViewTaskLinkGroup * find (const QString &name)

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 86 of file KDGanttViewTaskLinkGroup.cpp.

KDGanttViewTaskLinkGroup::KDGanttViewTaskLinkGroup (  ) 

Constructs an empty task link group

Definition at line 50 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 60 of file KDGanttViewTaskLinkGroup.cpp.

Member Function Documentation

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 212 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 318 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 294 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 282 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 181 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 244 of file KDGanttViewTaskLinkGroup.cpp.

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 102 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 116 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 193 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 162 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 224 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 132 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 148 of file KDGanttViewTaskLinkGroup.cpp.

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

kdgantt1

Skip menu "kdgantt1"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
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