KDialog

#include <kdialog.h>

Inheritance diagram for KDialog:

[legend]

Public Types
enum	ButtonCode { None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004, Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040, No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400, User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000 }

typedef QFlags< ButtonCode >	ButtonCodes

enum	ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }

typedef QFlags< ButtonPopupMode >	ButtonPopupModes

enum	CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }

typedef QFlags< CaptionFlag >	CaptionFlags

Public Types inherited from QDialog
enum	DialogCode

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Signals
void	aboutToShowDetails ()

void	applyClicked ()

void	buttonClicked (KDialog::ButtonCode button)

void	cancelClicked ()

void	closeClicked ()

void	defaultClicked ()

void	finished ()

void	helpClicked ()

void	hidden ()

void	layoutHintChanged ()

void	noClicked ()

void	okClicked ()

void	resetClicked ()

void	tryClicked ()

void	user1Clicked ()

void	user2Clicked ()

void	user3Clicked ()

void	yesClicked ()

Public Slots
void	delayedDestruct ()

void	enableButton (ButtonCode id, bool state)

void	enableButtonApply (bool state)

void	enableButtonCancel (bool state)

void	enableButtonOk (bool state)

void	enableLinkedHelp (bool state)

bool	isDetailsWidgetVisible () const

virtual void	setCaption (const QString &caption)

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

void	setDetailsWidget (QWidget *detailsWidget)

void	setDetailsWidgetVisible (bool visible)

void	setHelp (const QString &anchor, const QString &appname=QString())

void	setHelpLinkText (const QString &text)

virtual void	setPlainCaption (const QString &caption)

Public Member Functions
	KDialog (QWidget *parent=nullptr, Qt::WindowFlags flags={})

	~KDialog () override

QPushButton *	button (ButtonCode id) const

QIcon	buttonIcon (ButtonCode id) const

QString	buttonText (ButtonCode id) const

QString	buttonToolTip (ButtonCode id) const

QString	buttonWhatsThis (ButtonCode id) const

ButtonCode	defaultButton () const

QString	helpLinkText () const

void	incrementInitialSize (const QSize &size)

bool	isButtonEnabled (ButtonCode id) const

QWidget *	mainWidget ()

QSize	minimumSizeHint () const override

void	restoreDialogSize (const KConfigGroup &config)

void	saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const

void	setButtonFocus (ButtonCode id)

void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)

void	setButtonIcon (ButtonCode id, const QIcon &icon)

void	setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)

void	setButtons (ButtonCodes buttonMask)

void	setButtonsOrientation (Qt::Orientation orientation)

void	setButtonText (ButtonCode id, const QString &text)

void	setButtonToolTip (ButtonCode id, const QString &text)

void	setButtonWhatsThis (ButtonCode id, const QString &text)

void	setDefaultButton (ButtonCode id)

void	setEscapeButton (ButtonCode id)

void	setInitialSize (const QSize &size)

void	setMainWidget (QWidget *widget)

void	showButton (ButtonCode id, bool state)

void	showButtonSeparator (bool state)

QSize	sizeHint () const override

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

virtual void	accept ()

void	accepted ()

virtual void	done (int r)

virtual int	exec ()

QWidget *	extension () const const

void	finished (int result)

bool	isSizeGripEnabled () const const

virtual void	open ()

Qt::Orientation	orientation () const const

virtual void	reject ()

void	rejected ()

int	result () const const

void	setExtension (QWidget *extension)

void	setModal (bool modal)

void	setOrientation (Qt::Orientation orientation)

void	setResult (int i)

void	setSizeGripEnabled (bool)

virtual void	setVisible (bool visible) override

void	showExtension (bool showIt)

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

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (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

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () 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)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () 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

QLayout *	layout () 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

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () 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, 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

QScreen *	screen () 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)

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

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () 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

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () 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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const const

T	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 QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	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

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

T	qobject_cast (const QObject *object)

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

QThread *	thread () 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	avoidArea (QWidget *widget, const QRect &area, int screen=-1)

static void	centerOnScreen (QWidget *widget, int screen=-1)

static int	groupSpacingHint ()

static QString	makeStandardCaption (const QString &userCaption, QWidget *window=nullptr, CaptionFlags flags=HIGCompliantCaption)

static int	marginHint ()

static void	resizeLayout (QLayout *lay, int margin, int spacing)

static void	resizeLayout (QWidget *widget, int margin, int spacing)

static void	setAllowEmbeddingInGraphicsView (bool allowEmbedding)

static int	spacingHint ()

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 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
virtual void	slotButtonClicked (int button)

void	updateGeometry ()

Protected Member Functions
	KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags={})

void	closeEvent (QCloseEvent *e) override

void	hideEvent (QHideEvent *) override

void	keyPressEvent (QKeyEvent *) override

Protected Member Functions inherited from QDialog
virtual void	contextMenuEvent (QContextMenuEvent *e) override

virtual bool	eventFilter (QObject o, QEvent e) override

virtual void	resizeEvent (QResizeEvent *) override

virtual void	showEvent (QShowEvent *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 bool	event (QEvent *event) override

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
KDialogPrivate *const	d_ptr

Additional Inherited Members
Properties inherited from QDialog
	modal

	sizeGripEnabled

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 Attributes inherited from QDialog
	Accepted

	Rejected

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

A dialog base class with standard buttons and predefined layouts.

Provides basic functionality needed by nearly all dialogs.

It offers the standard action buttons you'd expect to find in a dialog as well as the capability to define at most three configurable buttons. You can define a main widget that contains your specific dialog layout

The class takes care of the geometry management. You only need to define a minimum size for the widget you want to use as the main widget.

By default, the dialog is non-modal.

Standard buttons (action buttons):
You select which buttons should be displayed, but you do not choose the order in which they are displayed. This ensures a standard interface in KDE. The button order can be changed, but this ability is only available for a central KDE control tool. The following buttons are available: OK, Cancel/Close, Apply/Try, Default, Help and three user definable buttons: User1, User2 and User3. You must specify the text of the UserN buttons. Each button emit a signal, so you can choose to connect that signal.

The default action of the Help button will open the help system if you have provided a path to the help text. The default action of Ok and Cancel will run QDialog::accept() and QDialog::reject(), which you can override by reimplementing slotButtonClicked(). The default action of the Close button will close the dialog.

Note that the KDialog will animate a button press when the user presses Escape. The button that is enabled is either Cancel, Close or the button that is defined by setEscapeButton(). Your custom dialog code should reimplement the keyPressEvent and animate the cancel button so that the dialog behaves like regular dialogs.

Layout:
The dialog consists of a help area on top (becomes visible if you define a help path and use enableLinkedHelp()), the main area which is the built-in dialog face or your own widget in the middle and by default a button box at the bottom. The button box can also be placed at the right edge (to the right of the main widget). Use setButtonsOrientation() to control this behavior. A separator can be placed above the button box (or to the left when the button box is at the right edge).

Standard compliance:
The marginHint() and spacingHint() sizes shall be used whenever you lay out the interior of a dialog. One special note. If you make your own action buttons (OK, Cancel etc), the space between the buttons shall be spacingHint(), whereas the space above, below, to the right and to the left shall be marginHint(). If you add a separator line above the buttons, there shall be a marginHint() between the buttons and the separator and a marginHint() above the separator as well.

Example:

KDialog *dialog = new KDialog( this );
dialog->setCaption( "My title" );
dialog->setButtons( KDialog::Ok | KDialog::Cancel | KDialog::Apply );
 
FooWidget *widget = new FooWidget( dialog );
dialog->setMainWidget( widget );
connect( dialog, SIGNAL( applyClicked() ), widget, SLOT( save() ) );
connect( dialog, SIGNAL( okClicked() ), widget, SLOT( save() ) );
connect( widget, SIGNAL( changed( bool ) ), dialog, SLOT( enableButtonApply( bool ) ) );
 
dialog->enableButtonApply( false );
dialog->show();

KDE Dialog example

This class can be used in many ways. Note that most KDE ui widgets and many of KDE core applications use the KDialog so for more inspiration you should study the code for these.

See also: KPageDialog

Author: Thomas Tanghus tangh[email protected][email protected][email protected]arthl[email protected]ing.[email protected]net; Espen Sand espen[email protected][email protected][email protected]nline[email protected].no; Mirko Boehm mirko[email protected]@kde[email protected].org; Olivier Goffart <ogoffart at kde.org>; Tobias Koenig tokoe[email protected]@kde[email protected].org

Definition at line 128 of file kdialog.h.

Member Enumeration Documentation

◆ ButtonCode

enum KDialog::ButtonCode

Enumerator
Help	Show Help button. (this button will run the help set with setHelp)
Default	Show Default button.
Ok	Show Ok button. (this button accept()s the dialog; result set to QDialog::Accepted)
Apply	Show Apply button.
Try	Show Try button.
Cancel	Show Cancel-button. (this button reject()s the dialog; result set to QDialog::Rejected)
Close	Show Close-button. (this button closes the dialog)
No	Show No button. (this button closes the dialog and sets the result to KDialog::No)
Yes	Show Yes button. (this button closes the dialog and sets the result to KDialog::Yes)
Reset	Show Reset button.
Details	Show Details button. (this button will show the detail widget set with setDetailsWidget)
User1	Show User defined button 1.
User2	Show User defined button 2.
User3	Show User defined button 3.
NoDefault	Used when specifying a default button; indicates that no button should be marked by default.

Definition at line 136 of file kdialog.h.

Constructor & Destructor Documentation

◆ KDialog()

KDialog::KDialog	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	flags = `{}`
	)

