KisKMainWindow Class Reference

KDE top level main window More...

#include <kmainwindow.h>

Inheritance diagram for KisKMainWindow:

Public Slots
void	appHelpActivated (void)
void	setSettingsDirty ()

Public Member Functions
virtual void	applyMainWindowSettings (const KConfigGroup &config)
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.

Static Public Member Functions
static bool	canBeRestored (int number)
static const QString	classNameOfToplevel (int number)
static QList< KisKMainWindow * >	memberList ()

Protected Slots
void	saveAutoSaveSettings ()

Protected Member Functions
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 Attributes
KisKMainWindowPrivate *const	k_ptr

Properties
QString	autoSaveGroup
bool	autoSaveSettings
bool	hasMenuBar

Private Member Functions
	Q_PRIVATE_SLOT (k_func(), void _k_slotSettingsChanged(int)) Q_PRIVATE_SLOT(k_func()

Friends
class	DockResizeListener
class	KMWSessionManager

Detailed Description

KDE top level main window

Top level widget that provides toolbars, a status line and a frame.

It should be used as a top level (parent-less) widget. It manages the geometry for all its children, including your main widget.

Normally, you will inherit from KisKMainWindow, then construct (or use some existing) widget as your main view. You can set only one main view.

You can add as many toolbars as you like. There can be only one menubar and only one statusbar.

The toolbars, menubar, and statusbar can be created by the KisKMainWindow and - unlike the old KisKMainWindow - may, but do not have to, be deleted by you. KisKMainWindow will handle that internally.

Height and width can be operated independently from each other. Simply define the minimum/maximum height/width of your main widget and KisKMainWindow will take this into account. For fixed size windows set your main widget to a fixed size.

Fixed aspect ratios (heightForWidth()) and fixed width widgets are not supported.

KisKMainWindow will set icon, mini icon and caption, which it gets from KApplication. It provides full session management, and will save its position, geometry and positions of toolbars and menubar on logout. If you want to save additional data, reimplement saveProperties() and (to read them again on next login) readProperties(). To save special data about your data, reimplement saveGlobalProperties(). To warn user that application or windows have unsaved data on close or logout, reimplement queryClose().

You have to implement session restoring also in your main() function. There are also kRestoreMainWindows convenience functions which can do this for you and restore all your windows on next login.

Note that KisKMainWindow uses KGlobal::ref() and KGlobal::deref() so that closing the last mainwindow will quit the application unless there is still something that holds a ref in KGlobal - like a KIO job, or a systray icon.

See also

KApplication

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 David Faure (faure.nosp@m.@kde.nosp@m..org)

Definition at line 88 of file kmainwindow.h.

Constructor & Destructor Documentation

KisKMainWindow() [1/2]

KisKMainWindow::KisKMainWindow ( 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 window flags. The default is none.

Note that a KisKMainWindow per-default is created with the WA_DeleteOnClose attribute, i.e. it is automatically destroyed when the window is closed. If you do not want this behavior, call setAttribute(Qt::WA_DeleteOnClose, false);

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

KisKMainWindow *kmw = new KisKMainWindow(...);
kmw->setObjectName(...);

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 159 of file kmainwindow.cpp.

    : QMainWindow(parent, f), k_ptr(new KisKMainWindowPrivate)
{
    k_ptr->init(this);
}

~KisKMainWindow()

KisKMainWindow::~KisKMainWindow ( )

override

Destructor.

Will also destroy the toolbars, and menubar if needed.

Definition at line 337 of file kmainwindow.cpp.

{
    sMemberList()->removeAll(this);
    delete static_cast<QObject *>(k_ptr->dockResizeListener);  //so we don't get anymore events after k_ptr is destroyed
    delete k_ptr;
}

References KisKMainWindowPrivate::dockResizeListener, and k_ptr.

KisKMainWindow() [2/2]

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

protected

Definition at line 165 of file kmainwindow.cpp.

    : QMainWindow(parent, f), k_ptr(&dd)
{
    k_ptr->init(this);
}

References KisKMainWindowPrivate::init(), and k_ptr.

Member Function Documentation

appHelpActivated

void KisKMainWindow::appHelpActivated ( void )

slot

Open the help page for the application.

The application name is used as a key to determine what to display and the system will attempt to open <appName>/index.html.

This method is intended for use by a help button in the toolbar or components outside the regular help menu. Use helpMenu() when you want to provide access to the help system from the help menu.

Example (adding a help button to the first toolbar):

toolBar(0)->addAction(KisIconUtils::loadIcon("help-contents"), i18n("Help"),
                      this, SLOT(appHelpActivated()));

Definition at line 398 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    if (!d->helpMenu) {
        d->helpMenu = new KisKHelpMenu(this);
        if (!d->helpMenu) {
            return;
        }
    }
    d->helpMenu->appHelpActivated();
}

References K_D.

applyMainWindowSettings()

void KisKMainWindow::applyMainWindowSettings ( const KConfigGroup & config )

virtual

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 in KXmlGuiWindow.

Definition at line 562 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    //qDebug(200) << "KisKMainWindow::applyMainWindowSettings " << cg.name();
 
    QWidget *focusedWidget = QApplication::focusWidget();
 
    const bool oldLetDirtySettings = d->letDirtySettings;
    d->letDirtySettings = false;
 
    if (!d->sizeApplied) {
        winId(); // ensure there's a window created
        KWindowConfig::restoreWindowSize(windowHandle(), cg);
        // NOTICE: QWindow::setGeometry() does NOT impact the backing QWidget geometry even if the platform
        // window was created -> QTBUG-40584. We therefore copy the size here.
        // TODO: remove once this was resolved in QWidget QPA
        resize(windowHandle()->size());
        d->sizeApplied = true;
    }
 
    QStatusBar *sb = internalStatusBar(this);
    if (sb) {
        QString entry = cg.readEntry("StatusBar", "Enabled");
        sb->setVisible( entry != QLatin1String("Disabled") );
    }
 
    QMenuBar *mb = internalMenuBar(this);
    if (mb && !mb->isNativeMenuBar()) {
        QString entry = cg.readEntry("MenuBar", "Enabled");
#ifdef Q_OS_ANDROID
        // HACK: Previously, since the native menubar was enabled, this made the
        // value in Config = "Disabled". This makes the menubar not show up on
        // devices.
        entry = QLatin1String("Enabled");
#endif
        mb->setVisible( entry != QLatin1String("Disabled") );
    }
 
    {
        QString entry = cg.readEntry("ToolBarsMovable", "Disabled");
        KisToolBar::setToolBarsLocked(entry == QLatin1String("Disabled"));
    }
 
    int n = 1; // Toolbar counter. toolbars are counted from 1,
    foreach (KisToolBar *toolbar, toolBars()) {
        QByteArray groupName("Toolbar");
        // Give a number to the toolbar, but prefer a name if there is one,
        // because there's no real guarantee on the ordering of toolbars
        groupName += (toolbar->objectName().isEmpty() ? QByteArray::number(n) : QByteArray(" ").append(toolbar->objectName().toUtf8()));
 
        KConfigGroup toolbarGroup(&cg, groupName.constData());
        toolbar->applySettings(toolbarGroup);
        n++;
    }
 
    QByteArray state;
    if (cg.hasKey("State")) {
        state = cg.readEntry("State", state);
        state = QByteArray::fromBase64(state);
        // One day will need to load the version number, but for now, assume 0
        restoreState(state);
    }
 
    if (focusedWidget) {
        focusedWidget->setFocus();
    }
 
    d->settingsDirty = false;
    d->letDirtySettings = oldLetDirtySettings;
}

