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

List:       kde-commits
Subject:    KDE/kdelibs/kdeui/actions
From:       Michael Pyne <mpyne () kde ! org>
Date:       2010-03-25 3:09:12
Message-ID: 20100325030912.34730AC876 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1107224 by mpyne:

API dox fixes for KStandardAction


 M  +19 -6     kactioncollection.h  
 M  +14 -2     kstandardaction.h  


--- trunk/KDE/kdelibs/kdeui/actions/kactioncollection.h #1107223:1107224
@@ -328,26 +328,39 @@
   QAction* takeAction(QAction *action);
 
   /**
-   * Creates a new standard action, adds it to the collection and connects the \
                action's triggered() signal to the
-   * specified receiver/member. The newly created action is also returned.
+   * Creates a new standard action, adds it to the collection and connects the
+   * action's triggered(bool) signal to the specified receiver/member. The
+   * newly created action is also returned.
    *
+   * Note: Using KStandardAction::OpenRecent will cause a different signal than
+   * triggered(bool) to be used, see KStandardAction for more information.
+   *
    * The action can be retrieved later from the collection by its standard name as \
                per
    * KStandardAction::stdName.
    */
   KAction *addAction(KStandardAction::StandardAction actionType, const QObject \
*receiver = 0, const char *member = 0); +
   /**
-   * Creates a new standard action, adds to the collection under the given name and \
                connects the action's triggered() signal to the
-   * specified receiver/member. The newly created action is also returned.
+   * Creates a new standard action, adds to the collection under the given name
+   * and connects the action's triggered(bool) signal to the specified
+   * receiver/member. The newly created action is also returned.
    *
+   * Note: Using KStandardAction::OpenRecent will cause a different signal than
+   * triggered(bool) to be used, see KStandardAction for more information.
+   *
    * The action can be retrieved later from the collection by the specified name.
    */
   KAction *addAction(KStandardAction::StandardAction actionType, const QString \
                &name,
                      const QObject *receiver = 0, const char *member = 0);
 
   /**
-   * Creates a new action under the given name to the collection and connects the \
                action's triggered()
-   * signal to the specified receiver/member. The newly created action is returned.
+   * Creates a new action under the given name to the collection and connects
+   * the action's triggered(bool) signal to the specified receiver/member. The
+   * newly created action is returned.
    *
+   * NOTE: KDE prior to 4.2 used the triggered() signal instead of the \
triggered(bool) +   * signal.
+   *
    * Inserting an action that was previously inserted under a different name will \
                replace the
    * old entry, i.e. the action will not be available under the old name anymore but \
                only under
    * the new one.
--- trunk/KDE/kdelibs/kdeui/actions/kstandardaction.h #1107223:1107224
@@ -164,8 +164,20 @@
   };
 
   /**
-   * Creates an action corresponding to the
-   * KStandardAction::StandardAction enum.
+   * Creates an action corresponding to one of the
+   * KStandardAction::StandardAction actions, which is connected to the given
+   * object and @p slot, and is owned by @p parent.
+   *
+   * The signal that is connected to @p slot is triggered(bool), except for the case \
of +   * OpenRecent standard action, which uses the urlSelected(const KUrl &) signal \
of +   * KRecentFilesAction.
+   *
+   * @param id The StandardAction identifier to create a KAction for.
+   * @param recvr The QObject to receive the signal, or 0 if no notification
+   *              is needed.
+   * @param slot  The slot to connect the signal to (remember to use the SLOT() \
macro). +   * @param parent The QObject that should own the created KAction, or 0 if \
no parent will +   *               own the KAction returned (ensure you delete it \
                manually in this case).
    */
   KDEUI_EXPORT KAction* create(StandardAction id, const QObject *recvr, const char \
*slot,  QObject *parent);


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