author | zecke <zecke> | 2002-09-10 12:09:49 (UTC) |
---|---|---|
committer | zecke <zecke> | 2002-09-10 12:09:49 (UTC) |
commit | 6b77a1cdb9536b1c135eb86d53a6b2c22c19b0a4 (patch) (side-by-side diff) | |
tree | 6ebc93c6432f4ed9d00ef1448b6a047ef522a79a /library/menubutton.cpp | |
parent | d10cddb3c9ce75bc90b14add14bc133737fe35aa (diff) | |
download | opie-6b77a1cdb9536b1c135eb86d53a6b2c22c19b0a4.zip opie-6b77a1cdb9536b1c135eb86d53a6b2c22c19b0a4.tar.gz opie-6b77a1cdb9536b1c135eb86d53a6b2c22c19b0a4.tar.bz2 |
Qtopia1-6 merge
still to test
bic changes to be resolved
more changes to be made?
-rw-r--r-- | library/menubutton.cpp | 71 |
1 files changed, 50 insertions, 21 deletions
diff --git a/library/menubutton.cpp b/library/menubutton.cpp index 6b1fa2b..f5c832c 100644 --- a/library/menubutton.cpp +++ b/library/menubutton.cpp @@ -1,5 +1,5 @@ /********************************************************************** -** Copyright (C) 2000 Trolltech AS. All rights reserved. +** Copyright (C) 2000-2002 Trolltech AS. All rights reserved. ** -** This file is part of Qtopia Environment. +** This file is part of the Qtopia Environment. ** @@ -27,3 +27,20 @@ - Similar in function to a QComboBox. + When the user presses the menubutton's pushbutton, the menu pops up. + A menu is composed of menu items each of which has a string label, + and optionally an icon. + + The index of the item that the user's input device (e.g. stylus) is + pointing at is the currentItem(), whose text is available using + currentText(). + + Menu items are inserted with the \link MenuButton::MenuButton() + constructor\endlink, insertItem() or insertItems(). Separators are + inserted with insertSeparator(). All the items in the menu can be + removed by calling clear(). + + Items can be selected programmatically using select(). When a menu + item is selected (programmatically or by the user), the selected() + signal is emitted. + + \ingroup qtopiaemb */ @@ -31,5 +48,5 @@ /*! - \fn void MenuButton::selected(int index) + \overload void MenuButton::selected(int index) - This signal is emitted when the item at \a index is selected. + This signal is emitted when the item at position \a index is selected. */ @@ -39,3 +56,3 @@ - This signal is emitted when the item with the given \a text is selected. + This signal is emitted when the item with the label \a text is selected. */ @@ -44,4 +61,6 @@ /*! - Constructs a MenuButton with the given \a items added (see insertItems()). - The standard \a parent an \a name arguments are passed to the base class. + Constructs a MenuButton. A menu item is created (see insertItem() + and insertItems()) for each string in the \a items string list. The + standard \a parent an \a name arguments are passed to the base + class. */ @@ -58,3 +77,3 @@ MenuButton::MenuButton( const QStringList& items, QWidget* parent, const char* n - \sa insertItems() + \sa insertItem() insertItems() */ @@ -77,3 +96,3 @@ void MenuButton::init() /*! - Removes all items from the button and menu. + Removes all the menu items from the button and menu. */ @@ -86,4 +105,5 @@ void MenuButton::clear() /*! - Inserts string \a items into the menu. The string "--" represents - a separator. + A menu item is created (see insertItem()) for each string in the \a + items string list. If any string is "--" a separator (see + insertSeparator()) is inserted in its place. */ @@ -101,5 +121,8 @@ void MenuButton::insertItems( const QStringList& items ) /*! - Inserts an \a icon and \a text into the menu. + Inserts a menu item with the icon \a icon and label \a text into + the menu. + + \sa insertItems() */ -void MenuButton::insertItem( const QIconSet& icon, const QString& text ) +void MenuButton::insertItem( const QIconSet& icon, const QString& text=QString::null ) { @@ -110,3 +133,6 @@ void MenuButton::insertItem( const QIconSet& icon, const QString& text ) /*! - Inserts \a text into the menu. + \overload + Inserts a menu item with the label \a text into the menu. + + \sa insertItems() */ @@ -119,3 +145,5 @@ void MenuButton::insertItem( const QString& text ) /*! - Inserts a visual separator into the menu. + Inserts a separator into the menu. + + \sa insertItems() */ @@ -127,3 +155,3 @@ void MenuButton::insertSeparator() /*! - Selects the items with text \a s. + Selects the items with label text \a s. */ @@ -140,3 +168,4 @@ void MenuButton::select(const QString& s) /*! - Selects the item at index \a s. + \overload + Selects the item at index position \a s. */ @@ -153,3 +182,3 @@ void MenuButton::select(int s) /*! - Returns the index of the current item. + Returns the index position of the current item. */ @@ -161,3 +190,3 @@ int MenuButton::currentItem() const /*! - Returns the text of the current item. + Returns the label text of the current item. */ @@ -169,3 +198,3 @@ QString MenuButton::currentText() const /*! - Sets the label. If \a label is empty, the + Sets the menubutton's label. If \a label is empty, the current item text is displayed, otherwise \a label should contain |