References KisToolBar::applySettings(), internalMenuBar(), internalStatusBar(), K_D, KisToolBar::setToolBarsLocked(), and toolBars().

autoSaveConfigGroup()

KConfigGroup KisKMainWindow::autoSaveConfigGroup

(

)

const

Returns

the group used for setting-autosaving. Only meaningful if setAutoSaveSettings() was called. This can be useful for forcing an apply, e.g. after using KisKEditToolbar.

Since

4.1

Definition at line 692 of file kmainwindow.cpp.

{
    K_D(const KisKMainWindow);
    return d->autoSaveSettings ? d->autoSaveGroup : KConfigGroup();
}

References K_D.

autoSaveGroup()

QString KisKMainWindow::autoSaveGroup

(

)

const

Returns

the group used for setting-autosaving. Only meaningful if setAutoSaveSettings(QString) was called. This can be useful for forcing a save or an apply, e.g. before and after using KisKEditToolbar.

NOTE: you should rather use saveAutoSaveSettings() for saving or autoSaveConfigGroup() for loading. This method doesn't make sense if setAutoSaveSettings(KConfigGroup) was called.

Definition at line 686 of file kmainwindow.cpp.

{
    K_D(const KisKMainWindow);
    return d->autoSaveSettings ? d->autoSaveGroup.name() : QString();
}

