KEditToolbar Class Reference
#include <kedittoolbar.h>
Inheritance diagram for KEditToolbar:

Detailed Description
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())); dlg.exec(); } void MyClass::slotNewToolbarConfig() // This is called when OK, Apply or Defaults is clicked { ...if you use any action list, use plugActionList on each here... createGUI(); 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(); void MyClass::slotNewToolbarConfig() // This is called when OK, Apply or Defaults is clicked { ...if you use any action list, use plugActionList on each here... // Do NOT call createGUI()! applyMainWindowSettings( KGlobal::config(), "MainWindow" ); }
- Author:
- Kurt Granroth <granroth@kde.org>
- Version:
- Id
- kedittoolbar.h 465272 2005-09-29 09:47:40Z mueller
Definition at line 110 of file kedittoolbar.h.
Signals | |
void | newToolbarConfig () |
Public Member Functions | |
KEditToolbar (KActionCollection *collection, const QString &xmlfile=QString::null, bool global=true, QWidget *parent=0, const char *name=0) | |
KEditToolbar (const QString &defaultToolbar, KActionCollection *collection, const QString &xmlfile=QString::null, bool global=true, QWidget *parent=0, const char *name=0) | |
KEditToolbar (KXMLGUIFactory *factory, QWidget *parent=0, const char *name=0) | |
KEditToolbar (const QString &defaultToolbar, KXMLGUIFactory *factory, QWidget *parent=0, const char *name=0) | |
~KEditToolbar () | |
Static Public Member Functions | |
static void | setDefaultToolbar (const char *toolbarName) |
Protected Slots | |
virtual void | slotOk () |
virtual void | slotApply () |
void | acceptOK (bool b) |
void | slotDefault () |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
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 378 of file kedittoolbar.cpp. |
|
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: KEditToolbar edit(factory()); if ( edit.exec() ) ...
Definition at line 401 of file kedittoolbar.cpp. |
|
Constructor for KParts based apps, which has an extra argument specifying the toolbar to be shown.
Definition at line 409 of file kedittoolbar.cpp. |
|
destructor
Definition at line 434 of file kedittoolbar.cpp. |
Member Function Documentation
|
should OK really save?
For internal use only.
Definition at line 439 of file kedittoolbar.cpp. |
|
Signal emitted when 'apply' or 'ok' is clicked or toolbars were resetted. Connect to it, to plug action lists and to call applyMainWindowSettings (see sample code in this class's documentation) |
|
Sets the default toolbar, which will be auto-selected when the constructor without the defaultToolbar argument is used.
Definition at line 535 of file kedittoolbar.cpp. |
|
idem
Reimplemented from KDialogBase. Definition at line 528 of file kedittoolbar.cpp. |
|
Set toolbars to default value.
Reimplemented from KDialogBase. Definition at line 445 of file kedittoolbar.cpp. |
|
Overridden in order to save any changes made to the toolbars.
Reimplemented from KDialogBase. Definition at line 510 of file kedittoolbar.cpp. |
The documentation for this class was generated from the following files: