[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdepimlibs/akonadi
From:       Stephen Kelly <steveire () gmail ! com>
Date:       2010-12-22 15:38:26
Message-ID: 20101222153826.697FFAC8AA () svn ! kde ! org
[Download RAW message or body]

SVN commit 1208623 by skelly:

More documentation.

 M  +13 -3     entitytreemodel.h  


--- trunk/KDE/kdepimlibs/akonadi/entitytreemodel.h #1208622:1208623
@@ -355,12 +355,22 @@
     };
 
     /**
-     * Describes the state of fetch jobs related to particular entities.
+     * Describes the state of fetch jobs related to particular collections.
+     *
+     * @code
+     *   QModelIndex collectionIndex = getIndex();
+     *   if (collectionIndex.data(EntityTreeModel::FetchStateRole).toLongLong() == \
FetchingState) { +     *     // There is a fetch underway
+     *   } else {
+     *     // There is no fetch underway.
+     *   }
+     * @endcode
+     *
      * @since 4.5
      */
     enum FetchState {
-      IdleState,                              ///< There is no fetch in progress.
-      FetchingState                           ///< There is a fetch in progress.
+      IdleState,                              ///< There is no fetch of items in \
this collection in progress. +      FetchingState                           ///< \
                There is a fetch of items in this collection in progress.
       // TODO: Change states for reporting of fetching payload parts of items.
     };
 


[prev in list] [next in list] [prev in thread] [next in thread]