| -rw-r--r-- | library/categorymenu.cpp | 62 |
1 files changed, 57 insertions, 5 deletions
diff --git a/library/categorymenu.cpp b/library/categorymenu.cpp index e733107..5d7adf7 100644 --- a/library/categorymenu.cpp +++ b/library/categorymenu.cpp @@ -26,4 +26,33 @@ +/*! + \class CategoryMenu + \brief The CategoryMenu widget aids in filtering records or files by Category. + + The CategoryMenu widget provides a popup menu that will make filtering records + or files by category much easier. The widget will lookup the available + categories for an application, populate the menu, and keep a track of which + categories are being filtered against. A set of categories can be tested + by the isSelected() function to see if a record or file containing those + categories would be allowed through by the filter. + + \warning Currently this class is not suitable for extending. + + \ingroup qtopiaemb +*/ + +/*! + \fn void CategoryMenu::categoryChange() + This signal is emitted when the user selects a different category in the + menu, hence changing what records or files should be selected. +*/ + +/*! + Creates a new CategoryMenu with \a parent and \a name. The menu will be + populated with the available categories for \a application. + + If \a globals is TRUE then it will also poplulate the menu with the + global categories. +*/ CategoryMenu::CategoryMenu( const QString &n, bool ig = TRUE, - QWidget *parent, const char *name ) : + QWidget *parent, const char *name ) : QPopupMenu(parent, name), @@ -37,3 +66,6 @@ CategoryMenu::CategoryMenu( const QString &n, bool ig = TRUE, -CategoryMenu::~CategoryMenu( ) +/*! + Destroys a CategoryMenu. +*/ +CategoryMenu::~CategoryMenu( ) { @@ -41,2 +73,5 @@ CategoryMenu::~CategoryMenu( ) +/*! + Repopulates the widget's list of available categories. +*/ void CategoryMenu::reload() @@ -68,3 +103,6 @@ void CategoryMenu::reload() -void CategoryMenu::mapMenuId(int id) +/*! + \internal +*/ +void CategoryMenu::mapMenuId(int id) { @@ -79,2 +117,7 @@ void CategoryMenu::mapMenuId(int id) +/*! + Returns TRUE if a record or file with the set of category ids \a cUids + is allowed by the current selection in the CategoryMenu. + Otherwise returns FALSE. +*/ bool CategoryMenu::isSelected(const QArray<int> &cUids) const @@ -84,3 +127,3 @@ bool CategoryMenu::isSelected(const QArray<int> &cUids) const - if (currentMid == 2 && cUids.count() == 0) + if (currentMid == 2 && cUids.count() == 0) return TRUE; @@ -93,5 +136,8 @@ bool CategoryMenu::isSelected(const QArray<int> &cUids) const +/*! + Sets the menu to have \a newCatUid as the currently selected Category. +*/ void CategoryMenu::setCurrentCategory( int newCatUid ) { - if (!idToMenu.contains(newCatUid)) + if (!idToMenu.contains(newCatUid)) return; @@ -101,2 +147,5 @@ void CategoryMenu::setCurrentCategory( int newCatUid ) +/*! + Sets the menu to allow all category sets. +*/ void CategoryMenu::setCurrentCategoryAll( ) @@ -106,2 +155,5 @@ void CategoryMenu::setCurrentCategoryAll( ) +/*! + Sets the menu to allow only empty category sets. +*/ void CategoryMenu::setCurrentCategoryUnfiled( ) |