kaddressbook Library API Documentation

CardView Class Reference

The CardView is a method of displaying data in cards. More...

#include <cardview.h>

Inheritance diagram for CardView:

QScrollView List of all members.

Public Types

enum  SelectionMode { Single, Multi, Extended, NoSelection }

Signals

void selectionChanged ()
void selectionChanged (CardViewItem *)
void clicked (CardViewItem *)
void executed (CardViewItem *)
void doubleClicked (CardViewItem *)
void currentChanged (CardViewItem *)
void returnPressed (CardViewItem *)
void contextMenuRequested (CardViewItem *, const QPoint &)

Public Methods

 CardView (QWidget *parent, const char *name)
virtual ~CardView ()
void insertItem (CardViewItem *item)
void takeItem (CardViewItem *item)
void clear ()
CardViewItemcurrentItem ()
void setCurrentItem (CardViewItem *item)
CardViewItemitemAt (const QPoint &viewPos)
QRect itemRect (const CardViewItem *item)
void ensureItemVisible (const CardViewItem *item)
void repaintItem (const CardViewItem *item)
void setSelectionMode (SelectionMode mode)
SelectionMode selectionMode () const
void setSelected (CardViewItem *item, bool selected)
void selectAll (bool state)
bool isSelected (CardViewItem *item) const
CardViewItemselectedItem () const
CardViewItemfirstItem () const
CardViewItemitemAfter (CardViewItem *item)
int childCount () const
CardViewItemfindItem (const QString &text, const QString &label, Qt::StringComparisonMode compare=Qt::BeginsWith)
uint columnWidth ()
void setDrawCardBorder (bool enabled)
bool drawCardBorder () const
void setDrawColSeparators (bool enabled)
bool drawColSeparators () const
void setDrawFieldLabels (bool enabled)
bool drawFieldLabels () const
void setShowEmptyFields (bool show)
bool showEmptyFields () const
uint itemMargin ()
void setItemMargin (uint margin)
uint itemSpacing ()
void setItemSpacing (uint spacing)
int itemWidth () const
void setItemWidth (int width)
void setHeaderFont (const QFont &fnt)
QFont headerFont () const
void setFont (const QFont &fnt)
void setSeparatorWidth (int width)
int separatorWidth ()
void setMaxFieldLines (int howmany)
int maxFieldLines () const

Protected Methods

void drawContents (QPainter *p, int clipx, int clipy, int clipw, int cliph)
void resizeEvent (QResizeEvent *e)
void contentsWheelEvent (QWheelEvent *e)
void setLayoutDirty (bool dirty)
void calcLayout ()
virtual void contentsMousePressEvent (QMouseEvent *e)
virtual void contentsMouseMoveEvent (QMouseEvent *e)
virtual void contentsMouseReleaseEvent (QMouseEvent *e)
virtual void contentsMouseDoubleClickEvent (QMouseEvent *e)
virtual void enterEvent (QEvent *)
virtual void leaveEvent (QEvent *)
virtual void focusInEvent (QFocusEvent *)
virtual void focusOutEvent (QFocusEvent *)
virtual void keyPressEvent (QKeyEvent *)
virtual void startDrag ()

Friends

class CardViewItem

Detailed Description

The CardView is a method of displaying data in cards.

This idea is similar to the idea of a rolodex or business cards. Each card has a caption and a list of fields, which are label<->value pairs. The CardView displays multiple cards in a grid. The Cards are sorted based on their caption.

The CardView class is designed to mirror the API of the QListView or QIconView. The CardView is also completely independant of KAddressBook and can be used elsewhere. With the exception of a few simple config checks, the CardView is also 100% independant of KDE.

Definition at line 174 of file cardview.h.


Constructor & Destructor Documentation

CardView::CardView QWidget   parent,
const char *    name
 

Constructor.

Definition at line 609 of file cardview.cpp.

References QFont::setBold(), QScrollView::setVScrollBarMode(), and QScrollView::viewport().


Member Function Documentation

void CardView::insertItem CardViewItem   item
 

Inserts the item into the card view.

This method does not have to be called if you created the item with a proper parent. Once inserted, the CardView takes ownership of the item.

Definition at line 646 of file cardview.cpp.

References setLayoutDirty().

void CardView::takeItem CardViewItem   item
 

Takes the item from the view.

The item will not be deleted and ownership of the item is returned to the caller.

Definition at line 652 of file cardview.cpp.

References CardViewItem::nextItem(), and setLayoutDirty().

void CardView::clear  
 

Clears the view and deletes all card view items.

Definition at line 661 of file cardview.cpp.

