Added comments to friendlistitem, friendlistview and listviewscreen.
[situare] / src / ui / friendlistview.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 FRIENDLISTVIEW_H
23 #define FRIENDLISTVIEW_H
24
25 #include <QWidget>
26 #include <QList>
27
28 class QVBoxLayout;
29 class QLabel;
30
31 /**
32 * @brief FriendListView shows items in list.
33 *
34 * @class FriendListView friendlistview.h "ui/friendlistview.h"
35 */
36 class FriendListView : public QWidget
37 {
38     Q_OBJECT
39
40 public:
41     /**
42     * @brief Constructor.
43     *
44     * @param parent parent widget
45     */
46     FriendListView(QWidget *parent = 0);
47
48 /******************************************************************************
49 * MEMBER FUNCTIONS AND SLOTS
50 ******************************************************************************/
51 public:
52     /**
53     * @brief Add widget to view and widget list.
54     *
55     * @param widget widget to add to list
56     */
57     void addWidget(QWidget *widget);
58
59     /**
60     * @brief Clear view.
61     *
62     * Clears all items from the view and widget list.
63     */
64     void clear();
65
66 /******************************************************************************
67 * DATA MEMBERS
68 ******************************************************************************/
69 private:
70     QVBoxLayout *m_friendListLayout;    ///< Layout for this view
71     QList<QWidget *> widgets;           ///< List of widgets in this view
72 };
73
74 #endif // FRIENDLISTVIEW_H