1 files changed, 293 insertions, 34 deletions

diff --git a/library/backend/categories.cpp b/library/backend/categories.cpp
index 6e011c4..e37b3b9 100644
--- a/library/backend/categories.cpp
+++ b/library/backend/categories.cpp
@@ -1,14 +1,13 @@
 /**********************************************************************
-** 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.
 **
 ** This file may be distributed and/or modified under the terms of the
-** GNU General Public License version 2 as published by the Free
-** Software Foundation and appearing in the file LICENSE.GPL included
-** in the packaging of this file.
+** GNU General Public License version 2 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.
 **
-** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
-** THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
-** PARTICULAR PURPOSE.
+** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
@@ -20,3 +19,4 @@
 **********************************************************************/
-#include "categories.h"
+#include <qtopia/categories.h>
+#include <qtopia/stringutil.h>
 #include <qfile.h>
@@ -24,3 +24,2 @@
 #include <qtextstream.h>
-#include "stringutil.h"
 
@@ -40,2 +39,20 @@ UidGen CategoryGroup::sUidGen( UidGen::Qtopia );
 
+/*! \class CategoryGroup categories.h
+  \brief Helper class that is used by Categories
+
+  CategoryGroup is a group of categories that is associated with an
+  application or global set. Mainly it defines a map of ids to
+  category labels and category labels to ids. Lookups can be done with
+  labels or unique idenifiers.
+
+  \ingroup qtopiaemb
+  \ingroup qtopiadesktop
+  \warning Categories API will likely change between Qtopia 1.5 and Qtopia 3
+  \sa Categories::appGroupMap(), Categories::globalGroup()
+ */
+
+/*! Add \a label and return the UID. If failure, then 0 is returned. Note
+  that All and Unfiled are reserved labels.
+  \internal
+*/
 int CategoryGroup::add( const QString &label )
@@ -60,2 +77,4 @@ void CategoryGroup::insert( int uid, const QString &label )
 
+/*! \internal
+ */
 bool CategoryGroup::add( int uid, const QString &label )
@@ -75,2 +94,5 @@ bool CategoryGroup::add( int uid, const QString &label )
 
+/*! Returns TRUE if \a label was removed from the group, FALSE if not.
+  \internal
+ */
 bool CategoryGroup::remove( const QString &label )
@@ -87,2 +109,5 @@ bool CategoryGroup::remove( const QString &label )
 
+/*! Returns TRUE if \a uid was removed from the group, FALSE if not.
+  \internal
+ */
 bool CategoryGroup::remove( int uid )
@@ -99,2 +124,4 @@ bool CategoryGroup::remove( int uid )
 
+/*! \internal
+ */
 bool CategoryGroup::rename( int uid, const QString &newLabel )
@@ -115,2 +142,4 @@ bool CategoryGroup::rename( int uid, const QString &newLabel )
 
+/*! \internal
+ */
 bool CategoryGroup::rename( const QString &oldLabel, const QString &newLabel )
@@ -120,2 +149,3 @@ bool CategoryGroup::rename( const QString &oldLabel, const QString &newLabel )
 
+/*! Returns TRUE if \a uid is stored in this group, FALSE if not. */
 bool CategoryGroup::contains(int uid) const
@@ -125,2 +155,3 @@ bool CategoryGroup::contains(int uid) const
 
+/*! Returns TRUE if \a label is stored in this group, FALSE if not. */
 bool CategoryGroup::contains(const QString &label) const
@@ -130,4 +161,4 @@ bool CategoryGroup::contains(const QString &label) const
 
-/** Returns label associated with the uid or QString::null if
- *   not found
+/*! Returns label associated with the \a uid or QString::null if
+  not found
  */
@@ -141,3 +172,3 @@ const QString &CategoryGroup::label(int uid) const
 
-/** Returns the uid associated with label or 0 if not found */
+/*! Returns the uid associated with \a label or 0 if not found */
 int CategoryGroup::id(const QString &label) const
@@ -150,2 +181,3 @@ int CategoryGroup::id(const QString &label) const
 
+/*! Returns a list of all labels stored in this group. */
 QStringList CategoryGroup::labels() const
@@ -161,2 +193,3 @@ QStringList CategoryGroup::labels() const
 
+/*! Returns a list of all labels associated with the \a catids */
 QStringList CategoryGroup::labels(const QArray<int> &catids ) const
@@ -179,5 +212,45 @@ QStringList CategoryGroup::labels(const QArray<int> &catids ) const
 
-/** Add the category name as long as it doesn't already exist locally
- *  or globally.  Return TRUE if added, FALSE if conflicts.
- */
+/*!
+  \class Categories categories.h
+  \brief The Categories class is a database that groups categories and maps ids to names.
+
+  The Categories class is the low level Categories accessor class. To
+  add a category menu and filter for your application, see CategoryMenu.
+
+  The Categories class allows the developer to add, remove, and rename
+  categories. Categories can be created for an individual application
+  such as Todo List or to be used for all applications. Categories
+  that can be used by all applications are called global
+  categories. Each PalmtopRecord subclass stores categories as an
+  QArray<int> using PalmtopRecord::setCategories() and
+  PalmtopRecord::categories(). This allows each record to be assigned
+  to multiple categories. This also allows the user to rename a
+  category and for it to update automatically in all records.
+
+  This class provides several methods to convert between a category id
+  and it's associated string such as id(), ids(), label() and labels(). A
+  helper class called CategoryGroup is used to access categories of a
+  single application group, such as Todo List. Global categories can
+  also be accessed via CategoryGroup objects.  See appGroupMap() and
+  globalGroup() for the appropriate accessor methods.
+
+  Categories are stored in an xml file in the Settings directory
+  (Categories.xml). A global function called categoryFileName() will
+  return to appropriate QString file location to be passed to load()
+  and save() for the master categories database.
+
+  \ingroup qtopiaemb
+  \ingroup qtopiadesktop
+  \warning Categories API will likely change between Qtopia 1.5 and Qtopia 3
+  \sa CategoryGroup, CategoryMenu
+*/
+
+
+/*!
+  Add the category name as long as it doesn't already exist locally or
+  globally.  The \a uid is assigned to the category if successfully
+  added. Return \a uid if added, 0 if conflicts (error).
+
+  \internal
+*/
 int Categories::addCategory( const QString &appname,
@@ -206,2 +279,7 @@ int Categories::addCategory( const QString &appname,
 
+/*!
+  Add the category name as long as it doesn't already exist locally or
+  globally.  Return UID if added, 0 if conflicts (error).
+*/
+
 int Categories::addCategory( const QString &appname,
@@ -231,2 +309,5 @@ int Categories::addCategory( const QString &appname,
 
+/*!
+  \internal
+*/
 int Categories::addGlobalCategory( const QString &catname, int uid )
@@ -238,2 +319,8 @@ int Categories::addGlobalCategory( const QString &catname, int uid )
 
+/*!
+  Add the global category \a catname while checking that it doesn't
+  already exist globally. Return UID if added, 0 if conflicts.
+
+  \sa addCategory()
+ */
 int Categories::addGlobalCategory( const QString &catname )
@@ -247,6 +334,8 @@ int Categories::addGlobalCategory( const QString &catname )
 
-/** Removes the category from the application; if it is not found
- *  in the application, then it attempts to remove it from
- *  the global list
- */
+/*!
+
+  Removes the \a catname from the application group. If it is not
+  found in the application group and \a checkGlobal is TRUE, then it
+  attempts to remove it from the global list
+*/
 bool Categories::removeCategory( const QString &appname,
@@ -270,2 +359,7 @@ bool Categories::removeCategory( const QString &appname,
 
+
+/*!
+  Removes the \a uid from the application group \a appname. Returns TRUE
+  if success, FALSE if not found.
+*/
 bool Categories::removeCategory( const QString &appname, int uid )
@@ -284,2 +378,6 @@ bool Categories::removeCategory( const QString &appname, int uid )
 
+/*!
+  Removes the global category \a catname. Returns TRUE
+  if success, FALSE if not found.
+*/
 bool Categories::removeGlobalCategory( const QString &catname )
@@ -294,3 +392,6 @@ bool Categories::removeGlobalCategory( const QString &catname )
 
-
+/*!
+  Removes the global category \a uid. Returns TRUE
+  if success, FALSE if not found.
+*/
 bool Categories::removeGlobalCategory( int uid )
@@ -304,5 +405,6 @@ bool Categories::removeGlobalCategory( int uid )
 
-/** Returns the sorted list of all categories that are associated with
- *   the app.  If includeGlobal parameter is TRUE then the returned
- *   categories will include the global category items.
+/*!
+  Returns the sorted list of all categories that are associated with
+  the \a app.  If \a includeGlobal is TRUE then the returned
+  categories will include the global category items.
  */
@@ -318,3 +420,3 @@ QStringList Categories::labels( const QString &app,
         cats += (*appIt).labels();
-    else qDebug("Categories::labels didn't find app %s", app.latin1() );
+    //else qDebug("Categories::labels didn't find app %s", app.latin1() );
     if ( includeGlobal )
@@ -340,2 +442,5 @@ QStringList Categories::labels( const QString &app,
 
+/*!
+  Returns the label associated with the id
+*/
 QString Categories::label( const QString &app, int id ) const
@@ -351,7 +456,13 @@ QString Categories::label( const QString &app, int id ) const
 
-/** Returns a single string associated with the cat ids for display in
-    *   a combobox or any area that requires one string.  If catids are empty
-    *   then "Unfiled" will be returned.  If multiple categories are assigned
-    *   the first cat id is shown with " (multi)" appended to the string.
-    */
+/*!
+  Returns a single string associated with \a catids for display in a
+  combobox or any area that requires one string.  If \a catids are empty
+  then "Unfiled" will be returned.  If multiple categories are
+  assigned then the behavior depends on the DisplaySingle type.
+
+  If \a display is set to ShowMulti then " (multi)" appended to the
+  first string. If \a display is set to ShowAll, then a space
+  seperated string is returned with all categories.  If ShowFirst is
+  set, the just the first string is returned.
+*/
 QString Categories::displaySingle( const QString &app,
@@ -382,2 +493,7 @@ QString Categories::displaySingle( const QString &app,
 
+/*!
+
+  Returns all ids associated with the application CategoryGroup \a app
+  and the passed in \a labels in that group.
+*/
 QArray<int> Categories::ids( const QString &app, const QStringList &labels) const
@@ -387,3 +503,3 @@ QArray<int> Categories::ids( const QString &app, const QStringList &labels) cons
   int i;
-  
+
   for ( i=0, it=labels.begin(); it!=labels.end(); i++, ++it ) {
@@ -399,2 +515,7 @@ QArray<int> Categories::ids( const QString &app, const QStringList &labels) cons
 
+/*!
+  Returns the id associated with the app. If the id is not found in the
+  application CategoryGroup, then it searches the global CategoryGroup.
+  If it is not found it either, 0 is returned.
+*/
 int Categories::id( const QString &app, const QString &cat ) const
@@ -410,4 +531,9 @@ int Categories::id( const QString &app, const QString &cat ) const
 
-/** Return TRUE if renaming succeeded; FALSE if app name not found,
- *   or if there was a name conflict
+/*!
+  Return TRUE if renaming succeeded; FALSE if \a appname or \a oldName
+  is not found, or if \a newName conflicts with an existing category
+  in the CategoryGroup.
+
+  It will first search the CategoryGroup associated with \a appname
+  and if not found it will try to replace in global CategoryGroup.
  */
@@ -431,2 +557,8 @@ bool Categories::renameCategory( const QString &appname,
 
+/*!
+  Return TRUE if renaming succeeded; FALSE if \a appname or \a oldName
+  is not found, or if \a newName conflicts with an existing category
+  in the CategoryGroup. This function will only rename categories found
+  in the global CategoryGroup.
+ */
 bool Categories::renameGlobalCategory( const QString &oldName,
@@ -442,2 +574,6 @@ bool Categories::renameGlobalCategory( const QString &oldName,
 
+/*!
+  Changes the grouping of a category. If a category was global and \a global
+  is set to TRUE, then the \a catname will be moved to the \a appname group.
+*/
 void Categories::setGlobal( const QString &appname,
@@ -460,2 +596,5 @@ void Categories::setGlobal( const QString &appname,
 
+/*!
+  Returns TRUE if the \a catname is in the global CategoryGroup, FALSE if not.
+*/
 bool Categories::isGlobal( const QString &catname ) const
@@ -466,3 +605,5 @@ bool Categories::isGlobal( const QString &catname ) const
 
-/** Returns true if the catname is associated with any application
+/*!
+  Returns true if the \a catname is associated with any CategoryGroup,
+  including global.
  */
@@ -480,2 +621,6 @@ bool Categories::exists( const QString &catname ) const
 
+/*!
+  Returns TRUE if the \a catname is associated with the \a appname
+  CategoryGroup, FALSE if not found.
+ */
 bool Categories::exists( const QString &appname,
@@ -492,3 +637,8 @@ bool Categories::exists( const QString &appname,
 
+/*!
+  Saves the Categories database to the \a fname. See categoryFileName()
+  for the default file name string used for the shared category database.
 
+  Returns FALSE if there is error writing the file or TRUE on success.
+ */
 bool Categories::save( const QString &fname ) const
@@ -536,2 +686,5 @@ bool Categories::save( const QString &fname ) const
 
+#ifdef Q_OS_WIN32
+    QFile::remove( fname );
+#endif
     if ( ::rename( strNewFile.latin1(), fname.latin1() ) < 0 ) {
@@ -546,2 +699,8 @@ bool Categories::save( const QString &fname ) const
 
+/*!
+  Loads the Categories database using \a fname. See categoryFileName()
+  for the default file name string used for the shared category database.
+
+  Returns FALSE if there is error reading the file or TRUE on success.
+ */
 bool Categories::load( const QString &fname )
@@ -621,2 +780,6 @@ bool Categories::load( const QString &fname )
 
+/*!
+  Clear the categories in memory. Equivelent to creating an empty Categories
+  object.
+*/
 void Categories::clear()
@@ -627,2 +790,5 @@ void Categories::clear()
 
+/*!
+  Dump the contents to standard out. Used for debugging only.
+*/
 void Categories::dump() const
@@ -677 +843,94 @@ void CheckedListView::setChecked( const QStringList &checked )
 }
+
+/*! \fn Categories &Categories::operator= ( const Categories &c )
+
+  Performs deep copy.
+ */
+
+
+/*! \fn  QStringList Categories::labels( const QString & app, const QArray<int> &catids ) const
+
+  Returns list of labels associated with the application and catids
+*/
+
+/*! \fn QStringList Categories::globalCategories() const
+
+  Returns list of all global category labels
+*/
+
+/*! \fn const QMap<QString, CategoryGroup> &Categories::appGroupMap() const
+
+  Returns a map of application names to CategoryGroup. The CategoryGroup
+  class defines a map of ids to category labels and category labels to ids.
+*/
+
+/*! \fn const CategoryGroup &Categories::globalGroup() const
+
+  Returns the global CategoryGroup. The CategoryGroup
+  class defines a map of ids to category labels and category labels to ids.
+*/
+
+/*! \fn void Categories::categoryAdded( const Categories &cats, const QString &appname, int uid)
+
+  Emitted if a category is added.
+
+  \a cats is a const reference to this object
+  \a appname is the CategoryGroup application name that the category was added to or QString::null if it was global
+  \a uid is the unique identifier associated with the added category
+        */
+
+/*! \fn void Categories::categoryRemoved( const Categories &cats, const QString &appname,
+  int uid)
+
+  Emitted if removed category is removed.
+
+  \a cats is a const reference to this object
+  \a appname is the CategoryGroup application name that the category was removed from or QString::null if it was the global CategoryGroup
+  \a uid is the unique identifier associated with the removed category
+*/
+
+
+/*! \fn void Categories::categoryRenamed( const Categories &cats, const QString &appname,
+  int uid)
+
+  Emitted if \a uid in the \a appname CategoryGroup is renamed in \a cats
+  object.
+
+  \a cats is a const reference to this object
+  \a appname is the CategoryGroup application name that the category was renamed in or QString::null if it was the global CategoryGroup
+  \a uid is the unique identifier associated with the renamed category
+*/
+
+/*! \fn Categories::Categories( QObject *parent=0, const char *name = 0 )
+
+  Constructor for an empty Categories object.
+*/
+
+/*! \fn Categories::Categories( const Categories &copyFrom )
+
+  Deep copy constructor
+*/
+
+/*! \fn Categories::~Categories()
+
+  Empty destructor. Call save() before destruction if there are changes
+  that need to be saved.
+*/
+
+/*! \fn CategoryGroup::clear()
+  \internal
+*/
+
+/*! \fn const QMap<int, QString> &CategoryGroup::idMap() const
+
+  Returns a const reference to the id to label QMap
+*/
+
+/*! \fn CategoryGroup::CategoryGroup()
+  \internal
+*/
+
+/*! \fn CategoryGroup::CategoryGroup(const CategoryGroup &c)
+  \internal
+*/
+