explicit

Creates a dialog.

Parameters

parent	The parent of the dialog.
flags	The widget flags passed to the QDialog constructor

Definition at line 199 of file kdialog.cpp.

◆ ~KDialog()

KDialog::~KDialog ( )

override

Destroys the dialog.

Definition at line 211 of file kdialog.cpp.

Member Function Documentation

◆ aboutToShowDetails

void KDialog::aboutToShowDetails ( )

signal

The detailsWidget is about to get shown.

This is your last chance to call setDetailsWidget if you haven't done so yet.

◆ applyClicked

void KDialog::applyClicked ( )

signal

The Apply button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ avoidArea()

bool KDialog::avoidArea	(	QWidget *	widget,
		const QRect &	area,
		int	screen = `-1`
	)

static

Places widget so that it doesn't cover a certain area of the screen.

This is typically used by the "find dialog" so that the match it finds can be read. For screen, see centerOnScreen

Returns: true on success (widget doesn't cover area anymore, or never did), false on failure (not enough space found)

Definition at line 613 of file kdialog.cpp.

◆ button()

QPushButton * KDialog::button ( ButtonCode id ) const

Returns the button that corresponds to the id.

Normally you should not use this function. Never delete the object returned by this function. See also enableButton(), showButton(), setButtonGuiItem().

Parameters

id	Identifier of the button.

Returns: The button or 0 if the button does not exist.

Definition at line 702 of file kdialog.cpp.

◆ buttonClicked

void KDialog::buttonClicked ( KDialog::ButtonCode button )

signal

A button has been pressed.

This signal is only emitted if slotButtonClicked() is not replaced

Parameters

button is the code of the pressed button.

◆ buttonIcon()

QIcon KDialog::buttonIcon ( ButtonCode id ) const

Returns the icon of any button.

Definition at line 804 of file kdialog.cpp.

◆ buttonText()

QString KDialog::buttonText ( ButtonCode id ) const

Returns the text of any button.

Definition at line 786 of file kdialog.cpp.

◆ buttonToolTip()

QString KDialog::buttonToolTip ( ButtonCode id ) const

Returns the tooltip of any button.

Definition at line 826 of file kdialog.cpp.

◆ buttonWhatsThis()

QString KDialog::buttonWhatsThis ( ButtonCode id ) const

Returns the "What's this?" text of any button.

Definition at line 848 of file kdialog.cpp.

◆ cancelClicked

void KDialog::cancelClicked ( )

signal

The Cancel button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ centerOnScreen()

void KDialog::centerOnScreen	(	QWidget *	widget,
		int	screen = `-1`
	)

static

Centers widget on the desktop, taking multi-head setups into account.

If screen is -1, widget will be centered on its current screen (if it was shown already) or on the primary screen. If screen is -3, widget will be centered on the screen that currently contains the mouse pointer. screen will be ignored if a merged display (like Xinerama) is not in use, or merged display placement is not enabled in kdeglobals.

Definition at line 593 of file kdialog.cpp.

◆ closeClicked

void KDialog::closeClicked ( )

signal

The Close button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ closeEvent()

void KDialog::closeEvent ( QCloseEvent * e )

overrideprotectedvirtual

Detects when a dialog is being closed from the window manager controls.

If the Cancel or Close button is present then the button is activated. Otherwise standard QDialog behavior will take place.

Reimplemented from QDialog.

Definition at line 1070 of file kdialog.cpp.

◆ defaultButton()

KDialog::ButtonCode KDialog::defaultButton ( ) const

Returns the button code of the default button, or NoDefault if there is no default button.

Definition at line 352 of file kdialog.cpp.

◆ defaultClicked

void KDialog::defaultClicked ( )

signal

The Default button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ delayedDestruct

void KDialog::delayedDestruct ( )

slot

Destruct the dialog delayed.

You can call this function from slots like closeClicked() and hidden(). You should not use the dialog any more after calling this function.

Deprecated:: use hide()+deleteLater()

Definition at line 934 of file kdialog.cpp.

◆ enableButton

void KDialog::enableButton	(	ButtonCode	id,
		bool	state
	)

slot

Enable or disable (gray out) a general action button.

Parameters

id	Button identifier.
state	`true` enables the button(s).

Definition at line 708 of file kdialog.cpp.

◆ enableButtonApply

void KDialog::enableButtonApply ( bool state )

slot

Enable or disable (gray out) the Apply button.

Parameters

state true enables the button.

Definition at line 731 of file kdialog.cpp.

◆ enableButtonCancel

void KDialog::enableButtonCancel ( bool state )

slot

Enable or disable (gray out) the Cancel button.

Parameters

state true enables the button.

Definition at line 736 of file kdialog.cpp.

◆ enableButtonOk

void KDialog::enableButtonOk ( bool state )

slot

Enable or disable (gray out) the OK button.

Parameters

state true enables the button.

Definition at line 726 of file kdialog.cpp.

◆ enableLinkedHelp

void KDialog::enableLinkedHelp ( bool state )

slot

Display or hide the help link area on the top of the dialog.

Parameters

state true will display the area.

See also: helpLinkText(); setHelpLinkText(); setHelp()

Definition at line 1008 of file kdialog.cpp.

◆ finished

void KDialog::finished ( )

signal

The dialog has finished.

A dialog emits finished after a user clicks a button that ends the dialog.

This signal is also emitted when you call hide()

If you have stored a pointer to the dialog do not try to delete the pointer in the slot that is connected to this signal.

You should use deleteLater() instead.

◆ groupSpacingHint()

int KDialog::groupSpacingHint ( )

static

Returns the number of pixels that should be used to visually separate groups of related options in a dialog according to the KDE standard.

Since: 4.2

Definition at line 469 of file kdialog.cpp.

◆ helpClicked

void KDialog::helpClicked ( )

signal

The Help button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ helpLinkText()

QString KDialog::helpLinkText ( ) const

Returns the help link text.

If no text has been defined, "Get help..." (internationalized) is returned.

Returns: The help link text.

See also: enableLinkedHelp(); setHelpLinkText(); setHelp()

Definition at line 1051 of file kdialog.cpp.

◆ hidden

void KDialog::hidden ( )

signal

The dialog is about to be hidden.

A dialog is hidden after a user clicks a button that ends the dialog or when the user switches to another desktop or minimizes the dialog.

◆ hideEvent()

void KDialog::hideEvent ( QHideEvent * event )

overrideprotectedvirtual

Emits the hidden signal.

You can connect to that signal to detect when a dialog has been closed.

Reimplemented from QWidget.

Definition at line 1061 of file kdialog.cpp.

◆ incrementInitialSize()

void KDialog::incrementInitialSize ( const QSize & size )

Convenience method.

Add a size to the default minimum size of a dialog.

This method should only be called right before show() or exec().

Parameters

size	Size added to minimum size.

Definition at line 696 of file kdialog.cpp.

◆ isButtonEnabled()

bool KDialog::isButtonEnabled ( ButtonCode id ) const

Returns whether any button is enabled.

Definition at line 716 of file kdialog.cpp.

◆ isDetailsWidgetVisible

bool KDialog::isDetailsWidgetVisible ( ) const

slot

Returns the status of the Details button.

Definition at line 887 of file kdialog.cpp.

◆ keyPressEvent()

void KDialog::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

Reimplemented from QDialog.

Definition at line 416 of file kdialog.cpp.

◆ layoutHintChanged

void KDialog::layoutHintChanged ( )

signal

Emitted when the margin size and/or spacing size have changed.

Use marginHint() and spacingHint() in your slot to get the new values.

Deprecated:: This signal is not emitted. Listen to QEvent::StyleChange events instead.

◆ mainWidget()

QWidget * KDialog::mainWidget ( )

Returns: The current main widget. Will create a QWidget as the mainWidget if none was set before. This way you can write
ui.setupUi(mainWidget());

when using designer.

Definition at line 380 of file kdialog.cpp.

◆ makeStandardCaption()

QString KDialog::makeStandardCaption	(	const QString &	userCaption,
		QWidget *	window = `nullptr`,
		CaptionFlags	flags = `HIGCompliantCaption`
	)

static

Builds a caption that contains the application name along with the userCaption using a standard layout.

To make a compliant caption for your window, simply do: setWindowTitle(KDialog::makeStandardCaption(yourCaption));

To ensure that the caption is appropriate to the desktop in which the application is running, pass in a pointer to the window the caption will be applied to.

If using a KDialog or KMainWindow subclass, call setCaption instead and an appropraite standard caption will be created for you

Parameters

userCaption	The caption string you want to display in the window caption area. Do not include the application name!
window	a pointer to the window this application will apply to
flags

Returns: the created caption

Definition at line 474 of file kdialog.cpp.

◆ marginHint()

int KDialog::marginHint ( )

static

Returns the number of pixels that should be used between a dialog edge and the outermost widget(s) according to the KDE standard.

Deprecated:: Use the style's pixelMetric() function to query individual margins. Different platforms may use different values for the four margins.

Definition at line 459 of file kdialog.cpp.

◆ minimumSizeHint()

QSize KDialog::minimumSizeHint ( ) const

overridevirtual

Reimplemented from QDialog.

Definition at line 403 of file kdialog.cpp.

◆ noClicked

void KDialog::noClicked ( )

signal

The No button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ okClicked

void KDialog::okClicked ( )

signal

The OK button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ resetClicked

void KDialog::resetClicked ( )

signal

The Reset button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ resizeLayout() [1/2]

void KDialog::resizeLayout	(	QLayout *	lay,
		int	margin,
		int	spacing
	)

static

Resize every layout associated with lay and its children.

Parameters

lay	layout to be resized
margin	The new layout margin
spacing	The new layout spacing

Deprecated:: Use QLayout functions where necessary. Setting margin and spacing values recursively for all children prevents QLayout from creating platform native layouts.

Definition at line 549 of file kdialog.cpp.

◆ resizeLayout() [2/2]

void KDialog::resizeLayout	(	QWidget *	widget,
		int	margin,
		int	spacing
	)

static

Resize every layout manager used in widget and its nested children.

Parameters

widget	The widget used.
margin	The new layout margin.
spacing	The new layout spacing.

Deprecated:: Use QLayout functions where necessary. Setting margin and spacing values recursively for all children prevents QLayout from creating platform native layouts.

Definition at line 533 of file kdialog.cpp.

◆ restoreDialogSize()

void KDialog::restoreDialogSize ( const KConfigGroup & config )

Restores the dialog's size from the configuration according to the screen size.

Note: the group must be set before calling

Parameters

config The config group to read from.

Deprecated:: use KWindowConfig::restoreWindowSize() instead

Definition at line 1088 of file kdialog.cpp.

◆ saveDialogSize()

void KDialog::saveDialogSize	(	KConfigGroup &	config,
		KConfigGroup::WriteConfigFlags	options = `KConfigGroup::Normal`
	)		const

Saves the dialog's size dependent on the screen dimension either to the global or application config file.

Note: the group must be set before calling

Parameters

config	The config group to read from.
options	passed to KConfigGroup::writeEntry()

Deprecated:: use KWindowConfig::saveWindowSize() instead

Definition at line 1095 of file kdialog.cpp.

◆ setAllowEmbeddingInGraphicsView()

void KDialog::setAllowEmbeddingInGraphicsView ( bool allowEmbedding )

static

Allow embedding the dialogs based on KDialog into a graphics view.

By default embedding is not allowed, dialogs will appear as separate windows.

Since: 4.6

Definition at line 1101 of file kdialog.cpp.

◆ setButtonFocus()

void KDialog::setButtonFocus ( ButtonCode id )

Sets the focus to the button of the passed id.

Definition at line 858 of file kdialog.cpp.

◆ setButtonGuiItem()

void KDialog::setButtonGuiItem	(	ButtonCode	id,
		const KGuiItem &	item
	)

Sets the KGuiItem directly for the button instead of using 3 methods to set the text, tooltip and whatsthis strings.

This also allows to set an icon for the button which is otherwise not possible for the extra buttons beside Ok, Cancel and Apply.

Parameters

id	The button identifier.
item	The KGuiItem for the button.

Definition at line 749 of file kdialog.cpp.

◆ setButtonIcon()

void KDialog::setButtonIcon	(	ButtonCode	id,
		const QIcon &	icon
	)

Sets the icon of any button.

Parameters

id	The button identifier.
icon	Button icon.

Definition at line 796 of file kdialog.cpp.

◆ setButtonMenu()

void KDialog::setButtonMenu	(	ButtonCode	id,
		QMenu *	menu,
		ButtonPopupMode	popupmode = `InstantPopup`
	)

Sets the menu of any button.

Parameters

id	The button identifier.
menu	The menu.
popupmode	Choose if QPushButton setMenu or setDelayedMenu is used

Definition at line 759 of file kdialog.cpp.

◆ setButtons()

void KDialog::setButtons ( ButtonCodes buttonMask )

Creates (or recreates) the button box and all the buttons in it.

Note that some combinations are not possible. That means, you can't have the following pairs of buttons in a dialog:

Default and Details
Cancel and Close
Ok and Try

This will reset all default KGuiItem of all button.

Parameters

buttonMask Specifies what buttons will be made.

Deprecated:: Since 5.0 use QDialogButtonBox

Definition at line 216 of file kdialog.cpp.

◆ setButtonsOrientation()

void KDialog::setButtonsOrientation ( Qt::Orientation orientation )

Sets the orientation of the button box.

It can be Vertical or Horizontal. If Horizontal (default), the button box is positioned at the bottom of the dialog. If Vertical it will be placed at the right edge of the dialog.

Parameters

orientation The button box orientation.

Definition at line 293 of file kdialog.cpp.

◆ setButtonText()

void KDialog::setButtonText	(	ButtonCode	id,
		const QString &	text
	)

Sets the text of any button.

Parameters

id	The button identifier.
text	Button text.

Definition at line 771 of file kdialog.cpp.

◆ setButtonToolTip()

void KDialog::setButtonToolTip	(	ButtonCode	id,
		const QString &	text
	)

Sets the tooltip text of any button.

Parameters

id	The button identifier.
text	Button text.

Definition at line 814 of file kdialog.cpp.

◆ setButtonWhatsThis()

void KDialog::setButtonWhatsThis	(	ButtonCode	id,
		const QString &	text
	)

Sets the "What's this?" text of any button.

Parameters

id	The button identifier.
text	Button text.

Definition at line 836 of file kdialog.cpp.

◆ setCaption [1/2]

void KDialog::setCaption ( const QString & caption )

virtualslot

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

Deprecated:: Since 5.0 use QWidget::setWindowTitle

Definition at line 502 of file kdialog.cpp.

◆ setCaption [2/2]

void KDialog::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 "**".

Deprecated:: Since 5.0 use QWidget::setWindowTitle and QWidget::setWindowModified.

Definition at line 508 of file kdialog.cpp.

◆ setDefaultButton()

void KDialog::setDefaultButton ( ButtonCode id )

Sets the button that will be activated when the Enter key is pressed.

By default, this is the Ok button if it is present

Parameters

id	The button code.

Definition at line 314 of file kdialog.cpp.

◆ setDetailsWidget

void KDialog::setDetailsWidget ( QWidget * detailsWidget )

slot

Sets the widget that gets shown when "Details" is enabled.

The dialog takes over ownership of the widget. Any previously set widget gets deleted.

Definition at line 866 of file kdialog.cpp.

◆ setDetailsWidgetVisible

void KDialog::setDetailsWidgetVisible ( bool visible )

slot

Sets the status of the Details button.

Definition at line 892 of file kdialog.cpp.

◆ setEscapeButton()

void KDialog::setEscapeButton ( ButtonCode id )

Sets the button that will be activated when the Escape key is pressed.

By default, the Escape key is mapped to either the Cancel or the Close button if one of these buttons are defined. The user expects that Escape will cancel an operation so use this function with caution.

Parameters

id	The button code.

Definition at line 309 of file kdialog.cpp.

◆ setHelp

void KDialog::setHelp	(	const QString &	anchor,
		const QString &	appname = `QString()`
	)

slot

Sets the help path and topic.

Parameters

anchor	Defined anchor in your docbook sources
appname	Defines the appname the help belongs to If empty it's the current one

Note: The help button works differently for the class KCMultiDialog, so it does not make sense to call this function for Dialogs of that type. See KCMultiDialog::slotHelp() for more information.

Definition at line 1035 of file kdialog.cpp.

◆ setHelpLinkText

void KDialog::setHelpLinkText ( const QString & text )

slot

Sets the text that is shown as the linked text.

If text is empty, the text "Get help..." (internationalized) is used instead.

Parameters

text	The link text.

See also: helpLinkText(); enableLinkedHelp(); setHelp()

Definition at line 1042 of file kdialog.cpp.

◆ setInitialSize()

void KDialog::setInitialSize ( const QSize & size )

Convenience method.

Sets the initial dialog size.

This method should only be called right before show() or exec(). The initial size will be ignored if smaller than the dialog's minimum size.

Parameters

size	Startup size.

Definition at line 690 of file kdialog.cpp.

◆ setMainWidget()

void KDialog::setMainWidget ( QWidget * widget )

Sets the main widget of the dialog.

Definition at line 366 of file kdialog.cpp.

◆ setPlainCaption

void KDialog::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 520 of file kdialog.cpp.

◆ showButton()

void KDialog::showButton	(	ButtonCode	id,
		bool	state
	)

Hide or display a general action button.

Only buttons that have been created in the constructor can be displayed. This method will not create a new button.

Parameters

id	Button identifier.
state	true display the button(s).

Definition at line 741 of file kdialog.cpp.

◆ showButtonSeparator()

void KDialog::showButtonSeparator ( bool state )

Hide or display the a separator line drawn between the action buttons an the main widget.

Definition at line 669 of file kdialog.cpp.

◆ sizeHint()

QSize KDialog::sizeHint ( ) const

overridevirtual

Reimplemented from QDialog.

Definition at line 389 of file kdialog.cpp.

◆ slotButtonClicked

void KDialog::slotButtonClicked ( int button )

protectedvirtualslot

Activated when the button button is clicked.

Sample that shows how to catch and handle button clicks within an own dialog;

class MyDialog : public KDialog {
    protected Q_SLOTS:
        virtual void slotButtonClicked(int button) {
            if (button == KDialog::Ok)
                accept();
            else
                KDialog::slotButtonClicked(button);
        }
}

Parameters

button is the type KDialog::ButtonCode

Deprecated:: since 5.0 use QDialogButtonBox and connect to the clicked signal

Definition at line 943 of file kdialog.cpp.

◆ spacingHint()

int KDialog::spacingHint ( )

static

Returns the number of pixels that should be used between widgets inside a dialog according to the KDE standard.

Deprecated:: Use the style's layoutSpacing() function to query individual spacings. Different platforms may use different values depending on widget types and pairs.

Definition at line 464 of file kdialog.cpp.

◆ tryClicked

void KDialog::tryClicked ( )

signal

The Try button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ updateGeometry

void KDialog::updateGeometry ( )

protectedslot

Updates the margins and spacings.

Deprecated:: KDialog respects the style's margins and spacings automatically. Calling this function has no effect.

Definition at line 1057 of file kdialog.cpp.

◆ user1Clicked

void KDialog::user1Clicked ( )

signal

The User1 button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ user2Clicked

void KDialog::user2Clicked ( )

signal

The User2 button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ user3Clicked

void KDialog::user3Clicked ( )

signal

The User3 button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

◆ yesClicked

void KDialog::yesClicked ( )

signal

The Yes button was pressed.

This signal is only emitted if slotButtonClicked() is not replaced

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

KDialog::mainWidget

QWidget * mainWidget()

Definition: kdialog.cpp:380

KDialog::Apply

@ Apply

Show Apply button.

Definition: kdialog.h:141

QObject::Q_SLOTS

Q_SLOTSQ_SLOTS

KDialog::setMainWidget

void setMainWidget(QWidget *widget)

Sets the main widget of the dialog.

Definition: kdialog.cpp:366

KDialog::applyClicked

void applyClicked()

The Apply button was pressed.

KDialog::Ok

@ Ok

Show Ok button. (this button accept()s the dialog; result set to QDialog::Accepted)

Definition: kdialog.h:140

KDialog::button

QPushButton * button(ButtonCode id) const

Returns the button that corresponds to the id.

Definition: kdialog.cpp:702

QObject::connect

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

QDialog::accept

virtual void accept()

KDialog

A dialog base class with standard buttons and predefined layouts.

Definition: kdialog.h:128

KDialog::KDialog

KDialog(QWidget *parent=nullptr, Qt::WindowFlags flags={})

Creates a dialog.

Definition: kdialog.cpp:199

KDialog::okClicked

void okClicked()

The OK button was pressed.

QWidget::show

void show()

KStandardShortcut::save

const QList< QKeySequence > & save()

KDialog::setCaption

virtual void setCaption(const QString &caption)

Make a KDE compliant caption.

Definition: kdialog.cpp:502

KDialog::Cancel

@ Cancel

Show Cancel-button. (this button reject()s the dialog; result set to QDialog::Rejected)

Definition: kdialog.h:143

KDialog::setButtons

void setButtons(ButtonCodes buttonMask)

Creates (or recreates) the button box and all the buttons in it.

Definition: kdialog.cpp:216

KDialog::slotButtonClicked

virtual void slotButtonClicked(int button)

Activated when the button button is clicked.

Definition: kdialog.cpp:943

KDialog::enableButtonApply

void enableButtonApply(bool state)

Enable or disable (gray out) the Apply button.

Definition: kdialog.cpp:731

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KDELibs4Support

KDialog

Public Types

Signals

Public Slots

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ButtonCode

Constructor & Destructor Documentation

◆ KDialog()

◆ ~KDialog()

Member Function Documentation

◆ aboutToShowDetails

◆ applyClicked

◆ avoidArea()

◆ button()

◆ buttonClicked

◆ buttonIcon()

◆ buttonText()

◆ buttonToolTip()

◆ buttonWhatsThis()

◆ cancelClicked

◆ centerOnScreen()

◆ closeClicked

◆ closeEvent()

◆ defaultButton()

◆ defaultClicked

◆ delayedDestruct

◆ enableButton

◆ enableButtonApply

◆ enableButtonCancel

◆ enableButtonOk

◆ enableLinkedHelp

◆ finished

◆ groupSpacingHint()

◆ helpClicked

◆ helpLinkText()

◆ hidden

◆ hideEvent()

◆ incrementInitialSize()

◆ isButtonEnabled()

◆ isDetailsWidgetVisible

◆ keyPressEvent()

◆ layoutHintChanged

◆ mainWidget()

◆ makeStandardCaption()

◆ marginHint()

◆ minimumSizeHint()

◆ noClicked

◆ okClicked

◆ resetClicked

◆ resizeLayout() [1/2]

◆ resizeLayout() [2/2]

◆ restoreDialogSize()

◆ saveDialogSize()

◆ setAllowEmbeddingInGraphicsView()

◆ setButtonFocus()

◆ setButtonGuiItem()

◆ setButtonIcon()

◆ setButtonMenu()

◆ setButtons()

◆ setButtonsOrientation()

◆ setButtonText()

◆ setButtonToolTip()

◆ setButtonWhatsThis()

◆ setCaption [1/2]

◆ setCaption [2/2]

◆ setDefaultButton()

◆ setDetailsWidget

◆ setDetailsWidgetVisible

◆ setEscapeButton()

◆ setHelp