Search for usage in LXR

#include <KMainWindow>

Inheritance diagram for KMainWindow:


QString autoSaveGroup
bool autoSaveSettings
bool hasMenuBar
- Properties inherited from QMainWindow
- Properties inherited from QWidget
- Properties inherited from QObject

Public Slots

void appHelpActivated ()
virtual void setCaption (const QString &caption)
virtual void setCaption (const QString &caption, bool modified)
virtual void setPlainCaption (const QString &caption)
void setSettingsDirty ()

Public Member Functions

 KMainWindow (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 ~KMainWindow () override
virtual void applyMainWindowSettings (const KConfigGroup &config)
KConfigGroup autoSaveConfigGroup () const
QString autoSaveGroup () const
bool autoSaveSettings () const
QMenucustomHelpMenu (bool showWhatsThis=true)
QString dbusName () const
bool hasMenuBar ()
QMenuhelpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true)
bool initialGeometrySet () const
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=QStringLiteral("MainWindow"), bool saveWindowSize=true)
void setStateConfigGroup (const QString &configGroup)
KConfigGroup stateConfigGroup () const
KToolBartoolBar (const QString &name=QString())
QList< KToolBar * > toolBars () const
- Public Member Functions inherited from QMainWindow
 QMainWindow (QWidget *parent, Qt::WindowFlags flags)
