KMainWindow

Search for usage in LXR

#include <KMainWindow>

Inheritance diagram for KMainWindow:

Properties

QString autoSaveGroup
 
bool autoSaveSettings
 
bool hasMenuBar
 
- Properties inherited from QMainWindow
 animated
 
 dockNestingEnabled
 
 dockOptions
 
 documentMode
 
 iconSize
 
 tabShape
 
 toolButtonStyle
 
 unifiedTitleAndToolBarOnMac
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 

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 flags=Qt::WindowFlags())
 
 ~KMainWindow () override
 
virtual void applyMainWindowSettings (const KConfigGroup &config)
 
KConfigGroup autoSaveConfigGroup () const
 
QString autoSaveGroup () const
 
bool autoSaveSettings () const
 
QString dbusName () const
 
bool hasMenuBar ()
 
void resetAutoSaveSettings ()
 
bool restore (int numberOfInstances, 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 ()
 
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 (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 (const 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 ()
 
QActionaddAction (const QIcon &icon, const QString &text)
 
QActionaddAction (const QIcon &icon, const QString &text, Args &&... args)
 
QActionaddAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)
 
QActionaddAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)
 
QActionaddAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type)
 
QActionaddAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type)
 
QActionaddAction (const QString &text)
 
QActionaddAction (const QString &text, Args &&... args)
 
QActionaddAction (const QString &text, const QKeySequence &shortcut)
 
QActionaddAction (const QString &text, const QKeySequence &shortcut, Args &&... args)
 
QActionaddAction (const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type)
 
QActionaddAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type)
 
void addAction (QAction *action)
 
