summaryrefslogtreecommitdiff
path: root/libopie2/opieui
authorzecke <zecke>2003-04-13 16:25:24 (UTC)
committer zecke <zecke>2003-04-13 16:25:24 (UTC)
commitc27d6327b9be5792fa507557f03997a46f32cc26 (patch) (unidiff)
tree3332ed2d1c673a898ba1862276d8688918618d7f /libopie2/opieui
parent3e1f225ed1e515c3425361fdc90ac4d5b6d86941 (diff)
downloadopie-c27d6327b9be5792fa507557f03997a46f32cc26.zip
opie-c27d6327b9be5792fa507557f03997a46f32cc26.tar.gz
opie-c27d6327b9be5792fa507557f03997a46f32cc26.tar.bz2
Add apie comments
QString -> const QString& fix
Diffstat (limited to 'libopie2/opieui') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opieui/odialog.h5
-rw-r--r--libopie2/opieui/oimageeffect.h1
-rw-r--r--libopie2/opieui/olistview.h4
-rw-r--r--libopie2/opieui/opopupmenu.h3
4 files changed, 9 insertions, 4 deletions
diff --git a/libopie2/opieui/odialog.h b/libopie2/opieui/odialog.h
index 7947dfb..4116ed7 100644
--- a/libopie2/opieui/odialog.h
+++ b/libopie2/opieui/odialog.h
@@ -30,59 +30,60 @@
30*/ 30*/
31 31
32#ifndef ODIALOG_H 32#ifndef ODIALOG_H
33#define ODIALOG_H 33#define ODIALOG_H
34 34
35class QLayoutItem; 35class QLayoutItem;
36 36
37#include <qdialog.h> 37#include <qdialog.h>
38 38
39/** 39/**
40 * Dialog with extended nonmodal support and methods for OPIE standard 40 * Dialog with extended nonmodal support and methods for OPIE standard
41 * compliance. 41 * compliance.
42 * 42 *
43 * The @ref marginHint() and @ref spacingHint() sizes shall be used 43 * The @ref marginHint() and @ref spacingHint() sizes shall be used
44 * whenever you layout the interior of a dialog. One special note. If 44 * whenever you layout the interior of a dialog. One special note. If
45 * you make your own action buttons (OK, Cancel etc), the space 45 * you make your own action buttons (OK, Cancel etc), the space
46 * beteween the buttons shall be @ref spacingHint(), whereas the space 46 * beteween the buttons shall be @ref spacingHint(), whereas the space
47 * above, below, to the right and to the left shall be @ref marginHint(). 47 * above, below, to the right and to the left shall be @ref marginHint().
48 * If you add a separator line above the buttons, there shall be a 48 * If you add a separator line above the buttons, there shall be a
49 * @ref marginHint() between the buttons and the separator and a 49 * @ref marginHint() between the buttons and the separator and a
50 * @ref marginHint() above the separator as well. 50 * @ref marginHint() above the separator as well.
51 * 51 *
52 * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de> 52 * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
53 */ 53 */
54 // lets fix up Qt instead! Size does matter. -zecke
54 55
55class ODialog : public QDialog 56class ODialog : public QDialog
56{ 57{
57 Q_OBJECT 58 Q_OBJECT
58 59
59 public: 60 public:
60 61
61 /** 62 /**
62 * Constructor. 63 * Constructor.
63 * 64 *
64 * Takes the same arguments as @ref QDialog. 65 * Takes the same arguments as @ref QDialog.
65 */ 66 */
66 ODialog(QWidget *parent = 0, const char *name = 0, bool modal = false, WFlags f = 0); 67 ODialog(QWidget *parent = 0, const char *name = 0, bool modal = false, WFlags f = 0);
67 68
68 /** 69 /**
69 * Return the number of pixels you shall use between a 70 * Return the number of pixels you shall use between a
70 * dialog edge and the outermost widget(s) according to the KDE standard. 71 * dialog edge and the outermost widget(s) according to the KDE standard.
71 **/ 72 **/
72 static int marginHint(); 73 static int marginHint();
73 74
74 /** 75 /**
75 * Return the number of pixels you shall use between 76 * Return the number of pixels you shall use between
76 * widgets inside a dialog according to the KDE standard. 77 * widgets inside a dialog according to the KDE standard.
77 */ 78 */
78 static int spacingHint(); 79 static int spacingHint();
79 80
80 private: 81 private:
81 static int mMarginSize; 82 static int mMarginSize;
82 static int mSpacingSize; 83 static int mSpacingSize;
83 84
84 //class ODialogPrivate; 85 class ODialogPrivate;
85 //ODialogPrivate *d; 86 ODialogPrivate *d; // d pointer always needed! -zecke
86 87
87}; 88};
88#endif // ODIALOG_H 89#endif // ODIALOG_H
diff --git a/libopie2/opieui/oimageeffect.h b/libopie2/opieui/oimageeffect.h
index 313ea50..fb4d22d 100644
--- a/libopie2/opieui/oimageeffect.h
+++ b/libopie2/opieui/oimageeffect.h
@@ -1,26 +1,27 @@
1//FIXME: Revise for Opie - do we really need such fancy stuff on PDA's? 1//FIXME: Revise for Opie - do we really need such fancy stuff on PDA's?
2//FIXME: Maybe not on SL5xxx, but surely on C700 :)) 2//FIXME: Maybe not on SL5xxx, but surely on C700 :))
3//FIXME: I think we don#t need that -zecke
3 4
4/* This file is part of the KDE libraries 5/* This file is part of the KDE libraries
5 Copyright (C) 1998, 1999, 2001, 2002 Daniel M. Duley <mosfet@interaccess.com> 6 Copyright (C) 1998, 1999, 2001, 2002 Daniel M. Duley <mosfet@interaccess.com>
6 (C) 1998, 1999 Christian Tibirna <ctibirna@total.net> 7 (C) 1998, 1999 Christian Tibirna <ctibirna@total.net>
7 (C) 1998, 1999 Dirk A. Mueller <mueller@kde.org> 8 (C) 1998, 1999 Dirk A. Mueller <mueller@kde.org>
8 9
9Redistribution and use in source and binary forms, with or without 10Redistribution and use in source and binary forms, with or without
10modification, are permitted provided that the following conditions 11modification, are permitted provided that the following conditions
11are met: 12are met:
12 13
131. Redistributions of source code must retain the above copyright 141. Redistributions of source code must retain the above copyright
14 notice, this list of conditions and the following disclaimer. 15 notice, this list of conditions and the following disclaimer.
152. Redistributions in binary form must reproduce the above copyright 162. Redistributions in binary form must reproduce the above copyright
16 notice, this list of conditions and the following disclaimer in the 17 notice, this list of conditions and the following disclaimer in the
17 documentation and/or other materials provided with the distribution. 18 documentation and/or other materials provided with the distribution.
18 19
19THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 20THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 21IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 22OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 23IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 24INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
diff --git a/libopie2/opieui/olistview.h b/libopie2/opieui/olistview.h
index bafc67c..b62e278 100644
--- a/libopie2/opieui/olistview.h
+++ b/libopie2/opieui/olistview.h
@@ -98,61 +98,61 @@ class OListViewItem;
98 98
99 /** 99 /**
100 * sets the column separator pen. 100 * sets the column separator pen.
101 * 101 *
102 * @param p the pen used to draw the column separator. 102 * @param p the pen used to draw the column separator.
103 */ 103 */
104 void setColumnSeparator( const QPen &p ); 104 void setColumnSeparator( const QPen &p );
105 105
106 /** 106 /**
107 * @return the alternate background color 107 * @return the alternate background color
108 */ 108 */
109 const QColor& alternateBackground() const; 109 const QColor& alternateBackground() const;
110 110
111 /** 111 /**
112 * @return the column separator pen 112 * @return the column separator pen
113 */ 113 */
114 const QPen& columnSeparator() const; 114 const QPen& columnSeparator() const;
115 115
116 /** 116 /**
117 * create a list view item as child of this object 117 * create a list view item as child of this object
118 * @return the new object 118 * @return the new object
119 */ 119 */
120 virtual OListViewItem* childFactory(); 120 virtual OListViewItem* childFactory();
121 121
122 #ifndef QT_NO_DATASTREAM 122#ifndef QT_NO_DATASTREAM
123 /** 123 /**
124 * serialize this object to a @ref QDataStream 124 * serialize this object to a @ref QDataStream
125 * @param s the stream used to serialize this object. 125 * @param s the stream used to serialize this object.
126 */ 126 */
127 virtual void serializeTo( QDataStream& s ) const; 127 virtual void serializeTo( QDataStream& s ) const;
128 128
129 /** 129 /**
130 * serialize this object from a @ref QDataStream 130 * serialize this object from a @ref QDataStream
131 * @param s the stream used to serialize this object. 131 * @param s the stream used to serialize this object.
132 */ 132 */
133 virtual void serializeFrom( QDataStream& s ); 133 virtual void serializeFrom( QDataStream& s );
134 #endif 134#endif
135 135
136 private: 136 private:
137 QColor m_alternateBackground; 137 QColor m_alternateBackground;
138 bool m_fullWidth; 138 bool m_fullWidth;
139 QPen m_columnSeparator; 139 QPen m_columnSeparator;
140}; 140};
141 141
142#ifndef QT_NO_DATASTREAM 142#ifndef QT_NO_DATASTREAM
143/** 143/**
144 * \relates QListView 144 * \relates QListView
145 * Writes a listview to the stream and returns a reference to the stream. 145 * Writes a listview to the stream and returns a reference to the stream.
146 */ 146 */
147QDataStream& operator<<( QDataStream& s, const OListView& lv ); 147QDataStream& operator<<( QDataStream& s, const OListView& lv );
148/** 148/**
149 * \relates QListView 149 * \relates QListView
150 * Reads a listview from the stream and returns a reference to the stream. 150 * Reads a listview from the stream and returns a reference to the stream.
151 */ 151 */
152QDataStream& operator>>( QDataStream& s, OListView& lv ); 152QDataStream& operator>>( QDataStream& s, OListView& lv );
153#endif // QT_NO_DATASTREAM 153#endif // QT_NO_DATASTREAM
154 154
155//****************************** OListViewItem ****************************************************************** 155//****************************** OListViewItem ******************************************************************
156 156
157class OListViewItem: public QListViewItem 157class OListViewItem: public QListViewItem
158{ 158{
diff --git a/libopie2/opieui/opopupmenu.h b/libopie2/opieui/opopupmenu.h
index 94f05f4..54e4301 100644
--- a/libopie2/opieui/opopupmenu.h
+++ b/libopie2/opieui/opopupmenu.h
@@ -1,24 +1,27 @@
1//FIXME what is ODE? ODE Desktop Environemt? -zecke
2//FIXME do we need titles? space is limited that is only eyecandy? -zecke
3//FIXME keyboard navigation is also not that popular on a PDA might be with a keyboard (tuxphone) -zecke
1/* This file is part of the ODE libraries 4/* This file is part of the ODE libraries
2 Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org> 5 Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org>
3 6
4 This library is free software; you can redistribute it and/or 7 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public 8 modify it under the terms of the GNU Library General Public
6 License version 2 as published by the Free Software Foundation. 9 License version 2 as published by the Free Software Foundation.
7 10
8 This library is distributed in the hope that it will be useful, 11 This library is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 Library General Public License for more details. 14 Library General Public License for more details.
12 15
13 You should have received a copy of the GNU Library General Public License 16 You should have received a copy of the GNU Library General Public License
14 along with this library; see the file COPYING.LIB. If not, write to 17 along with this library; see the file COPYING.LIB. If not, write to
15 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 Boston, MA 02111-1307, USA. 19 Boston, MA 02111-1307, USA.
17*/ 20*/
18#ifndef _OPOPUP_H 21#ifndef _OPOPUP_H
19#define _OPOPUP_H 22#define _OPOPUP_H
20 23
21#define INCLUDE_MENUITEM_DEF 24#define INCLUDE_MENUITEM_DEF
22 25
23/* QT */ 26/* QT */
24 27