KDE 4.5 API Reference kdgantt1
KDGanttViewItem Class Reference
#include <KDGanttViewItem.h>
Detailed Description
This class represents an item in a Gantt chart.
This class is an abstract base class, it cannot be instantiated directly. Instead, you should create items of one of the subclasses. This class provides methods common to all Gantt items.
The initialization of the shapes/colors of the item works as follows:
Shapes: When a new item is created, the shapes are set to the default values for items of the type of this item, defined in the KDGanttView class with void setShapes( KDGanttViewItem::Type type, KDGanttViewItem::Shape start, KDGanttViewItem::Shape middle, KDGanttViewItem::Shape end ); If there is no default value defined for this type, the shapes are set as follows: For TaskViewItems all three shapes are set to Square. For SummaryViewItems all three shapes are set to TriangleDown. For EventViewItems all three shapes are set to Diamond.
Colors: When a new item is created, the colors are set to the default values for items of the type of this item, defined in the KDGanttView class with void setColors( KDGanttViewItem::Type type, const QColor& start, const QColor& middle, const QColor& end ); If there is no default value defined for this type, the colors of the shapes are set to the default color for items of this type, defined in the KDGanttView class with: void setDefaultColor( KDGanttViewItem::Type type, const QColor& ); The initial default color in the KDGanttView class is set to blue for KDGanttViewItem::Event, green for KDGanttViewItem::Task, cyan for KDGanttViewItem::Summary.
Highlight Colors: When a new item is created, the highlight colors are set to the default values for items of the type of this item, defined in the KDGanttView class with: void setHighlightColors( KDGanttViewItem::Type type, const QColor& start, const QColor& middle, const QColor& end ); If there is no default value defined for this type, the highlight colors of the shapes are set to the default color for items of this type, defined in the KDGanttView class with: void setDefaultHighlightColor( KDGanttViewItem::Type type, const QColor& ); The initial default highlight color in the KDGanttView class is set to red for all types.
Start/End time: When a new item is created, the start time and the end time is set automatically. The time, which is currently displayed in the middle of the Gantt View, is set as start/end time. At startup of a newly created Gantt view, this is the current time.
The Priority: The priority is set with setPriority(). The priority determines which items are painted over which other items. The item with the highest priority is painted on top of all others. The priority for an item can be between 1 and 199. A priority less than 100 means that the item is painted below the grid in the Gantt chart. For Task items, the default priority is 50, for all other items it is 150. This feature only makes sense for an item which is a child of another item, for which displaySubitemsAsGroup() property is set to true.
The Display Mode: The display mode is set with setDisplaySubitemsAsGroup(). In the normal view mode (set with setDisplaySubitemsAsGroup( false ); ), an item is displayed in the same manner, when its child items are shown or not. In the other mode (set with setDisplaySubitemsAsGroup( true ); ), called "calendar mode", the item is displayed as follows: If the item has no children, it is displayed as usual. If the item is opened (i.e., its children are displayed), the start/end time of this item is computed automatically according to the earliest start time/latest end time of its children. The item and its children are displayed as usual. If the item is closed (i.e., its children are hidden in the left list view), the item itself is hidden, and its children are displayed on the timeline of this item instead. To control the painting of overlapping children, call setPriority() for the children.
Blocking of user interaction to open item: If you want to block users to open items used as parents of calendar items, call KDGanttView::setCalendarMode( true );
Example 1, Color: If you create an instance of a KDGanttView class and add a SummaryViewItem without setting any color/shape values, you get an item with three shapes of the form TriangleDown in the color magenta. If the item is highlighted, the color will change to the highlight color red.
Example 2, Calender View: To use a Gantt view as a calendar view, call KDGanttView::setCalendarMode( true ); KDGanttView::setDisplaySubitemsAsGroup( true ); Insert root items in the Gantt view. Insert items as children of these root item in the Gantt view. You may use any item type as parent and child; there are no limitations. It is, however, recommended to use KDGanttViewTaskItems Actually, you may add child items to the children themselves. Such a child behaves then like a parent. Now set the start/end time of the children to specify a time interval for these items.
Definition at line 57 of file KDGanttViewItem.h.
Member Enumeration Documentation
This enum is used to define the types of connectors items can have.
Definition at line 62 of file KDGanttViewItem.h.
This enum is used in order to specify the shapes of a Gantt chart item.
Definition at line 61 of file KDGanttViewItem.h.
This enum is used in order to return the type of a Gantt chart item.
Definition at line 60 of file KDGanttViewItem.h.
Constructor & Destructor Documentation
| KDGanttViewItem::KDGanttViewItem | ( | Type | type, | |
| KDGanttView * | view, | |||
| const QString & | lvtext = QString(), |
|||
| const QString & | name = QString() | |||
| ) | [protected] |
Constructs an empty Gantt item.
- Parameters:
-
type the type of the item to insert view the Gantt view to insert this item into lvtext the text to show in the list view name the name by which the item can be identified. If no name is specified, a unique name will be generated
Definition at line 172 of file KDGanttViewItem.cpp.
| KDGanttViewItem::KDGanttViewItem | ( | Type | type, | |
| KDGanttViewItem * | parentItem, | |||
| const QString & | lvtext = QString(), |
|||
| const QString & | name = QString() | |||
| ) | [protected] |
Constructs an empty Gantt item.
- Parameters:
-
type the type of the item to insert parentItem a parent item under which this one goes lvtext the text to show in the list view name the name by which the item can be identified. If no name is specified, a unique name will be generated
Definition at line 193 of file KDGanttViewItem.cpp.
| KDGanttViewItem::KDGanttViewItem | ( | Type | type, | |
| KDGanttView * | view, | |||
| KDGanttViewItem * | after, | |||
| const QString & | lvtext = QString(), |
|||
| const QString & | name = QString() | |||
| ) | [protected] |
Constructs an empty Gantt item.
- Parameters:
-
type the type of the item to insert view the Gantt view to insert this item into after another item at the same level behind which this one should go lvtext the text to show in the list view name the name by which the item can be identified. If no name is specified, a unique name will be generated
Definition at line 214 of file KDGanttViewItem.cpp.
| KDGanttViewItem::KDGanttViewItem | ( | Type | type, | |
| KDGanttViewItem * | parentItem, | |||
| KDGanttViewItem * | after, | |||
| const QString & | lvtext = QString(), |
|||
| const QString & | name = QString() | |||
| ) | [protected] |
Constructs an empty Gantt item.
- Parameters:
-
type the type of the item to insert parentItem a parent item under which this one goes after another item at the same level behind which this one should go lvtext the text to show in the list view name the name by which the item can be identified. If no name is specified, a unique name will be generated
Definition at line 236 of file KDGanttViewItem.cpp.
| KDGanttViewItem::~KDGanttViewItem | ( | ) | [virtual] |
Destroys the object and frees any allocated resources.
Definition at line 250 of file KDGanttViewItem.cpp.
Member Function Documentation
| void KDGanttViewItem::checkCoord | ( | int * | co | ) | [protected] |
Definition at line 2726 of file KDGanttViewItem.cpp.
Returns the colors used for this item
- Parameters:
-
start returns the start color middle returns the middle color end returns the end color
- See also:
- setColors(), setShapes(), shapes(), setDefaultColor(), defaultColor()
Definition at line 1194 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::createFromDomElement | ( | KDGanttViewItem * | parent, | |
| KDGanttViewItem * | previous, | |||
| QDomElement & | element | |||
| ) | [static] |
Creates a KDGanttViewItem according to the specification in a DOM element.
- Parameters:
-
parent the parent item under which the item will be inserted previous to item behind this one should appear element the DOM element from which to read the specification
- Returns:
- the newly created item
Definition at line 2001 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::createFromDomElement | ( | KDGanttViewItem * | parent, | |
| QDomElement & | element | |||
| ) | [static] |
Creates a KDGanttViewItem according to the specification in a DOM element.
- Parameters:
-
parent the parent item under which the item will be inserted element the DOM element from which to read the specification
- Returns:
- the newly created item
Definition at line 1979 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::createFromDomElement | ( | KDGanttView * | view, | |
| KDGanttViewItem * | previous, | |||
| QDomElement & | element | |||
| ) | [static] |
Creates a KDGanttViewItem according to the specification in a DOM element.
- Parameters:
-
view the view in which the item will be inserted previous to item behind this one should appear element the DOM element from which to read the specification
- Returns:
- the newly created item
Definition at line 1954 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::createFromDomElement | ( | KDGanttView * | view, | |
| QDomElement & | element | |||
| ) | [static] |
Creates a KDGanttViewItem according to the specification in a DOM element.
- Parameters:
-
view the view in which the item will be inserted element the DOM element from which to read the specification
- Returns:
- the newly created item
Definition at line 1932 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::createNode | ( | QDomDocument & | doc, | |
| QDomElement & | parentElement | |||
| ) |
Creates a DOM node that describes this item.
- Parameters:
-
doc the DOM document to which the node belongs parentElement the element into which to insert this node
Definition at line 1858 of file KDGanttViewItem.cpp.
| QColor KDGanttViewItem::defaultColor | ( | ) | const |
Returns the default color that is used for the item if no specific start, middle, or end colors are set.
- Returns:
- color the default color used
- See also:
- setDefaultColor(), setColors(), colors()
Definition at line 1392 of file KDGanttViewItem.cpp.
| QColor KDGanttViewItem::defaultHighlightColor | ( | ) | const |
Returns the default highlighting color that is used for the item if no specific start, middle, or end colors are set.
- Returns:
- color the default highlighting color used
Definition at line 1436 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::displaySubitemsAsGroup | ( | ) | const |
Returns whether this item displays hidden subitems. Initial set to false.
- Returns:
- true if this item displays hidden subitems, false otherwise
- See also:
- setDisplaySubitemsAsGroup()
Definition at line 685 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::editable | ( | ) | const |
Returns whether this item is editable.
- Returns:
- true if this item is editable, false otherwise
Definition at line 646 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::enabled | ( | ) | const |
Returns whether this item is enabled.
- Returns:
- true if this item is enabled, false otherwise
- See also:
- setEnabled()
Definition at line 588 of file KDGanttViewItem.cpp.
| QDateTime KDGanttViewItem::endTime | ( | ) | const |
Returns the end time of this item.
- Returns:
- the end time of this item
- See also:
- setEndTime(), setStartTime(), startTime()
Definition at line 789 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::find | ( | const QString & | name | ) | [static] |
Returns the item with the specified name.
- Parameters:
-
name the name to search for
- Returns:
- the item with the specified name; 0 if no item with that name exists
Definition at line 365 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::firstChild | ( | ) | const |
Returns the first child of this item.
- Returns:
- the first child of this item, 0 if this item has no children
Definition at line 1447 of file KDGanttViewItem.cpp.
| QFont KDGanttViewItem::font | ( | ) | const |
Returns the font used for the text in this item.
- Returns:
- the font used for the text in this item
- See also:
- setFont()
Definition at line 882 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::generateAndInsertName | ( | const QString & | name | ) | [protected] |
Generates a unique name if necessary and inserts it into the item dictionary.
Definition at line 291 of file KDGanttViewItem.cpp.
| unsigned int KDGanttViewItem::getAllSubChildTimeForTimespan | ( | const QDateTime & | start, | |
| const QDateTime & | end | |||
| ) |
Computes for a set of items recursively the amount of time each item do have in the specified timespan. (Specified by the items start datetime and end datetime). The set of items in this method is the list of all children of this item. I.e. all subchildren ( children of children ) are in this list. The item itself is in the list as well. It calls for each item getTimeForTimespan() and returns the sum of the computed times. Please read getTimeForTimespan() for an example.
- Parameters:
-
start the start QDateTime of the interval. If an invalid QDateTime is passed it is an open interval, i.e. all items before the end datetime will be computed end the end QDateTime of the interval. If an invalid QDateTime is passed it is an open interval, i.e. all items after the start datetime will be computed. if start and end are invalid all items will be computed.
- Returns:
- the sum of times of computed items in seconds
Definition at line 492 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::getChildByName | ( | const QString & | name | ) |
If the name of this item is name (i.e., listViewText() == name), the pointer to this item is returned. Otherwise, it looks for an item with name name in the set of children and subchildren of this item.
- Parameters:
-
name the name of the item
- Returns:
- the pointer to the item with name name
Definition at line 2461 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::getChildByUid | ( | const QString & | uid | ) |
If the uid of this item is uid (i.e. a user defined unique id), the pointer to this item is returned. Otherwise, it looks for an item with uid uid in the set of children and subchildren of this item. The uid of an item is not set automatically, it has to be set by the programmer.
- Parameters:
-
uid the uid of the item
- Returns:
- the pointer to the item with uid uid
- See also:
- setUid() uid() KDGanttView::getItemByUid()
Definition at line 2486 of file KDGanttViewItem.cpp.
| QPtrList< KDGanttViewItem > KDGanttViewItem::getChildListForTimespan | ( | const QDateTime & | start, | |
| const QDateTime & | end | |||
| ) |
Computes a list of direct subitems of this item which do have some duration during the timespan. It call for every direct subitem getTimeForTimespan() and appends it to the list if this call does not return 0. Please read getTimeForTimespan() for an example when a call of getTimeForTimespan() does not return 0.
- Parameters:
-
start the start QDateTime of the interval. If an invalid QDateTime is passed it is an open interval, i.e. all items before the end datetime will be computed end the end QDateTime of the interval. If an invalid QDateTime is passed it is an open interval, i.e. all items after the start datetime will be computed. if start and end are invalid all items will be computed.
- Returns:
- a list of direct subitems of this item which do have some duration during the timespan
Definition at line 429 of file KDGanttViewItem.cpp.
| unsigned int KDGanttViewItem::getChildTimeForTimespan | ( | const QDateTime & | start, | |
| const QDateTime & | end | |||
| ) |
Computes for a set of items the amount of time each item do have in the specified timespan. (Specified by the items start datetime and end datetime). The set of items in this method is the list of direct children of this item. No subchildren ( children of children ) are in this list. The item itself is not in the list. It calls for each item getTimeForTimespan() and returns the sum of the computed times. Please read getTimeForTimespan() for an example.
- Parameters:
-
start the start QDateTime of the interval. If an invalid QDateTime is passed it is an open interval, i.e. all items before the end datetime will be computed end the end QDateTime of the interval. If an invalid QDateTime is passed it is an open interval, i.e. all items after the start datetime will be computed. if start and end are invalid all items will be computed.
- Returns:
- the sum of times of computed items in seconds
Definition at line 522 of file KDGanttViewItem.cpp.
| KDGanttViewItem::Connector KDGanttViewItem::getConnector | ( | QPoint | p | ) | [virtual] |
Returns the region of the item for the position p. A region is a connector and it is used for changing item in the gantt view. This virtual method is reimplemented in the subclasses.
- Parameters:
-
p point to check for a connector
- Returns:
- This virtual method does nothing and returns NoConnector
- See also:
- moveConnector()
Reimplemented in KDGanttViewEventItem, KDGanttViewSummaryItem, and KDGanttViewTaskItem.
Definition at line 342 of file KDGanttViewItem.cpp.
| int KDGanttViewItem::getCoordY | ( | ) | [protected] |
Returns the y coordinate of this item.
- Returns:
- the y coordinate of this item
Definition at line 2277 of file KDGanttViewItem.cpp.
| unsigned int KDGanttViewItem::getTimeForTimespan | ( | const QDateTime & | start, | |
| const QDateTime & | end | |||
| ) | [virtual] |
The virtual method computes for this item the amount of time this item do have in the specified timespan. (Specified by the items start datetime and end datetime). The default implementation of this method returns 0. This method is reimplemented in the subclass KDGanttViewTaskItem only. Example: Let eTask be a task item with start date time 24. March 2005 - 17:00 and end date time 24. March 2005 - 19:30 i.e. it has a duration of 2:30 hours , which are 9000 seconds.
eTask->getTimeForTimespan( QDateTime(),QDateTime() ) returns the complete duration of 9000, because an open interval was specified eTask->getTimeForTimespan( QDateTime(),QDateTime( 24. March 2005 - 18:00 ) ) returns 3600. eTask->getTimeForTimespan( QDateTime( 24. March 2005 - 17:30 ),QDateTime( 24. March 2005 - 18:00 ) ) returns 1800. eTask->getTimeForTimespan( QDateTime( 24. March 2005 - 17:30 ),QDateTime( 28. April 2005 - 18:00 ) ) returns 7200 ( 2 hours ). eTask->getTimeForTimespan( QDateTime( 1. March 2005 - 0:30 ),QDateTime( 28. April 2005 - 18:00 ) ) returns 9000 ( complete duration ). eTask->getTimeForTimespan( QDateTime( 1. Jan 2004 - 12:30 ),QDateTime( 1. April 2004 - 1:00 ) ) returns 0.
- Parameters:
-
start the start QDateTime of the interval. If an invalid QDateTime is passed it is an open interval. end the end QDateTime of the interval. If an invalid QDateTime is passed it is an open interval. if start and end are invalid the duration (start time to end time in seconds) is returned.
- Returns:
- the time of this item in the interval in seconds
Reimplemented in KDGanttViewTaskItem.
Definition at line 470 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::highlight | ( | ) | const |
Returns whether this item is highlighted, either programmatically with setHighlight() or by the user with the mouse.
- Returns:
- true if the item is highlighted
- See also:
- setHighlight()
Definition at line 977 of file KDGanttViewItem.cpp.
Returns the highlight colors used for this item
- Parameters:
-
start returns the start highlight color middle returns the middle highlight color end returns the end highlight color
- See also:
- setHighlightColors(), setShapes(), shapes()
Definition at line 1247 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::isMoveable | ( | ) | const [protected] |
Definition at line 3035 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::isResizeable | ( | ) | const [protected] |
Definition at line 3040 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::itemAbove | ( | ) |
Returns the item above this item in the listview
- Returns:
- the item above this item, 0 if this is the first item
Definition at line 1483 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::itemBelow | ( | bool | includeDisabled = true |
) |
Returns the item below this item in the listview. It can be specified whether the disabled items are taken into account as well.
- Parameters:
-
includeDisabled if true, disabled items are considered as well
- Returns:
- the item below this item, 0 if this is the last item
Definition at line 1497 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::itemText | ( | ) | const |
Returns the text to be shown in this item in the Gantt view.
- Returns:
- the text to be shown in this item
- See also:
- setText(), setTextColor(), textColor(), setListViewText(), listViewText()
Definition at line 821 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::itemVisible | ( | ) | const |
Returns whether this item is visible.
- Returns:
- true if this item is visible, false otherwise
- See also:
- setItemVisible()
Definition at line 618 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::listViewText | ( | int | column = 0 |
) | const |
Returns the text to be shown in this item in the list view.
- Parameters:
-
column the column in which the text will be shown
- Returns:
- the text to be shown in this item
- See also:
- setText(), setTextColor(), textColor(), text(), setListViewText()
Definition at line 857 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::moveConnector | ( | KDGanttViewItem::Connector | c, | |
| QPoint | p | |||
| ) | [virtual] |
Moves the connector c to point p. This virtual method is reimplemented in the subclasses.
- Parameters:
-
c the connector to move p point for connector where to move to
- Returns:
- true if some value of the item was changed
- See also:
- getConnector()
Reimplemented in KDGanttViewEventItem, KDGanttViewSummaryItem, and KDGanttViewTaskItem.
Definition at line 325 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::moveTextCanvas | ( | int | x, | |
| int | y | |||
| ) | [protected] |
Moves this items text.
Definition at line 2957 of file KDGanttViewItem.cpp.
| QDateTime KDGanttViewItem::myChildEndTime | ( | ) |
Returns the latest end time of the direct children of this item. If for a child the displaySubitemsAsGroup() property is set the end time of this child is computed recursively.
- Returns:
- the latest end time of the direct children of this item
- See also:
- displaySubitemsAsGroup()
Definition at line 2364 of file KDGanttViewItem.cpp.
| QDateTime KDGanttViewItem::myChildStartTime | ( | ) |
Returns the earliest start time of the children of this item. If for a child the displaySubitemsAsGroup() property is set the start time of this child is computed recursively.
- Returns:
- the earliest start time of the direct children of this item
- See also:
- displaySubitemsAsGroup()
Definition at line 2323 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::name | ( | ) | const |
Returns the unique name that can identify the item. You can look up for an item with a specific unique name uName with find( uName ).
- Returns:
- the unique item name
Definition at line 378 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::nextSibling | ( | ) | const |
Returns the next sibling item of this item
- Returns:
- the next sibling item of this item, 0 if this item has no more siblings
Definition at line 1460 of file KDGanttViewItem.cpp.
| KDGanttViewItem * KDGanttViewItem::parent | ( | ) | const |
Returns the parent item of this item
- Returns:
- the parent item of this item, 0 if this item is a top-level item
Definition at line 1472 of file KDGanttViewItem.cpp.
| const QPixmap * KDGanttViewItem::pixmap | ( | int | column = 0 |
) | const |
Returns a pixmap that is shown in the listview.
- Parameters:
-
column the column for which to query the pixmap
- Returns:
- a pointer to the pixmap shown
- See also:
- setPixmap()
Definition at line 1345 of file KDGanttViewItem.cpp.
| int KDGanttViewItem::priority | ( | ) |
Returns the priority of this item.
- Returns:
- the priority of this item
- See also:
- setDisplaySubitemsAsGroup()
Definition at line 726 of file KDGanttViewItem.cpp.
Specifies the colors in which to draw the shapes of this item.
It is advisable not to use this method, but rather set the colors for all items of a type with KDGanttView::setColors() in order to get a uniform Gantt view.
- Parameters:
-
start the color for the start shape middle the color for the middle shape end the color for the end shape
- See also:
- colors(), setShapes(), shapes(), setDefaultColor(), defaultColor()
Definition at line 1165 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setDefaultColor | ( | const QColor & | color | ) |
Sets the default color that is used for the item if no specific start, middle, or end colors are set.
It is advisable not to use this method, but rather set the colors for all items of a type with KDGanttView::setDefaultColor() in order to get a uniform Gantt view.
If the item displays its subitems (children) as a group, (displaySubitemsAsGroup() == true) all changes apply to all subitems as well.
- Parameters:
-
color the default color to use
- See also:
- defaultColor(), setColors(), colors()
Definition at line 1366 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setDefaultHighlightColor | ( | const QColor & | color | ) |
Sets the default highlighting color that is used for the item if no specific start, middle, or end colors are set.
It is advisable not to use this method, but rather set the colors for all items of a type with KDGanttView::setDefaultHighlightColor() in order to get a uniform Gantt view.
If the item displays its subitems (children) as a group, (displaySubitemsAsGroup() == true) all changes apply to all subitems as well.
- Parameters:
-
color the default highlighting color to use
Definition at line 1413 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setDisplaySubitemsAsGroup | ( | bool | show | ) |
Specifies whether this item shows hidden subitems on its timeline. Useful to get a so called "calendar view" with many items in one row. When displaySubitemsAsGroup() is set to true, this item has a normal view, when it is expanded. If it is not expanded (and has at least one child), the item itself is hidden, and all children are displayed instead. To manage the painting priority of the children (if overlapping), you may set priority() of these items.
- Parameters:
-
show pass true to make this item displaying hidden subitems
Definition at line 664 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setEditable | ( | bool | editable | ) |
Specifies whether this item is editable. The whole Gantt view needs to be editable as well for this to have any effect.
- Parameters:
-
editable pass true to make this item editable
Definition at line 633 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setEnabled | ( | bool | on | ) |
Specifies whether this item is enabled. If disabled, the item stays in the Gantt view and the item is shown in gray to show that the item is disabled. All signals of this item (like itemLeftClicked( this )) are blocked. If the item displays its subitems (children) as a group, (displaySubitemsAsGroup() == true) all changes apply to all subitems as well.
- Parameters:
-
on pass true to make this item editable
- See also:
- enabled ()
Definition at line 565 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setEndTime | ( | const QDateTime & | end | ) | [virtual] |
Specifies the end time of this item. The parameter must be valid and non-null. If the parameter is invalid or null, no value is set. Reimplemented in the subclasses
- Parameters:
-
end the end time
- See also:
- endTime(), setStartTime(), startTime()
Reimplemented in KDGanttViewSummaryItem, and KDGanttViewTaskItem.
Definition at line 765 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setFloatEndTime | ( | const QDateTime & | end | ) |
Specifies the float end time of this item. If the time is invalid, the end float is not shown.
- Parameters:
-
end the float end time
Definition at line 3025 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setFloatStartTime | ( | const QDateTime & | start | ) |
Specifies the float start time of this item. If the time is invalid, the start float is not shown.
- Parameters:
-
start the float start time
Definition at line 3012 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setFont | ( | const QFont & | font | ) |
Sets the font to be used for the text in this item.
- Parameters:
-
font the font to be shown
- See also:
- font()
Definition at line 869 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setHighlight | ( | bool | highlight | ) |
Specifies whether this item should be shown highlighted. The user can also highlight items with the mouse. If the item displays its subitems (children) as a group (displaySubitemsAsGroup() == true), all changes apply to all subitems as well.
- Parameters:
-
highlight true in order to highlight, false in order to turn highlighting off for this item
- See also:
- highlight()
Definition at line 952 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setHighlightColors | ( | const QColor & | start, | |
| const QColor & | middle, | |||
| const QColor & | end | |||
| ) |
Specifies the highlight colors in which to draw the shapes of this item.
It is advisable not to use this method, but rather set the highlight colors for all items of a type with KDGanttView::setHighlightColors() in order to get a uniform Gantt view.
If the item displays its subitems (children) as a group, (displaySubitemsAsGroup() == true) all changes apply to all subitems as well.
- Parameters:
-
start the highlight color for the start shape middle the highlight color for the middle shape end the highlight color for the end shape
- See also:
- highlightColors(), setShapes(), shapes()
Definition at line 1220 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setItemText | ( | const QString & | text | ) |
Sets the text to be shown in this item in the Gantt view. For a KDGanttViewTaskItem witht displaySubitemsAsGroup() == true, the text is shown in the item itself and the text is truncated automatically, if it does not fit in the item. For all other item types, the text is shown to the right of the item.
- Parameters:
-
text the text to be shown
- See also:
- text(), setTextColor(), textColor(), setListViewText(), listViewText()
Definition at line 806 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setItemVisible | ( | bool | on | ) |
Specifies whether this item is visible.
- Parameters:
-
on pass true to make this item visible
- See also:
- itemVisible ()
Definition at line 601 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setListViewText | ( | int | column, | |
| const QString & | text | |||
| ) |
Sets the text to be shown in this item in the list view.
- Parameters:
-
column the column in which the text will be shown text the text to be shown
- See also:
- text(), setTextColor(), textColor(), setText(), listViewText()
Definition at line 843 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setListViewText | ( | const QString & | text, | |
| int | column = 0 | |||
| ) |
- Deprecated:
- Use setListViewTest( int, const QString& ) instead
Definition at line 830 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setMoveable | ( | bool | m | ) | [protected] |
Definition at line 3030 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setOpen | ( | bool | open | ) | [virtual] |
This method is reimplemented for internal purposes.
Definition at line 1616 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setPixmap | ( | const QPixmap & | pixmap | ) |
- Deprecated:
- use setPixmap( int, const QPixmap& ) instead
Definition at line 1332 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setPixmap | ( | int | column, | |
| const QPixmap & | pixmap | |||
| ) |
Sets the pixmap that is shown in the listview.
- Parameters:
-
column the column in which the pixmap is shown pixmap the pixmap to show
- See also:
- pixmap()
Definition at line 1324 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setPriority | ( | int | prio | ) |
Specifies the priority of this item. Valid values are between 1 and 199. A priority less than 100 means that the item is painted in the Gantt chart below the grid. A priority more than 100 means that the item is painted in the Gantt chart over the grid. For a value of 100, the behavior is unspecified. An item with a higher priority is painted over an item with a lower priority in the Gantt chart. The painting order of items with the same priority is unspecified. For Calendar items, the default priority is 50, for all other items it is 150. This feature makes only sense for an item which is a child of another item, which displaySubitemsAsGroup() property is set to true.
- Parameters:
-
prio the new priority of this item.
- See also:
- priority(), displaySubitemsAsGroup()
Definition at line 710 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setProgress | ( | int | percent | ) |
Specifies the progress of this item in percent. Progress is limited to minimum 0, maximum 100.
- Parameters:
-
percent the progress in percent.
Definition at line 2998 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setResizeable | ( | bool | r | ) | [protected] |
Definition at line 3045 of file KDGanttViewItem.cpp.
Specifies the shapes to be used for this item.
It is advisable not to use this method, but rather set the shapes for all items of a type with KDGanttView::setShapes() in order to get a uniform Gantt view.
- Parameters:
-
start the start shape middle the middle shape end the end shape
- See also:
- shapes(), setColors(), colors()
Definition at line 995 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setShowNoInformation | ( | bool | show | ) |
Specifies whether the 'showNoInformation' line should be shown for this item. The 'showNoInformation' line is drawn over the whole timeline. The height of the line is the height of the item. The brush of the line is specified by KDGanttView::setNoInformationBrush(). (i.e. the same brush for all items of the Gantt view). The default brush is QBrush( QColor ( 100,100,100 ), Qt::FDiagPattern );
- Parameters:
-
show if true, the 'showNoInformation' line is shown for this item
- See also:
- showNoInformation(), KDGanttView::setNoInformationBrush(), KDGanttView::noInformationBrush()
Definition at line 2431 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setShowNoInformationBeforeAndAfter | ( | bool | show | ) |
Specifies whether the 'showNoInformation' line should be shown for periods before and after this item. The height of the line is the height of the item. The brush of the line is specified by KDGanttView::setNoInformationBrush(). (i.e. the same brush for all items of the Gantt view). The default brush is QBrush( QColor ( 100,100,100 ), Qt::FDiagPattern );
- Parameters:
-
show if true, the 'showNoInformation' line is shown for this item
- See also:
- showNoInformationBeforeAndAfter(), KDGanttView::setNoInformationBrush(), KDGanttView::noInformationBrush()
Definition at line 2447 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setStartTime | ( | const QDateTime & | start | ) | [virtual] |
Specifies the start time of this item. The parameter must be valid and non-null. If the parameter is invalid or null, no value is set. Reimplemented in the subclasses.
- Parameters:
-
start the start time
- See also:
- startTime(), setEndTime(), endTime()
Reimplemented in KDGanttViewEventItem, KDGanttViewSummaryItem, and KDGanttViewTaskItem.
Definition at line 740 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setTextColor | ( | const QColor & | color | ) |
Specifies the color to be used for the text of this item.
It is advisable not to use this method, but rather set the text color for all items with KDGanttView::setTextColor() in order to get a uniform Gantt view. If the item displays its subitems (children) as a group, (displaySubitemsAsGroup() == true) all changes apply to all subitems as well.
- Parameters:
-
color the text color
- See also:
- textColor(), setText(), text()
Definition at line 1267 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setTooltipText | ( | const QString & | text | ) |
Sets the text to show in a tooltip for this item.
- Parameters:
-
text the tooltip text
- See also:
- tooltipText()
Definition at line 897 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setUid | ( | const QString & | text | ) | [virtual] |
Sets the uid of this item (i.e. in general a user defined unique id). The uid of an item is not set automatically, it has to be set by the programmer. Please read uid() for details.
- Parameters:
-
uid the uid of the item
Definition at line 2742 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::setWhatsThisText | ( | const QString & | text | ) |
Sets the text to show in a What's This window for this item.
- Parameters:
-
text the what's this text
- See also:
- whatsThisText()
Definition at line 922 of file KDGanttViewItem.cpp.
Returns the shapes used for this item
- Parameters:
-
start returns the start shape middle returns the middle shape end returns the end shape
- See also:
- setShapes(), setColors(), colors()
Definition at line 1145 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::showNoInformation | ( | ) |
Returns whether the 'showNoInformation' line should be shown for this item
- Returns:
- true if showNoInformation line should be shown
- See also:
- setShowNoInformation(), KDGanttView::setNoInformationBrush(), KDGanttView::noInformationBrush()
Definition at line 2403 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::showNoInformationBeforeAndAfter | ( | ) |
Returns whether the 'showNoInformation' line should be shown for the time periods before and after this item
- Returns:
- true if showNoInformation line should be shown
- See also:
- setShowNoInformationBeforeAndAfter(), KDGanttView::setNoInformationBrush(), KDGanttView::noInformationBrush()
Definition at line 2415 of file KDGanttViewItem.cpp.
| QDateTime KDGanttViewItem::startTime | ( | ) | const |
Returns the start time of this item.
- Returns:
- the start time of this item
- See also:
- setStartTime(), setEndTime(), endTime()
Definition at line 751 of file KDGanttViewItem.cpp.
| bool KDGanttViewItem::subitemIsCalendar | ( | ) | const |
Returns whether this item has at least one subitem that is a calendar. A subitem is a calendar, if that item has at least one subitem or displaySubitemAsGroup() is true for that item.
- Returns:
- true if the item has at least one subitem that is a calendar.
Definition at line 2519 of file KDGanttViewItem.cpp.
| QCanvasText * KDGanttViewItem::textcanvas | ( | ) | [protected] |
Definition at line 1666 of file KDGanttViewItem.cpp.
| QColor KDGanttViewItem::textColor | ( | ) | const |
Returns the color used for the text of this item.
- Returns:
- the text color
- See also:
- setTextColor(), setText(), text()
Definition at line 1290 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::tooltipText | ( | ) | const |
Returns the tooltip text of this item
- Returns:
- the tooltip text
- See also:
- setTooltipText()
Definition at line 909 of file KDGanttViewItem.cpp.
| KDGanttViewItem::Type KDGanttViewItem::type | ( | ) | const |
Returns the type of the item. This may be Event, Task, Summary.
- Returns:
- the type of the item
Definition at line 406 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::typeString | ( | ) | const [virtual] |
Returns the type of the item as string value. This may be Event, Task, Summary. Reimplement this virtual method in your subclass of a KDGanttViewTaskItem, KDGanttViewEventItem or KDGanttViewSummaryItem to know what type your items is of.
- Returns:
- the type of the item as string value
Definition at line 393 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::uid | ( | ) | const [virtual] |
Returns the uid of this item (i.e. in general a user defined unique id) The uid of an item is not set automatically, it has to be set by the programmer. Note that there may be more than one item in the gantt view with the same uid. That depends on how the programmer handles the uid management. You can look up for items with a specific uid with getChildByUid() and KDGanttView::getItemByUid(). When there is more than one subitem with the same uid for an item then the result of getChildByUid() and KDGanttView::getItemByUid() is not well defined. Note that after a Drag&Drop (DnD) drop operation you may get another item somewhere in the gantt view with the same uid. If you want to use a unique id which is unique in every case (even after a DnD drop operation) please use KDGanttViewItem::name() which is set automatically and which has a very fast lookup compared to KDGanttViewItem::getChildByUid().
- Returns:
- the uid of the item
Definition at line 2766 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::updateCanvasItems | ( | ) | [protected] |
Updates the colors of the item, but not the coordinates.
Definition at line 1520 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::updateItemsOnCanvas | ( | bool | forceUpdate = false |
) |
Definition at line 1679 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::userReadFromElement | ( | QDomElement & | element | ) | [protected, virtual] |
This virtual method does nothing. Reimplement it to read your own data from the QDomElement. The data was written from userWriteToElement(). You should reimplement it in a subclass to make Drag&Drop working properly. The body contains a small example to read an int value and a QString, which is commented out. This method is automatically called from createFromDomElement()=>loadFromDomElement() after a Drop operation or if a configuration file is loaded via KDGanttView::loadProject().
- Parameters:
-
doc the DOM document to which the node belongs parentElement the element which contains user defined data
- See also:
- userWriteToElement() createFromDomElement() loadFromDomElement()
Definition at line 2028 of file KDGanttViewItem.cpp.
| void KDGanttViewItem::userWriteToElement | ( | QDomDocument & | doc, | |
| QDomElement & | userElement | |||
| ) | [protected, virtual] |
This virtual method does nothing. Reimplement it to save your own data to the QDomElement. The data can be read with userReadFromElement(). You should reimplement it in a subclass to make Drag&Drop working properly. The body contains a small example to write an int value and a QString, which is commented out. This method is automatically called from KDGanttViewItem::createNode() after a start Drag operation or if a configuration file is saved via KDGanttView::saveProject().
- Parameters:
-
doc the DOM document to which the node belongs parentElement the element into which to insert user defined data
Definition at line 1837 of file KDGanttViewItem.cpp.
| QString KDGanttViewItem::whatsThisText | ( | ) | const |
Returns the what's this text of this item
- Returns:
- the what's this text
- See also:
- setWhatsThisText()
Definition at line 935 of file KDGanttViewItem.cpp.
Member Data Documentation
KDGanttViewItem::actualEnd [protected] |
the line at the actual end of the item
Definition at line 83 of file KDGanttViewItem.h.
KDGanttViewItem::blockUpdating [protected] |
if true, updates to this item are currently blocked, to reduce flicker or speed up redraws
Definition at line 95 of file KDGanttViewItem.h.
KDGanttViewItem::endLine [protected] |
the line at the end of the item
Definition at line 83 of file KDGanttViewItem.h.
KDGanttViewItem::endLineBack [protected] |
the background line at the end of the item
Definition at line 83 of file KDGanttViewItem.h.
KDGanttViewItem::endShape [protected] |
the shape at the end of the item
Definition at line 85 of file KDGanttViewItem.h.
KDGanttViewItem::endShapeBack [protected] |
the background shape at the end of the item
Definition at line 85 of file KDGanttViewItem.h.
KDCanvasPolygonItem * KDGanttViewItem::floatEndShape [protected] |
Definition at line 85 of file KDGanttViewItem.h.
KDCanvasPolygonItem * KDGanttViewItem::floatStartShape [protected] |
Definition at line 85 of file KDGanttViewItem.h.
KDGanttViewItem::isEditable [protected] |
whether this item is currently editable or not
Definition at line 93 of file KDGanttViewItem.h.
KDGanttViewItem::isHighlighted [protected] |
whether this item is currently highlighted or not
Definition at line 93 of file KDGanttViewItem.h.
KDGanttViewItem::isVisibleInGanttView [protected] |
this instance variable is true if the item is visible in the Gantt view
Definition at line 80 of file KDGanttViewItem.h.
int KDGanttViewItem::mCurrentConnectorCoordX [protected] |
Definition at line 206 of file KDGanttViewItem.h.
int KDGanttViewItem::mCurrentConnectorDiffX [protected] |
Definition at line 207 of file KDGanttViewItem.h.
int KDGanttViewItem::mCurrentCoord_Y [protected] |
Definition at line 205 of file KDGanttViewItem.h.
KDGanttViewItem::midShape [protected] |
the shape in the middle of the item
Definition at line 85 of file KDGanttViewItem.h.
KDGanttViewItem::midShapeBack [protected] |
the background shape in the middle of the item
Definition at line 85 of file KDGanttViewItem.h.
KDCanvasText* KDGanttViewItem::mTextCanvas [protected] |
Definition at line 90 of file KDGanttViewItem.h.
QString KDGanttViewItem::mUid [protected] |
Definition at line 98 of file KDGanttViewItem.h.
KDGanttViewItem::myEndTime [protected] |
the ending time of this item
Definition at line 92 of file KDGanttViewItem.h.
QDateTime KDGanttViewItem::myFloatEndTime [protected] |
Definition at line 104 of file KDGanttViewItem.h.
QDateTime KDGanttViewItem::myFloatStartTime [protected] |
Definition at line 103 of file KDGanttViewItem.h.
KDGanttViewItem::myGanttView [protected] |
a pointer to the KDGanttView object to which this item belongs
Definition at line 89 of file KDGanttViewItem.h.
KDGanttViewItem::myItemSize [protected] |
the current size of this item
Definition at line 94 of file KDGanttViewItem.h.
int KDGanttViewItem::myProgress [protected] |
Definition at line 102 of file KDGanttViewItem.h.
KDGanttViewItem::myStartTime [protected] |
the starting time of this item
Definition at line 92 of file KDGanttViewItem.h.
KDCanvasPolygonItem * KDGanttViewItem::progressShape [protected] |
Definition at line 85 of file KDGanttViewItem.h.
KDGanttViewItem::startLine [protected] |
Specifies whether this item should behave like a calendar. In calendar mode, only those items can be opened which have subitems which have subitems. An item which has subitems which have no subitems is called a calendar. I.e., an item that contains multiple calendars can be opened, while a calendar item itself cannot. But if all calendars of an item do not have any subitem (e.g at startup), the program cannot detect automatically that it should be possible to open this item. To enable this, call setIsCalendar( true ); for at least one calendar
- Parameters:
-
cal true in order behave this item like a calendar highlighting off for this item
- See also:
- isCalendar()
Returns whether this item behaves like a calendar, even though it has no subitem which has subitems; when highlighting with setHighlight() or by the user with the mouse.
- Returns:
- true if the item behaves like a calendar
- See also:
- setIsCalendar()
the line at the beginning of the item
Definition at line 83 of file KDGanttViewItem.h.
KDGanttViewItem::startLineBack [protected] |
the background line at the beginning of the item
Definition at line 83 of file KDGanttViewItem.h.
KDGanttViewItem::startShape [protected] |
the shape at the beginning of the item
Definition at line 85 of file KDGanttViewItem.h.
KDGanttViewItem::startShapeBack [protected] |
the background shape at the beginning of the item
Definition at line 85 of file KDGanttViewItem.h.
KDGanttViewItem::textCanvasText [protected] |
the actual string that is displayed in the text object for this item
Definition at line 91 of file KDGanttViewItem.h.
The documentation for this class was generated from the following files:
