-rw-r--r-- | libopie/colordialog.cpp | 2 | ||||
-rw-r--r-- | libopie/colordialog.h | 4 | ||||
-rw-r--r-- | libopie/colorpopupmenu.h | 6 | ||||
-rw-r--r-- | libopie/ocheckitem.h | 9 | ||||
-rw-r--r-- | libopie/oclickablelabel.h | 11 | ||||
-rw-r--r-- | libopie/ocolorbutton.h | 6 | ||||
-rw-r--r-- | libopie/odevicebutton.cpp | 14 | ||||
-rw-r--r-- | libopie/ofileselector.h | 17 | ||||
-rw-r--r-- | libopie/ofontselector.h | 3 | ||||
-rw-r--r-- | libopie/oprocess.h | 24 | ||||
-rw-r--r-- | libopie/orecurrancewidget.h | 6 | ||||
-rw-r--r-- | libopie/otabbar.h | 2 | ||||
-rw-r--r-- | libopie/otabinfo.h | 8 | ||||
-rw-r--r-- | libopie/otabwidget.h | 10 | ||||
-rw-r--r-- | libopie/oticker.h | 3 | ||||
-rw-r--r-- | libopie/otimepicker.h | 8 | ||||
-rw-r--r-- | libopie/todayconfigwidget.h | 2 | ||||
-rw-r--r-- | libopie/todayplugininterface.h | 3 |
18 files changed, 93 insertions, 45 deletions
diff --git a/libopie/colordialog.cpp b/libopie/colordialog.cpp index 35f15d6..c7421ec 100644 --- a/libopie/colordialog.cpp +++ b/libopie/colordialog.cpp @@ -693,5 +693,5 @@ OColorDialogPrivate::OColorDialogPrivate( OColorDialog *dialog ) : // BEING REVISED: jo /*! - \class OColorDialog OColorDialog.h + \class ColorDialog ColorDialog.h \brief The OColorDialog class provides a dialog widget for specifying colors. \ingroup dialogs diff --git a/libopie/colordialog.h b/libopie/colordialog.h index e9bb7ed..1a6a3fd 100644 --- a/libopie/colordialog.h +++ b/libopie/colordialog.h @@ -45,5 +45,5 @@ class OColorDialogPrivate; -/** +/* * @class OColorDialog * @brief The OColorDialog class is a copy of QColorDialog for use in Opie. @@ -62,5 +62,5 @@ class Q_EXPORT OColorDialog : public QDialog public: - static QColor getColor( const QColor&, QWidget *parent=0, const char* name=0 ); + static QColor getColor( const QColor&, QWidget *parent=0, const char* name=0 ); static QRgb getRgba( const QRgb&, bool* ok = 0, QWidget *parent=0, const char* name=0 ); diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h index 184b132..3e90c5e 100644 --- a/libopie/colorpopupmenu.h +++ b/libopie/colorpopupmenu.h @@ -69,5 +69,5 @@ public: /** - * @fn ~ColorPanelButton() + * @fn ~OColorPanelButton() * @brief Object destructor. */ @@ -108,9 +108,9 @@ public: /** - * @fn paintEvent( QEvent* e ) + * @fn paintEvent( QPaintEvent* e ) * @brief Reimplemented for internal reasons. * * @param e Event currently being processed. - * + * @reimp * Reimplemented to ensure correct display of button. */ diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h index 2387134..82ee3d0 100644 --- a/libopie/ocheckitem.h +++ b/libopie/ocheckitem.h @@ -30,4 +30,5 @@ class OCheckItem : public QTableItem { public: + /** The size of a box currently unused */ enum Size { BoxSize = 10 }; OCheckItem( QTable *t, const QString &sortkey ); @@ -36,7 +37,15 @@ public: virtual void toggle(); bool isChecked() const; + /** + * @short Set the sort key + * @reimp + */ void setKey( const QString &key ) { m_sortKey = key; } virtual QString key() const; + /** + * foo + * @internal + */ void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected ); diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h index 4b6dcbc..6e7a123 100644 --- a/libopie/oclickablelabel.h +++ b/libopie/oclickablelabel.h @@ -33,6 +33,9 @@ public: protected: + /** @internal */ void mousePressEvent( QMouseEvent *e ); + /** @internal */ void mouseReleaseEvent( QMouseEvent *e ); + /** @internal */ void mouseMoveEvent( QMouseEvent *e ); @@ -40,5 +43,13 @@ public: void setOn(bool on); signals: + /** + * emitted when the labels gets clicked + */ void clicked(); + + /** + * emitted when the labels gets toggled + * @param the new new state of the label + */ void toggled(bool on); private: diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h index 338e654..7ff9cd2 100644 --- a/libopie/ocolorbutton.h +++ b/libopie/ocolorbutton.h @@ -51,4 +51,7 @@ public: signals: + /** + * emitted when a color gets selected + */ void colorSelected ( const QColor & ); @@ -57,4 +60,7 @@ public slots: protected slots: + /** + * @internal + */ virtual void updateColor ( const QColor & ); diff --git a/libopie/odevicebutton.cpp b/libopie/odevicebutton.cpp index 4b22358..eccb57c 100644 --- a/libopie/odevicebutton.cpp +++ b/libopie/odevicebutton.cpp @@ -29,5 +29,5 @@ using namespace Opie; class OQCopMessageData { -public: +public: QCString m_channel; QCString m_message; @@ -36,5 +36,5 @@ public: -OQCopMessage::OQCopMessage ( ) +OQCopMessage::OQCopMessage ( ) : d ( 0 ) { @@ -42,5 +42,5 @@ OQCopMessage::OQCopMessage ( ) } -OQCopMessage::OQCopMessage ( const OQCopMessage © ) +OQCopMessage::OQCopMessage ( const OQCopMessage © ) : d ( 0 ) { @@ -54,5 +54,5 @@ OQCopMessage &OQCopMessage::operator = ( const OQCopMessage &assign ) } -OQCopMessage::OQCopMessage ( const QCString &ch, const QCString &m, const QByteArray &arg ) +OQCopMessage::OQCopMessage ( const QCString &ch, const QCString &m, const QByteArray &arg ) : d ( 0 ) { @@ -75,5 +75,5 @@ bool OQCopMessage::send ( ) QCopEnvelope e ( d-> m_channel, d-> m_message ); - + if ( d-> m_data. size ( )) e. writeRawBytes ( d-> m_data. data ( ), d-> m_data. size ( )); @@ -112,6 +112,6 @@ void OQCopMessage::setData ( const QByteArray &data ) } -/*! \class ODeviceButton - \brief The ODeviceButton class represents a physical user mappable button on a Qtopia device. +/*! \class Opie::ODeviceButton + \brief The Opie::ODeviceButton class represents a physical user mappable button on a Qtopia device. This class represents a physical button on a Qtopia device. A diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h index 06ac806..d06aa0a 100644 --- a/libopie/ofileselector.h +++ b/libopie/ofileselector.h @@ -45,11 +45,5 @@ #include <qlistview.h> -/** This is OPIEs FileDialog Widget. You can use it - * as a dropin replacement of the fileselector and - * or use any of the new features. - * This is also a complete FileSave and FileLoad widget - * If you look for a Dialog check OFileDialog - * - */ + class DocLnk; class QCheckBox; @@ -70,4 +64,13 @@ class QHBox; typedef QMap< QString, QStringList> MimeTypes; +/** + * This is OPIEs FileDialog Widget. You can use it + * as a dropin replacement of the fileselector and + * or use any of the new features. + * This is also a complete FileSave and FileLoad widget + * If you look for a Dialog check OFileDialog + * + * NOTE THAT the API will change to be more extendable! + */ class OFileSelector : public QWidget { Q_OBJECT diff --git a/libopie/ofontselector.h b/libopie/ofontselector.h index 95ffd04..b819c45 100644 --- a/libopie/ofontselector.h +++ b/libopie/ofontselector.h @@ -74,6 +74,9 @@ signals: protected slots: + /** @internal */ virtual void fontFamilyClicked ( int ); + /** @internal */ virtual void fontStyleClicked ( int ); + /** @internal */ virtual void fontSizeClicked ( int ); diff --git a/libopie/oprocess.h b/libopie/oprocess.h index bf5fe0e..f2853b0 100644 --- a/libopie/oprocess.h +++ b/libopie/oprocess.h @@ -47,5 +47,5 @@ class OProcessPrivate; * @sect General usage and features * - *This class allows a KDE application to start child processes without having + *This class allows a KDE and OPIE application to start child processes without having *to worry about UN*X signal handling issues and zombie process reaping. * @@ -189,5 +189,11 @@ public: */ OProcess(QObject *parent = 0, const char *name = 0); + /** + * Constructor + */ OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0); + /** + * Constructor + */ OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0); @@ -411,5 +417,5 @@ public: */ bool runPrivileged() const; - + /** * Modifies the environment of the process to be started. @@ -419,5 +425,5 @@ public: /** - * Changes the current working directory (CWD) of the process + * Changes the current working directory (CWD) of the process * to be started. * This function must be called before starting the process. @@ -453,5 +459,5 @@ public: * child process. */ - void detach(); + void detach(); @@ -487,6 +493,6 @@ signals: * been received on stdout. * - * To actually get these signals, the respective communications link - * (stdout/stderr) has to be turned on in @ref start() and the + * To actually get these signals, the respective communications link + * (stdout/stderr) has to be turned on in @ref start() and the * @p NoRead flag should have been passed. * @@ -495,5 +501,5 @@ signals: * to ensure that this signal is not emitted when no one is connected * to it, otherwise this signal will not be emitted. - * + * * The data still has to be read from file descriptor @p fd. **/ @@ -551,5 +557,5 @@ protected: /** - * Sets up the environment according to the data passed via + * Sets up the environment according to the data passed via * setEnvironment(...) */ @@ -713,5 +719,5 @@ protected: private: /** - * Searches for a valid shell. + * Searches for a valid shell. * Here is the algorithm used for finding an executable shell: * diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h index af87ce9..a5d6489 100644 --- a/libopie/orecurrancewidget.h +++ b/libopie/orecurrancewidget.h @@ -47,5 +47,11 @@ public: public slots: void slotSetRType( int ); + /** + * set the new end date + */ void endDateChanged( int, int, int ); + /** + * enable/disable end date + */ void slotNoEnd( bool unused ); void setStartDate( const QDate& ); diff --git a/libopie/otabbar.h b/libopie/otabbar.h index c413611..0b353e2 100644 --- a/libopie/otabbar.h +++ b/libopie/otabbar.h @@ -63,5 +63,5 @@ public: protected: /** - * @fn paintLabel( QPainter* p, const QRect& br, QTab* t, bool has_focus ) + * @fn paintLabel( QPainter* p, const QRect& br , QTab* t, bool has_focus)const * @brief Internal function to draw a tab's label. * diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h index 6589638..eebaf8e 100644 --- a/libopie/otabinfo.h +++ b/libopie/otabinfo.h @@ -78,5 +78,5 @@ public: /** - * @fn id() + * @fn id()const * @brief Returns TabBar ID. */ @@ -84,5 +84,5 @@ public: /** - * @fn label() + * @fn label()const * @brief Returns text label for widget. */ @@ -98,5 +98,5 @@ public: /** - * @fn control() + * @fn control()const * @brief Returns pointer to widget. */ @@ -104,5 +104,5 @@ public: /** - * @fn icon() + * @fn icon()const * @brief Returns name of icon file. */ diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h index bcd9a85..a67fe06 100644 --- a/libopie/otabwidget.h +++ b/libopie/otabwidget.h @@ -128,5 +128,5 @@ public: /** - * @fn changeTab( QWidget *widget, const QIconSet &icon, const QString &label ) + * @fn changeTab( QWidget *widget, const QString &icon, const QString &label ) * @brief Change text and/or icon for existing tab * @@ -138,5 +138,5 @@ public: /** - * @fn tabStyle() + * @fn tabStyle()const * @brief Returns current widget selection control style. */ @@ -152,5 +152,5 @@ public: /** - * @fn tabPosition() + * @fn tabPosition()const * @brief Returns current widget selection control position. */ @@ -190,5 +190,5 @@ public: /** - * @fn sizeHint() + * @fn sizeHint()const * @brief Reimplemented for internal purposes. */ @@ -245,5 +245,5 @@ private: void setUpLayout(); - + signals: /** diff --git a/libopie/oticker.h b/libopie/oticker.h index 30b7517..c848654 100644 --- a/libopie/oticker.h +++ b/libopie/oticker.h @@ -67,5 +67,5 @@ public: ~OTicker(); /*! - * @fn setText() + * @fn setText(const QString& ) * @brief sets text to be displayed * @param text QString text to be displayed. @@ -79,4 +79,5 @@ public: * */ + //FIXME const QColor& please -zecke void setBackgroundColor(QColor color); /*! diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h index 495c806..d501a95 100644 --- a/libopie/otimepicker.h +++ b/libopie/otimepicker.h @@ -27,11 +27,11 @@ class OTimePicker: public QWidget { OTimePicker(QWidget* parent = 0, const char* name = 0, WFlags fl = 0); - - public slots: + + public slots: void setHour(int h); void setMinute(int m); void setTime( const QTime& ); void setTime( int h, int m ); - + public: QTime time()const; @@ -57,5 +57,5 @@ class OTimePicker: public QWidget { /** * - * @short + * @short A small dialog to pick a time * @version 1.0 * @author Stefan Eilers diff --git a/libopie/todayconfigwidget.h b/libopie/todayconfigwidget.h index 6b49efc..f3501a1 100644 --- a/libopie/todayconfigwidget.h +++ b/libopie/todayconfigwidget.h @@ -25,5 +25,5 @@ public: * * @param parent The parent of the widget - * @paran name The name of the object + * @param name The name of the object */ TodayConfigWidget( QWidget *parent, const char *name ) : QWidget( parent, name ) {} ; diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h index 29a12bc..532f492 100644 --- a/libopie/todayplugininterface.h +++ b/libopie/todayplugininterface.h @@ -101,4 +101,7 @@ public: */ struct TodayPluginInterface : public QUnknownInterface { + /** + * return the TodayPluginObject implementation + */ virtual TodayPluginObject *guiPart() = 0; }; |