Commented information panels code to comply with DoD doxygen check
[situare] / src / ui / situareuser.h
1 /*
2    Situare - A location system for Facebook
3    Copyright (C) 2010  Ixonos Plc. Authors:
4
5        Jukka Saastamoinen - jukka.saastamoinen@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 SITUAREUSER_H
23 #define SITUAREUSER_H
24
25 #include <QLabel>
26 #include <QPixmap>
27
28 /**
29 * @brief User class for personal information tab
30 *
31 * @class SituareUser situareuser.h "ui/situareuser.h"
32 */
33 class SituareUser : public QLabel
34 {
35     Q_OBJECT
36 public:
37     /**
38     * @brief Constructor
39     *
40     * @param parent Parent
41     */
42     SituareUser(QWidget *parent=0);
43 /*******************************************************************************
44 * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
45 *******************************************************************************/
46 protected:
47     /**
48     * @brief This function is called when the widget is drawn
49     *
50     * @param aPaintEvent Pointer to paint event
51     */
52     void paintEvent(QPaintEvent *aPaintEvent);
53     /**
54     * @brief This function suggests layouter correct size.
55     *
56     * @return QSize Size of the label
57     */
58     QSize sizeHint() const;
59 };
60
61 #endif // SITUAREUSER_H