| -rw-r--r-- | libopie/ofontmenu.cc | 46 |
1 files changed, 45 insertions, 1 deletions
diff --git a/libopie/ofontmenu.cc b/libopie/ofontmenu.cc index 52ff3ee..d16c5e5 100644 --- a/libopie/ofontmenu.cc +++ b/libopie/ofontmenu.cc @@ -6,3 +6,9 @@ - +/** + * Constructs the FontMenu. + * + * @param parent The parent widget + * @param name A name for this widget + * @param list The list of widgets to be controlled + */ OFontMenu::OFontMenu(QWidget *parent, const char *name, const QList<QWidget> &list ) @@ -22,2 +28,9 @@ OFontMenu::OFontMenu(QWidget *parent, const char *name, const QList<QWidget> &li } + +/** + * This method saves the font size + * into a Config object + * OFontMenu will be used as group and size as key + * @param cfg The Config object to be used + */ void OFontMenu::save(Config *cfg ) @@ -27,2 +40,8 @@ void OFontMenu::save(Config *cfg ) } + +/** + * This method restores the font size from a Config object + * it'll apply the sizes to the widgets and will also set the + * menu appropriate + */ void OFontMenu::restore(Config *cfg ) @@ -49,2 +68,7 @@ void OFontMenu::restore(Config *cfg ) } + +/** + * set the list of widgets + * @param list the widget list + */ void OFontMenu::setWidgets(const QList<QWidget> &list ) @@ -53,2 +77,7 @@ void OFontMenu::setWidgets(const QList<QWidget> &list ) } + +/** + * add a widget to the list + * @param wid The widget to be added + */ void OFontMenu::addWidget( QWidget *wid ) @@ -57,2 +86,7 @@ void OFontMenu::addWidget( QWidget *wid ) } + +/** + * removes the widget from the list of controlled objects + * @param wid the to be removed widget + */ void OFontMenu::removeWidget( QWidget *wid ) @@ -61,2 +95,6 @@ void OFontMenu::removeWidget( QWidget *wid ) } + +/** + * The list of controlled widgets + */ const QList<QWidget> &OFontMenu::widgets()const @@ -65,2 +103,8 @@ const QList<QWidget> &OFontMenu::widgets()const } + +/** + * Forces a size on a widget + * @param wid The widget + * @param size The font size forced onto the widget + */ void OFontMenu::forceSize(QWidget *wid, int size ) |