References setLayoutDirty().

Referenced by KAddressBookCardView::refresh().

CardViewItem * CardView::currentItem  
 

Returns:
The current item, the item that has the focus. Whenever the view has focus, this item has a focus rectangle painted at it's border.
See also:
setCurrentItem()

Definition at line 668 of file cardview.cpp.

Referenced by CardViewItem::paintCard(), and setCurrentItem().

void CardView::setCurrentItem CardViewItem   item
 

Sets the CardViewItem item to the current item in the view.

Definition at line 675 of file cardview.cpp.

References CardViewItem::cardView(), currentChanged(), currentItem(), ensureItemVisible(), CardViewItem::repaintCard(), and setSelected().

CardViewItem * CardView::itemAt const QPoint   viewPos
 

Returns:
The item found at the given point, or 0 if there is no item at that point.

Definition at line 706 of file cardview.cpp.

References QPtrListIterator::current(), CardViewItem::d, CardViewItem::height(), and QPtrListIterator::toFirst().

QRect CardView::itemRect const CardViewItem   item
 

Returns:
The bounding rect of the given item.

Definition at line 725 of file cardview.cpp.

References CardViewItem::d, and CardViewItem::height().

void CardView::ensureItemVisible const CardViewItem   item
 

Ensures that the given item is in the viewable area of the widget.

Definition at line 731 of file cardview.cpp.

References CardViewItem::d, and QScrollView::ensureVisible().

Referenced by setCurrentItem(), and KAddressBookCardView::setSelected().

void CardView::repaintItem const CardViewItem   item
 

Repaints the given item.

Definition at line 737 of file cardview.cpp.

References CardViewItem::d, CardViewItem::height(), and QScrollView::repaintContents().

Referenced by CardViewItem::repaintCard().

void CardView::setSelectionMode SelectionMode    mode
 

Sets the selection mode.

See also:
QListView

Definition at line 743 of file cardview.cpp.

References selectAll().

CardView::SelectionMode CardView::selectionMode   const
 

Returns:
The current selection mode.

Definition at line 750 of file cardview.cpp.

void CardView::setSelected CardViewItem   item,
bool    selected
 

Selects or deselects the given item.

This method honors the current selection mode, so if other items are selected, they may be unselected.

Definition at line 788 of file cardview.cpp.

References CardViewItem::isSelected(), CardViewItem::repaintCard(), selectAll(), selectionChanged(), and CardViewItem::setSelected().

Referenced by setCurrentItem(), and KAddressBookCardView::setSelected().

void CardView::selectAll bool    state
 

Selects or deselects all items.

Definition at line 755 of file cardview.cpp.

References QPtrListIterator::current(), selectionChanged(), QPtrListIterator::toFirst(), and QScrollView::viewport().

Referenced by KAddressBookCardView::setSelected(), setSelected(), and setSelectionMode().

bool CardView::isSelected CardViewItem   item const
 

Returns:
True if the given item is selected, false otherwise.

Definition at line 840 of file cardview.cpp.

References CardViewItem::isSelected().

CardViewItem * CardView::selectedItem   const
 

Returns:
The first selected item. In single select mode, this will be the only selected item, in other modes this will be the first selected item, but others may exist. 0 if no item is selected.

Definition at line 845 of file cardview.cpp.

References QPtrListIterator::current(), and QPtrListIterator::toFirst().

CardViewItem * CardView::firstItem   const
 

Returns:
The first item in the view. This may be 0 if no items have been inserted. This method combined with CardViewItem::nextItem() can be used to iterator through the list of items.

Definition at line 858 of file cardview.cpp.

Referenced by KAddressBookCardView::refresh(), KAddressBookCardView::selectedUids(), and KAddressBookCardView::setSelected().

CardViewItem * CardView::itemAfter CardViewItem   item
 

Returns:
The item after the given item or 0 if the item is the last item.

Definition at line 1035 of file cardview.cpp.

Referenced by CardViewItem::nextItem().

int CardView::childCount   const
 

Returns:
The number of items in the view.

Definition at line 863 of file cardview.cpp.

CardViewItem * CardView::findItem const QString   text,
const QString   label,
Qt::StringComparisonMode    compare = Qt::BeginsWith
 

Attempts to find the first item matching the params.

Parameters:
text  The text to match.
label  The label of the field to match against.
compare  The compare method to use in doing the search.
Returns:
The first matching item, or 0 if no items match.

Definition at line 868 of file cardview.cpp.

References QPtrListIterator::current(), QString::isEmpty(), QString::startsWith(), QPtrListIterator::toFirst(), and QString::upper().

