KPageDialog

#include <KPageDialog>

Inheritance diagram for KPageDialog:

[legend]

Public Types
enum	FaceType { Auto = KPageView::Auto, Plain = KPageView::Plain, List = KPageView::List, Tree = KPageView::Tree, Tabbed = KPageView::Tabbed, FlatList = KPageView::FlatList }

Public Types inherited from QDialog
enum	DialogCode

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Signals
void	currentPageChanged (KPageWidgetItem current, KPageWidgetItem before)

void	pageRemoved (KPageWidgetItem *page)

Public Member Functions
	KPageDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())

	~KPageDialog () override

void	addActionButton (QAbstractButton *button)

void	addPage (KPageWidgetItem *item)

KPageWidgetItem *	addPage (QWidget *widget, const QString &name)

void	addSubPage (KPageWidgetItem parent, KPageWidgetItem item)

KPageWidgetItem *	addSubPage (KPageWidgetItem parent, QWidget widget, const QString &name)

QPushButton *	button (QDialogButtonBox::StandardButton which) const

KPageWidgetItem *	currentPage () const

void	insertPage (KPageWidgetItem before, KPageWidgetItem item)

KPageWidgetItem *	insertPage (KPageWidgetItem before, QWidget widget, const QString &name)

void	removePage (KPageWidgetItem *item)

void	setCurrentPage (KPageWidgetItem *item)

void	setFaceType (FaceType faceType)

void	setStandardButtons (QDialogButtonBox::StandardButtons buttons)

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 QSize	minimumSizeHint () const const override

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)

virtual QSize	sizeHint () const const override

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

Protected Member Functions
KWIDGETSADDONS_NO_EXPORT	KPageDialog (KPageDialogPrivate &dd, KPageWidget widget, QWidget parent, Qt::WindowFlags flags=Qt::WindowFlags())

	KPageDialog (KPageWidget widget, QWidget parent, Qt::WindowFlags flags=Qt::WindowFlags())

QDialogButtonBox *	buttonBox ()

const QDialogButtonBox *	buttonBox () const

KPageWidget *	pageWidget ()

const KPageWidget *	pageWidget () const

void	setButtonBox (QDialogButtonBox *box)

void	setPageWidget (KPageWidget *widget)

Protected Member Functions inherited from QDialog
virtual void	closeEvent (QCloseEvent *e) override

virtual void	contextMenuEvent (QContextMenuEvent *e) override

virtual bool	eventFilter (QObject o, QEvent e) override

virtual void	keyPressEvent (QKeyEvent *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	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (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
const std::unique_ptr< class KPageDialogPrivate >	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

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)

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 which can handle multiple pages.

This class provides a dialog base class which handles multiple pages and allows the user to switch between these pages in different ways.

Currently, Auto, Plain, List, Tree and Tabbed face types are available (cmp. KPageView).

By default a QDialogButtonBox is added to the dialog with two buttons, OK (QDialogButtonBox::Ok) and Cancel (QDialogButtonBox::Cancel). You can customize which buttons are added to the dialog by using any of the available buttons-related methods.

Note that if there is a QDialogButtonBox (either the one added by default, or one you added manually) some logical connections are created:

QDialogButtonBox::accepted() is connected to QDialog::accept()
QDialogButtonBox::rejected() is connected to QDialog::reject() this means that you shouldn't create these connections again (otherwise you would end up receiving two duplicate accepted() signals for example).

Example:

UrlDialog::UrlDialog( QWidget *parent )
  : KPageDialog( parent )
{
  setFaceType(List);
 
  QLabel *label = new QLabel("Test Page");
  addPage(label, i18n("My Test Page"));
 
  label = new QLabel("Second Test Page");
  KPageWidgetItem *page = new KPageWidgetItem(label, i18n("My Second Test Page"));
  page->setHeader(i18n("My header string"));
  page->setIcon(QIcon::fromTheme("file"));
 
  addPage(page);
 
  // Change the buttons added to the dialog
  setStandardButtons(QDialogButtonBox::Ok | QDialogButtonBox::Apply | QDialogButtonBox::Cancel);
 
  // Alternatively you can create a QDialogButtonBox, add the buttons you want to it,
  // then add that button box to the dialog
  QDialogButtonBox *btnBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Apply | QDialogButtonBox::Cancel,
                                                  Qt::Horizontal,
                                                  this);
  setButtonBox(btnBox);
}

Author: Tobias Koenig (tokoe[email protected]@kde[email protected].org)

