ListView Class Reference

View for ListItems. More...

#include <listview.h>

Inheritance diagram for ListView:
Inheritance graph
[legend]
Collaboration diagram for ListView:
Collaboration graph
[legend]

List of all members.

Signals

void listItemSelectionChanged ()
 Emitted when list item selection changes.

Public Member Functions

 ListView (QWidget *parent=0)
 Constructor.
 ~ListView ()
 Destructor.
void addListItem (const QString &key, ListItem *item)
 Add item to view and item list.
void addListItemToView (ListItem *item)
 Adds item to view.
void clearUnused (const QStringList &itemIDs)
 Clear unused items from view.
void clearFilter ()
 Clears filtering from list.
void clearItemSelection ()
 Deselects all selected items.
void clearList ()
 Clears list.
bool contains (const QString &userID)
 Checks if view contains item with userID.
void filter (const QList< QString > &itemIDs)
 Filters list by item IDs.
void filter (const QString &pattern)
 Filters list by text pattern.
ListItemtakeListItemFromView (const QString &itemID)
 Takes item from view.
ListItemlistItem (const QString &itemID)
 Returns ListItem with itemID.
ListItemlistItemAt (int index)
 Returns ListItem by index.
QHash< QString, ListItem * > listItems () const
 Returns all list items.
void prependListItem (const QString &key, ListItem *item)
 Prepends item to view and item list.
void removeLastItem ()
 Removes last ListItem in list.
ListItemselectedItem ()
 Returns selected ListItem.
void setSelectedItem (ListItem *item)
 Sets selected item.

Protected Slots

virtual bool listItemClicked (ListItem *clickedItem)
 Slot for list item clicked.

Private Slots

void listItemClicked (QListWidgetItem *item)
 Slot for list item clicked.

Private Attributes

QHash< QString, ListItem * > m_listItems
 List of items in this view. Key = user ID.
QList< QString > m_filteredItemIDs
 List of filtered item IDs.
ListItemm_currentItem
 Previously selected item.

Detailed Description

View for ListItems.

ListView is used to show ListItems in list view. Items can be added, removed or filtered.

Author:
Jussi Laitinen - jussi.laitinen (at) ixonos.com

Constructor & Destructor Documentation

ListView::ListView ( QWidget *  parent = 0  ) 

Constructor.

Parameters:
parent QWidget
ListView::~ListView (  ) 

Destructor.

Calls ListView::clearList().


Member Function Documentation

void ListView::addListItem ( const QString &  key,
ListItem item 
)

Add item to view and item list.

Parameters:
key user ID
item item to add to view and list
void ListView::addListItemToView ( ListItem item  ) 

Adds item to view.

Parameters:
item FriendListItem
void ListView::clearFilter (  ) 

Clears filtering from list.

Clears m_filteredItemIDs and shows all items.

void ListView::clearList (  ) 

Clears list.

Items are removed from view and item list.

void ListView::clearUnused ( const QStringList &  itemIDs  ) 

Clear unused items from view.

Clears items which are not in item ID's list from the view and items list.

Parameters:
itemIDs list of item ID's to keep in list view
bool ListView::contains ( const QString &  userID  ) 

Checks if view contains item with userID.

Parameters:
userID user's ID
Returns:
true if view contains item, false otherwise
void ListView::filter ( const QString &  pattern  ) 

Filters list by text pattern.

Filtering uses item names. If filtering by item IDs is on, filters only those items.

Parameters:
pattern text pattern to filter
void ListView::filter ( const QList< QString > &  itemIDs  ) 

Filters list by item IDs.

Hide all items that are not in the itemIDs list.

Parameters:
itemIDs item ID's for items that are shown
ListItem * ListView::listItem ( const QString &  itemID  ) 

Returns ListItem with itemID.

Parameters:
itemID item's ID
Returns:
ListItem
ListItem * ListView::listItemAt ( int  index  ) 

Returns ListItem by index.

Parameters:
index item's index
Returns:
ListItem
void ListView::listItemClicked ( QListWidgetItem *  item  )  [private, slot]

Slot for list item clicked.

Calls listItemClicked(ListItem *item)

Parameters:
item QListWidgetItem
bool ListView::listItemClicked ( ListItem clickedItem  )  [protected, virtual, slot]

Slot for list item clicked.

Toggles items selection state and emits listItemClicked signal.

Parameters:
clickedItem clicked ListItem
Returns:
true if item was selected, false otherwise

Reimplemented in FriendListView, LocationListView, RouteWaypointListView, and SearchHistoryListView.

QHash< QString, ListItem * > ListView::listItems (  )  const

Returns all list items.

Item ID is key.

Returns:
list of ListItems
void ListView::prependListItem ( const QString &  key,
ListItem item 
)

Prepends item to view and item list.

Parameters:
key user ID
item item to prepend to view and list
ListItem * ListView::selectedItem (  ) 

Returns selected ListItem.

Returns:
ListItem if there is selected, 0 otherwise
void ListView::setSelectedItem ( ListItem item  ) 

Sets selected item.

Parameters:
item ListItem to select
ListItem * ListView::takeListItemFromView ( const QString &  itemID  ) 

Takes item from view.

Item is not deleted.

Parameters:
itemID item's ID
Returns:
ListItem

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

Generated on Fri Sep 3 12:05:41 2010 for Situare client for Maemo by  doxygen 1.6.1