References K_D.

autoSaveSettings()

bool KisKMainWindow::autoSaveSettings

(

)

const

Returns

the current autosave setting, i.e. true if setAutoSaveSettings() was called, false by default or if resetAutoSaveSettings() was called.

Definition at line 680 of file kmainwindow.cpp.

{
    K_D(const KisKMainWindow);
    return d->autoSaveSettings;
}

References K_D.

canBeRestored()

bool KisKMainWindow::canBeRestored ( int number )

static

If the session did contain so high a number, true is returned, else false.

See also

restore()

Definition at line 344 of file kmainwindow.cpp.

{
    if (!qApp->isSessionRestored()) {
        return false;
    }
    KConfig *config = KConfigGui::sessionConfig();
    if (!config) {
        return false;
    }
 
    KConfigGroup group(config, "Number");
    const int n = group.readEntry("NumberOfWindows", 1);
    return number >= 1 && number <= n;
}

classNameOfToplevel()

const QString KisKMainWindow::classNameOfToplevel ( int number )

static

Returns the className() of the number of the toplevel window which should be restored.

This is only useful if your application uses different kinds of toplevel windows.

Definition at line 359 of file kmainwindow.cpp.

{
    return QString();
#if 0
    if (!qApp->isSessionRestored()) {
        return QString();
    }
    KConfig *config = KConfigGui::sessionConfig();
    if (!config) {
        return QString();
    }
 
    KConfigGroup group(config, QByteArray(WINDOW_PROPERTIES).append(QByteArray::number(number)).constData());
    if (!group.hasKey("ClassName")) {
        return QString();
    } else {
        return group.readEntry("ClassName");
    }
#endif
}

References WINDOW_PROPERTIES.

closeEvent()

void KisKMainWindow::closeEvent ( QCloseEvent * e )

overrideprotected

Reimplemented to autosave settings and call queryClose().

We recommend that you reimplement queryClose() rather than closeEvent(). If you do it anyway, ensure to call the base implementation to keep the feature of auto-saving window settings working.

Definition at line 410 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
 
    // Save settings if auto-save is enabled, and settings have changed
    if (d->settingsTimer && d->settingsTimer->isActive()) {
        d->settingsTimer->stop();
        saveAutoSaveSettings();
    }
    if (d->sizeTimer && d->sizeTimer->isActive()) {
        d->sizeTimer->stop();
        d->_k_slotSaveAutoSaveSize();
    }
 
    if (queryClose()) {
        // widgets will start destroying themselves at this point and we don't
        // want to save state anymore after this as it might be incorrect
        d->autoSaveSettings = false;
        d->letDirtySettings = false;
        e->accept();
    } else {
        e->ignore();    //if the window should not be closed, don't close it
    }
}

