KPageWidgetItem

#include <KPageWidgetItem>

Inheritance diagram for KPageWidgetItem:

Properties
QList< QAction * >	actions

bool	checkable

bool	checked

bool	enabled

QString	header

bool	headerVisible

QIcon	icon

QString	name

Properties inherited from QObject
	objectName

Signals
void	actionsChanged ()

void	changed ()

void	toggled (bool checked)

Public Slots
void	setChecked (bool checked)

void	setEnabled (bool)

Public Member Functions
	KPageWidgetItem (QWidget *widget)

	KPageWidgetItem (QWidget *widget, const QString &name)

	~KPageWidgetItem () override

QList< QAction * >	actions () const

QString	header () const

QIcon	icon () const

bool	isCheckable () const

bool	isChecked () const

bool	isEnabled () const

bool	isHeaderVisible () const

QString	name () const

void	setActions (QList< QAction * > actions)

void	setCheckable (bool checkable)

void	setHeader (const QString &header)

void	setHeaderVisible (bool visible)

void	setIcon (const QIcon &icon)

void	setName (const QString &name)

QWidget *	widget () const

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

QBindable< QString >	bindableObjectName ()

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

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

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

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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const 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_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

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	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

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

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

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

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

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

bool	disconnect (const QMetaObject::Connection &connection)

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

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

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

Detailed Description

KPageWidgetItem is used by KPageWidget and represents a page.

Example:

ColorPage *page = new ColorPage;
 
KPageWidgetItem *item = new KPageWidgetItem( page, i18n( "Colors" ) );
item->setHeader( i18n( "Colors of Main Window" ) );
item->setIcon( QIcon::fromTheme( "colors" ) );
 
KPageWidget *pageWidget = new KPageWidget( this );
pageWidget->addPage( item );

Author: Tobias Koenig (tokoe.nosp@m.@kde.nosp@m..org)

Definition at line 38 of file kpagewidgetmodel.h.

Property Documentation

◆ actions

QList<QAction *> KPageWidgetItem::actions

readwrite

This property holds the actions associated to the page.

Warning: This is not supported when using a KPageView/KPageWidget/KPageDialog with the Tabbed face type.

Since: 6.6

Definition at line 63 of file kpagewidgetmodel.h.

◆ checkable

bool KPageWidgetItem::checkable

readwrite

Definition at line 44 of file kpagewidgetmodel.h.

◆ checked

bool KPageWidgetItem::checked

readwrite

Definition at line 45 of file kpagewidgetmodel.h.

◆ enabled

bool KPageWidgetItem::enabled

readwrite

This property holds whether the item is enabled.

It dis-/enables both the widget and the item in the list-/treeview.

Definition at line 51 of file kpagewidgetmodel.h.

◆ header

QString KPageWidgetItem::header

readwrite

Definition at line 42 of file kpagewidgetmodel.h.

◆ headerVisible

bool KPageWidgetItem::headerVisible

readwrite

Since: 5.52

Definition at line 55 of file kpagewidgetmodel.h.

◆ icon

QIcon KPageWidgetItem::icon

readwrite

Definition at line 43 of file kpagewidgetmodel.h.

◆ name

QString KPageWidgetItem::name

readwrite

Definition at line 41 of file kpagewidgetmodel.h.

Constructor & Destructor Documentation

◆ KPageWidgetItem() [1/2]

KPageWidgetItem::KPageWidgetItem ( QWidget * widget )

Creates a new page widget item.

Parameters

widget The widget that is shown as page in the KPageWidget.

Definition at line 46 of file kpagewidgetmodel.cpp.

◆ KPageWidgetItem() [2/2]

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

Creates a new page widget item.

Parameters

widget	The widget that is shown as page in the KPageWidget.
name	The localized string that is show in the navigation view of the KPageWidget.

Definition at line 60 of file kpagewidgetmodel.cpp.

◆ ~KPageWidgetItem()

KPageWidgetItem::~KPageWidgetItem ( )

overridedefault

Destroys the page widget item.

Member Function Documentation

◆ actions()

QList< QAction * > KPageWidgetItem::actions ( ) const

Returns the actions associated to the page.

Since: 6.6

Definition at line 169 of file kpagewidgetmodel.cpp.

◆ actionsChanged

void KPageWidgetItem::actionsChanged ( )

signal

This signal is emitted whenever the actions associated to the page are changed.

