KEditToolbar Class Reference
This is a dialog used to customize or configure toolbars. A dialog used to customize or configure toolbars. More...
#include <kedittoolbar.h>
Inheritance diagram for KEditToolbar:

Signals | |
void | newToolbarConfig () |
Signal emitted when 'apply' or 'ok' is clicked. | |
Public Member Functions | |
KEditToolbar (KActionCollection *collection, const QString &xmlfile=QString::null, bool global=true, QWidget *parent=0, const char *name=0) | |
Constructor for apps that do not use components. | |
KEditToolbar (KXMLGUIFactory *factory, QWidget *parent=0, const char *name=0) | |
Constructor for KParts based apps. | |
~KEditToolbar () | |
destructor | |
Protected Slots | |
virtual void | slotOk () |
Overridden in order to save any changes made to the toolbars. | |
virtual void | slotApply () |
idem | |
void | acceptOK (bool b) |
should OK really save? | |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
This is a dialog used to customize or configure toolbars. A dialog used to customize or configure toolbars.This dialog only works if your application uses the XML UI framework for creating menus and toolbars. It depends on the XML files to describe the toolbar layouts and it requires the actions to determine which buttons are active.
Typically, you would include the KStdAction::configureToolbars() standard action in your application. In your slot to this action, you would have something like so:
KEditToolbar dlg(actionCollection()); if (dlg.exec()) { createGUI(); }That code snippet also takes care of redrawing the menu and toolbars if you have made any changes.
If you are using KMainWindow's settings methods (either save/apply manually or autoSaveSettings), you should write something like:
void MyClass::slotConfigureToolbars() { saveMainWindowSettings( KGlobal::config(), "MainWindow" ); KEditToolbar dlg(actionCollection()); connect(&dlg,SIGNAL(newToolbarConfig()),this,SLOT(slotNewToolbarConfig())); if (dlg.exec()) { createGUI(); } }
void MyClass::slotNewToolbarConfig() // This is called when OK or Apply is clicked { ...if you use any action list, use plugActionList on each here... applyMainWindowSettings( KGlobal::config(), "MainWindow" ); }Note that the procedure is a bit different for KParts applications. In this case, you need only pass along a pointer to your application's KXMLGUIFactory object. The editor will take care of finding all of the action collections and xml files. The editor aims to be semi-intelligent about where it assigns any modifications. In other words, it will not write out part specific changes to your shell's xml file.
An example would be:
saveMainWindowSettings( KGlobal::config(), "MainWindow" ); KEditToolbar dlg(factory()); connect(&dlg,SIGNAL(newToolbarConfig()),this,SLOT(slotNewToolbarConfig())); dlg.exec(); // Note that you shouldn't call createGUI(), so if() might not be even needed anymore
... // See above for slotNewToolbarConfig
- Author:
- Kurt Granroth <granroth@kde.org>
- Id
- kedittoolbar.h,v 1.25.4.2 2003/07/15 10:42:17 mueller Exp
Definition at line 102 of file kedittoolbar.h.
Constructor & Destructor Documentation
|
Constructor for apps that do not use components. This is the only entry point to this class. You must pass along your collection of actions (some of which appear in your toolbars). The other two parameters are optional. 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.
The third parameter, global(), controls whether or not the global resource file is used. If this is
Definition at line 187 of file kedittoolbar.cpp. References KStdAccel::name(). |
|
Constructor for KParts based apps. The main 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. Use this like so:
Definition at line 195 of file kedittoolbar.cpp. References KStdAccel::name(). |
|
destructor
Definition at line 216 of file kedittoolbar.cpp. |
Member Function Documentation
|
Overridden in order to save any changes made to the toolbars.
Reimplemented from KDialogBase. Definition at line 227 of file kedittoolbar.cpp. References QDialog::accept(), newToolbarConfig(), QDialog::reject(), and KEditToolbarWidget::save(). |
|
idem
Reimplemented from KDialogBase. Definition at line 245 of file kedittoolbar.cpp. References KDialogBase::enableButtonApply(), newToolbarConfig(), and KEditToolbarWidget::save(). |
|
should OK really save?
Definition at line 221 of file kedittoolbar.cpp. References KDialogBase::enableButtonOK(). |
|
Signal emitted when 'apply' or 'ok' is clicked. Connect to it, to plug action lists and to call applyMainWindowSettings (see sample code in this class's documentation) Referenced by slotApply(), and slotOk(). |
The documentation for this class was generated from the following files: