KXmlGui

View on LXR

#include <KMainWindow>

Inheritance diagram for KMainWindow:

[legend]

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

	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 f=Qt::WindowFlags())

	~KMainWindow () override

virtual void	applyMainWindowSettings (const KConfigGroup &config)

KConfigGroup	autoSaveConfigGroup () const

QString	autoSaveGroup () const

bool	autoSaveSettings () const

KXMLGUI_DEPRECATED QMenu *	customHelpMenu (bool showWhatsThis=true)

QString	dbusName () const

bool	hasMenuBar ()

KXMLGUI_DEPRECATED QMenu *	helpMenu (const QString &aboutAppText=QString(), bool showWhatsThis=true)

KXMLGUI_DEPRECATED bool	initialGeometrySet () const

void	resetAutoSaveSettings ()

bool	restore (int number, bool show=true)

void	saveMainWindowSettings (KConfigGroup &config)

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

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

KToolBar *	toolBar (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)

QToolBar *	addToolBar (const QString &title)

void	addToolBar (Qt::ToolBarArea area, QToolBar *toolbar)

void	addToolBar (QToolBar *toolbar)

void	addToolBarBreak (Qt::ToolBarArea area)

QWidget *	centralWidget () const

Qt::DockWidgetArea	corner (Qt::Corner corner) const

virtual QMenu *	createPopupMenu ()

DockOptions	dockOptions () const

Qt::DockWidgetArea	dockWidgetArea (QDockWidget *dockwidget) const

bool	documentMode () const

QSize	iconSize () const

void	iconSizeChanged (const QSize &iconSize)

void	insertToolBar (QToolBar before, QToolBar toolbar)

void	insertToolBarBreak (QToolBar *before)

bool	isAnimated () const

bool	isDockNestingEnabled () const

QMenuBar *	menuBar () const

QWidget *	menuWidget () const

void	removeDockWidget (QDockWidget *dockwidget)

void	removeToolBar (QToolBar *toolbar)

void	removeToolBarBreak (QToolBar *before)

bool	restoreDockWidget (QDockWidget *dockwidget)

bool	restoreState (const QByteArray &state, int version)

QByteArray	saveState (int version) const

void	setAnimated (bool enabled)

void	setCentralWidget (QWidget *widget)

void	setCorner (Qt::Corner corner, Qt::DockWidgetArea area)

void	setDockNestingEnabled (bool enabled)

void	setDockOptions (QFlags< QMainWindow::DockOption > 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)

QStatusBar *	statusBar () const

QList< QDockWidget * >	tabifiedDockWidgets (QDockWidget *dockwidget) const

void	tabifyDockWidget (QDockWidget first, QDockWidget second)

QTabWidget::TabPosition	tabPosition (Qt::DockWidgetArea area) const

QTabWidget::TabShape	tabShape () const

QWidget *	takeCentralWidget ()

Qt::ToolBarArea	toolBarArea (QToolBar *toolbar) const

bool	toolBarBreak (QToolBar *toolbar) const

Qt::ToolButtonStyle	toolButtonStyle () const

void	toolButtonStyleChanged (Qt::ToolButtonStyle toolButtonStyle)

bool	unifiedTitleAndToolBarOnMac () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

QPalette::ColorRole	backgroundRole () const

QBackingStore *	backingStore () const

QSize	baseSize () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const

void	ensurePolished () const

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) 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)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

virtual bool	hasHeightForWidth () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isEnabled () const

bool	isEnabledTo (const QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isTopLevel () const

bool	isVisible () const

bool	isVisibleTo (const QWidget *ancestor) const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

virtual QSize	minimumSizeHint () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget () const

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

QRect	rect () const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () 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 (int basew, int baseh)

void	setBaseSize (const QSize &)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

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 (Qt::FocusReason reason)

void	setFocus ()

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, Qt::WindowFlags f)

void	setParent (QWidget *parent)

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::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

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

virtual QSize	sizeHint () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

int	toolTipDuration () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QWindow *	windowHandle () const

QIcon	windowIcon () const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QString	windowTitle () const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
int	colorCount () const

int	depth () const

int	devicePixelRatio () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () 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
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

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 receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

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, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &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 KXMLGUI_DEPRECATED 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)

KXMLGUI_DEPRECATED void	restoreWindowSize (const KConfigGroup &config)

virtual void	saveGlobalProperties (KConfig *sessionConfig)

virtual void	saveProperties (KConfigGroup &)

void	savePropertiesInternal (KConfig *, int)

KXMLGUI_DEPRECATED void	saveWindowSize (KConfigGroup &config) const

bool	settingsDirty () const

Protected Member Functions inherited from QMainWindow
virtual void	contextMenuEvent (QContextMenuEvent *event)

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

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const

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 QPaintDevice *	redirected (QPoint *offset) const

virtual void	resizeEvent (QResizeEvent *event)

virtual QPainter *	sharedPainter () const

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

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
KMainWindowPrivate *const	k_ptr

Additional Inherited Members
Public Attributes inherited from QMainWindow
typedef	DockOptions

Public Attributes inherited from QWidget
typedef	RenderFlags

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.

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

Constructor & Destructor Documentation