Since: 6.6

◆ changed

void KPageWidgetItem::changed ( )

signal

This signal is emitted whenever the icon or header is changed.

◆ header()

QString KPageWidgetItem::header ( ) const

Returns the header of the page widget item.

Definition at line 127 of file kpagewidgetmodel.cpp.

◆ icon()

QIcon KPageWidgetItem::icon ( ) const

Returns the icon of the page widget item.

Definition at line 139 of file kpagewidgetmodel.cpp.

◆ isCheckable()

bool KPageWidgetItem::isCheckable ( ) const

Returns whether the page widget item is checkable.

Definition at line 151 of file kpagewidgetmodel.cpp.

◆ isChecked()

bool KPageWidgetItem::isChecked ( ) const

Returns whether the page widget item is checked.

Definition at line 164 of file kpagewidgetmodel.cpp.

◆ isEnabled()

bool KPageWidgetItem::isEnabled ( ) const

Returns whether the page widget item is enabled.

Definition at line 86 of file kpagewidgetmodel.cpp.

◆ isHeaderVisible()

bool KPageWidgetItem::isHeaderVisible ( ) const

Returns whether the page will show the header title.

Since: 5.52

Definition at line 91 of file kpagewidgetmodel.cpp.

◆ name()

QString KPageWidgetItem::name ( ) const

Returns the name of the page widget item.

Definition at line 115 of file kpagewidgetmodel.cpp.

◆ setActions()

void KPageWidgetItem::setActions ( QList< QAction * > actions )

Set the actions associated to the page.

Since: 6.6

Definition at line 174 of file kpagewidgetmodel.cpp.

◆ setCheckable()

void KPageWidgetItem::setCheckable ( bool checkable )

Sets whether the page widget item is checkable in the view.

Parameters

checkable True if the page widget is checkable, otherwise false.

Definition at line 144 of file kpagewidgetmodel.cpp.

◆ setChecked

void KPageWidgetItem::setChecked ( bool checked )

slot

Sets whether the page widget item is checked.

Definition at line 156 of file kpagewidgetmodel.cpp.

◆ setEnabled

void KPageWidgetItem::setEnabled ( bool enabled )

slot

Sets whether the page widget item is enabled.

Definition at line 77 of file kpagewidgetmodel.cpp.

◆ setHeader()

void KPageWidgetItem::setHeader ( const QString & header )

Sets the header of the page widget item.

If setHeader(QString()) is used, what is the default if the header does not got set explicit, then the defined name() will also be used for the header.

Parameters

header Header of the page widget item.

Definition at line 120 of file kpagewidgetmodel.cpp.

◆ setHeaderVisible()

void KPageWidgetItem::setHeaderVisible ( bool visible )

Set whether the page should show the header title.

Since: 5.52

Definition at line 96 of file kpagewidgetmodel.cpp.

◆ setIcon()

void KPageWidgetItem::setIcon ( const QIcon & icon )

Sets the icon of the page widget item.

Parameters

icon	Icon of the page widget item.

Definition at line 132 of file kpagewidgetmodel.cpp.

◆ setName()

void KPageWidgetItem::setName ( const QString & name )

Sets the name of the item as shown in the navigation view of the page widget.

Definition at line 108 of file kpagewidgetmodel.cpp.

◆ toggled

void KPageWidgetItem::toggled ( bool checked )

signal

This signal is emitted whenever the user checks or unchecks the item of setChecked() is called.

◆ widget()

QWidget * KPageWidgetItem::widget ( ) const

Returns the widget of the page widget item.

Definition at line 103 of file kpagewidgetmodel.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KPageWidgetItem

Properties

Signals

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ actions

◆ checkable

◆ checked

◆ enabled

◆ header

◆ headerVisible

◆ icon

◆ name

Constructor & Destructor Documentation

◆ KPageWidgetItem() [1/2]

◆ KPageWidgetItem() [2/2]

◆ ~KPageWidgetItem()

Member Function Documentation

◆ actions()

◆ actionsChanged

◆ changed

◆ header()

◆ icon()

◆ isCheckable()

◆ isChecked()

◆ isEnabled()

◆ isHeaderVisible()

◆ name()

◆ setActions()

◆ setCheckable()

◆ setChecked

◆ setEnabled

◆ setHeader()

◆ setHeaderVisible()

◆ setIcon()

◆ setName()

◆ toggled

◆ widget()