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

List:       kde-commits
Subject:    kdenonbeta/akregator/src
From:       Frank Osterfeld <f_osterf () informatik ! uni-kl ! de>
Date:       2004-11-28 11:39:32
Message-ID: 20041128113932.F3C0C17A2B () office ! kde ! org
[Download RAW message or body]

CVS commit by osterfeld: 

added comments


  M +26 -3     articlelist.h   1.18


--- kdenonbeta/akregator/src/articlelist.h  #1.17:1.18
@@ -44,17 +44,40 @@ namespace Akregator
             ~ArticleList();
 
+            /**
+            Listen to notification signals of the viewed node. Disable this if you \
don't want this view updated when the node changes. +            It's enabled by \
default. +            
+            @param doReceive whether listen to notification signals or not
+            @param remember if @c true: if an update request occured while receiving \
updates was disabled, the view is updated on re-enabling. You have to set this when \
reenabling, not when disabling! Ignored when @c doReceive is set to false.(Anyone got \
this?) */  void setReceiveUpdates(bool doReceive, bool remember=true);
             
         public slots:
+
+            /** show article list of tree node @c node (also connects to the \
notification signals of the node) */  void slotShowNode(TreeNode* node);
+            
+            /** clears the list and disconnects from the observed node (if any) */
             void slotClear();
+            
+            /** Update view */
             void slotUpdate();
+            
+            /** sets text filter and status filter
+            @param textFilter filters text
+            @param statusFilter filters status (read, unread, new) */
             void slotSetFilter(const ArticleFilter& textFilter, const ArticleFilter& \
statusFilter); +
+            /** selects previous article in list view, first article if no article \
was selected */  void slotPreviousArticle();
+            /** selects next article in list view, first article if no article was \
selected */  void slotNextArticle();
+            /** selects previous unread article in list view, first unread article \
if no article was selected */  void slotPreviousUnreadArticle();
+            /** selects next unread article in list view, first unread article if no \
article was selected */  void slotNextUnreadArticle();
 
         signals:
+             /** emitted when an article was selected
+                 @param article the article selected*/
              void signalArticleSelected(MyArticle article);
              


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