author | zecke <zecke> | 2003-04-16 10:59:24 (UTC) |
---|---|---|
committer | zecke <zecke> | 2003-04-16 10:59:24 (UTC) |
commit | 5b9d1ddde859ff783f95babf1887fa40e6bfe0be (patch) (unidiff) | |
tree | 0a8596c4de5145e5f469a6c0d8dbd2f946ef0817 /libopie/otabinfo.h | |
parent | eeb29547890a2d162de66d7d5b98d3840a7e2d79 (diff) | |
download | opie-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
-rw-r--r-- | libopie/otabinfo.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h index 6589638..eebaf8e 100644 --- a/libopie/otabinfo.h +++ b/libopie/otabinfo.h | |||
@@ -32,101 +32,101 @@ | |||
32 | #ifndef OTABINFO_H | 32 | #ifndef OTABINFO_H |
33 | #define OTABINFO_H | 33 | #define OTABINFO_H |
34 | 34 | ||
35 | #include <qlist.h> | 35 | #include <qlist.h> |
36 | #include <qstring.h> | 36 | #include <qstring.h> |
37 | 37 | ||
38 | class QWidget; | 38 | class QWidget; |
39 | 39 | ||
40 | /** | 40 | /** |
41 | * @class OTabInfo | 41 | * @class OTabInfo |
42 | * @brief The OTabInfo class is used internally by OTabWidget to keep track | 42 | * @brief The OTabInfo class is used internally by OTabWidget to keep track |
43 | * of widgets added to the control. | 43 | * of widgets added to the control. |
44 | * | 44 | * |
45 | * OTabInfo provides the following information about a widget added to an | 45 | * OTabInfo provides the following information about a widget added to an |
46 | * OTabWidget control: | 46 | * OTabWidget control: |
47 | * | 47 | * |
48 | * ID - integer tab bar ID | 48 | * ID - integer tab bar ID |
49 | * Control - QWidget pointer to child widget | 49 | * Control - QWidget pointer to child widget |
50 | * Label - QString text label for OTabWidget selection control | 50 | * Label - QString text label for OTabWidget selection control |
51 | * Icon - QString name of icon file | 51 | * Icon - QString name of icon file |
52 | */ | 52 | */ |
53 | class OTabInfo | 53 | class OTabInfo |
54 | { | 54 | { |
55 | public: | 55 | public: |
56 | /** | 56 | /** |
57 | * @fn OTabInfo() | 57 | * @fn OTabInfo() |
58 | * @brief Object constructor. | 58 | * @brief Object constructor. |
59 | * | 59 | * |
60 | * @param parent Pointer to parent of this control. | 60 | * @param parent Pointer to parent of this control. |
61 | * @param name Name of control. | 61 | * @param name Name of control. |
62 | * @param s Style of widget selection control. | 62 | * @param s Style of widget selection control. |
63 | * @param p Position of the widget selection control. | 63 | * @param p Position of the widget selection control. |
64 | */ | 64 | */ |
65 | OTabInfo() : i( -1 ), c( 0 ), p( 0 ), l( QString::null ) {} | 65 | OTabInfo() : i( -1 ), c( 0 ), p( 0 ), l( QString::null ) {} |
66 | 66 | ||
67 | /** | 67 | /** |
68 | * @fn OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) | 68 | * @fn OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) |
69 | * @brief Object constructor. | 69 | * @brief Object constructor. |
70 | * | 70 | * |
71 | * @param id TabBar identifier for widget. | 71 | * @param id TabBar identifier for widget. |
72 | * @param control QWidget pointer to widget. | 72 | * @param control QWidget pointer to widget. |
73 | * @param icon QString name of icon file. | 73 | * @param icon QString name of icon file. |
74 | * @param label QString text label for OTabWidget selection control. | 74 | * @param label QString text label for OTabWidget selection control. |
75 | */ | 75 | */ |
76 | OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) | 76 | OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) |
77 | : i( id ), c( control ), p( icon ), l( label ) {} | 77 | : i( id ), c( control ), p( icon ), l( label ) {} |
78 | 78 | ||
79 | /** | 79 | /** |
80 | * @fn id() | 80 | * @fn id()const |
81 | * @brief Returns TabBar ID. | 81 | * @brief Returns TabBar ID. |
82 | */ | 82 | */ |
83 | int id() const { return i; } | 83 | int id() const { return i; } |
84 | 84 | ||
85 | /** | 85 | /** |
86 | * @fn label() | 86 | * @fn label()const |
87 | * @brief Returns text label for widget. | 87 | * @brief Returns text label for widget. |
88 | */ | 88 | */ |
89 | const QString &label() const { return l; } | 89 | const QString &label() const { return l; } |
90 | 90 | ||
91 | /** | 91 | /** |
92 | * @fn setLabel( const QString &label ) | 92 | * @fn setLabel( const QString &label ) |
93 | * @brief Set label for tab. | 93 | * @brief Set label for tab. |
94 | * | 94 | * |
95 | * @param label QString text label for OTabWidget selection control. | 95 | * @param label QString text label for OTabWidget selection control. |
96 | */ | 96 | */ |
97 | void setLabel( const QString &label ) { l = label; } | 97 | void setLabel( const QString &label ) { l = label; } |
98 | 98 | ||
99 | /** | 99 | /** |
100 | * @fn control() | 100 | * @fn control()const |
101 | * @brief Returns pointer to widget. | 101 | * @brief Returns pointer to widget. |
102 | */ | 102 | */ |
103 | QWidget *control() const { return c; } | 103 | QWidget *control() const { return c; } |
104 | 104 | ||
105 | /** | 105 | /** |
106 | * @fn icon() | 106 | * @fn icon()const |
107 | * @brief Returns name of icon file. | 107 | * @brief Returns name of icon file. |
108 | */ | 108 | */ |
109 | const QString &icon() const { return p; } | 109 | const QString &icon() const { return p; } |
110 | 110 | ||
111 | /** | 111 | /** |
112 | * @fn setIcon( const QString &icon ) | 112 | * @fn setIcon( const QString &icon ) |
113 | * @brief Set icon for tab. | 113 | * @brief Set icon for tab. |
114 | * | 114 | * |
115 | * @param icon QString name of icon file. | 115 | * @param icon QString name of icon file. |
116 | */ | 116 | */ |
117 | void setIcon( const QString &icon ) { p = icon; } | 117 | void setIcon( const QString &icon ) { p = icon; } |
118 | 118 | ||
119 | private: | 119 | private: |
120 | int i; | 120 | int i; |
121 | QWidget *c; | 121 | QWidget *c; |
122 | QString p; | 122 | QString p; |
123 | QString l; | 123 | QString l; |
124 | }; | 124 | }; |
125 | 125 | ||
126 | /** | 126 | /** |
127 | * @class OTabInfoList | 127 | * @class OTabInfoList |
128 | * @brief A list of OTabInfo objects used by OTabWidget. | 128 | * @brief A list of OTabInfo objects used by OTabWidget. |
129 | */ | 129 | */ |
130 | typedef QList<OTabInfo> OTabInfoList; | 130 | typedef QList<OTabInfo> OTabInfoList; |
131 | 131 | ||
132 | #endif | 132 | #endif |