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

List:       kde-commits
Subject:    KDE/kdelibs/kdeui/dialogs
From:       David Faure <faure () kde ! org>
Date:       2010-11-18 23:54:44
Message-ID: 20101118235444.78EFDAC8A0 () svn ! kde ! org
[Download RAW message or body]

SVN commit 1198570 by dfaure:

Fix a bunch of outdated documentation.


 M  +1 -2      kedittoolbar.h  
 M  +39 -33    kedittoolbar_p.h  


--- trunk/KDE/kdelibs/kdeui/dialogs/kedittoolbar.h #1198569:1198570
@@ -76,7 +76,6 @@
    * You really want to use the other constructor.
    *
    * You @em must pass along your collection of actions (some of which appear in your toolbars).
-   * The other two parameters are optional.
    *
    * @param collection The collection of actions to work on.
    * @param parent The parent of the dialog.
@@ -87,7 +86,7 @@
   /**
    * Main constructor.
    *
-   * The main parameter, factory(), is a pointer to the
+   * The main parameter, @p factory, is a pointer to the
    * XML GUI factory object for your application.  It contains a list
    * of all of the GUI clients (along with the action collections and
    * xml files) and the toolbar editor uses that.
--- trunk/KDE/kdelibs/kdeui/dialogs/kedittoolbar_p.h #1198569:1198570
@@ -120,51 +120,27 @@
     Q_OBJECT
 public:
     /**
-     * Constructor.  This is the only entry point to this class.  You
-     * @p must pass along your collection of actions (some of which
-     * appear in your toolbars).  The other three parameters are
-     * optional.
+     * Old constructor for apps that do not use components.
+     * This constructor is somewhat deprecated, since it doesn't work
+     * with any KXMLGuiClient being added to the mainwindow.
+     * You really want to use the other constructor.
      *
-     * The second parameter, xmlfile, is the name (absolute or
-     * relative) of your application's UI resource file.  If it is
-     * left blank, then the resource file: share/apps/appname/appnameui.rc
-     * is used.  This is the same resource file that is used by the
-     * default createGUI function in KMainWindow so you're usually
-     * pretty safe in leaving it blank.
+     * You @em must pass along your collection of actions (some of which appear in your toolbars).
+     * Then call old-style load.
      *
-     * The third parameter, global, controls whether or not the
-     * global resource file is used.  If this is true, then you may
-     * edit all of the actions in your toolbars -- global ones and
-     * local one.  If it is false, then you may edit only your
-     * application's entries.  The only time you should set this to
-     * false is if your application does not use the global resource
-     * file at all (very rare)
-     *
-     * The last parameter, parent, is the standard parent stuff.
-     *
      * @param collection The collection of actions to work on
-     * @param xmlfile The application's local resource file
-     * @param global If true, then the global resource file will also
-     *               be parsed
      * @param parent This widget's parent
      */
     explicit KEditToolBarWidget( KActionCollection *collection,
                                  QWidget *parent = 0L);
 
     /**
-     * Constructor for KParts based apps.
+     * Main constructor.
      *
-     * The first parameter, factory, is a pointer to the XML GUI
-     * factory object for your application.  It contains a list of all
-     * of the GUI clients (along with the action collections and xml
-     * files) and the toolbar editor uses that.
-     *
-     * The second parameter, parent, is the standard parent
-     *
      * Use this like so:
      * \code
-     * KEditToolBar edit(factory());
-     * if ( edit.exec() )
+     * KEditToolBarWidget widget(this);
+     * widget.load(factory());
      * ...
      * \endcode
      *
@@ -181,7 +157,28 @@
     virtual ~KEditToolBarWidget();
 
     /**
+     * Old-style load.
+     *
      * Loads the toolbar configuration into the widget. Should be called before being shown.
+     *
+     * @param resourceFile the name (absolute or relative) of your application's UI
+     * resource file.  If it is left blank, then the resource file: share/apps/appname/appnameui.rc
+     * is used.  This is the same resource file that is used by the
+     * default createGUI function in KMainWindow so you're usually
+     * pretty safe in leaving it blank.
+     *
+     * @param global controls whether or not the
+     * global resource file is used.  If this is true, then you may
+     * edit all of the actions in your toolbars -- global ones and
+     * local one.  If it is false, then you may edit only your
+     * application's entries.  The only time you should set this to
+     * false is if your application does not use the global resource
+     * file at all (very rare)
+     *
+     * @param defaultToolBar the default toolbar that will be selected when the dialog is shown.
+     * If not set, or QString() is passed in, the global default tool bar name
+     * will be used.
+     *
      * @see KEditToolBar
      */
     void load( const QString& resourceFile,
@@ -190,6 +187,15 @@
 
     /**
      * Loads the toolbar configuration into the widget. Should be called before being shown.
+     *
+     * @param factory pointer to the XML GUI factory object for your application.
+     * It contains a list of all of the GUI clients (along with the action
+     * collections and xml files) and the toolbar editor uses that.
+     *
+     * @param defaultToolBar the default toolbar that will be selected when the dialog is shown.
+     * If not set, or QString() is passed in, the global default tool bar name
+     * will be used.
+     *
      * @see KEditToolBar
      */
     void load( KXMLGUIFactory* factory,
[prev in list] [next in list] [prev in thread] [next in thread]