void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget)
void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dockwidget, Qt::Orientation orientation)
QToolBaraddToolBar (const QString &title)
void addToolBar (Qt::ToolBarArea area, QToolBar *toolbar)
void addToolBar (QToolBar *toolbar)
void addToolBarBreak (Qt::ToolBarArea area)
QWidgetcentralWidget () const const
Qt::DockWidgetArea corner (Qt::Corner corner) const const
virtual QMenucreatePopupMenu ()
QMainWindow::DockOptions dockOptions () const const
Qt::DockWidgetArea dockWidgetArea (QDockWidget *dockwidget) const const
bool documentMode () const const
QSize iconSize () const const
void iconSizeChanged (const QSize &iconSize)
void insertToolBar (QToolBar *before, QToolBar *toolbar)
void insertToolBarBreak (QToolBar *before)
bool isAnimated () const const
bool isDockNestingEnabled () const const
QMenuBarmenuBar () const const
QWidgetmenuWidget () const const
void removeDockWidget (QDockWidget *dockwidget)
void removeToolBar (QToolBar *toolbar)
void removeToolBarBreak (QToolBar *before)
void resizeDocks (const QList< QDockWidget * > &docks, const QList< int > &sizes, Qt::Orientation orientation)
bool restoreDockWidget (QDockWidget *dockwidget)
bool restoreState (const QByteArray &state, int version)
QByteArray saveState (int version) const const
void setAnimated (bool enabled)
void setCentralWidget (QWidget *widget)
void setCorner (Qt::Corner corner, Qt::DockWidgetArea area)
void setDockNestingEnabled (bool enabled)
void setDockOptions (QMainWindow::DockOptions options)
void setDocumentMode (bool enabled)
void setIconSize (const QSize &iconSize)
void setMenuBar (QMenuBar *menuBar)
void setMenuWidget (QWidget *menuBar)
void setStatusBar (QStatusBar *statusbar)
void setTabPosition (Qt::DockWidgetAreas areas, QTabWidget::TabPosition tabPosition)
void setTabShape (QTabWidget::TabShape tabShape)
void setToolButtonStyle (Qt::ToolButtonStyle toolButtonStyle)
void setUnifiedTitleAndToolBarOnMac (bool set)
void splitDockWidget (QDockWidget *first, QDockWidget *second, Qt::Orientation orientation)
QStatusBarstatusBar () const const
void tabifiedDockWidgetActivated (QDockWidget *dockWidget)
QList< QDockWidget * > tabifiedDockWidgets (QDockWidget *dockwidget) const const
void tabifyDockWidget (QDockWidget *first, QDockWidget *second)
QTabWidget::TabPosition tabPosition (Qt::DockWidgetArea area) const const
QTabWidget::TabShape tabShape () const const
QWidgettakeCentralWidget ()
Qt::ToolBarArea toolBarArea (QToolBar *toolbar) const const
bool toolBarBreak (QToolBar *toolbar) const const
Qt::ToolButtonStyle toolButtonStyle () const const
void toolButtonStyleChanged (Qt::ToolButtonStyle toolButtonStyle)
bool unifiedTitleAndToolBarOnMac () const const
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
bool acceptDrops () const const
QString accessibleDescription () const const
QString accessibleName () const const
QList< QAction * > actions () const const
void activateWindow ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (const QPoint &p) const const
QWidgetchildAt (int x, int y) const const
QRect childrenRect () const const
QRegion childrenRegion () const const
void clearFocus ()
void clearMask ()
bool close ()
QMargins contentsMargins () const const
QRect contentsRect () const const
Qt::ContextMenuPolicy contextMenuPolicy () const const
QCursor cursor () const const
void customContextMenuRequested (const QPoint &pos)
WId effectiveWinId () const const
void ensurePolished () const const
Qt::FocusPolicy focusPolicy () const const
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
QPixmap grab (const QRect &rectangle)
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () const const
bool hasEditFocus () const const
bool hasFocus () const const
virtual bool hasHeightForWidth () const const
bool hasMouseTracking () const const
bool hasTabletTracking () const const
int height () const const
virtual int heightForWidth (int w) const const
void hide ()
Qt::InputMethodHints inputMethodHints () const const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const const
bool isAncestorOf (const QWidget *child) const const
bool isEnabled () const const
bool isEnabledTo (const QWidget *ancestor) const const
bool isEnabledToTLW () const const
bool isFullScreen () const const
bool isHidden () const const
bool isMaximized () const const
bool isMinimized () const const
bool isModal () const const
bool isTopLevel () const const
bool isVisible () const const
bool isVisibleTo (const QWidget *ancestor) const const
bool isWindow () const const
bool isWindowModified () const const
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &pos) const const
QRegion mask () const const
int maximumHeight () const const
QSize maximumSize () const const
int maximumWidth () const const
int minimumHeight () const const
QSize minimumSize () const const
virtual QSize minimumSizeHint () const const
int minimumWidth () const const
void move (const QPoint &)
void move (int x, int y)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
void raise ()
QRect rect () const const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void repaint (int x, int y, int w, int h)
void resize (const QSize &)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () const const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &r)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool on)
void setAutoFillBackground (bool enabled)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &)
void setDisabled (bool disable)
void setEditFocus (bool enable)
void setEnabled (bool)
void setFixedHeight (int h)
void setFixedSize (const QSize &s)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus ()
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *w)
void setFont (const QFont &)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setHidden (bool hidden)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags f)
void setShortcutAutoRepeat (int id, bool enable)
void setShortcutEnabled (int id, bool enable)
void setSizeIncrement (const QSize &)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &)
void setStyle (QStyle *style)
void setStyleSheet (const QString &styleSheet)
void setTabletTracking (bool enable)
void setToolTip (const QString &)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setupUi (QWidget *widget)
virtual void setVisible (bool visible)
void setWhatsThis (const QString &)
void setWindowFilePath (const QString &filePath)
void setWindowFlag (Qt::WindowType flag, bool on)
void setWindowFlags (Qt::WindowFlags type)
void setWindowIcon (const QIcon &icon)
void setWindowIconText (const QString &)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowModified (bool)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
void setWindowTitle (const QString &)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
QSize size () const const
virtual QSize sizeHint () const const
QSize sizeIncrement () const const
QSizePolicy sizePolicy () const const
void stackUnder (QWidget *w)
QString statusTip () const const
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update ()
void update (const QRect &rect)
void update (const QRegion &rgn)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () const const
QIcon windowIcon () const const
void windowIconChanged (const QIcon &icon)
QString windowIconText () const const
void windowIconTextChanged (const QString &iconText)
Qt::WindowModality windowModality () const const
qreal windowOpacity () const const
QString windowRole () const const
Qt::WindowStates windowState () const const
QString windowTitle () const const
void windowTitleChanged (const QString &title)
Qt::WindowType windowType () const const
WId winId () const const
int x () const const
int y () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int devicePixelRatio () const const
qreal devicePixelRatioF () const const
int height () const const
int heightMM () const const
int logicalDpiX () const const
int logicalDpiY () const const
bool paintingActive () const const
int physicalDpiX () const const
int physicalDpiY () const const
int width () const const
int widthMM () const const

Static Public Member Functions

static bool canBeRestored (int number)
static const QString classNameOfToplevel (int number)
static QList< KMainWindow * > memberList ()
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Slots

void saveAutoSaveSettings ()
virtual void showAboutApplication ()

Protected Member Functions

 KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
void closeEvent (QCloseEvent *) override
bool event (QEvent *event) override
virtual bool queryClose ()
virtual void readGlobalProperties (KConfig *sessionConfig)
virtual void readProperties (const KConfigGroup &)
bool readPropertiesInternal (KConfig *, int)
void restoreWindowSize (const KConfigGroup &config)
virtual void saveGlobalProperties (KConfig *sessionConfig)
virtual void saveProperties (KConfigGroup &)
void savePropertiesInternal (KConfig *, int)
void saveWindowSize (KConfigGroup &config) const
bool settingsDirty () const
- Protected Member Functions inherited from QMainWindow
virtual void contextMenuEvent (QContextMenuEvent *event) override
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void changeEvent (QEvent *event)
void create (WId window, bool initializeWindow, bool destroyOldWindow)
void destroy (bool destroyWindow, bool destroySubWindows)
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dragLeaveEvent (QDragLeaveEvent *event)
virtual void dragMoveEvent (QDragMoveEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual void enterEvent (QEvent *event)
virtual void focusInEvent (QFocusEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
virtual void focusOutEvent (QFocusEvent *event)
bool focusPreviousChild ()
virtual void hideEvent (QHideEvent *event)
virtual void initPainter (QPainter *painter) const const override
virtual void inputMethodEvent (QInputMethodEvent *event)
virtual void keyPressEvent (QKeyEvent *event)
virtual void keyReleaseEvent (QKeyEvent *event)
virtual void leaveEvent (QEvent *event)
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void mouseDoubleClickEvent (QMouseEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *event)
virtual void mouseReleaseEvent (QMouseEvent *event)
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void paintEvent (QPaintEvent *event)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *event)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
virtual void wheelEvent (QWheelEvent *event)
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Protected Attributes

const std::unique_ptr< KMainWindowPrivate > k_ptr

Related Functions

(Note that these are not member functions.)


Additional Inherited Members

- Public Types inherited from QMainWindow
enum  DockOption
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
- Public Attributes inherited from QMainWindow
typedef DockOptions
- Public Attributes inherited from QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice

Detailed Description

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 KMainWindow, 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 KMainWindow and - unlike the old KMainWindow - may, but do not have to, be deleted by you. KMainWindow 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 KMainWindow 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.

KMainWindow 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 KMainWindow 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.

Reginald Stadlbauer (reggi[email protected][email protected][email protected]
Stephan Kulow (coolo[email protected]@kde[email protected].org)
Matthias Ettrich (ettri[email protected][email protected][email protected]de.or[email protected]g)
Chris Schlaeger ([email protected][email protected]e.or[email protected]g)
Sven Radej (radej[email protected]@kde[email protected].org) Maintained by David Faure (faure[email protected]@kde[email protected].org)

Definition at line 96 of file kmainwindow.h.

Constructor & Destructor Documentation

◆ KMainWindow()

KMainWindow::KMainWindow ( QWidget parent = nullptr,
Qt::WindowFlags  f = Qt::WindowFlags() 

Construct a main window.

parentThe widget parent. This is usually 0 but it may also be the window group leader. In that case, the KMainWindow becomes sort of a secondary window.
fSpecify the window flags. The default is none.

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

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

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

Since the KDE Frameworks 5.16 release, KMainWindow will also enter information regarding the application's translators by default, using KAboutData::setTranslator(). This only occurs if no translators are already assigned in KAboutData (see KAboutData::setTranslator() for details – the auto-assignment here uses the same translated strings as specified for that function).

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, KMainWindow 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 KMainWindow 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 208 of file kmainwindow.cpp.

◆ ~KMainWindow()

KMainWindow::~KMainWindow ( )


Will also destroy the toolbars, and menubar if needed.

Definition at line 437 of file kmainwindow.cpp.

Member Function Documentation

◆ appHelpActivated

void KMainWindow::appHelpActivated ( )

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(QIcon::fromTheme("help-contents"), i18n("Help"),
this, SLOT(appHelpActivated()));

Definition at line 538 of file kmainwindow.cpp.

◆ applyMainWindowSettings()

void KMainWindow::applyMainWindowSettings ( const KConfigGroup config)

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

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

◆ autoSaveConfigGroup()

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

Definition at line 877 of file kmainwindow.cpp.

◆ autoSaveGroup()

QString KMainWindow::autoSaveGroup ( ) const
the group used for setting-autosaving. Only meaningful if setAutoSaveSettings(const QString&, bool) was called. This can be useful for forcing a save or an apply, e.g. before and after using KEditToolBar.
You should rather use saveAutoSaveSettings() for saving or autoSaveConfigGroup() for loading. This method doesn't make sense if setAutoSaveSettings(const KConfigGroup&, bool) was called.

◆ autoSaveSettings()

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

◆ canBeRestored()

bool KMainWindow::canBeRestored ( int  number)

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

See also

Definition at line 474 of file kmainwindow.cpp.

◆ classNameOfToplevel()

const QString KMainWindow::classNameOfToplevel ( int  number)

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

◆ closeEvent()

void KMainWindow::closeEvent ( QCloseEvent e)

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.

Reimplemented from QWidget.

Definition at line 550 of file kmainwindow.cpp.

◆ customHelpMenu()

QMenu * KMainWindow::customHelpMenu ( bool  showWhatsThis = true)

Returns the help menu.

Creates a standard help menu if none exists yet.

It contains entries for the help system (activated by F1), an optional "What's This?" entry (activated by Shift F1), an application specific dialog box, and an "About KDE" dialog box. You must create the application specific dialog box yourself. When the "About application" menu entry is activated, a signal will trigger the showAboutApplication slot. See showAboutApplication for more information.

Example (adding a help menu to your application):

showWhatsThisSet this to false if you do not want to include the "What's This" menu entry.
A standard help menu.
Since 5.0, use XMLGUI instead, or KHelpMenu directly

Definition at line 462 of file kmainwindow.cpp.

◆ dbusName()

QString KMainWindow::dbusName ( ) const

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


Definition at line 1031 of file kmainwindow.cpp.

◆ event()

bool KMainWindow::event ( QEvent event)

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.

Reimplemented from QMainWindow.

Reimplemented in KXmlGuiWindow.

Definition at line 906 of file kmainwindow.cpp.

◆ hasMenuBar()

bool KMainWindow::hasMenuBar ( )

Returns true, if there is a menubar.

◆ helpMenu()

QMenu * KMainWindow::helpMenu ( const QString aboutAppText = QString(),
bool  showWhatsThis = true 

Retrieve the standard help menu.

It contains entries for the help system (activated by F1), an optional "What's This?" entry (activated by Shift F1), an application specific dialog box, and an "About KDE" dialog box.

Example (adding a standard help menu to your application):

QMenu *help = helpMenu( <myTextString> );
menuBar()->addMenu( help );
aboutAppTextThe string that is used in the application specific dialog box. If you leave this string empty the information in the global KAboutData of the application will be used to make a standard dialog box.
showWhatsThisSet this to false if you do not want to include the "What's This" menu entry.
A standard help menu.
Since 5.0, use KHelpMenu directly

Definition at line 444 of file kmainwindow.cpp.

◆ initialGeometrySet()

bool KMainWindow::initialGeometrySet ( ) const
Always false
since 5.0, the functionality got removed

Definition at line 416 of file kmainwindow.h.

◆ memberList()

QList< KMainWindow * > KMainWindow::memberList ( )

List of members of KMainWindow class.

Definition at line 1026 of file kmainwindow.cpp.

◆ queryClose()

bool KMainWindow::queryClose ( )

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:

i18n("Save changes to document foo?"), QString(),
// save document here. If saving fails, return false;
return true;
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

Definition at line 592 of file kmainwindow.cpp.

◆ readGlobalProperties()

void KMainWindow::readGlobalProperties ( KConfig sessionConfig)

The counterpart of saveGlobalProperties().

Read the application-specific properties in again.

Definition at line 601 of file kmainwindow.cpp.

◆ readProperties()

virtual void KMainWindow::readProperties ( const KConfigGroup )

Read your instance-specific properties.

Is called indirectly by restore().

Definition at line 553 of file kmainwindow.h.

◆ resetAutoSaveSettings()

void KMainWindow::resetAutoSaveSettings ( )

Disable the auto-save-settings feature.

You don't normally need to call this, ever.

Definition at line 856 of file kmainwindow.cpp.

◆ restore()

bool KMainWindow::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;
(new childMW)->restore(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 KMainWindow::classNameOfToplevel(n) to determine the exact type before calling the childMW constructor in the example from above.

You don't need to deal with this function. Use the kRestoreMainWindows() convenience template function instead!
See also

Definition at line 503 of file kmainwindow.cpp.

◆ restoreWindowSize()

void KMainWindow::restoreWindowSize ( const KConfigGroup config)

For inherited classes.

Since 5.0, use KWindowConfig::restoreWindowSize

Definition at line 807 of file kmainwindow.cpp.

◆ saveAutoSaveSettings

void KMainWindow::saveAutoSaveSettings ( )

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


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

Definition at line 895 of file kmainwindow.cpp.

◆ saveGlobalProperties()

void KMainWindow::saveGlobalProperties ( KConfig sessionConfig)

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

◆ saveMainWindowSettings()

void KMainWindow::saveMainWindowSettings ( KConfigGroup config)

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

configConfig group to save the settings to.

Definition at line 626 of file kmainwindow.cpp.

◆ saveProperties()

virtual void KMainWindow::saveProperties ( KConfigGroup )

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 544 of file kmainwindow.h.

◆ saveWindowSize()

void KMainWindow::saveWindowSize ( KConfigGroup config) const

For inherited classes.

Since 5.0, use KWindowConfig::saveWindowSize

Definition at line 814 of file kmainwindow.cpp.

◆ setAutoSaveSettings() [1/2]

void KMainWindow::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().


Definition at line 837 of file kmainwindow.cpp.

◆ setAutoSaveSettings() [2/2]

void KMainWindow::setAutoSaveSettings ( const QString groupName = QStringLiteral("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.

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

Typically, you will call setAutoSaveSettings() in your KMainWindow-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 KMainWindow 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 832 of file kmainwindow.cpp.

◆ setCaption [1/2]

void KMainWindow::setCaption ( const QString caption)

Makes a KDE compliant caption (window title).

captionYour caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.

Definition at line 518 of file kmainwindow.cpp.

◆ setCaption [2/2]

void KMainWindow::setCaption ( const QString caption,
bool  modified 

Makes a KDE compliant caption.

captionYour caption. Do not include the application name in this string. It will be added automatically according to the KDE standard.
modifiedSpecify whether the document is modified. This displays an additional sign in the title bar, usually "**".

Definition at line 523 of file kmainwindow.cpp.

◆ setPlainCaption

void KMainWindow::setPlainCaption ( const QString caption)

Make a plain caption without any modifications.

captionYour caption. This is the string that will be displayed in the window title.

Definition at line 533 of file kmainwindow.cpp.

◆ setSettingsDirty

void KMainWindow::setSettingsDirty ( )

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

◆ setStateConfigGroup()

void KMainWindow::setStateConfigGroup ( const QString configGroup)

Set the config group name for state config returned by stateConfigGroup If this method is called the window size and window state are stored in the resulting KConfigGroup.

If this is used in combination with setAutoSaveSettings, you should call this method first
See also

Definition at line 883 of file kmainwindow.cpp.

◆ settingsDirty()

bool KMainWindow::settingsDirty ( ) const

For inherited classes.

Definition at line 826 of file kmainwindow.cpp.

◆ showAboutApplication

virtual void KMainWindow::showAboutApplication ( )

This slot does nothing.

It must be reimplemented if you want to use a custom About Application dialog box. This slot is connected to the About Application entry in the menu returned by customHelpMenu.


void MyMainLevel::setupInterface()
void MyMainLevel::showAboutApplication()
<activate your custom dialog>
Since 5.0, use KHelpMenu

Definition at line 634 of file kmainwindow.h.

◆ toolBar()

KToolBar * KMainWindow::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.

nameThe internal name of the toolbar. If no name is specified "mainToolBar" is assumed.
A pointer to the toolbar

Definition at line 996 of file kmainwindow.cpp.

◆ toolBars()

QList< KToolBar * > KMainWindow::toolBars ( ) const
A list of all toolbars for this window

Definition at line 1012 of file kmainwindow.cpp.

Friends And Related Function Documentation


Since 5.65, use Qt::WindowFlags()

Definition at line 35 of file kmainwindow.h.

The documentation for this class was generated from the following files:
QWidget * window() const const
bool settingsDirty() const
For inherited classes.
void appHelpActivated()
Open the help page for the application.
KMainWindow(QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
Construct a main window.
QIcon fromTheme(const QString &name)
void setAttribute(Qt::WidgetAttribute attribute, bool on)
bool restore(int number, bool show=true)
Try to restore the toplevel widget as defined by number (1..X).
KGuiItem save()
void saveAutoSaveSettings()
This slot should only be called in case you reimplement closeEvent() and if you are using the "auto-s...
QAction * addMenu(QMenu *menu)
const QList< QKeySequence > & help()
QString i18n(const char *text, const TYPE &arg...)
QMenu * helpMenu(const QString &aboutAppText=QString(), bool showWhatsThis=true)
Retrieve the standard help menu.
static bool canBeRestored(int number)
If the session did contain so high a number, true is returned, else false.
QMenuBar * menuBar() const const
QMenu * customHelpMenu(bool showWhatsThis=true)
Returns the help menu.
KToolBar * toolBar(const QString &name=QString())
Returns a pointer to the toolbar with the specified name.
QAction * addAction(const QString &text)
Top level main window.
Definition: kmainwindow.h:96
void setObjectName(const QString &name)
ButtonCode warningTwoActionsCancel(QWidget *parent, const QString &text, const QString &title, const KGuiItem &primaryAction, const KGuiItem &secondaryAction, const KGuiItem &cancelAction=KStandardGuiItem::cancel(), const QString &dontAskAgainName=QString(), Options options=Options(Notify|Dangerous))
KGuiItem discard()
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Dec 9 2022 04:06:30 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.