CardView Class Reference
The CardView is a method of displaying data in cards.
More...
#include <cardview.h>
Inherits QScrollView.
Inherited by AddresseeCardView.
List of all members.
Public Types
- enum SelectionMode { Single,
Multi,
Extended,
NoSelection
}
Signals
Public Member Functions
Protected Member Functions
- void drawContents (QPainter *p, int clipx, int clipy, int clipw, int cliph)
- void resizeEvent (QResizeEvent *)
- void contentsWheelEvent (QWheelEvent *)
- void setLayoutDirty (bool dirty)
- void calcLayout ()
-
virtual void contentsMousePressEvent (QMouseEvent *)
-
virtual void contentsMouseMoveEvent (QMouseEvent *)
-
virtual void contentsMouseReleaseEvent (QMouseEvent *)
-
virtual void contentsMouseDoubleClickEvent (QMouseEvent *)
-
virtual void enterEvent (QEvent *)
-
virtual void leaveEvent (QEvent *)
-
virtual void focusInEvent (QFocusEvent *)
-
virtual void focusOutEvent (QFocusEvent *)
-
virtual void keyPressEvent (QKeyEvent *)
- virtual void startDrag ()
Friends
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.
Constructor & Destructor Documentation
CardView::CardView |
( |
QWidget * |
parent, |
|
|
const char * |
name |
|
) |
|
|
Member Function Documentation
|
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. |
|
Takes the item from the view.
The item will not be deleted and ownership of the item is returned to the caller. |
|
Clears the view and deletes all card view items.
|
|
- 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()
|
CardViewItem * CardView::itemAt |
( |
const QPoint & |
viewPos |
) |
const |
|
|
- Returns:
- The item found at the given point, or 0 if there is no item at that point.
|
QRect CardView::itemRect |
( |
const CardViewItem * |
item |
) |
const |
|
|
- Returns:
- The bounding rect of the given item.
|
void CardView::ensureItemVisible |
( |
const CardViewItem * |
item |
) |
|
|
|
Ensures that the given item is in the viewable area of the widget.
|
void CardView::setSelectionMode |
( |
SelectionMode |
mode |
) |
|
|
|
Sets the selection mode.
- See also:
- QListView
|
CardView::SelectionMode CardView::selectionMode |
( |
|
) |
const |
|
|
- Returns:
- The current selection mode.
|
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. |
void CardView::selectAll |
( |
bool |
state |
) |
|
|
|
Selects or deselects all items.
|
|
- Returns:
- True if the given item is selected, false otherwise.
|
|
- 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.
|
|
- 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.
|
|
- Returns:
- The item after the given item or 0 if the item is the last item.
|
int CardView::childCount |
( |
|
) |
const |
|
|
- Returns:
- The number of items in the view.
|
CardViewItem * CardView::findItem |
( |
const QString & |
text, |
|
|
const QString & |
label, |
|
|
Qt::StringComparisonMode |
compare = Qt::BeginsWith |
|
) |
const |
|
|
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.
|
uint CardView::columnWidth |
( |
|
) |
const |
|
|
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()
|
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. |
bool CardView::drawCardBorder |
( |
|
) |
const |
|
|
- Returns:
- True if borders are drawn, false otherwise.
|
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. |
bool CardView::drawColSeparators |
( |
|
) |
const |
|
|
- Returns:
- True if column separators are drawn, false otherwise.
|
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. |
bool CardView::drawFieldLabels |
( |
|
) |
const |
|
|
- Returns:
- True if the field labels are drawn, false otherwise.
|
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.
..) |
bool CardView::showEmptyFields |
( |
|
) |
const |
|
|
- Returns:
- Wheather empty fields should be shown
|
uint CardView::itemMargin |
( |
|
) |
const |
|
|
- 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.
|
void CardView::setItemMargin |
( |
uint |
margin |
) |
|
|
uint CardView::itemSpacing |
( |
|
) |
const |
|
|
- 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.
|
void CardView::setItemSpacing |
( |
uint |
spacing |
) |
|
|
int CardView::itemWidth |
( |
|
) |
const |
|
|
- Returns:
- the width made available to the card items.
|
void CardView::setItemWidth |
( |
int |
width |
) |
|
|
|
Sets the width made available to card items.
|
void CardView::setHeaderFont |
( |
const QFont & |
fnt |
) |
|
|
QFont CardView::headerFont |
( |
|
) |
const |
|
void CardView::setFont |
( |
const QFont & |
fnt |
) |
|
|
|
Reimplementation from QWidget.
|
void CardView::setSeparatorWidth |
( |
int |
width |
) |
|
|
|
Sets the column separator width.
|
int CardView::separatorWidth |
( |
|
) |
const |
|
|
- Returns:
- the column separator width
|
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. |
int CardView::maxFieldLines |
( |
|
) |
const |
|
|
- Returns:
- the maximum number of lines pr field
|
void CardView::selectionChanged |
( |
|
) |
[signal] |
|
|
Emitted whenever the selection changes.
This means a user highlighted a new item or unhighlighted a currently selected item. |
|
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. |
|
This method is emitted whenever an item is clicked.
|
|
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. |
|
Emitted whenever the user double clicks on an item.
|
|
Emitted when the current item changes.
|
|
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.
|
void CardView::resizeEvent |
( |
QResizeEvent * |
|
) |
[protected] |
|
|
Sets the layout to dirty and repaints.
|
void CardView::contentsWheelEvent |
( |
QWheelEvent * |
|
) |
[protected] |
|
|
Changes the direction the canvas scolls.
|
void CardView::setLayoutDirty |
( |
bool |
dirty |
) |
[protected] |
|
|
Sets the layout to dirty and calls for a repaint.
|
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. |
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. |
The documentation for this class was generated from the following files: