vcs.maemo.org Git - situare/blob - src/ui/listview.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5        Jussi Laitinen - jussi.laitinen@ixonos.com
   6
   7    Situare is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License
   9    version 2 as published by the Free Software Foundation.
  10
  11    Situare is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Situare; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  19    USA.
  20 */
  21
  22 #ifndef LISTVIEW_H
  23 #define LISTVIEW_H
  24
  25 #include <QListWidget>
  26
  27 class GeoCoordinate;
  28 class ListItem;
  29
  30 /**
  31 * @brief View for ListItems.
  32 *
  33 * ListView is used to show ListItems in list view. Items can be added, removed or
  34 * filtered.
  35 *
  36 * @author Jussi Laitinen - jussi.laitinen (at) ixonos.com
  37 */
  38 class ListView : public QListWidget
  39 {
  40     Q_OBJECT
  41
  42 public:
  43     /**
  44     * @brief Constructor.
  45     *
  46     * @param parent QWidget
  47     */
  48     ListView(QWidget *parent = 0);
  49
  50     /**
  51     * @brief Destructor.
  52     *
  53     * Calls ListView::clearList().
  54     */
  55     ~ListView();
  56
  57 /******************************************************************************
  58 * MEMBER FUNCTIONS AND SLOTS
  59 ******************************************************************************/
  60 public:
  61     /**
  62     * @brief Add item to view and item list.
  63     *
  64     * @param key user ID
  65     * @param item item to add to view and list
  66     */
  67     void addListItem(const QString &key, ListItem *item);
  68
  69     /**
  70     * @brief Adds item to view.
  71     *
  72     * @param item FriendListItem
  73     */
  74     void addListItemToView(ListItem *item);
  75
  76     /**
  77     * @brief Clear unused items from view.
  78     *
  79     * Clears items which are not in item ID's list from the view and items list.
  80     *
  81     * @param itemIDs list of item ID's to keep in list view
  82     */
  83     void clearUnused(const QStringList &itemIDs);
  84
  85     /**
  86     * @brief Clears filtering from list.
  87     *
  88     * Clears m_filteredItemIDs and shows all items.
  89     */
  90     void clearFilter();
  91
  92     /**
  93     * @brief Clears list.
  94     *
  95     * Items are removed from view and item list.
  96     */
  97     void clearList();
  98
  99     /**
 100     * @brief Checks if view contains item with userID.
 101     *
 102     * @param userID user's ID
 103     * @return true if view contains item, false otherwise
 104     */
 105     bool contains(const QString &userID);
 106
 107     /**
 108     * @brief Filters list by item IDs.
 109     *
 110     * Hide all items that are not in the itemIDs list.
 111     *
 112     * @param itemIDs item ID's for items that are shown
 113     */
 114     void filter(const QList<QString> &itemIDs);
 115
 116     /**
 117     * @brief Filters list by text pattern.
 118     *
 119     * Filtering uses item names. If filtering by item IDs is on, filters only those items.
 120     *
 121     * @param pattern text pattern to filter
 122     */
 123     void filter(const QString &pattern);
 124
 125     /**
 126     * @brief Takes item from view.
 127     *
 128     * Item is not deleted.
 129     *
 130     * @param itemID item's ID
 131     * @return ListItem
 132     */
 133     ListItem *takeListItemFromView(const QString &itemID);
 134
 135     /**
 136     * @brief Returns ListItem with itemID.
 137     *
 138     * @param itemID item's ID
 139     * @return ListItem
 140     */
 141     ListItem *listItem(const QString &itemID);
 142
 143     /**
 144     * @brief Returns ListItem by index.
 145     *
 146     * @param index item's index
 147     * @return ListItem
 148     */
 149     ListItem *listItemAt(int index);
 150
 151     /**
 152     * @brief Returns selected ListItem.
 153     *
 154     * @return ListItem if there is selected, 0 otherwise
 155     */
 156     ListItem *selectedItem();
 157
 158     /**
 159     * @brief Sets selected item.
 160     *
 161     * @param item ListItem to select
 162     */
 163     void setSelectedItem(ListItem *item);
 164
 165 protected slots:
 166     /**
 167     * @brief Slot for list item clicked.
 168     *
 169     * Toggles items selection state and emits listItemClicked signal.
 170     */
 171     virtual bool listItemClicked(ListItem *item);
 172
 173 private slots:
 174     /**
 175     * @brief Slot for list item clicked.
 176     *
 177     * Toggles items selection state and emits listItemClicked signal.
 178     */
 179     void listItemClicked(QListWidgetItem *item);
 180
 181 /*******************************************************************************
 182  * DATA MEMBERS
 183  ******************************************************************************/
 184 private:
 185     QHash<QString, ListItem *> m_listItems; ///< List of items in this view. Key = user ID
 186
 187     QList<QString> m_filteredItemIDs;       ///< List of filtered item IDs
 188
 189     ListItem *m_previousItem;               ///< Previously selected item
 190 };
 191
 192 #endif // LISTVIEW_H