uint CardView::columnWidth  
 

Returns the amounts of pixels required for one column.

This depends on wheather drawSeparators is enabled: If so, it is itemWidth + 2*itemSpacing + separatorWidth If not, it is itemWidth + itemSpacing

See also:
itemWidth(), setItemWidth(), itemSpacing() and setItemSpacing()

Definition at line 895 of file cardview.cpp.

void CardView::setDrawCardBorder bool    enabled
 

Sets if the border around a card should be draw.

The border is a thing (1 or 2 pixel) line that bounds the card. When drawn, it shows when a card is highlighted and when it isn't.

Definition at line 1530 of file cardview.cpp.

Referenced by KAddressBookCardView::readConfig().

bool CardView::drawCardBorder   const
 

Returns:
True if borders are drawn, false otherwise.

Definition at line 1539 of file cardview.cpp.

void CardView::setDrawColSeparators bool    enabled
 

Sets if the column separator should be drawn.

The column separator is a thin verticle line (1 or 2 pixels) that is used to separate the columns in the list view. The separator is just for esthetics and it does not serve a functional purpose.

Definition at line 1544 of file cardview.cpp.

References setLayoutDirty().

Referenced by KAddressBookCardView::readConfig().

bool CardView::drawColSeparators   const
 

Returns:
True if column separators are drawn, false otherwise.

Definition at line 1553 of file cardview.cpp.

void CardView::setDrawFieldLabels bool    enabled
 

Sets if the field labels should be drawn.

The field labels are the unique strings used to identify the fields. Sometimes drawing these labels makes sense as a source of clarity for the user, othertimes they waste too much space and do not assist the user.

Definition at line 1558 of file cardview.cpp.

Referenced by KAddressBookCardView::readConfig().

bool CardView::drawFieldLabels   const
 

Returns:
True if the field labels are drawn, false otherwise.

Definition at line 1567 of file cardview.cpp.

Referenced by CardViewItem::showFullString().

void CardView::setShowEmptyFields bool    show
 

Sets if fields with no value should be drawn (of cause the label only, but it allows for embedded editing sometimes...).

Definition at line 1572 of file cardview.cpp.

References setLayoutDirty().

Referenced by KAddressBookCardView::readConfig().

bool CardView::showEmptyFields   const
 

Returns:
Wheather empty fields should be shown

Definition at line 1581 of file cardview.cpp.

Referenced by CardViewItem::fieldAt(), CardViewItem::height(), and CardViewItem::showFullString().

uint CardView::itemMargin  
 

Returns:
the advisory internal margin in items. Setting a value above 1 means a space between the item contents and the focus recttangle drawn around the current item. The default value is 0. The value should be used by CardViewItem and derived classes. Note that this should not be greater than half of the minimal item width, which is 80. It is currently not checked, so setting a value greater than 40 will probably mean a crash in the items painting routine. @private Note: I looked for a value in QStyle::PixelMetric to use, but I could not see a useful one. One may turn up in a future version of Qt.

Definition at line 1041 of file cardview.cpp.

Referenced by CardViewItem::height(), CardViewItem::paintCard(), and CardViewItem::showFullString().

void CardView::setItemMargin uint    margin
 

Sets the internal item margin.

See also:
itemMargin().

Definition at line 1046 of file cardview.cpp.

References setLayoutDirty().

Referenced by KAddressBookCardView::readConfig().

uint CardView::itemSpacing  
 

Returns:
the item spacing. The item spacing is the space (in pixels) between each item in a column, between the items and column separators if drawn, and between the items and the borders of the widget. The default value is set to 10. @private Note: There is no useful QStyle::PixelMetric to use for this atm. An option would be using KDialog::spacingHint().

Definition at line 1055 of file cardview.cpp.

void CardView::setItemSpacing uint    spacing
 

Sets the item spacing.

See also:
itemSpacing()

Definition at line 1060 of file cardview.cpp.

References setLayoutDirty().

Referenced by KAddressBookCardView::readConfig().

int CardView::itemWidth   const
 

Returns:
the width made available to the card items.

Definition at line 1641 of file cardview.cpp.

Referenced by CardViewItem::paintCard(), CardViewItem::showFullString(), and KAddressBookCardView::writeConfig().

void CardView::setItemWidth int    width
 

Sets the width made available to card items.

Definition at line 1646 of file cardview.cpp.

References setLayoutDirty(), and QScrollView::updateContents().

Referenced by KAddressBookCardView::readConfig().

void CardView::setHeaderFont const QFont   fnt
 

Sets the header font.

Definition at line 1657 of file cardview.cpp.

Referenced by KAddressBookCardView::readConfig().

QFont CardView::headerFont   const
 

Returns:
the header font

Definition at line 1664 of file cardview.cpp.

Referenced by CardViewItem::paintCard(), and CardViewItem::showFullString().

void CardView::setFont const QFont   fnt
 

@reimp.

Definition at line 1669 of file cardview.cpp.

Referenced by KAddressBookCardView::readConfig().

void CardView::setSeparatorWidth int    width
 

Sets the column separator width.

Definition at line 1681 of file cardview.cpp.

References setLayoutDirty().

Referenced by KAddressBookCardView::readConfig().

int CardView::separatorWidth  
 

Returns:
the column separator width

Definition at line 1676 of file cardview.cpp.

void CardView::setMaxFieldLines int    howmany
 

Sets the maximum number of lines to display pr field.

If set to 0 (the default) all lines will be displayed.

Definition at line 1692 of file cardview.cpp.

int CardView::maxFieldLines   const
 

Returns:
the maximum number of lines pr field

Definition at line 1687 of file cardview.cpp.

Referenced by CardViewItem::fieldAt(), CardViewItem::height(), CardViewItem::paintCard(), and CardViewItem::showFullString().

void CardView::selectionChanged   [signal]
 

Emitted whenever the selection changes.

This means a user highlighted a new item or unhighlighted a currently selected item.

Referenced by selectAll(), and setSelected().

void CardView::selectionChanged CardViewItem   [signal]
 

Same as above method, only it carries the item that was selected.

This method will only be emitted in single select mode, since it defineds which item was selected.

void CardView::clicked CardViewItem   [signal]
 

This method is emitted whenever an item is clicked.

void CardView::executed CardViewItem   [signal]
 

Emitted whenever the user 'executes' an item.

This is dependant on the KDE global config. This could be a single click or a doubleclick. Also emitted when the return key is pressed on an item.

void CardView::doubleClicked CardViewItem   [signal]
 

Emitted whenever the user double clicks on an item.

void CardView::currentChanged CardViewItem   [signal]
 

Emitted when the current item changes.

Referenced by setCurrentItem().

void CardView::returnPressed CardViewItem   [signal]
 

Emitted when the return key is pressed in an item.

void CardView::contextMenuRequested CardViewItem  ,
const QPoint  
[signal]
 

Emitted when the context menu is requested in some way.

void CardView::drawContents QPainter   p,
int    clipx,
int    clipy,
int    clipw,
int    cliph
[protected]
 

Determines which cards intersect that region and tells them to paint themselves.

Reimplemented from QScrollView.

Definition at line 902 of file cardview.cpp.

References calcLayout(), QRect::contains(), QPtrListIterator::current(), CardViewItem::d, QScrollView::drawContents(), CardViewItem::height(), QRect::intersects(), CardViewItem::paintCard(), QPainter::restore(), QPainter::save(), QRect::setRect(), QPtrListIterator::toFirst(), QPainter::translate(), QScrollView::viewport(), QRect::x(), and QRect::y().

void CardView::resizeEvent QResizeEvent   e [protected]
 

Sets the layout to dirty and repaints.

Definition at line 961 of file cardview.cpp.

References setLayoutDirty().

void CardView::contentsWheelEvent QWheelEvent   e [protected]
 

Changes the direction the canvas scolls.

Reimplemented from QScrollView.

Definition at line 1516 of file cardview.cpp.

References QWheelEvent::delta(), and QScrollView::scrollBy().

void CardView::setLayoutDirty bool    dirty [protected]
 

Sets the layout to dirty and calls for a repaint.

Definition at line 1521 of file cardview.cpp.

Referenced by clear(), CardViewItem::clearFields(), CardViewItem::insertField(), insertItem(), CardViewItem::removeField(), resizeEvent(), setDrawColSeparators(), setItemMargin(), setItemSpacing(), setItemWidth(), setSeparatorWidth(), setShowEmptyFields(), and takeItem().

void CardView::calcLayout   [protected]
 

Does the math based on the bounding rect of the cards to properly lay the cards out on the screen.

This is only done if the layout is marked as dirty.

Definition at line 968 of file cardview.cpp.

References QPtrListIterator::current(), CardViewItem::d, CardViewItem::height(), QScrollView::horizontalScrollBar(), QScrollView::resizeContents(), and QPtrListIterator::toFirst().

Referenced by drawContents().

void CardView::startDrag   [protected, virtual]
 

Overload this method to be told when a drag should be started.

In most cases you will want to start a drag event with the currently selected item.

Definition at line 1586 of file cardview.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kaddressbook Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:38:54 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003