org.kde.koala

Class KEditToolbar

public class KEditToolbar extends KDialogBase

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" );
 }
 
See KEditToolbarSignals for signals emitted by KEditToolbar

Version: $Id: KEditToolbar.java 473384 2005-10-23 14:17:09Z rdale $

Author: Kurt Granroth

UNKNOWN: A dialog used to customize or configure toolbars.

Constructor Summary
protected KEditToolbar(Class dummy)
KEditToolbar(KActionCollection collection, String xmlfile, boolean global, QWidget parent, String name)
Constructor for apps that do not use components.
KEditToolbar(KActionCollection collection, String xmlfile, boolean global, QWidget parent)
KEditToolbar(KActionCollection collection, String xmlfile, boolean global)
KEditToolbar(KActionCollection collection, String xmlfile)
KEditToolbar(KActionCollection collection)
KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile, boolean global, QWidget parent, String name)
KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile, boolean global, QWidget parent)
KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile, boolean global)
KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile)
KEditToolbar(String defaultToolbar, KActionCollection collection)
KEditToolbar(KXMLGUIFactory factory, QWidget parent, String name)
Constructor for KParts based apps.
KEditToolbar(KXMLGUIFactory factory, QWidget parent)
KEditToolbar(KXMLGUIFactory factory)
KEditToolbar(String defaultToolbar, KXMLGUIFactory factory, QWidget parent, String name)
Constructor for KParts based apps, which has an extra argument specifying the toolbar to be shown.
KEditToolbar(String defaultToolbar, KXMLGUIFactory factory, QWidget parent)
KEditToolbar(String defaultToolbar, KXMLGUIFactory factory)
Method Summary
protected voidacceptOK(boolean b)
should OK really save?
StringclassName()
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
protected voidfinalize()
Deletes the wrapped C++ instance
booleanisDisposed()
Has the wrapped C++ instance been deleted?
QMetaObjectmetaObject()
static voidsetDefaultToolbar(String toolbarName)
Sets the default toolbar, which will be auto-selected when the constructor without the defaultToolbar argument is used.
protected voidslotApply()
idem
protected voidslotDefault()
Set toolbars to default value
protected voidslotOk()
Overridden in order to save any changes made to the toolbars

Constructor Detail

KEditToolbar

protected KEditToolbar(Class dummy)

KEditToolbar

public KEditToolbar(KActionCollection collection, String xmlfile, boolean global, QWidget parent, String name)
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 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).

Parameters: collection The collection of actions to work on. xmlfile The application's local resource file. global If true, then the global resource file will also be parsed. parent The parent of the dialog. name An internal name.

UNKNOWN: Constructor for apps that do not use components.

KEditToolbar

public KEditToolbar(KActionCollection collection, String xmlfile, boolean global, QWidget parent)

KEditToolbar

public KEditToolbar(KActionCollection collection, String xmlfile, boolean global)

KEditToolbar

public KEditToolbar(KActionCollection collection, String xmlfile)

KEditToolbar

public KEditToolbar(KActionCollection collection)

KEditToolbar

public KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile, boolean global, QWidget parent, String name)

KEditToolbar

public KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile, boolean global, QWidget parent)

KEditToolbar

public KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile, boolean global)

KEditToolbar

public KEditToolbar(String defaultToolbar, KActionCollection collection, String xmlfile)

KEditToolbar

public KEditToolbar(String defaultToolbar, KActionCollection collection)

KEditToolbar

public KEditToolbar(KXMLGUIFactory factory, QWidget parent, String 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:
		 KEditToolbar edit(factory());
		 if ( edit.exec() )
		 ...
		 

Parameters: factory Your application's factory object parent The usual parent for the dialog. name An internal name. Some people seem tempted to use this also in non-KParts apps, using KMainWindow.guiFactory(). This works, but only _if_ setting conserveMemory to false when calling KMainWindow.createGUI()! If not, use the other KEditToolbar constructor.

UNKNOWN: Constructor for KParts based apps.

KEditToolbar

public KEditToolbar(KXMLGUIFactory factory, QWidget parent)

KEditToolbar

public KEditToolbar(KXMLGUIFactory factory)

KEditToolbar

public KEditToolbar(String defaultToolbar, KXMLGUIFactory factory, QWidget parent, String name)
Constructor for KParts based apps, which has an extra argument specifying the toolbar to be shown.

Parameters: defaultToolbar The toolbar with this name will appear for editing. factory Your application's factory object parent The usual parent for the dialog. name An internal name.

UNKNOWN: Constructor for KParts based apps, which has an extra argument specifying the toolbar to be shown.

KEditToolbar

public KEditToolbar(String defaultToolbar, KXMLGUIFactory factory, QWidget parent)

KEditToolbar

public KEditToolbar(String defaultToolbar, KXMLGUIFactory factory)

Method Detail

acceptOK

protected void acceptOK(boolean b)
should OK really save?

UNKNOWN: should OK really save?

className

public String className()

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

finalize

protected void finalize()
Deletes the wrapped C++ instance

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

metaObject

public QMetaObject metaObject()

setDefaultToolbar

public static void setDefaultToolbar(String toolbarName)
Sets the default toolbar, which will be auto-selected when the constructor without the defaultToolbar argument is used.

Parameters: toolbarName the name of the toolbar

UNKNOWN: Sets the default toolbar, which will be auto-selected when the constructor without the defaultToolbar argument is used.

slotApply

protected void slotApply()
idem

UNKNOWN: idem

slotDefault

protected void slotDefault()
Set toolbars to default value

UNKNOWN: Set toolbars to default value

slotOk

protected void slotOk()
Overridden in order to save any changes made to the toolbars

UNKNOWN: Overridden in order to save any changes made to the toolbars