References K_D, queryClose(), and saveAutoSaveSettings().

dbusName()

QString KisKMainWindow::dbusName

(

)

const

Returns the path under which this window's D-Bus object is exported.

Since

4.0.1

Definition at line 832 of file kmainwindow.cpp.

{
    return k_func()->dbusName;
}

event()

bool KisKMainWindow::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 708 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    switch (ev->type()) {
#ifdef Q_OS_WIN
    case QEvent::Move:
#endif
    case QEvent::Resize:
        d->setSizeDirty();
        break;
    case QEvent::Polish:
        d->polish(this);
        break;
    case QEvent::ChildPolished: {
        QChildEvent *event = static_cast<QChildEvent *>(ev);
        QDockWidget *dock = qobject_cast<QDockWidget *>(event->child());
        KisToolBar *toolbar = qobject_cast<KisToolBar *>(event->child());
        QMenuBar *menubar = qobject_cast<QMenuBar *>(event->child());
        if (dock) {
            connect(dock, SIGNAL(dockLocationChanged(Qt::DockWidgetArea)),
                    this, SLOT(setSettingsDirty()));
            connect(dock, SIGNAL(visibilityChanged(bool)),
                    this, SLOT(setSettingsDirty()), Qt::QueuedConnection);
            connect(dock, SIGNAL(topLevelChanged(bool)),
                    this, SLOT(setSettingsDirty()));
 
            // there is no signal emitted if the size of the dock changes,
            // hence install an event filter instead
            dock->installEventFilter(k_ptr->dockResizeListener);
        } else if (toolbar) {
            // there is no signal emitted if the size of the toolbar changes,
            // hence install an event filter instead
            toolbar->installEventFilter(k_ptr->dockResizeListener);
        } else if (menubar) {
            // there is no signal emitted if the size of the menubar changes,
            // hence install an event filter instead
            menubar->installEventFilter(k_ptr->dockResizeListener);
        }
    }
    break;
    case QEvent::ChildRemoved: {
        QChildEvent *event = static_cast<QChildEvent *>(ev);
        QDockWidget *dock = qobject_cast<QDockWidget *>(event->child());
        KisToolBar *toolbar = qobject_cast<KisToolBar *>(event->child());
        QMenuBar *menubar = qobject_cast<QMenuBar *>(event->child());
        if (dock) {
            disconnect(dock, SIGNAL(dockLocationChanged(Qt::DockWidgetArea)),
                       this, SLOT(setSettingsDirty()));
            disconnect(dock, SIGNAL(visibilityChanged(bool)),
                       this, SLOT(setSettingsDirty()));
            disconnect(dock, SIGNAL(topLevelChanged(bool)),
                       this, SLOT(setSettingsDirty()));
            dock->removeEventFilter(k_ptr->dockResizeListener);
        } else if (toolbar) {
            toolbar->removeEventFilter(k_ptr->dockResizeListener);
        } else if (menubar) {
            menubar->removeEventFilter(k_ptr->dockResizeListener);
        }
    }
    break;
    default:
        break;
    }
    return QMainWindow::event(ev);
}

References connect(), KisKMainWindowPrivate::dockResizeListener, event(), K_D, k_ptr, and setSettingsDirty().

hasMenuBar()

bool KisKMainWindow::hasMenuBar

(

)

Returns true, if there is a menubar

memberList()

QList< KisKMainWindow * > KisKMainWindow::memberList ( )

static

List of members of KisKMainWindow class.

Definition at line 827 of file kmainwindow.cpp.

{
    return *sMemberList();
}

Q_PRIVATE_SLOT()

KisKMainWindow::Q_PRIVATE_SLOT ( k_func() , void _k_slotSettingsChangedint )

private

queryClose()

bool KisKMainWindow::queryClose ( )

protectedvirtual

Called before the window is closed, either by the user or indirectly by the session manager.

The purpose of this function is to prepare the window in a way that it is safe to close it, i.e. without the user losing some data.

Default implementation returns true. Returning false will cancel the closing, and, if KApplication::sessionSaving() is true, it will also cancel KDE logout.

Reimplement this function to prevent the user from losing data. Example:

switch ( KMessageBox::warningYesNoCancel( this,
         i18n("Save changes to document foo?")) ) {
case KMessageBox::Yes :
  // save document here. If saving fails, return false;
  return true;
case KMessageBox::No :
  return true;
default: // cancel
  return false;

Note that you should probably not actually close the document from within this method, as it may be called by the session manager before the session is saved. If the document is closed before the session save occurs, its location might not be properly saved. In addition, the session shutdown may be canceled, in which case the document should remain open.

See also

KApplication::sessionSaving()

Definition at line 435 of file kmainwindow.cpp.

{
    return true;
}

readGlobalProperties()

void KisKMainWindow::readGlobalProperties ( KConfig * sessionConfig )

protectedvirtual

The counterpart of saveGlobalProperties().

Read the application-specific properties in again.

Definition at line 444 of file kmainwindow.cpp.

{
}

readProperties()

virtual void KisKMainWindow::readProperties ( const KConfigGroup & )

inlineprotectedvirtual

Read your instance-specific properties.

Is called indirectly by restore().

Definition at line 422 of file kmainwindow.h.

{}

readPropertiesInternal()

bool KisKMainWindow::readPropertiesInternal ( KConfig * config, int number )

protected

Definition at line 531 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
 
    const bool oldLetDirtySettings = d->letDirtySettings;
    d->letDirtySettings = false;
 
    if (number == 1) {
        readGlobalProperties(config);
    }
 
    // in order they are in toolbar list
    KConfigGroup cg(config, QByteArray(WINDOW_PROPERTIES).append(QByteArray::number(number)).constData());
 
    // restore the object name (window role)
    if (cg.hasKey("ObjectName")) {
        setObjectName(cg.readEntry("ObjectName"));
    }
 
    d->sizeApplied = false; // since we are changing config file, reload the size of the window
    // if necessary. Do it before the call to applyMainWindowSettings.
    applyMainWindowSettings(cg); // Menubar, statusbar and toolbar settings.
 
    KConfigGroup grp(config, QByteArray::number(number).constData());
    readProperties(grp);
 
    d->letDirtySettings = oldLetDirtySettings;
 
    return true;
}

References applyMainWindowSettings(), K_D, readGlobalProperties(), readProperties(), and WINDOW_PROPERTIES.

resetAutoSaveSettings()

void KisKMainWindow::resetAutoSaveSettings

(

)

Disable the auto-save-settings feature. You don't normally need to call this, ever.

Definition at line 671 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    d->autoSaveSettings = false;
    if (d->settingsTimer) {
        d->settingsTimer->stop();
    }
}

References K_D.

restore()

bool KisKMainWindow::restore	(	int	number,
		bool	show = true )

Try to restore the toplevel widget as defined by number (1..X).

You should call canBeRestored() first.

If the session did not contain so high a number, the configuration is not changed and false returned.

That means clients could simply do the following:

if (qApp->isSessionRestored()){
  int n = 1;
  while (KisKMainWindow::canBeRestored(n)){
    (new childMW)->restore(n);
    n++;
  }
} else {
  // create default application as usual
}

Note that if show is true (default), QWidget::show() is called implicitly in restore.

With this you can easily restore all toplevel windows of your application.

If your application uses different kinds of toplevel windows, then you can use KisKMainWindow::classNameOfToplevel(n) to determine the exact type before calling the childMW constructor in the example from above.

Note that you don't need to deal with this function. Use the kRestoreMainWindows() convenience template function instead!

See also

kRestoreMainWindows()

readProperties()

canBeRestored()

Definition at line 380 of file kmainwindow.cpp.

{
#if 0
    if (!canBeRestored(number)) {
        return false;
    }
    KConfig *config = KConfigGui::sessionConfig();
    if (readPropertiesInternal(config, number)) {
        if (show) {
            KisKMainWindow::show();
        }
        return false;
    }
#endif
    return false;
}

References canBeRestored(), and readPropertiesInternal().

saveAutoSaveSettings

void KisKMainWindow::saveAutoSaveSettings ( )

protectedslot

This slot should only be called in case you reimplement closeEvent() and if you are using the "auto-save" feature. In all other cases, setSettingsDirty() should be called instead to benefit from the delayed saving.

See also

setAutoSaveSettings

setSettingsDirty

Example:

void MyMainWindow::closeEvent( QCloseEvent *e )
{
  // Save settings if auto-save is enabled, and settings have changed
  if ( settingsDirty() && autoSaveSettings() )
    saveAutoSaveSettings();
  ..
}

Definition at line 698 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    Q_ASSERT(d->autoSaveSettings);
    //qDebug(200) << "KisKMainWindow::saveAutoSaveSettings -> saving settings";
    saveMainWindowSettings(d->autoSaveGroup);
    d->autoSaveGroup.sync();
    d->settingsDirty = false;
}

References K_D, and saveMainWindowSettings().

saveGlobalProperties()

void KisKMainWindow::saveGlobalProperties ( KConfig * sessionConfig )

protectedvirtual

Save your application-wide properties. The function is invoked when the session manager requests your application to save its state.

This function is similar to saveProperties() but is only called for the very first main window, regardless how many main window are open.

Override it if you need to save other data about your documents on session end. sessionConfig is a config to which that data should be saved. Normally, you don't need this function. But if you want to save data about your documents that are not in opened windows you might need it.

Default implementation does nothing.

Definition at line 440 of file kmainwindow.cpp.

{
}

saveMainWindowSettings()

void KisKMainWindow::saveMainWindowSettings

(

KConfigGroup &

config

)

Save settings for statusbar, menubar and toolbar to their respective groups in the config group config.

Parameters

config

Config group to save the settings to.

Definition at line 469 of file kmainwindow.cpp.

{
    if (!windowsLayoutSavingAllowed()) return;
 
    K_D(KisKMainWindow);
    //qDebug(200) << "KisKMainWindow::saveMainWindowSettings " << cg.name();
 
    // Called by session management - or if we want to save the window size anyway
    if (d->autoSaveWindowSize) {
        KWindowConfig::saveWindowSize(windowHandle(), cg);
    }
 
    // One day will need to save the version number, but for now, assume 0
    // Utilize the QMainWindow::saveState() functionality.
    const QByteArray state = saveState();
    cg.writeEntry("State", state.toBase64());
 
    QStatusBar *sb = internalStatusBar(this);
    if (sb) {
        if (!cg.hasDefault("StatusBar") && !sb->isHidden()) {
            cg.revertToDefault("StatusBar");
        } else {
            cg.writeEntry("StatusBar", sb->isHidden() ? "Disabled" : "Enabled");
        }
    }
 
    QMenuBar *mb = internalMenuBar(this);
    if (mb && !mb->isNativeMenuBar()) {
        if (!cg.hasDefault("MenuBar") && !mb->isHidden()) {
            cg.revertToDefault("MenuBar");
        } else {
            // with native Menu Bar we don't have an easy way of knowing if it
            // is Enabled or not, so we assume it is to prevent any mishap if
            // the flag is toggled
            if (!QCoreApplication::testAttribute(Qt::AA_DontUseNativeMenuBar)) {
                cg.writeEntry("MenuBar", "Enabled");
            }
            cg.writeEntry("MenuBar", mb->isHidden() ? "Disabled" : "Enabled");
        }
    }
 
    {
        if (!cg.hasDefault("ToolBarsMovable") && KisToolBar::toolBarsLocked()) {
            cg.revertToDefault("ToolBarsMovable");
        } else {
            cg.writeEntry("ToolBarsMovable", KisToolBar::toolBarsLocked() ? "Disabled" : "Enabled");
        }
    }
 
    int n = 1; // Toolbar counter. toolbars are counted from 1,
    foreach (KisToolBar *toolbar, toolBars()) {
        QByteArray groupName("Toolbar");
        // Give a number to the toolbar, but prefer a name if there is one,
        // because there's no real guarantee on the ordering of toolbars
        groupName += (toolbar->objectName().isEmpty() ? QByteArray::number(n) : QByteArray(" ").append(toolbar->objectName().toUtf8()));
 
        KConfigGroup toolbarGroup(&cg, groupName.constData());
        toolbar->saveSettings(toolbarGroup);
        n++;
    }
}

