KDE top level main window with predefined action layout More...

#include <kxmlguiwindow.h>

Inheritance diagram for KXmlGuiWindow:

Public Types
enum	StandardWindowOption { ToolBar = 1 , Keys = 2 , StatusBar = 4 , Save = 8 , Create = 16 , Default = ToolBar \| Keys \| StatusBar \| Save \| Create }

Public Types inherited from KisKXMLGUIClient
enum	ReverseStateChange { StateNoReverse , StateReverse }

Public Slots
virtual void	configureToolbars ()

virtual void	slotStateChanged (const QString &newstate)

void	slotStateChanged (const QString &newstate, bool reverse)

Public Slots inherited from KisKMainWindow
void	appHelpActivated (void)

void	setSettingsDirty ()

Public Member Functions
void	applyMainWindowSettings (const KConfigGroup &config) override

void	createGUI (const QString &xmlfile=QString())

void	createStandardStatusBarAction ()

void	finalizeGUI (bool force)

void	finalizeGUI (KisKXMLGUIClient *client) override

virtual KisKXMLGUIFactory *	guiFactory ()

bool	isHelpMenuEnabled () const

bool	isStandardToolBarMenuEnabled () const

	KXmlGuiWindow (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())

void	setHelpMenuEnabled (bool showHelpMenu=true)

void	setStandardToolBarMenuEnabled (bool enable)

void	setupGUI (const QSize &defaultSize, StandardWindowOptions options=Default, const QString &xmlfile=QString())

void	setupGUI (StandardWindowOptions options=Default, const QString &xmlfile=QString())

void	setupToolbarMenuActions ()

QAction *	toolBarMenuAction ()

	~KXmlGuiWindow () override
	Destructor.

Public Member Functions inherited from KisKMainWindow
KConfigGroup	autoSaveConfigGroup () const

QString	autoSaveGroup () const

bool	autoSaveSettings () const

QString	dbusName () const

bool	hasMenuBar ()

	KisKMainWindow (QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())

void	resetAutoSaveSettings ()

bool	restore (int number, bool show=true)

void	saveMainWindowSettings (KConfigGroup &config)

void	setAutoSaveSettings (const KConfigGroup &group, bool saveWindowSize=true)

void	setAutoSaveSettings (const QString &groupName=QLatin1String("MainWindow"), bool saveWindowSize=true)

KisToolBar *	toolBar (const QString &name=QString())

QList< KisToolBar * >	toolBars () const

	~KisKMainWindow () override
	Destructor.

Public Member Functions inherited from KisKXMLGUIBuilder
KisKXMLGUIClient *	builderClient () const

virtual QStringList	containerTags () const

virtual QWidget *	createContainer (QWidget parent, int index, const QDomElement &element, QAction &containerAction)

virtual QAction *	createCustomElement (QWidget *parent, int index, const QDomElement &element)

virtual QStringList	customTags () const

	KisKXMLGUIBuilder (QWidget *widget)

virtual void	removeContainer (QWidget container, QWidget parent, QDomElement &element, QAction *containerAction)

virtual void	removeCustomElement (QWidget parent, QAction action)

void	setBuilderClient (KisKXMLGUIClient *client)

QWidget *	widget ()

virtual	~KisKXMLGUIBuilder ()

Public Member Functions inherited from KisKXMLGUIClient
QAction *	action (const char *name) const

virtual QAction *	action (const QDomElement &element) const

virtual KisKActionCollection *	actionCollection () const

void	addStateActionDisabled (const QString &state, const QString &action)

void	addStateActionEnabled (const QString &state, const QString &action)

void	beginXMLPlug (QWidget *)

QList< KisKXMLGUIClient * >	childClients ()

KisKXMLGUIBuilder *	clientBuilder () const

virtual QString	componentName () const

virtual QDomDocument	domDocument () const

void	endXMLPlug ()

KisKXMLGUIFactory *	factory () const

StateChange	getActionsToChangeForState (const QString &state)

void	insertChildClient (KisKXMLGUIClient *child)

	KisKXMLGUIClient ()

	KisKXMLGUIClient (KisKXMLGUIClient *parent)

virtual QString	localXMLFile () const

KisKXMLGUIClient *	parentClient () const

