KDE PIM / Developers / API Docs / kaddressbook

CardViewItem Class Reference

Represents a single card (item) in the card view. More...

#include <cardview.h>

Inherited by AddresseeCardViewItem.

List of all members.

Public Types

Public Member Functions

Protected Member Functions

Friends


Detailed Description

Represents a single card (item) in the card view.

A card has a caption and a list of fields. A Field is a label<->value pair. The labels in a card should be unique, since they will be used to index the values.


Member Typedef Documentation

typedef QPair<QString, QString> CardViewItem::Field
 

A single field in the card view.

The first item is the label and the second item is the value.


Constructor & Destructor Documentation

CardViewItem::CardViewItem CardView parent,
const QString &  caption = QString()
 

Constructor.

Parameters:
parent The CardView that this card should be displayed on.
caption The caption of the card. This is the text that will appear at the top of the card. This is also the string that will be used to sort the cards in the view.

Member Function Documentation

const QString & CardViewItem::caption  )  const
 

Returns:
The caption of the card, or QString::null if none was ever set.

void CardViewItem::setCaption const QString &  caption  ) 
 

Sets the caption of the card.

This is the text that will appear at the top of the card. This is also the string that will be used to sort the cards in the view.

void CardViewItem::paintCard QPainter *  p,
QColorGroup &  cg
[virtual]
 

Paints the card using the given painter and color group.

The card will handle painting itself selected if it is selected.

void CardViewItem::repaintCard  )  [virtual]
 

Repaints the card.

This is done by sending a repaint event to the view with the clip rect defined as this card.

void CardViewItem::insertField const QString &  label,
const QString &  value
 

Adds a field to the card.

Parameters:
label The label of the field. The field labels must be unique within a card.
value The value of the field.

void CardViewItem::removeField const QString &  label  ) 
 

Removes the field with label label from the card.

QString CardViewItem::fieldValue const QString &  label  )  const
 

Returns:
The value of the field with label label.

void CardViewItem::clearFields  ) 
 

Removes all the fields from this card.

CardViewItem * CardViewItem::nextItem  )  const
 

Returns:
The next card item. The order of the items will be the same as the display order in the view. 0 will be returned if this is the last card.

bool CardViewItem::isSelected  )  const
 

Returns:
True if this card is currently selected, false otherwise.

void CardViewItem::showFullString const QPoint &  pos,
CardViewTip *  tip
 

Called by the parent card view when the mouse has been resting for a certain amount of time.

If the label or value at pos is obscured (trimmed) make the label display the full text.

CardViewItem::Field * CardViewItem::fieldAt const QPoint &  itempos  )  const
 

Returns:
a pointer to the Field at the position itempos in this item. 0 is returned if itempos is in the caption.
Parameters:
itempos the position in item coordinates

int CardViewItem::height bool  allowCache = true  )  const
 

Returns:
The height of this item as rendered, in pixels.
if allowCache is true, the item may use an internally cached value rather than recalculating from scratch. The argument is mainly to allow the cardView to change global settings (like maxFieldLines) that might influence the items heights

void CardViewItem::setSelected bool  selected  )  [protected]
 

Sets the card as selected.

This is usually only called from the card view.


The documentation for this class was generated from the following files: