| -rw-r--r-- | libopie/colordialog.cpp | 2 | ||||
| -rw-r--r-- | libopie/colordialog.h | 2 | ||||
| -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 | 4 | ||||
| -rw-r--r-- | libopie/ofileselector.h | 17 | ||||
| -rw-r--r-- | libopie/ofontselector.h | 3 | ||||
| -rw-r--r-- | libopie/oprocess.h | 8 | ||||
| -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 | 8 | ||||
| -rw-r--r-- | libopie/oticker.h | 3 | ||||
| -rw-r--r-- | libopie/otimepicker.h | 2 | ||||
| -rw-r--r-- | libopie/todayconfigwidget.h | 2 | ||||
| -rw-r--r-- | libopie/todayplugininterface.h | 3 |
18 files changed, 75 insertions, 27 deletions
diff --git a/libopie/colordialog.cpp b/libopie/colordialog.cpp index 35f15d6..c7421ec 100644 --- a/libopie/colordialog.cpp +++ b/libopie/colordialog.cpp @@ -687,17 +687,17 @@ OColorDialogPrivate::OColorDialogPrivate( OColorDialog *dialog ) : connect( cs, SIGNAL(newCol(QRgb)), this, SLOT(newColorTypedIn(QRgb))); topLay->addWidget( cs ); } // BEING REVISED: jo /*! - \class OColorDialog OColorDialog.h + \class ColorDialog ColorDialog.h \brief The OColorDialog class provides a dialog widget for specifying colors. \ingroup dialogs The color dialog's function is to allow users to choose colors - for instance, you might use this in a drawing program to allow the user to set the brush color. This version of Qt only provides modal color dialogs. The static diff --git a/libopie/colordialog.h b/libopie/colordialog.h index e9bb7ed..1a6a3fd 100644 --- a/libopie/colordialog.h +++ b/libopie/colordialog.h @@ -39,17 +39,17 @@ #define OColorDialog_H #ifndef QT_H #include <qdialog.h> #endif // QT_H class OColorDialogPrivate; -/** +/* * @class OColorDialog * @brief The OColorDialog class is a copy of QColorDialog for use in Opie. * * OColorDialog is a copy of TrollTech's QColorDialog for use in Opie. The default * build of QT/Embedded used by Opie does not include QColorDialog, so it is provided * here. It is renamed to prevent conflicts in the event the QColorDialog is included * at a later date in QP/E. * diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h index 184b132..3e90c5e 100644 --- a/libopie/colorpopupmenu.h +++ b/libopie/colorpopupmenu.h @@ -63,17 +63,17 @@ public: * @param parent Pointer to parent of this control. * @param name Name of control. * * Constructs a new ColorPanelButton control with parent, name and desired color. */ OColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0); /** - * @fn ~ColorPanelButton() + * @fn ~OColorPanelButton() * @brief Object destructor. */ ~OColorPanelButton(); /** * @fn setActive( bool active ) * @brief Sets button selection state. * @@ -102,21 +102,21 @@ public: * @param e Event currently being processed. * * Reimplemented to ensure correct display of button based on whether it is * active or not. */ void leaveEvent(QEvent* e); /** - * @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. */ void paintEvent(QPaintEvent* e); /** * @fn mouseReleaseEvent( QMouseEvent* e ) * @brief Slot executed when button is pressed. * diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h index 2387134..82ee3d0 100644 --- a/libopie/ocheckitem.h +++ b/libopie/ocheckitem.h @@ -24,25 +24,34 @@ * @short An checkable QTableItem * @version 1.0 * @author Stefan Eilers ( eilers@handhelds.org ) */ class OCheckItem : public QTableItem { public: + /** The size of a box currently unused */ enum Size { BoxSize = 10 }; OCheckItem( QTable *t, const QString &sortkey ); virtual void setChecked( bool b ); 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 ); //static const int BoxSize = 10; private: class OCheckItemPrivate; OCheckItemPrivate *d; bool m_checked: 1; diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h index 4b6dcbc..6e7a123 100644 --- a/libopie/oclickablelabel.h +++ b/libopie/oclickablelabel.h @@ -27,24 +27,35 @@ class OClickableLabel: public QLabel { Q_OBJECT public: OClickableLabel(QWidget* parent = 0, const char* name = 0, WFlags fl = 0); void setToggleButton(bool t); protected: + /** @internal */ void mousePressEvent( QMouseEvent *e ); + /** @internal */ void mouseReleaseEvent( QMouseEvent *e ); + /** @internal */ void mouseMoveEvent( QMouseEvent *e ); public slots: 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: bool isToggle : 1; bool isDown : 1; bool textInverted : 1; void showState(bool on); void setInverted(bool on); diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h index 338e654..7ff9cd2 100644 --- a/libopie/ocolorbutton.h +++ b/libopie/ocolorbutton.h @@ -45,22 +45,28 @@ class OColorButton : public QPushButton { Q_OBJECT public: OColorButton ( QWidget *parent = 0, const QColor & = black, const char *name = 0 ); virtual ~OColorButton ( ); QColor color ( ) const; signals: + /** + * emitted when a color gets selected + */ void colorSelected ( const QColor & ); public slots: virtual void setColor ( const QColor & ); protected slots: + /** + * @internal + */ virtual void updateColor ( const QColor & ); private: OColorButtonPrivate *d; }; #endif diff --git a/libopie/odevicebutton.cpp b/libopie/odevicebutton.cpp index 4b22358..eccb57c 100644 --- a/libopie/odevicebutton.cpp +++ b/libopie/odevicebutton.cpp @@ -106,18 +106,18 @@ void OQCopMessage::setMessage ( const QCString &m ) d-> m_message = m; } void OQCopMessage::setData ( const QByteArray &data ) { d-> m_data = 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 device may have "user programmable" buttons. The location and number of buttons will vary from device to device. userText() and pixmap() may be used to describe this button to the user in help documentation. \ingroup qtopiaemb diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h index 06ac806..d06aa0a 100644 --- a/libopie/ofileselector.h +++ b/libopie/ofileselector.h @@ -39,23 +39,17 @@ #include <qpixmap.h> #include <qstringlist.h> #include <qmap.h> #include <qvaluelist.h> #include <qpe/applnk.h> #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; class QComboBox; class QPushButton; class FileSelector; class QGridLayout; class QLineEdit; class QLabel; @@ -64,16 +58,25 @@ class QHBoxLayout; class QVBoxLayout; class QPopupMenu; class QFileInfo; 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 public: /** * The mode of the file selector * Either open, save, fileselector or dir browsing mode * */ diff --git a/libopie/ofontselector.h b/libopie/ofontselector.h index 95ffd04..b819c45 100644 --- a/libopie/ofontselector.h +++ b/libopie/ofontselector.h @@ -68,18 +68,21 @@ public: signals: /** * This signal gets emitted when a font got chosen */ void fontSelected ( const QFont & ); protected slots: + /** @internal */ virtual void fontFamilyClicked ( int ); + /** @internal */ virtual void fontStyleClicked ( int ); + /** @internal */ virtual void fontSizeClicked ( int ); protected: virtual void resizeEvent ( QResizeEvent *re ); private: void loadFonts ( QListBox * ); diff --git a/libopie/oprocess.h b/libopie/oprocess.h index bf5fe0e..f2853b0 100644 --- a/libopie/oprocess.h +++ b/libopie/oprocess.h @@ -41,17 +41,17 @@ class QSocketNotifier; class OProcessPrivate; /** * Child process invocation, monitoring and control. * * @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. * *@see KProcIO * *Basically, this class distinguishes three different ways of running *child processes: * *@li OProcess::DontCare -- The child process is invoked and both the child @@ -183,17 +183,23 @@ public: * The application is suspended until the started process is finished. */ Block }; /** * Constructor */ 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); /** *Destructor: * * If the process is running when the destructor for this class * is called, the child process is killed with a SIGKILL, but * only if the run mode is not of type @p DontCare. diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h index af87ce9..a5d6489 100644 --- a/libopie/orecurrancewidget.h +++ b/libopie/orecurrancewidget.h @@ -41,17 +41,23 @@ public: QWidget* parent = 0, const char* name =0, bool modal = TRUE, WFlags = 0 ); ~ORecurranceWidget(); ORecur recurrence()const; QDate endDate()const; 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& ); void setRecurrence( const ORecur& recur, const QDate& start ); void setRecurrence( const ORecur& recur ); private slots: void setupRepeatLabel( const QString& ); void setupRepeatLabel( int ); diff --git a/libopie/otabbar.h b/libopie/otabbar.h index c413611..0b353e2 100644 --- a/libopie/otabbar.h +++ b/libopie/otabbar.h @@ -57,17 +57,17 @@ public: * * Constructs a new OTabBar control with parent and name. */ // FIXME Allow WFlags? -zecke OTabBar( QWidget * = 0, const char * = 0 ); 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. * * @param p Pointer to QPainter used for drawing. * @param br QRect providing region to draw label in. * @param t Tab to draw label for. * @param has_focus Boolean value not used, retained for compatibility reasons. */ void paintLabel( QPainter *, const QRect &, QTab *, bool ) const; diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h index 6589638..eebaf8e 100644 --- a/libopie/otabinfo.h +++ b/libopie/otabinfo.h @@ -72,43 +72,43 @@ public: * @param control QWidget pointer to widget. * @param icon QString name of icon file. * @param label QString text label for OTabWidget selection control. */ OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) : i( id ), c( control ), p( icon ), l( label ) {} /** - * @fn id() + * @fn id()const * @brief Returns TabBar ID. */ int id() const { return i; } /** - * @fn label() + * @fn label()const * @brief Returns text label for widget. */ const QString &label() const { return l; } /** * @fn setLabel( const QString &label ) * @brief Set label for tab. * * @param label QString text label for OTabWidget selection control. */ void setLabel( const QString &label ) { l = label; } /** - * @fn control() + * @fn control()const * @brief Returns pointer to widget. */ QWidget *control() const { return c; } /** - * @fn icon() + * @fn icon()const * @brief Returns name of icon file. */ const QString &icon() const { return p; } /** * @fn setIcon( const QString &icon ) * @brief Set icon for tab. * diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h index bcd9a85..a67fe06 100644 --- a/libopie/otabwidget.h +++ b/libopie/otabwidget.h @@ -122,41 +122,41 @@ public: * @fn removePage( QWidget *widget ) * @brief Remove widget from control. Does not delete widget. * * @param widget Widget control to be removed. */ void removePage( QWidget * ); /** - * @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 * * @param child Widget control. * @param icon Path to icon. * @param label Text label. */ void changeTab( QWidget *, const QString &, const QString & ); /** - * @fn tabStyle() + * @fn tabStyle()const * @brief Returns current widget selection control style. */ TabStyle tabStyle() const; /** * @fn setTabStyle( TabStyle s ) * @brief Set the current widget selection control style. * * @param s New style to be used. */ void setTabStyle( TabStyle ); /** - * @fn tabPosition() + * @fn tabPosition()const * @brief Returns current widget selection control position. */ TabPosition tabPosition() const; /** * @fn setTabPosition( TabPosition p ) * @brief Set the current widget selection control position. * @@ -184,17 +184,17 @@ public: * @fn setCurrentTab( int ) * @brief Selects and brings to top the desired widget, by using id. * * @param tab id for widget to select. */ void setCurrentTab(int); /** - * @fn sizeHint() + * @fn sizeHint()const * @brief Reimplemented for internal purposes. */ QSize sizeHint() const; /** * @fn currentTab( ) * @brief returns current tab id. */ diff --git a/libopie/oticker.h b/libopie/oticker.h index 30b7517..c848654 100644 --- a/libopie/oticker.h +++ b/libopie/oticker.h @@ -61,28 +61,29 @@ public: */ OTicker( QWidget* parent=0 ); /*! * @fn ~OTicker() * @brief Object destructor. */ ~OTicker(); /*! - * @fn setText() + * @fn setText(const QString& ) * @brief sets text to be displayed * @param text QString text to be displayed. * */ void setText( const QString& text ) ; /*! * @fn setBackgroundColor(QColor color) * @brief sets color of the ticker's background * @param color QColor color to be set. * */ + //FIXME const QColor& please -zecke void setBackgroundColor(QColor color); /*! * @fn setForegroundColor(QColor color) * @brief sets color of text * @param color QColor color of text * */ void setForegroundColor(QColor color); diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h index 495c806..d501a95 100644 --- a/libopie/otimepicker.h +++ b/libopie/otimepicker.h @@ -51,17 +51,17 @@ class OTimePicker: public QWidget { /** * gets emitted when the time got changed by the user */ void timeChanged(const QTime &); }; /** * - * @short + * @short A small dialog to pick a time * @version 1.0 * @author Stefan Eilers */ class OTimePickerDialog: public OTimePickerDialogBase { Q_OBJECT public: diff --git a/libopie/todayconfigwidget.h b/libopie/todayconfigwidget.h index 6b49efc..f3501a1 100644 --- a/libopie/todayconfigwidget.h +++ b/libopie/todayconfigwidget.h @@ -19,17 +19,17 @@ class TodayConfigWidget : public QWidget { public: /** * This will construct the widget. The widget gets deleted once the parent * gets deleted as in any Qt application * * @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 ) {} ; virtual ~TodayConfigWidget() {}; /** * Plugins need to reimplement this in the config widget * Used when the config dialog is closed to write config stuff */ diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h index 29a12bc..532f492 100644 --- a/libopie/todayplugininterface.h +++ b/libopie/todayplugininterface.h @@ -95,12 +95,15 @@ public: // virtual int maxHeight() const = 0; }; /** * This is part of the QCOM works. See example plugins how to do it right */ struct TodayPluginInterface : public QUnknownInterface { + /** + * return the TodayPluginObject implementation + */ virtual TodayPluginObject *guiPart() = 0; }; #endif |