void	plugActionList (const QString &name, const QList< QAction * > &actionList)

void	prepareXMLUnplug (QWidget *)

void	reloadXML ()

void	removeChildClient (KisKXMLGUIClient *child)

void	replaceXMLFile (const QString &xmlfile, const QString &localxmlfile, bool merge=false)

void	setClientBuilder (KisKXMLGUIBuilder *builder)

void	setFactory (KisKXMLGUIFactory *factory)

void	setXMLGUIBuildDocument (const QDomDocument &doc)

void	unplugActionList (const QString &name)

virtual QString	xmlFile () const

QDomDocument	xmlguiBuildDocument () const

virtual	~KisKXMLGUIClient ()

Protected Slots
virtual void	saveNewToolbarConfig ()

Protected Slots inherited from KisKMainWindow
void	saveAutoSaveSettings ()

Protected Member Functions
bool	event (QEvent *event) override

Protected Member Functions inherited from KisKMainWindow
void	closeEvent (QCloseEvent *) override

bool	event (QEvent *event) override

	KisKMainWindow (KisKMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)

virtual bool	queryClose ()

virtual void	readGlobalProperties (KConfig *sessionConfig)

virtual void	readProperties (const KConfigGroup &)

bool	readPropertiesInternal (KConfig *, int)

virtual void	saveGlobalProperties (KConfig *sessionConfig)

virtual void	saveProperties (KConfigGroup &)

void	savePropertiesInternal (KConfig *, int)

bool	settingsDirty () const

virtual bool	windowsLayoutSavingAllowed () const

Protected Member Functions inherited from KisKXMLGUIBuilder
virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from KisKXMLGUIClient
void	loadStandardsXmlFile ()

virtual void	setComponentName (const QString &componentName, const QString &componentDisplayName)

void	setDOMDocument (const QDomDocument &document, bool merge=false)

void	setLocalXMLFile (const QString &file)

void	setXML (const QString &document, bool merge=false)

void	setXMLFile (const QString &file, bool merge=false, bool setXMLDoc=true)

virtual void	stateChanged (const QString &newstate, ReverseStateChange reverse=StateNoReverse)

virtual void	virtual_hook (int id, void *data)

Properties
QString	autoSaveGroup

bool	autoSaveSettings

bool	hasMenuBar

bool	standardToolBarMenuEnabled

Properties inherited from KisKMainWindow
QString	autoSaveGroup

bool	autoSaveSettings

bool	hasMenuBar

Additional Inherited Members
Static Public Member Functions inherited from KisKMainWindow
static bool	canBeRestored (int number)

static const QString	classNameOfToplevel (int number)

static QList< KisKMainWindow * >	memberList ()

Static Public Member Functions inherited from KisKXMLGUIClient
static QString	findMostRecentXMLFile (const QStringList &files, QString &doc)

Static Protected Member Functions inherited from KisKXMLGUIClient
static QString	standardsXmlFileLocation ()

Protected Attributes inherited from KisKMainWindow
KisKMainWindowPrivate *const	k_ptr

Detailed Description

KDE top level main window with predefined action layout

Instead of creating a KisKMainWindow manually and assigning menus, menu entries, toolbar buttons and actions to it by hand, this class can be used to load an rc file to manage the main window's actions.

See http://techbase.kde.org/Development/Tutorials/Using_KActions#XMLGUI for essential information on the XML file format and usage of this class.

See also: KisKMainWindow

Author: Reginald Stadlbauer (reggi.nosp@m.e@kd.nosp@m.e.org) Stephan Kulow (coolo.nosp@m.@kde.nosp@m..org), Matthias Ettrich (ettri.nosp@m.ch@k.nosp@m.de.or.nosp@m.g), Chris Schlaeger (cs@kd.nosp@m.e.or.nosp@m.g), Sven Radej (radej.nosp@m.@kde.nosp@m..org). Maintained by Sven Radej (radej.nosp@m.@kde.nosp@m..org)

Definition at line 46 of file kxmlguiwindow.h.

Member Enumeration Documentation

◆ StandardWindowOption

enum KXmlGuiWindow::StandardWindowOption

See also: setupGUI()

Enumerator
ToolBar	adds action to show/hide the toolbar(s) and adds action to configure the toolbar(s). See also setStandardToolBarMenuEnabled
Keys	adds action to show the key configure action.
StatusBar	adds action to show/hide the statusbar if the statusbar exists. See also createStandardStatusBarAction
Save	auto-saves (and loads) the toolbar/menubar/statusbar settings and window size using the default name. See also setAutoSaveSettings Typically you want to let the default window size be determined by the widgets size hints. Make sure that setupGUI() is called after all the widgets are created ( including setCentralWidget ) so the default size's will be correct. See also setAutoSaveSettings for more information on this topic.
Create	calls createGUI() once ToolBar, Keys and Statusbar have been taken care of. See also createGUI NOTE: when using KParts::MainWindow, remove this flag from the setupGUI call, since you'll be using createGUI(part) instead. setupGUI(ToolBar \| Keys \| StatusBar \| Save); KXmlGuiWindow::StatusBar @ StatusBar Definition kxmlguiwindow.h:191 KXmlGuiWindow::Save @ Save Definition kxmlguiwindow.h:203 KXmlGuiWindow::ToolBar @ ToolBar Definition kxmlguiwindow.h:180 KXmlGuiWindow::Keys @ Keys Definition kxmlguiwindow.h:185 KXmlGuiWindow::setupGUI void setupGUI(StandardWindowOptions options=Default, const QString &xmlfile=QString()) Definition kxmlguiwindow.cpp:173
Default	All the above option (this is the default)

Definition at line 174 of file kxmlguiwindow.h.

                              {
        ToolBar = 1,
 
        Keys = 2,
 
        StatusBar = 4,
 
        Save = 8,
 
        Create = 16,
 
        Default = ToolBar | Keys | StatusBar | Save | Create
    };

Constructor & Destructor Documentation

◆ KXmlGuiWindow()

KXmlGuiWindow::KXmlGuiWindow	(	QWidget *	parent = 0,
		Qt::WindowFlags	f = Qt::WindowFlags() )

explicit

Construct a main window.

Parameters

parent	The widget parent. This is usually 0 but it may also be the window group leader. In that case, the KisKMainWindow becomes sort of a secondary window.
f	Specify the widget flags. The default is Qt::Window and Qt::WA_DeleteOnClose. Qt::Window indicates that a main window is a toplevel window, regardless of whether it has a parent or not. Qt::WA_DeleteOnClose indicates that a main window is automatically destroyed when its window is closed. Pass 0 if you do not want this behavior.

See also: http://doc.trolltech.com/qt.html#WindowType-enum

KisKMainWindows must be created on the heap with 'new', like:

KisKMainWindow *kmw = new KisKMainWindow(...);

kmw->setObjectName(...);

KisKMainWindow

KDE top level main window

Definition kmainwindow.h:89

KisKMainWindow::KisKMainWindow

KisKMainWindow(QWidget *parent=0, Qt::WindowFlags f=Qt::WindowFlags())

Definition kmainwindow.cpp:159

IMPORTANT: For session management and window management to work properly, all main windows in the application should have a different name. If you don't do it, KisKMainWindow will create a unique name, but it's recommended to explicitly pass a window name that will also describe the type of the window. If there can be several windows of the same type, append '#' (hash) to the name, and KisKMainWindow will replace it with numbers to make the names unique. For example, for a mail client which has one main window showing the mails and folders, and which can also have one or more windows for composing mails, the name for the folders window should be e.g. "mainwindow" and for the composer windows "composer#".

Definition at line 73 of file kxmlguiwindow.cpp.

    : KisKMainWindow(*new KXmlGuiWindowPrivate, parent, f), KisKXMLGUIBuilder(this)
{
    K_D(KXmlGuiWindow);
    d->showHelpMenu = true;
    d->toolBarHandler = 0;
    d->showStatusBarAction = 0;
    d->factory = 0;
#ifdef HAVE_DBUS
    new KisKMainWindowInterface(this);
#endif
}

References KisKXMLGUIBuilder::d, and K_D.

◆ ~KXmlGuiWindow()

KXmlGuiWindow::~KXmlGuiWindow ( )

override

Destructor.

Will also destroy the toolbars, and menubar if needed.

Definition at line 104 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    delete d->factory;
}

References KisKXMLGUIBuilder::d, and K_D.

Member Function Documentation

◆ applyMainWindowSettings()

void KXmlGuiWindow::applyMainWindowSettings ( const KConfigGroup & config )

overridevirtual

Read settings for statusbar, menubar and toolbar from their respective groups in the config file and apply them.

Parameters

config Config group to read the settings from. KF5 porting note: the unused bool argument was removed, make sure to remove it from your reimplementations too! And add a override for good measure.

Reimplemented from KisKMainWindow.

Definition at line 365 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    KisKMainWindow::applyMainWindowSettings(config);
    QStatusBar *sb = findChild<QStatusBar *>();
    if (sb && d->showStatusBarAction) {
        d->showStatusBarAction->setChecked(!sb->isHidden());
    }
}

References KisKMainWindow::applyMainWindowSettings(), KisKXMLGUIBuilder::d, and K_D.

◆ configureToolbars

void KXmlGuiWindow::configureToolbars ( )

virtualslot

Show a standard configure toolbar dialog.

This slot can be connected directly to the action to configure toolbar. This is very simple to do that by adding a single line

KStandardAction::configureToolbars( this, SLOT( configureToolbars() ),

actionCollection() );

KXmlGuiWindow::configureToolbars

virtual void configureToolbars()

Definition kxmlguiwindow.cpp:149

KisKXMLGUIClient::actionCollection

virtual KisKActionCollection * actionCollection() const

Definition kxmlguiclient.cpp:124

KStandardAction::configureToolbars

QAction * configureToolbars(const QObject *recvr, const char *slot, QObject *parent)

Definition kstandardaction.cpp:578

Definition at line 149 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    KConfigGroup cg(KSharedConfig::openConfig(), "");
    saveMainWindowSettings(cg);
    if (!d->toolBarEditor) {
        d->toolBarEditor = new KisKEditToolBar(guiFactory(), this);
        d->toolBarEditor->setAttribute(Qt::WA_DeleteOnClose);
        connect(d->toolBarEditor, SIGNAL(newToolBarConfig()), SLOT(saveNewToolbarConfig()));
    }
    d->toolBarEditor->show();
}

References connect(), KisKXMLGUIBuilder::d, guiFactory(), K_D, KisKMainWindow::saveMainWindowSettings(), and saveNewToolbarConfig().

◆ createGUI()

void KXmlGuiWindow::createGUI ( const QString & xmlfile = QString() )

Create a GUI given a local XML file. In a regular app you usually want to use setupGUI() instead of this one since it does more things for free like setting up the toolbar/shortcut edit actions, etc.

If xmlfile is 0, then it will try to construct a local XML filename like appnameui.xmlgui where 'appname' is your app's name. If that file does not exist, then the XML UI code will only use the global (standard) XML file for the layout purposes.

Parameters

xmlfile The local xmlfile (relative or absolute)

Definition at line 216 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    // disabling the updates prevents unnecessary redraws
    //setUpdatesEnabled( false );
 
    // just in case we are rebuilding, let's remove our old client
    guiFactory()->removeClient(this);
 
    // make sure to have an empty GUI
    QMenuBar *mb = menuBar();
    if (mb) {
        mb->clear();
    }
 
    qDeleteAll(toolBars());   // delete all toolbars
 
    // don't build a help menu unless the user ask for it
    if (d->showHelpMenu) {
        delete d->helpMenu;
        // we always want a help menu
        d->helpMenu = new KisKHelpMenu(this, KAboutData::applicationData(), true);
 
        KisKActionCollection *actions = actionCollection();
        QAction *helpContentsAction = d->helpMenu->action(KisKHelpMenu::menuHelpContents);
        QAction *whatsThisAction = d->helpMenu->action(KisKHelpMenu::menuWhatsThis);
        QAction *reportBugAction = d->helpMenu->action(KisKHelpMenu::menuReportBug);
        QAction *switchLanguageAction = d->helpMenu->action(KisKHelpMenu::menuSwitchLanguage);
        QAction *aboutAppAction = d->helpMenu->action(KisKHelpMenu::menuAboutApp);
        QAction *aboutKdeAction = d->helpMenu->action(KisKHelpMenu::menuAboutKDE);
 
        if (helpContentsAction) {
            actions->addAction(helpContentsAction->objectName(), helpContentsAction);
        }
        if (whatsThisAction) {
            actions->addAction(whatsThisAction->objectName(), whatsThisAction);
        }
        if (reportBugAction) {
            actions->addAction(reportBugAction->objectName(), reportBugAction);
        }
        if (switchLanguageAction) {
            actions->addAction(switchLanguageAction->objectName(), switchLanguageAction);
        }
        if (aboutAppAction) {
            actions->addAction(aboutAppAction->objectName(), aboutAppAction);
        }
        if (aboutKdeAction) {
            actions->addAction(aboutKdeAction->objectName(), aboutKdeAction);
        }
    }
 
    const QString windowXmlFile = xmlfile.isNull() ? componentName() + QStringLiteral("ui.xmlgui") : xmlfile;
 
    // Help beginners who call setXMLFile and then setupGUI...
    if (!xmlFile().isEmpty() && xmlFile() != windowXmlFile) {
        qWarning() << "You called setXMLFile(" << xmlFile() << ") and then createGUI or setupGUI,"
                   << "which also calls setXMLFile and will overwrite the file you have previously set.\n"
                   << "You should call createGUI(" << xmlFile() << ") or setupGUI(<options>," << xmlFile() << ") instead.";
    }
 
    // we always want to load in our global standards file
    loadStandardsXmlFile();
 
    // now, merge in our local xml file.
    setXMLFile(windowXmlFile, true);
 
    // make sure we don't have any state saved already
    setXMLGUIBuildDocument(QDomDocument());
 
    // do the actual GUI building
    guiFactory()->reset();
    guiFactory()->addClient(this);
 
    //  setUpdatesEnabled( true );
}

References KisKXMLGUIClient::actionCollection(), KisKActionCollection::addAction(), KisKXMLGUIFactory::addClient(), KisKXMLGUIClient::componentName(), KisKXMLGUIBuilder::d, guiFactory(), K_D, KisKXMLGUIClient::loadStandardsXmlFile(), KisKHelpMenu::menuAboutApp, KisKHelpMenu::menuAboutKDE, KisKHelpMenu::menuHelpContents, KisKHelpMenu::menuReportBug, KisKHelpMenu::menuSwitchLanguage, KisKHelpMenu::menuWhatsThis, KisKXMLGUIFactory::removeClient(), KisKXMLGUIFactory::reset(), KisKXMLGUIClient::setXMLFile(), KisKXMLGUIClient::setXMLGUIBuildDocument(), KisKMainWindow::toolBars(), and KisKXMLGUIClient::xmlFile().

◆ createStandardStatusBarAction()

void KXmlGuiWindow::createStandardStatusBarAction ( )

Sets whether KisKMainWindow should provide a menu that allows showing/hiding of the statusbar ( using KToggleStatusBarAction ).

The menu / menu item is implemented using xmlgui. It will be inserted in your menu structure in the 'Settings' menu.

Note that you should enable this feature before calling createGUI() ( or similar ).

If an application maintains the action on its own (i.e. never calls this function) a connection needs to be made to let KisKMainWindow know when that status (hidden/shown) of the statusbar has changed. For example: connect(action, SIGNAL(activated()), kmainwindow, SLOT(setSettingsDirty())); Otherwise the status (hidden/show) of the statusbar might not be saved by KisKMainWindow.

Definition at line 337 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    if (!d->showStatusBarAction) {
        d->showStatusBarAction = KStandardAction::showStatusbar(this, SLOT(setSettingsDirty()), actionCollection());
        QStatusBar *sb = statusBar(); // Creates statusbar if it doesn't exist already.
        connect(d->showStatusBarAction, SIGNAL(toggled(bool)), sb, SLOT(setVisible(bool)));
        d->showStatusBarAction->setChecked(sb->isHidden());
    } else {
        // If the language has changed, we'll need to grab the new text and whatsThis
        QAction *tmpStatusBar = KStandardAction::showStatusbar(0, 0, 0);
        d->showStatusBarAction->setText(tmpStatusBar->text());
        d->showStatusBarAction->setWhatsThis(tmpStatusBar->whatsThis());
        delete tmpStatusBar;
    }
}

References KisKXMLGUIClient::actionCollection(), connect(), KisKXMLGUIBuilder::d, K_D, KisKMainWindow::setSettingsDirty(), and KStandardAction::showStatusbar().

