summaryrefslogtreecommitdiff
path: root/libopie/ocheckitem.h
authorzecke <zecke>2003-04-16 10:59:24 (UTC)
committer zecke <zecke>2003-04-16 10:59:24 (UTC)
commit5b9d1ddde859ff783f95babf1887fa40e6bfe0be (patch) (unidiff)
tree0a8596c4de5145e5f469a6c0d8dbd2f946ef0817 /libopie/ocheckitem.h
parenteeb29547890a2d162de66d7d5b98d3840a7e2d79 (diff)
downloadopie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.zip
opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.gz
opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.bz2
API docu fixes...
if using \fn infront of a function make sure to name the right function ljp please see my comment in oticker about constness
Diffstat (limited to 'libopie/ocheckitem.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/ocheckitem.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h
index 2387134..82ee3d0 100644
--- a/libopie/ocheckitem.h
+++ b/libopie/ocheckitem.h
@@ -1,53 +1,62 @@
1/********************************************************************** 1/**********************************************************************
2** Copyright (C) 2002 Stefan Eilers (se, eilers.stefan@epost.de) 2** Copyright (C) 2002 Stefan Eilers (se, eilers.stefan@epost.de)
3** 3**
4** This file may be distributed and/or modified under the terms of the 4** This file may be distributed and/or modified under the terms of the
5** GNU Library General Public License version 2 as published by the 5** GNU Library General Public License version 2 as published by the
6** Free Software Foundation and appearing in the file LICENSE.GPL 6** Free Software Foundation and appearing in the file LICENSE.GPL
7** included in the packaging of this file. 7** included in the packaging of this file.
8** 8**
9** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE 9** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
10** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 10** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
11**********************************************************************/ 11**********************************************************************/
12#include <qtable.h> 12#include <qtable.h>
13 13
14#ifndef CHECKITEM_H__ 14#ifndef CHECKITEM_H__
15#define CHECKITEM_H__ 15#define CHECKITEM_H__
16 16
17/** 17/**
18 * This class represents a checkable QTableItem. This can 18 * This class represents a checkable QTableItem. This can
19 * be added to any QTable. 19 * be added to any QTable.
20 * 20 *
21 * 21 *
22 * @see QTable 22 * @see QTable
23 * @see QTableItem 23 * @see QTableItem
24 * @short An checkable QTableItem 24 * @short An checkable QTableItem
25 * @version 1.0 25 * @version 1.0
26 * @author Stefan Eilers ( eilers@handhelds.org ) 26 * @author Stefan Eilers ( eilers@handhelds.org )
27 */ 27 */
28 28
29class OCheckItem : public QTableItem 29class OCheckItem : public QTableItem
30{ 30{
31public: 31public:
32 /** The size of a box currently unused */
32 enum Size { BoxSize = 10 }; 33 enum Size { BoxSize = 10 };
33 OCheckItem( QTable *t, const QString &sortkey ); 34 OCheckItem( QTable *t, const QString &sortkey );
34 35
35 virtual void setChecked( bool b ); 36 virtual void setChecked( bool b );
36 virtual void toggle(); 37 virtual void toggle();
37 bool isChecked() const; 38 bool isChecked() const;
39 /**
40 * @short Set the sort key
41 * @reimp
42 */
38 void setKey( const QString &key ) { m_sortKey = key; } 43 void setKey( const QString &key ) { m_sortKey = key; }
39 virtual QString key() const; 44 virtual QString key() const;
40 45
46 /**
47 * foo
48 * @internal
49 */
41 void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected ); 50 void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected );
42 51
43 //static const int BoxSize = 10; 52 //static const int BoxSize = 10;
44 53
45private: 54private:
46 class OCheckItemPrivate; 55 class OCheckItemPrivate;
47 OCheckItemPrivate *d; 56 OCheckItemPrivate *d;
48 bool m_checked: 1; 57 bool m_checked: 1;
49 QString m_sortKey; 58 QString m_sortKey;
50 59
51}; 60};
52 61
53#endif 62#endif