KPageWidgetItem

#include <KPageWidgetItem>

Inheritance diagram for KPageWidgetItem:

Properties

bool checkable
 
bool checked
 
bool enabled
 
QString header
 
bool headerVisible
 
QIcon icon
 
QString name
 
- Properties inherited from QObject
 objectName
 

Signals

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 ()
 
QString header () const
 
QIcon icon () const
 
bool isCheckable () const
 
bool isChecked () const
 
bool isEnabled () const
 
bool isHeaderVisible () const
 
QString name () const
 
void setCheckable (bool checkable)
 
void setHeader (const QString &header)
 
void setHeaderVisible (bool visible)
 
void setIcon (const QIcon &icon)
 
void setName (const QString &name)
 
QWidgetwidget () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_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
 
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)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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[email protected]@kde[email protected].org)

Definition at line 36 of file kpagewidgetmodel.h.

Property Documentation

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 49 of file kpagewidgetmodel.h.

bool KPageWidgetItem::headerVisible
readwrite
Since
5.52

Definition at line 53 of file kpagewidgetmodel.h.

Constructor & Destructor Documentation

KPageWidgetItem::KPageWidgetItem ( QWidget widget)

Creates a new page widget item.

Parameters
widgetThe widget that is shown as page in the KPageWidget.

Hide the widget, otherwise when the widget has this KPageView as parent the widget is shown outside the QStackedWidget if the page was not selected ( and reparented ) yet.

Definition at line 42 of file kpagewidgetmodel.cpp.

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

Creates a new page widget item.

Parameters
widgetThe widget that is shown as page in the KPageWidget.
nameThe localized string that is show in the navigation view of the KPageWidget.

Hide the widget, otherwise when the widget has this KPageView as parent the widget is shown outside the QStackedWidget if the page was not selected ( and reparented ) yet.

Definition at line 57 of file kpagewidgetmodel.cpp.

KPageWidgetItem::~KPageWidgetItem ( )

Destroys the page widget item.

Definition at line 73 of file kpagewidgetmodel.cpp.

Member Function Documentation

void KPageWidgetItem::changed ( )
signal

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

QString KPageWidgetItem::header ( ) const

Returns the header of the page widget item.

QIcon KPageWidgetItem::icon ( ) const

Returns the icon of the page widget item.

bool KPageWidgetItem::isCheckable ( ) const

Returns whether the page widget item is checkable.

Definition at line 157 of file kpagewidgetmodel.cpp.

bool KPageWidgetItem::isChecked ( ) const

Returns whether the page widget item is checked.

Definition at line 170 of file kpagewidgetmodel.cpp.

bool KPageWidgetItem::isEnabled ( ) const

Returns whether the page widget item is enabled.

Definition at line 87 of file kpagewidgetmodel.cpp.

bool KPageWidgetItem::isHeaderVisible ( ) const

Returns whether the page will show the header title.

Since
5.52

Definition at line 92 of file kpagewidgetmodel.cpp.

QString KPageWidgetItem::name ( ) const

Returns the name of the page widget item.

void KPageWidgetItem::setCheckable ( bool  checkable)

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

Parameters
checkableTrue if the page widget is checkable, otherwise false.

Definition at line 150 of file kpagewidgetmodel.cpp.

void KPageWidgetItem::setChecked ( bool  checked)
slot

Sets whether the page widget item is checked.

Definition at line 162 of file kpagewidgetmodel.cpp.

void KPageWidgetItem::setEnabled ( bool  enabled)
slot

Sets whether the page widget item is enabled.

Definition at line 78 of file kpagewidgetmodel.cpp.

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.

For backward-compatibility, if setHeader("") is used, the header will be hidden even if the KPageView::FaceType is something else then Tabbed. This feature is deprecated since 5.52. use setHeaderVisible(false) instead.

Parameters
headerHeader of the page widget item.

Definition at line 121 of file kpagewidgetmodel.cpp.

void KPageWidgetItem::setHeaderVisible ( bool  visible)

Set whether the page should show the header title.

Since
5.52

Definition at line 97 of file kpagewidgetmodel.cpp.

void KPageWidgetItem::setIcon ( const QIcon icon)

Sets the icon of the page widget item.

Parameters
iconIcon of the page widget item.

Definition at line 138 of file kpagewidgetmodel.cpp.

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 109 of file kpagewidgetmodel.cpp.

void KPageWidgetItem::toggled ( bool  checked)
signal

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

QWidget * KPageWidgetItem::widget ( ) const

Returns the widget of the page widget item.

Definition at line 104 of file kpagewidgetmodel.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Jul 5 2020 22:44:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.