◆ event()

bool KXmlGuiWindow::event ( QEvent * event )

overrideprotected

Reimplemented to catch QEvent::Polish in order to adjust the object name if needed, once all constructor code for the main window has run. Also reimplemented to catch when a QDockWidget is added or removed.

Definition at line 110 of file kxmlguiwindow.cpp.

{
    bool ret = KisKMainWindow::event(ev);
#ifdef HAVE_DBUS
    if (ev->type() == QEvent::Polish) {
        QDBusConnection::sessionBus().registerObject(dbusName() + QStringLiteral("/actions"), actionCollection(),
                QDBusConnection::ExportScriptableSlots |
                QDBusConnection::ExportScriptableProperties |
                QDBusConnection::ExportNonScriptableSlots |
                QDBusConnection::ExportNonScriptableProperties |
                QDBusConnection::ExportChildObjects);
    }
#endif
    return ret;
}

References KisKXMLGUIClient::actionCollection(), KisKMainWindow::dbusName(), and KisKMainWindow::event().

◆ finalizeGUI() [1/2]

void KXmlGuiWindow::finalizeGUI ( bool force )

Definition at line 354 of file kxmlguiwindow.cpp.

{
    // FIXME: this really needs to be removed with a code more like the one we had on KDE3.
    //        what we need to do here is to position correctly toolbars so they don't overlap.
    //        Also, take in count plugins could provide their own toolbars and those also need to
    //        be restored.
    if (autoSaveSettings() && autoSaveConfigGroup().isValid()) {
        applyMainWindowSettings(autoSaveConfigGroup());
    }
}

References applyMainWindowSettings(), KisKMainWindow::autoSaveConfigGroup(), and autoSaveSettings.

◆ finalizeGUI() [2/2]

void KXmlGuiWindow::finalizeGUI ( KisKXMLGUIClient * client )

overridevirtual

Reimplemented from KisKXMLGUIBuilder.

Definition at line 377 of file kxmlguiwindow.cpp.

{
    KisKXMLGUIBuilder::finalizeGUI(client);
}

References KisKXMLGUIBuilder::finalizeGUI().

◆ guiFactory()

KisKXMLGUIFactory * KXmlGuiWindow::guiFactory ( )

virtual

Definition at line 138 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    if (!d->factory) {
        d->factory = new KisKXMLGUIFactory(this, this);
        connect(d->factory, SIGNAL(makingChanges(bool)),
                this, SLOT(_k_slotFactoryMakingChanges(bool)));
    }
    return d->factory;
}

References connect(), KisKXMLGUIBuilder::d, and K_D.

◆ isHelpMenuEnabled()

bool KXmlGuiWindow::isHelpMenuEnabled ( ) const

Return true when the help menu is enabled

Definition at line 132 of file kxmlguiwindow.cpp.

{
    K_D(const KXmlGuiWindow);
    return d->showHelpMenu;
}

References KisKXMLGUIBuilder::d, and K_D.

◆ isStandardToolBarMenuEnabled()

bool KXmlGuiWindow::isStandardToolBarMenuEnabled ( ) const

Definition at line 331 of file kxmlguiwindow.cpp.

{
    K_D(const KXmlGuiWindow);
    return (d->toolBarHandler);
}

References KisKXMLGUIBuilder::d, and K_D.

◆ saveNewToolbarConfig

void KXmlGuiWindow::saveNewToolbarConfig ( )

protectedvirtualslot

Rebuilds the GUI after KisKEditToolbar changed the toolbar layout.

See also: configureToolbars()

Definition at line 162 of file kxmlguiwindow.cpp.

{
    // createGUI(xmlFile()); // this loses any plugged-in guiclients, so we use remove+add instead.
 
    guiFactory()->removeClient(this);
    guiFactory()->addClient(this);
 
    KConfigGroup cg(KSharedConfig::openConfig(), "");
    applyMainWindowSettings(cg);
}

References KisKXMLGUIFactory::addClient(), applyMainWindowSettings(), guiFactory(), and KisKXMLGUIFactory::removeClient().

◆ setHelpMenuEnabled()

void KXmlGuiWindow::setHelpMenuEnabled ( bool showHelpMenu = true )

Enables the build of a standard help menu when calling createGUI/setupGUI().

The default behavior is to build one, you must call this function to disable it

Definition at line 126 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    d->showHelpMenu = showHelpMenu;
}

References KisKXMLGUIBuilder::d, and K_D.

◆ setStandardToolBarMenuEnabled()

void KXmlGuiWindow::setStandardToolBarMenuEnabled ( bool enable )

Sets whether KisKMainWindow should provide a menu that allows showing/hiding the available toolbars ( using KToggleToolBarAction ) . In case there is only one toolbar configured a simple 'Show <toolbar name here>' menu item is shown.

The menu / menu item is implemented using xmlgui. It will be inserted in your menu structure in the 'Settings' menu.

If your application uses a non-standard xmlgui resource file then you can specify the exact position of the menu / menu item by adding a <Merge name="StandardToolBarMenuHandler" /> line to the settings menu section of your resource file ( usually appname.xmlgui ).

Note that you should enable this feature before calling createGUI() ( or similar ) .

Definition at line 304 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    if (enable) {
        if (d->toolBarHandler) {
            return;
        }
 
        d->toolBarHandler = new KDEPrivate::ToolBarHandler(this);
 
        if (factory()) {
            factory()->addClient(d->toolBarHandler);
        }
    } else {
        if (!d->toolBarHandler) {
            return;
        }
 
        if (factory()) {
            factory()->removeClient(d->toolBarHandler);
        }
 
        delete d->toolBarHandler;
        d->toolBarHandler = 0;
    }
}

References KisKXMLGUIFactory::addClient(), KisKXMLGUIBuilder::d, KisKXMLGUIClient::factory(), K_D, and KisKXMLGUIFactory::removeClient().

◆ setupGUI() [1/2]

void KXmlGuiWindow::setupGUI	(	const QSize &	defaultSize,
		StandardWindowOptions	options = Default,
		const QString &	xmlfile = QString() )

Configures the current windows and its actions in the typical KDE fashion. The options are all enabled by default but can be turned off if desired through the params or if the prereqs don't exists.

defaultSize The default size of the window

Typically this function replaces createGUI().

See also: StandardWindowOptions

Note: Since this method will restore the state of the application (toolbar, dockwindows positions...), you need to have added all your actions to your toolbars etc before calling to this method. (This note is only applicable if you are using the Default or Save flag).

Warning: If you are calling createGUI yourself, remember to remove the Create flag from the options parameter. Also, call setupGUI always after you call createGUI.

Definition at line 178 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    if (options & Keys) {
        KStandardAction::keyBindings(guiFactory(),
                                     SLOT(configureShortcuts()), actionCollection());
    }
    if ((options & StatusBar) && statusBar()) {
        createStandardStatusBarAction();
    }
 
    if (options & ToolBar) {
        setStandardToolBarMenuEnabled(true);
        KStandardAction::configureToolbars(this,
                                           SLOT(configureToolbars()), actionCollection());
    }
 
    d->defaultSize = defaultSize;
 
    if (options & Create) {
        createGUI(xmlfile);
    }
 
    if (d->defaultSize.isValid()) {
        resize(d->defaultSize);
    } else if (isHidden()) {
        adjustSize();
    }
 
    if (options & Save) {
        const KConfigGroup cg(autoSaveConfigGroup());
        if (cg.isValid()) {
            setAutoSaveSettings(cg);
        } else {
            setAutoSaveSettings();
        }
    }
}

References KisKXMLGUIClient::actionCollection(), KisKMainWindow::autoSaveConfigGroup(), configureToolbars(), KStandardAction::configureToolbars(), Create, createGUI(), createStandardStatusBarAction(), KisKXMLGUIBuilder::d, guiFactory(), K_D, KStandardAction::keyBindings(), Keys, Save, KisKMainWindow::setAutoSaveSettings(), setStandardToolBarMenuEnabled(), StatusBar, and ToolBar.

◆ setupGUI() [2/2]

void KXmlGuiWindow::setupGUI	(	StandardWindowOptions	options = Default,
		const QString &	xmlfile = QString() )

Configures the current windows and its actions in the typical KDE fashion. The options are all enabled by default but can be turned off if desired through the params or if the prereqs don't exists.