void addActions (const 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
 
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, const 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 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
 
QPointF mapFrom (const QWidget *parent, const QPointF &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPointF mapFromGlobal (const QPointF &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPointF mapFromParent (const QPointF &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPointF mapTo (const QWidget *parent, const QPointF &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPointF mapToGlobal (const QPointF &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QPointF mapToParent (const QPointF &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
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
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, RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, 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 setScreen (QScreen *screen)
 
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)
 
QBindable< QStringbindableObjectName ()
 
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 () const const
 
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 QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
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_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
qreal 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 numberOfInstances)
 
static const QString classNameOfToplevel (int instanceNumber)
 
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)
 
void setTabOrder (std::initializer_list< QWidget * > widgets)
 
- 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)
 

Protected Slots

void saveAutoSaveSettings ()
 

Protected Member Functions

KXMLGUI_NO_EXPORT KMainWindow (KMainWindowPrivate &dd, QWidget *parent, Qt::WindowFlags f)
 
void closeEvent (QCloseEvent *) override
 
bool event (QEvent *event) override
 
void keyPressEvent (QKeyEvent *keyEvent) override
 
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
 
- 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 (QEnterEvent *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 keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (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, qintptr *result)
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void resizeEvent (QResizeEvent *event)
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus (Qt::InputMethodQuery query)
 
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

std::unique_ptr< KMainWindowPrivate > const d_ptr
 

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
 AllowNestedDocks
 
 AllowTabbedDocks
 
 AnimatedDocks
 
typedef DockOptions
 
 ForceTabbedDocks
 
 GroupedDragging
 
 VerticalTabs
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 

Detailed Description

KMainWindow represents a top-level main window.

It extends QMainWindow with session management capabilities. For ready-made window functionality and simpler UI management, use KXmlGuiWindow instead.

Define the minimum/maximum height/width of your central widget and KMainWindow will take this into account. For fixed size windows set your main widget to a fixed size. Fixed aspect ratios (QWidget::heightForWidth()) and fixed width widgets are not supported.

Use toolBar() to generate a main toolbar "mainToolBar" or refer to a specific toolbar. For a simpler way to manage your toolbars, use KXmlGuiWindow::setupGUI() instead.

Use setAutoSaveSettings() to automatically save and restore the window geometry and toolbar/menubar/statusbar state when the application is restarted.

Use kRestoreMainWindows() in your main function to restore your windows when the session is restored.

The window state is saved when the application is exited. Reimplement queryClose() to warn the user of unsaved data upon close or exit.

Reimplement saveProperties() / readProperties() or saveGlobalProperties() / readGlobalProperties() to save/restore application-specific state during session management.

Note that session saving is automatically called, session restoring is not, and so it needs to be implemented in your main() function.

See https://develop.kde.org/docs/use/session-managment for more information on session management.

Definition at line 59 of file kmainwindow.h.

Property Documentation

◆ autoSaveGroup

QString KMainWindow::autoSaveGroup
read

Definition at line 66 of file kmainwindow.h.

◆ autoSaveSettings

bool KMainWindow::autoSaveSettings
read

Definition at line 65 of file kmainwindow.h.

◆ hasMenuBar

bool KMainWindow::hasMenuBar
read

Definition at line 64 of file kmainwindow.h.

Constructor & Destructor Documentation

◆ KMainWindow() [1/2]

KMainWindow::KMainWindow ( QWidget * parent = nullptr,
Qt::WindowFlags flags = Qt::WindowFlags() )
explicit

Constructs a main window.

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

Note that by default a KMainWindow 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

WA_DeleteOnClose
void setAttribute(Qt::WidgetAttribute attribute, bool on)
QWidget * window() const const

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

kmw->setObjectName(...);
KMainWindow represents a top-level main window.
Definition kmainwindow.h:60
KMainWindow(QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
Constructs a main window.
QList< T > findChildren(Qt::FindChildOptions options) const const

Since KDE Frameworks 5.16, KMainWindow will 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. Otherwise, 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#".

See also
KAboutData

Definition at line 207 of file kmainwindow.cpp.

◆ ~KMainWindow()

KMainWindow::~KMainWindow ( )
override

Destructor.

Will also destroy the toolbars and menubar if needed.

Definition at line 429 of file kmainwindow.cpp.

◆ KMainWindow() [2/2]

KMainWindow::KMainWindow ( KMainWindowPrivate & dd,
QWidget * parent,
Qt::WindowFlags f )
protected

Definition at line 216 of file kmainwindow.cpp.

Member Function Documentation

◆ appHelpActivated

void KMainWindow::appHelpActivated ( )
slot

Opens 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()->addAction(QIcon::fromTheme("help-contents"), i18n("Help"),
void appHelpActivated()
Opens the help page for the application.
KToolBar * toolBar(const QString &name=QString())
This is useful to both call specific toolbars that have been created or to generate a default one upo...
QString i18n(const char *text, const TYPE &arg...)
QIcon fromTheme(const QString &name)
QAction * addAction(const QIcon &icon, const QString &text)
See also
helpMenu()
toolBar()

Definition at line 499 of file kmainwindow.cpp.

◆ applyMainWindowSettings()

void KMainWindow::applyMainWindowSettings ( const KConfigGroup & config)
virtual

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

Parameters
configConfig group to read the settings from.

Reimplemented in KXmlGuiWindow.

Definition at line 675 of file kmainwindow.cpp.

◆ autoSaveConfigGroup()

KConfigGroup KMainWindow::autoSaveConfigGroup ( ) const
Returns
The group used for autosaving settings.

Only meaningful if setAutoSaveSettings(const QString&, bool) was called.

Do not use this method if setAutoSaveSettings(const KConfigGroup&, bool) was called.

This can be useful for forcing an apply, e.g. after using KEditToolBar.

See also
setAutoSaveSettings()
autoSaveGroup()
Since
4.1

Definition at line 822 of file kmainwindow.cpp.

◆ autoSaveGroup()

QString KMainWindow::autoSaveGroup ( ) const
Returns
The group used for autosaving settings.

Do not mistake this with autoSaveConfigGroup.

Only meaningful if setAutoSaveSettings(const QString&, bool) was called.

Do not use this method if setAutoSaveSettings(const KConfigGroup&, bool) was called.

This can be useful for forcing a save or an apply, e.g. before and after using KEditToolBar.

Note
Prefer saveAutoSaveSettings() for saving or autoSaveConfigGroup() for loading.
See also
autoSaveSettings()
setAutoSaveSettings()
saveAutoSaveSettings()
resetAutoSaveSettings()
autoSaveConfigGroup()

Definition at line 816 of file kmainwindow.cpp.

◆ autoSaveSettings()

bool KMainWindow::autoSaveSettings ( ) const
Returns
true if setAutoSaveSettings() was called, false by default or if resetAutoSaveSettings() was called.
See also
setAutoSaveSettings()
resetAutoSaveSettings()

Definition at line 810 of file kmainwindow.cpp.

◆ canBeRestored()

bool KMainWindow::canBeRestored ( int numberOfInstances)
static
Parameters
numberOfInstancesThe number of KMainWindow instances in the application.
Returns
true if the number of KMainWindow instances of the previous session did contain the requested numberOfInstances, false otherwise.
See also
restore()

Definition at line 435 of file kmainwindow.cpp.

◆ classNameOfToplevel()

const QString KMainWindow::classNameOfToplevel ( int instanceNumber)
static

Useful if your application uses different kinds of top-level windows.

Returns
The class name of the top-level window to be restored that corresponds to instanceNumber.
Parameters
instanceNumber
See also
restore()

Definition at line 449 of file kmainwindow.cpp.

◆ closeEvent()

void KMainWindow::closeEvent ( QCloseEvent * e)
overrideprotectedvirtual

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 autosaving window settings working.

Reimplemented from QWidget.

Definition at line 511 of file kmainwindow.cpp.

◆ dbusName()

QString KMainWindow::dbusName ( ) const
Returns
The path for the exported window's D-Bus object.
Since
4.0.1

Definition at line 993 of file kmainwindow.cpp.

◆ event()

bool KMainWindow::event ( QEvent * event)
overrideprotectedvirtual

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

◆ hasMenuBar()

bool KMainWindow::hasMenuBar ( )
Returns
true if there is a menubar, false otherwise.

◆ keyPressEvent()

void KMainWindow::keyPressEvent ( QKeyEvent * keyEvent)
overrideprotectedvirtual

Reimplemented to open context menus on Shift+F10.

Reimplemented from QWidget.

Definition at line 909 of file kmainwindow.cpp.

◆ memberList()

QList< KMainWindow * > KMainWindow::memberList ( )
static
Returns
The list of members of the KMainWindow class.

Definition at line 988 of file kmainwindow.cpp.

◆ queryClose()

bool KMainWindow::queryClose ( )
protectedvirtual

This function is called before the window is closed, either by the user or indirectly by the session manager.

This can be used to prompt the user to save unsaved data before the window is closed.

Example:

i18n("Save changes to document foo?"), QString(),
// save document here. If saving fails, return false;
return true;
return true;
default: // cancel
return false;
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 save()
KGuiItem discard()
Note
Do not 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.
Returns
true by default, false according to the reimplementation. Returning false will cancel the closing operation, and if KApplication::sessionSaving() is true, it cancels logout.
See also
KApplication::sessionSaving()

Definition at line 553 of file kmainwindow.cpp.

◆ readGlobalProperties()

void KMainWindow::readGlobalProperties ( KConfig * sessionConfig)
protectedvirtual

Reads your application-wide properties.

Parameters
sessionConfigA pointer to the KConfig instance used to load the session data.
See also
saveGlobalProperties()
readProperties()

Definition at line 562 of file kmainwindow.cpp.

◆ readProperties()

virtual void KMainWindow::readProperties ( const KConfigGroup & )
inlineprotectedvirtual

Reads your instance-specific properties.

This function is called indirectly by restore().

void MainWindow::readProperties(KConfigGroup &config) {
if (config.hasKey("myKey")) {
config.readEntry("myKey", "DefaultValue");
}
...
}
bool hasKey(const char *key) const
QString readEntry(const char *key, const char *aDefault=nullptr) const
See also
readGlobalProperties()

Definition at line 560 of file kmainwindow.h.

◆ readPropertiesInternal()

bool KMainWindow::readPropertiesInternal ( KConfig * config,
int number )
protected

Definition at line 644 of file kmainwindow.cpp.

◆ resetAutoSaveSettings()

void KMainWindow::resetAutoSaveSettings ( )

Disables the autosave settings feature.

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

See also
setAutoSaveSettings()
autoSaveSettings()

Definition at line 801 of file kmainwindow.cpp.

◆ restore()

bool KMainWindow::restore ( int numberOfInstances,
bool show = true )

Attempt to restore the top-level widget as defined by numberOfInstances (1..X).

You should call canBeRestored() first.

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

That means clients could simply do the following:

if (qApp->isSessionRestored()){
int n = 1;
(new childMW)->restore(n);
n++;
}
} else {
// create default application as usual
}
bool restore(int numberOfInstances, bool show=true)
Attempt to restore the top-level widget as defined by numberOfInstances (1..X).
static bool canBeRestored(int numberOfInstances)

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

With this you can easily restore all top-level windows of your application.

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

Note
You don't need to deal with this function. Use the kRestoreMainWindows() convenience template function instead!
Parameters
numberOfInstancesThe number of KMainWindow instances from the last session.
showWhether the KMainWindow instances will be visible by default.
Returns
true if the session contained the same number of instances as the requested number, false if the session contained less instances than the requested number, in which case no configuration is changed.
See also
kRestoreMainWindows()
readProperties()
canBeRestored()

Definition at line 464 of file kmainwindow.cpp.

◆ saveAutoSaveSettings

void KMainWindow::saveAutoSaveSettings ( )
protectedslot

This slot should only be called in case you reimplement closeEvent() and if you are using the autosave feature.

In all other cases, setSettingsDirty() should be called instead to benefit from the delayed saving.

Example:

void MyMainWindow::closeEvent( QCloseEvent *e )
{
// Save settings if autosave is enabled, and settings have changed
if ( settingsDirty() && autoSaveSettings() )
..
}
void saveAutoSaveSettings()
This slot should only be called in case you reimplement closeEvent() and if you are using the autosav...
bool settingsDirty() const
For inherited classes.
See also
setAutoSaveSettings()
setSettingsDirty()

Definition at line 840 of file kmainwindow.cpp.

◆ saveGlobalProperties()

void KMainWindow::saveGlobalProperties ( KConfig * sessionConfig)
protectedvirtual

Saves your application-wide properties.

Parameters
sessionConfigA pointer to the KConfig instance used to save the session data.

This function is invoked when the session manager requests your application to save its state. It is similar to saveProperties(), but it is only called for the first main window. This is useful to save global state of your application that isn't bound to a particular window.

The default implementation does nothing.

See also
readGlobalProperties()
saveProperties()

Definition at line 558 of file kmainwindow.cpp.

◆ saveMainWindowSettings()

void KMainWindow::saveMainWindowSettings ( KConfigGroup & config)

Manually save the settings for statusbar, menubar and toolbar to their respective groups in the KConfigGroup config.

Example:

KConfigGroup group(KSharedConfig::openConfig(), "MainWindow");
void saveMainWindowSettings(KConfigGroup &config)
Manually save the settings for statusbar, menubar and toolbar to their respective groups in the KConf...
static KSharedConfig::Ptr openConfig(const QString &fileName=QString(), OpenFlags mode=FullConfig, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
Parameters
configConfig group to save the settings to.
See also
setAutoSaveSettings()
KConfig
KSharedConfig
KConfigGroup

Definition at line 587 of file kmainwindow.cpp.

◆ saveProperties()

virtual void KMainWindow::saveProperties ( KConfigGroup & )
inlineprotectedvirtual

Saves your instance-specific properties.

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

Reimplement this function in child classes.

void MainWindow::saveProperties(KConfigGroup &config) {
config.writeEntry("myKey", "newValue");
...
}
void writeEntry(const char *key, const char *value, WriteConfigFlags pFlags=Normal)
Note
No user interaction is allowed in this function!

Definition at line 540 of file kmainwindow.h.

◆ savePropertiesInternal()

void KMainWindow::savePropertiesInternal ( KConfig * config,
int number )
protected

Definition at line 566 of file kmainwindow.cpp.

◆ setAutoSaveSettings() [1/2]

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

This is an overloaded function.

This allows the settings to be saved into a different file that does not correspond to that used for KSharedConfig::openConfig().

See also
setAutoSaveSettings(const QString &groupName, bool saveWindowSize)
KConfig
KSharedConfig
Since
4.1

Definition at line 782 of file kmainwindow.cpp.

◆ setAutoSaveSettings() [2/2]

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

This enables autosave of toolbar/menubar/statusbar settings (and optionally window size).

Parameters
groupNameA name that identifies the type of window. You can have several types of window in the same application. If no groupName is specified, the value defaults to "MainWindow".
saveWindowSizeWhether to include the window size when saving. true by default.

If the *bars were modified when the window is closed, saveMainWindowSettings( KConfigGroup(KSharedConfig::openConfig(), groupName) ) will be called.

Typically, you will call setAutoSaveSettings() in your KMainWindow-inherited class constructor, and it will take care of restoring and saving automatically.

By default, this generates an appnamerc ini file as if using default KConfig constructor or KConfig::SimpleConfig.

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:

Definition at line 777 of file kmainwindow.cpp.

◆ setCaption [1/2]

void KMainWindow::setCaption ( const QString & caption)
virtualslot

Assigns a KDE compliant caption (window title).

Parameters
captionThe string that will be displayed in the window title, before the application name.
Note
This function does the same as setPlainCaption().
Do not include the application name in this string. It will be added automatically according to the KDE standard.
See also
setPlainCaption()

Definition at line 479 of file kmainwindow.cpp.

◆ setCaption [2/2]

void KMainWindow::setCaption ( const QString & caption,
bool modified )
virtualslot

Makes a KDE compliant caption.

Parameters
captionYour caption.
modifiedWhether the document is modified. This displays an additional sign in the title bar, usually "**".

This is an overloaded function.

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

Definition at line 484 of file kmainwindow.cpp.

◆ setPlainCaption

void KMainWindow::setPlainCaption ( const QString & caption)
virtualslot

Make a plain caption without any modifications.

Parameters
captionThe string that will be displayed in the window title, before the application name.
Note
This function does the same as setCaption().
Do not include the application name in this string. It will be added automatically according to the KDE standard.
See also
setCaption()

Definition at line 494 of file kmainwindow.cpp.

◆ setSettingsDirty

void KMainWindow::setSettingsDirty ( )
slot

Tell the main window that it should save its settings when being closed.

This is part of the autosave 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.

See also
saveAutoSaveSettings()

Definition at line 765 of file kmainwindow.cpp.

◆ setStateConfigGroup()

void KMainWindow::setStateConfigGroup ( const QString & configGroup)

Assigns the config group name for the KConfigGroup returned by stateConfigGroup.

Parameters
configGroupThe config group to be assigned. Window size and state are stored in the resulting KConfigGroup when this function is called.
Note
If this is used in combination with setAutoSaveSettings, you should call this method first.
See also
KConfigGroup()
KSharedConfig::openStateConfig()
stateConfigGroup()
Since
5.88

Definition at line 828 of file kmainwindow.cpp.

◆ settingsDirty()

bool KMainWindow::settingsDirty ( ) const
protected

For inherited classes.

Definition at line 771 of file kmainwindow.cpp.

◆ stateConfigGroup()

KConfigGroup KMainWindow::stateConfigGroup ( ) const
Returns
The KConfigGroup used to store state data like window sizes or window state.

The resulting group is invalid if setStateConfig is not called explicitly.

See also
KConfigGroup
Since
5.88

Definition at line 834 of file kmainwindow.cpp.

◆ toolBar()

KToolBar * KMainWindow::toolBar ( const QString & name = QString())

This is useful to both call specific toolbars that have been created or to generate a default one upon call.

This refers to toolbars created dynamically from the XML UI framework via KConfig or appnameui.rc.

If the toolbar does not exist, one will be created.

Parameters
nameThe internal name of the toolbar. If no name is specified, "mainToolBar" is assumed.
Returns
A pointer to the toolbar with the specified name.
See also
toolBars()

Definition at line 958 of file kmainwindow.cpp.

◆ toolBars()

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

Definition at line 974 of file kmainwindow.cpp.

Member Data Documentation

◆ d_ptr

std::unique_ptr<KMainWindowPrivate> const KMainWindow::d_ptr
protected

Definition at line 629 of file kmainwindow.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:51:59 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.