Definition at line 77 of file kpagedialog.h.

Member Enumeration Documentation

◆ FaceType

enum KPageDialog::FaceType

The face types supported.

Enumerator
Auto	A dialog with a face based on the structure of the available pages. If only a single page is added, the dialog behaves like in `Plain` mode, with multiple pages without sub pages it behaves like in `List` mode and like in `Tree` mode otherwise.
Plain	A normal dialog.
List	A dialog with an icon list on the left side and a representation of the contents on the right side.
Tree	A dialog with a tree on the left side and a representation of the contents on the right side.
Tabbed	A dialog with a tab bar above the representation of the contents.
FlatList	A dialog with an flat list with small icons on the left side and a representation of the contents on the right side.

Definition at line 86 of file kpagedialog.h.

Constructor & Destructor Documentation

◆ KPageDialog() [1/2]

KPageDialog::KPageDialog	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	flags = `Qt::WindowFlags()`
	)

explicit

Creates a new page dialog.

Definition at line 17 of file kpagedialog.cpp.

◆ ~KPageDialog()

KPageDialog::~KPageDialog ( )

overridedefault

Destroys the page dialog.

◆ KPageDialog() [2/2]

KPageDialog::KPageDialog	(	KPageWidget *	widget,
		QWidget *	parent,
		Qt::WindowFlags	flags = `Qt::WindowFlags()`
	)

protected

This constructor can be used by subclasses to provide a custom page widget.

Parameters

widget The KPageWidget object will be reparented to this object, so you can create it without parent and you are not allowed to delete it.

Definition at line 22 of file kpagedialog.cpp.

Member Function Documentation

◆ addActionButton()

void KPageDialog::addActionButton ( QAbstractButton * button )

Set an action button.

Definition at line 144 of file kpagedialog.cpp.

◆ addPage() [1/2]

void KPageDialog::addPage ( KPageWidgetItem * item )

Adds a new top level page to the dialog.

Parameters

item	The KPageWidgetItem which describes the page.

Definition at line 74 of file kpagedialog.cpp.

◆ addPage() [2/2]

KPageWidgetItem * KPageDialog::addPage	(	QWidget *	widget,
		const QString &	name
	)

Adds a new top level page to the dialog.

Parameters

widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated KPageWidgetItem.

Definition at line 67 of file kpagedialog.cpp.

◆ addSubPage() [1/2]

void KPageDialog::addSubPage	(	KPageWidgetItem *	parent,
		KPageWidgetItem *	item
	)

Inserts a new sub page in the dialog.

Parameters

parent	The new page will be insert as child of this KPageWidgetItem.
item	The KPageWidgetItem which describes the page.

Definition at line 102 of file kpagedialog.cpp.

◆ addSubPage() [2/2]

KPageWidgetItem * KPageDialog::addSubPage	(	KPageWidgetItem *	parent,
		QWidget *	widget,
		const QString &	name
	)

Inserts a new sub page in the dialog.

Parameters

parent	The new page will be insert as child of this KPageWidgetItem.
widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated KPageWidgetItem.

Definition at line 95 of file kpagedialog.cpp.

◆ button()

QPushButton * KPageDialog::button ( QDialogButtonBox::StandardButton which ) const

Returns the QPushButton corresponding to the standard button which, or a null pointer if the standard button doesn't exist in this dialog.

Definition at line 137 of file kpagedialog.cpp.

◆ buttonBox() [1/2]

const QDialogButtonBox * KPageDialog::buttonBox ( )

protected

Returns the button box of the dialog or a null pointer if no button box is set.

Definition at line 174 of file kpagedialog.cpp.

◆ buttonBox() [2/2]

const QDialogButtonBox* KPageDialog::buttonBox ( ) const

protected

Returns the button box of the dialog or a null pointer if no button box is set.

◆ currentPage()

KPageWidgetItem * KPageDialog::currentPage ( ) const

Returns the KPageWidgetItem for the current page or a null pointer if there is no current page.

Definition at line 123 of file kpagedialog.cpp.

◆ currentPageChanged

void KPageDialog::currentPageChanged	(	KPageWidgetItem *	current,
		KPageWidgetItem *	before
	)

signal

This signal is emitted whenever the current page has changed.

Parameters

current	The new current page or a null pointer if no current page is available.
before	The page that was current before the new current page has changed.

◆ insertPage() [1/2]

void KPageDialog::insertPage	(	KPageWidgetItem *	before,
		KPageWidgetItem *	item
	)

Inserts a new page in the dialog.

Parameters

before	The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
item	The KPageWidgetItem which describes the page.

Definition at line 88 of file kpagedialog.cpp.

◆ insertPage() [2/2]

KPageWidgetItem * KPageDialog::insertPage	(	KPageWidgetItem *	before,
		QWidget *	widget,
		const QString &	name
	)

Inserts a new page in the dialog.

Parameters

before	The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
widget	The widget of the page.
name	The name which is displayed in the navigation view.

Returns: The associated KPageWidgetItem.

Definition at line 81 of file kpagedialog.cpp.

◆ pageRemoved

void KPageDialog::pageRemoved ( KPageWidgetItem * page )

signal

This signal is emitted whenever a page has been removed.

Parameters

page	The page which has been removed

◆ pageWidget() [1/2]

const KPageWidget * KPageDialog::pageWidget ( )

protected

Returns the page widget of the dialog or a null pointer if no page widget is set.

Definition at line 151 of file kpagedialog.cpp.

◆ pageWidget() [2/2]

const KPageWidget* KPageDialog::pageWidget ( ) const

protected

Returns the page widget of the dialog or a null pointer if no page widget is set.

◆ removePage()

void KPageDialog::removePage ( KPageWidgetItem * item )

Removes the page associated with the given KPageWidgetItem.

Definition at line 109 of file kpagedialog.cpp.

◆ setButtonBox()

void KPageDialog::setButtonBox ( QDialogButtonBox * box )

protected

Set the button box of the dialog.

Note: the previous buttonBox will be deleted.

Parameters

box	The QDialogButtonBox object will be reparented to this object, so you can create it without parent and you are not allowed to delete it.

Definition at line 188 of file kpagedialog.cpp.

◆ setCurrentPage()

void KPageDialog::setCurrentPage ( KPageWidgetItem * item )

Sets the page which is associated with the given KPageWidgetItem to be the current page and emits the currentPageChanged() signal.

Definition at line 116 of file kpagedialog.cpp.

◆ setFaceType()

void KPageDialog::setFaceType ( FaceType faceType )

Sets the face type of the dialog.

Definition at line 47 of file kpagedialog.cpp.

◆ setPageWidget()

void KPageDialog::setPageWidget ( KPageWidget * widget )

protected

Set the page widget of the dialog.

Note: the previous pageWidget will be deleted.

Parameters

widget The KPageWidget object will be reparented to this object, so you can create it without parent and you are not allowed to delete it.

Definition at line 158 of file kpagedialog.cpp.

◆ setStandardButtons()

void KPageDialog::setStandardButtons ( QDialogButtonBox::StandardButtons buttons )

Sets the collection of standard buttons displayed by this dialog.

Definition at line 130 of file kpagedialog.cpp.

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

QWidget

QIcon::fromTheme

QIcon fromTheme(const QString &name)

QLabel

KPageWidgetItem::setIcon

void setIcon(const QIcon &icon)

Sets the icon of the page widget item.

Definition: kpagewidgetmodel.cpp:137

i18n

QString i18n(const char *text, const TYPE &arg...)

Qt::Horizontal

Horizontal

KPageWidgetItem

Definition: kpagewidgetmodel.h:37

QDialogButtonBox::Ok

KStandardShortcut::label

QString label(StandardShortcut id)

KPageDialog

A dialog base class which can handle multiple pages.

Definition: kpagedialog.h:77

KPageWidgetItem::setHeader

void setHeader(const QString &header)

Sets the header of the page widget item.

Definition: kpagewidgetmodel.cpp:119

QDialogButtonBox

QObject::parent

QObject * parent() const const

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KPageDialog

Public Types

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FaceType

Constructor & Destructor Documentation

◆ KPageDialog() [1/2]

◆ ~KPageDialog()

◆ KPageDialog() [2/2]

Member Function Documentation

◆ addActionButton()

◆ addPage() [1/2]

◆ addPage() [2/2]

◆ addSubPage() [1/2]

◆ addSubPage() [2/2]

◆ button()

◆ buttonBox() [1/2]

◆ buttonBox() [2/2]

◆ currentPage()

◆ currentPageChanged

◆ insertPage() [1/2]

◆ insertPage() [2/2]

◆ pageRemoved

◆ pageWidget() [1/2]

◆ pageWidget() [2/2]

◆ removePage()

◆ setButtonBox()

◆ setCurrentPage()

◆ setFaceType()

◆ setPageWidget()

◆ setStandardButtons()