Typically this function replaces createGUI().

See also: StandardWindowOptions

Note: Since this method will restore the state of the application (toolbar, dockwindows positions...), you need to have added all your actions to your toolbars etc before calling to this method. (This note is only applicable if you are using the Default or Save flag).

Warning: If you are calling createGUI yourself, remember to remove the Create flag from the options parameter.

Definition at line 173 of file kxmlguiwindow.cpp.

{
    setupGUI(QSize(), options, xmlfile);
}

References setupGUI().

◆ setupToolbarMenuActions()

void KXmlGuiWindow::setupToolbarMenuActions ( )

Definition at line 96 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    if (d->toolBarHandler) {
        d->toolBarHandler->setupActions();
    }
}

References KisKXMLGUIBuilder::d, and K_D.

◆ slotStateChanged [1/2]

void KXmlGuiWindow::slotStateChanged ( const QString & newstate )

virtualslot

Apply a state change

Enable and disable actions as defined in the XML rc file

Definition at line 292 of file kxmlguiwindow.cpp.

{
    stateChanged(newstate, KisKXMLGUIClient::StateNoReverse);
}

References KisKXMLGUIClient::stateChanged(), and KisKXMLGUIClient::StateNoReverse.

◆ slotStateChanged [2/2]

void KXmlGuiWindow::slotStateChanged	(	const QString &	newstate,
		bool	reverse )

slot

Apply a state change

Enable and disable actions as defined in the XML rc file, can "reverse" the state (disable the actions which should be enabled, and vice-versa) if specified.

Definition at line 297 of file kxmlguiwindow.cpp.

{
    stateChanged(newstate,
                 reverse ? KisKXMLGUIClient::StateReverse : KisKXMLGUIClient::StateNoReverse);
}

References KisKXMLGUIClient::stateChanged(), KisKXMLGUIClient::StateNoReverse, and KisKXMLGUIClient::StateReverse.

◆ toolBarMenuAction()

QAction * KXmlGuiWindow::toolBarMenuAction ( )

Returns a pointer to the mainwindows action responsible for the toolbars menu

Definition at line 86 of file kxmlguiwindow.cpp.

{
    K_D(KXmlGuiWindow);
    if (!d->toolBarHandler) {
        return 0;
    }
 
    return d->toolBarHandler->toolBarMenuAction();
}

References KisKXMLGUIBuilder::d, and K_D.

Property Documentation

◆ autoSaveGroup

QString KXmlGuiWindow::autoSaveGroup

read

Definition at line 52 of file kxmlguiwindow.h.

◆ autoSaveSettings

bool KXmlGuiWindow::autoSaveSettings

read

Definition at line 51 of file kxmlguiwindow.h.

◆ hasMenuBar

bool KXmlGuiWindow::hasMenuBar

read

Definition at line 50 of file kxmlguiwindow.h.

◆ standardToolBarMenuEnabled

bool KXmlGuiWindow::standardToolBarMenuEnabled

readwrite

Definition at line 53 of file kxmlguiwindow.h.

The documentation for this class was generated from the following files:

libs/widgetutils/xmlgui/kxmlguiwindow.h
libs/widgetutils/xmlgui/kxmlguiwindow.cpp

Public Types

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ StandardWindowOption

Constructor & Destructor Documentation

◆ KXmlGuiWindow()

◆ ~KXmlGuiWindow()

Member Function Documentation

◆ applyMainWindowSettings()

◆ configureToolbars

◆ createGUI()

◆ createStandardStatusBarAction()

◆ event()

◆ finalizeGUI() [1/2]

◆ finalizeGUI() [2/2]

◆ guiFactory()

◆ isHelpMenuEnabled()

◆ isStandardToolBarMenuEnabled()

◆ saveNewToolbarConfig

◆ setHelpMenuEnabled()

◆ setStandardToolBarMenuEnabled()

◆ setupGUI() [1/2]

◆ setupGUI() [2/2]

◆ setupToolbarMenuActions()

◆ slotStateChanged [1/2]

◆ slotStateChanged [2/2]

◆ toolBarMenuAction()

Property Documentation

◆ autoSaveGroup

◆ autoSaveSettings

◆ hasMenuBar

◆ standardToolBarMenuEnabled