References internalMenuBar(), internalStatusBar(), K_D, KisToolBar::saveSettings(), toolBars(), KisToolBar::toolBarsLocked(), and windowsLayoutSavingAllowed().

saveProperties()

virtual void KisKMainWindow::saveProperties ( KConfigGroup & )

inlineprotectedvirtual

Save your instance-specific properties. The function is invoked when the session manager requests your application to save its state.

Please reimplement these function in childclasses.

Note: No user interaction is allowed in this function!

Definition at line 415 of file kmainwindow.h.

{}

savePropertiesInternal()

void KisKMainWindow::savePropertiesInternal ( KConfig * config, int number )

protected

Definition at line 448 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    const bool oldASWS = d->autoSaveWindowSize;
    d->autoSaveWindowSize = true; // make saveMainWindowSettings save the window size
 
    KConfigGroup cg(config, QByteArray(WINDOW_PROPERTIES).append(QByteArray::number(number)).constData());
 
    // store objectName, className, Width and Height  for later restoring
    // (Only useful for session management)
    cg.writeEntry("ObjectName", objectName());
    cg.writeEntry("ClassName", metaObject()->className());
 
    saveMainWindowSettings(cg); // Menubar, statusbar and Toolbar settings.
 
    cg = KConfigGroup(config, QByteArray::number(number).constData());
    saveProperties(cg);
 
    d->autoSaveWindowSize = oldASWS;
}

References K_D, saveMainWindowSettings(), saveProperties(), and WINDOW_PROPERTIES.

setAutoSaveSettings() [1/2]

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

Overload that lets you specify a KConfigGroup. This allows the settings to be saved into another file than KSharedConfig::openConfig().

Since

4.1

Definition at line 655 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    d->autoSaveSettings = true;
    d->autoSaveGroup = group;
    d->autoSaveWindowSize = saveWindowSize;
 
    if (!saveWindowSize && d->sizeTimer) {
        d->sizeTimer->stop();
    }
 
    // Now read the previously saved settings
    applyMainWindowSettings(d->autoSaveGroup);
}

References applyMainWindowSettings(), and K_D.

setAutoSaveSettings() [2/2]

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

Call this to enable "auto-save" of toolbar/menubar/statusbar settings (and optionally window size). If the *bars were moved around/shown/hidden when the window is closed, saveMainWindowSettings( KConfigGroup(KSharedConfig::openConfig(), groupName) ) will be called.

Parameters

groupName	a name that identifies this "type of window". You can have several types of window in the same application.
saveWindowSize	set it to true to include the window size when saving.

Typically, you will call setAutoSaveSettings() in your KisKMainWindow-inherited class constructor, and it will take care of restoring and saving automatically. Make sure you call this after all your *bars have been created.

To make sure that KisKMainWindow properly obtains the default size of the window you should do the following:

• Remove hard coded resize() calls in the constructor or main, they should be removed in favor of letting the automatic resizing determine the default window size. Hard coded window sizes will be wrong for users that have big fonts, use different styles, long/small translations, large toolbars, and other factors.
• Put the setAutoSaveSettings ( or setupGUI() ) call after all widgets have been created and placed inside the main window (i.e. for 99% of apps setCentralWidget())
• Widgets that inherit from QWidget (like game boards) should overload "virtual QSize sizeHint() const;" to specify a default size rather than letting QWidget::adjust use the default size of 0x0.

Definition at line 650 of file kmainwindow.cpp.

{
    setAutoSaveSettings(KConfigGroup(KSharedConfig::openConfig(), groupName), saveWindowSize);
}

References setAutoSaveSettings().

setSettingsDirty

void KisKMainWindow::setSettingsDirty ( )

slot

Tell the main window that it should save its settings when being closed. This is part of the auto-save-settings feature. For everything related to toolbars this happens automatically, but you have to call setSettingsDirty() in the slot that toggles the visibility of the statusbar.

Definition at line 633 of file kmainwindow.cpp.

{
    K_D(KisKMainWindow);
    d->setSettingsDirty();
}

References K_D.

settingsDirty()

bool KisKMainWindow::settingsDirty ( ) const

protected

For inherited classes

Definition at line 639 of file kmainwindow.cpp.

{
    K_D(const KisKMainWindow);
    return d->settingsDirty;
}

References K_D.

toolBar()

KisToolBar * KisKMainWindow::toolBar

(

const QString &

name = QString()

)

Returns a pointer to the toolbar with the specified name. This refers to toolbars created dynamically from the XML UI framework. If the toolbar does not exist one will be created.

Parameters

name	The internal name of the toolbar. If no name is specified "mainToolBar" is assumed.

Returns

A pointer to the toolbar

Definition at line 799 of file kmainwindow.cpp.

{
    QString childName = name;
    if (childName.isEmpty()) {
        childName = QStringLiteral("mainToolBar");
    }
 
    KisToolBar *tb = findChild<KisToolBar *>(childName);
    if (tb) {
        return tb;
    }
 
    KisToolBar *toolbar = new KisToolBar(childName, this); // non-XMLGUI toolbar
    return toolbar;
}

toolBars()

QList< KisToolBar * > KisKMainWindow::toolBars

(

)

const

Returns

A list of all toolbars for this window

Definition at line 815 of file kmainwindow.cpp.

{
    QList<KisToolBar *> ret;
 
    foreach (QObject *child, children())
        if (KisToolBar *toolBar = qobject_cast<KisToolBar *>(child)) {
            ret.append(toolBar);
        }
 
    return ret;
}

References toolBar().

windowsLayoutSavingAllowed()

bool KisKMainWindow::windowsLayoutSavingAllowed ( ) const

protectedvirtual

Reimplemented in KisMainWindow.

Definition at line 645 of file kmainwindow.cpp.

{
    return true;
}

Friends And Related Symbol Documentation

DockResizeListener

friend class DockResizeListener

friend

Definition at line 91 of file kmainwindow.h.

KMWSessionManager

friend class KMWSessionManager

friend

Definition at line 90 of file kmainwindow.h.

Member Data Documentation

k_ptr

KisKMainWindowPrivate* const KisKMainWindow::k_ptr

protected

Definition at line 486 of file kmainwindow.h.

Property Documentation

autoSaveGroup

QString KisKMainWindow::autoSaveGroup

read

Definition at line 96 of file kmainwindow.h.

autoSaveSettings

bool KisKMainWindow::autoSaveSettings

read

Definition at line 95 of file kmainwindow.h.

hasMenuBar

bool KisKMainWindow::hasMenuBar

read

Definition at line 94 of file kmainwindow.h.

---

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

• libs/widgetutils/xmlgui/kmainwindow.h
• libs/widgetutils/xmlgui/kmainwindow.cpp