KMainWindow::KMainWindow	(	QWidget *	parent = `nullptr`,
		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 KMainWindow becomes sort of a secondary window.
f	Specify 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

window->setAttribute(Qt::WA_DeleteOnClose, false);

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

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

kmw->setObjectName(...);

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

KMainWindow::~KMainWindow ( )

override

Destructor.

Will also destroy the toolbars, and menubar if needed.

Definition at line 401 of file kmainwindow.cpp.

Member Function Documentation

void KMainWindow::appHelpActivated ( )

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

this, SLOT(appHelpActivated()));

Definition at line 508 of file kmainwindow.cpp.

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

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

KConfigGroup KMainWindow::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 KEditToolBar.

Since: 4.1

Definition at line 798 of file kmainwindow.cpp.

QString KMainWindow::autoSaveGroup ( ) const

Returns: 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.

Note: You should rather use saveAutoSaveSettings() for saving or autoSaveConfigGroup() for loading. This method doesn't make sense if setAutoSaveSettings(const KConfigGroup&, bool) was called.

bool KMainWindow::autoSaveSettings ( ) const

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

bool KMainWindow::canBeRestored ( int number )

static

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

See also: restore()

Definition at line 440 of file kmainwindow.cpp.

const QString KMainWindow::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 455 of file kmainwindow.cpp.

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

Reimplemented from QWidget.

Definition at line 520 of file kmainwindow.cpp.

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):

menuBar()->addMenu( customHelpMenu() );

Parameters

showWhatsThis Set this to false if you do not want to include the "What's This" menu entry.

Returns: A standard help menu.

Deprecated:: use XMLGUI instead, or KHelpMenu directly

Definition at line 427 of file kmainwindow.cpp.

QString KMainWindow::dbusName ( ) const

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

Since: 4.0.1

Definition at line 938 of file kmainwindow.cpp.

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

bool KMainWindow::hasMenuBar ( )

Returns true, if there is a menubar.

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 );

Parameters

aboutAppText	The 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.
showWhatsThis	Set this to false if you do not want to include the "What's This" menu entry.

Returns: A standard help menu.

Deprecated:: use KHelpMenu directly

Definition at line 409 of file kmainwindow.cpp.

KXMLGUI_DEPRECATED bool KMainWindow::initialGeometrySet ( ) const

inline

Returns: Always false

Deprecated:: since 5.0, the functionality got removed

Definition at line 407 of file kmainwindow.h.

QList< KMainWindow * > KMainWindow::memberList ( )

static

List of members of KMainWindow class.

Definition at line 933 of file kmainwindow.cpp.

bool KMainWindow::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 545 of file kmainwindow.cpp.

void KMainWindow::readGlobalProperties ( KConfig * sessionConfig )

protectedvirtual

The counterpart of saveGlobalProperties().

Read the application-specific properties in again.

Definition at line 554 of file kmainwindow.cpp.

virtual void KMainWindow::readProperties ( const KConfigGroup & )

inlineprotectedvirtual

Read your instance-specific properties.

Is called indirectly by restore().

Definition at line 538 of file kmainwindow.h.

void KMainWindow::resetAutoSaveSettings ( )

Disable the auto-save-settings feature.

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

Definition at line 777 of file kmainwindow.cpp.

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;
  while (KMainWindow::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 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!

See also: kRestoreMainWindows(); readProperties(); canBeRestored()

Definition at line 473 of file kmainwindow.cpp.

void KMainWindow::restoreWindowSize ( const KConfigGroup & config )

protected

For inherited classes.

Deprecated:: use KWindowConfig::restoreWindowSize

Definition at line 731 of file kmainwindow.cpp.

void KMainWindow::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 804 of file kmainwindow.cpp.

void KMainWindow::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 550 of file kmainwindow.cpp.

void KMainWindow::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 579 of file kmainwindow.cpp.

virtual void KMainWindow::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 531 of file kmainwindow.h.

void KMainWindow::saveWindowSize ( KConfigGroup & config ) const

protected

For inherited classes.

Deprecated:: use KWindowConfig::saveWindowSize

Definition at line 738 of file kmainwindow.cpp.

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.

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

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().

Since: 4.1

Definition at line 761 of file kmainwindow.cpp.

void KMainWindow::setCaption ( const QString & caption )

virtualslot

Makes a KDE compliant caption (window title).

Parameters

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

Definition at line 488 of file kmainwindow.cpp.

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

virtualslot

Makes a KDE compliant caption.

Parameters

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

Definition at line 493 of file kmainwindow.cpp.

void KMainWindow::setPlainCaption ( const QString & caption )

virtualslot

Make a plain caption without any modifications.

Parameters

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

Definition at line 503 of file kmainwindow.cpp.

void KMainWindow::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 744 of file kmainwindow.cpp.

bool KMainWindow::settingsDirty ( ) const

protected

For inherited classes.

Definition at line 750 of file kmainwindow.cpp.

virtual KXMLGUI_DEPRECATED void KMainWindow::showAboutApplication ( )

inlineprotectedvirtualslot

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.

Example:

void MyMainLevel::setupInterface()
{
  ..
  menuBar()->addMenu( customHelpMenu() );
  ..
}
void MyMainLevel::showAboutApplication()
{
  <activate your custom dialog>
}

Deprecated:: use KHelpMenu

Definition at line 614 of file kmainwindow.h.

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.

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

QList< KToolBar * > KMainWindow::toolBars ( ) const

Returns: A list of all toolbars for this window

Definition at line 921 of file kmainwindow.cpp.

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

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

Properties

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation