git.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 class ListView : public QListWidget
  37 {
  38     Q_OBJECT
  39
  40 public:
  41     ListView(QWidget *parent = 0);
  42
  43 /******************************************************************************
  44 * MEMBER FUNCTIONS AND SLOTS
  45 ******************************************************************************/
  46 public:
  47     /**
  48     * @brief Add item to view and item list.
  49     *
  50     * @param key user ID
  51     * @param item item to add to view and list
  52     */
  53     void addListItem(const QString &key, ListItem *item);
  54
  55     /**
  56     * @brief Adds item to view.
  57     *
  58     * @param item FriendListItem
  59     */
  60     void addListItemToView(ListItem *item);
  61
  62     /**
  63     * @brief Clear unused items from view.
  64     *
  65     * Clears items which are not in user ID's list from the view and items list.
  66     *
  67     * @param userIDs list of new user ID's.
  68     */
  69     void clearUnused(const QStringList &userIDs);
  70
  71     /**
  72     * @brief Clears filtering from list.
  73     *
  74     * Shows all items.
  75     */
  76     void clearFilter();
  77
  78     /**
  79     * @brief Clears list.
  80     *
  81     * Items are removed from view and item list.
  82     */
  83     void clearList();
  84
  85     /**
  86     * @brief Checks if view contains item with userID.
  87     *
  88     * @param userID user's ID
  89     * @return true if view contains item, false otherwise
  90     */
  91     bool contains(const QString &userID);
  92
  93     /**
  94     * @brief Sets filter to list.
  95     *
  96     * Hide all items that are not in the userIDs list.
  97     *
  98     * @param userIDs user ID's to items that are shown
  99     */
 100     void filter(const QList<QString> &userIDs);
 101
 102     /**
 103     * @brief Takes item from view.
 104     *
 105     * Item is not deleted.
 106     *
 107     * @param userID user's ID
 108     * @return ListItem
 109     */
 110     ListItem *takeListItemFromView(const QString &userID);
 111
 112     /**
 113     * @brief Returns ListItem with userID.
 114     *
 115     * @param userID user's ID
 116     * @return ListItem
 117     */
 118     ListItem *listItem(const QString &userID);
 119
 120 private slots:
 121     /**
 122     * @brief Slot for list item clicked.
 123     *
 124     * Toggles items selection state and emits listItemClicked signal.
 125     */
 126     void listItemClicked(QListWidgetItem *item);
 127
 128 /******************************************************************************
 129 * SIGNALS
 130 ******************************************************************************/
 131 signals:
 132     /**
 133     * @brief Signal is emitted when list item is clicked.
 134     *
 135     * @param coordinates item's coordinates
 136     */
 137     void listItemClicked(const GeoCoordinate &coordinates);
 138
 139 /*******************************************************************************
 140  * DATA MEMBERS
 141  ******************************************************************************/
 142 private:
 143     ListItem *m_previousItem;               ///< Previously selected item
 144     QHash<QString, ListItem *> m_listItems; ///< List of items in this view. Key = user ID
 145 };
 146
 147 #endif // LISTVIEW_H