digiKam
Digikam::DConfigDlgWdgItem Class Reference
+ Inheritance diagram for Digikam::DConfigDlgWdgItem:

Public Slots

void setChecked (bool checked)
 
void setEnabled (bool)
 

Signals

void changed ()
 
void toggled (bool checked)
 

Public Member Functions

 DConfigDlgWdgItem (QWidget *widget)
 
 DConfigDlgWdgItem (QWidget *widget, const QString &name)
 
QString header () const
 
QIcon icon () const
 
bool isCheckable () const
 
bool isChecked () const
 
bool isEnabled () const
 
QString name () const
 
void setCheckable (bool checkable)
 
void setHeader (const QString &header)
 
void setIcon (const QIcon &icon)
 
void setName (const QString &name)
 
QWidget * widget () const
 
 ~DConfigDlgWdgItem () override
 

Properties

bool checkable
 
bool checked
 
bool enabled
 
QString header
 
QIcon icon
 
QString name
 

Detailed Description

DConfigDlgWdgItem is used by DConfigDlgWdg and represents a page.

Constructor & Destructor Documentation

◆ DConfigDlgWdgItem() [1/2]

Digikam::DConfigDlgWdgItem::DConfigDlgWdgItem ( QWidget *  widget)
explicit

Creates a new page widget item.

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

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

References widget().

◆ DConfigDlgWdgItem() [2/2]

Digikam::DConfigDlgWdgItem::DConfigDlgWdgItem ( QWidget *  widget,
const QString &  name 
)

Creates a new page widget item.

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

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

References name, and widget().

◆ ~DConfigDlgWdgItem()

Digikam::DConfigDlgWdgItem::~DConfigDlgWdgItem ( )
override

Destroys the page widget item.

Member Function Documentation

◆ changed

void Digikam::DConfigDlgWdgItem::changed ( )
signal

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

Referenced by setCheckable(), setChecked(), setEnabled(), setHeader(), setIcon(), and setName().

◆ header()

QString Digikam::DConfigDlgWdgItem::header ( ) const

Returns the header of the page widget item.

◆ icon()

QIcon Digikam::DConfigDlgWdgItem::icon ( ) const

Returns the icon of the page widget item.

◆ isCheckable()

bool Digikam::DConfigDlgWdgItem::isCheckable ( ) const

Returns whether the page widget item is checkable.

Referenced by Digikam::DConfigDlgWdgModel::data(), Digikam::DConfigDlgWdgModel::flags(), and Digikam::DConfigDlgWdgModel::setData().

◆ isChecked()

bool Digikam::DConfigDlgWdgItem::isChecked ( ) const

Returns whether the page widget item is checked.

Referenced by Digikam::DConfigDlgWdgModel::data().

◆ isEnabled()

bool Digikam::DConfigDlgWdgItem::isEnabled ( ) const

Returns whether the page widget item is enabled.

Referenced by Digikam::DConfigDlgWdgModel::flags().

◆ name()

QString Digikam::DConfigDlgWdgItem::name ( ) const

Returns the name of the page widget item.

◆ setCheckable()

void Digikam::DConfigDlgWdgItem::setCheckable ( bool  checkable)

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

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

References changed(), and checkable.

◆ setChecked

void Digikam::DConfigDlgWdgItem::setChecked ( bool  checked)
slot

Sets whether the page widget item is checked.

References changed(), checked, and toggled().

Referenced by Digikam::DConfigDlgWdgModel::setData().

◆ setEnabled

void Digikam::DConfigDlgWdgItem::setEnabled ( bool  enabled)
slot

Sets whether the page widget item is enabled.

References changed(), and enabled.

◆ setHeader()

void Digikam::DConfigDlgWdgItem::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. If setHeader("") is used, the header will be hidden even if the DConfigDlgView::FaceType is something else then Tabbed.

Parameters
headerHeader of the page widget item.

References changed(), and header.

◆ setIcon()

void Digikam::DConfigDlgWdgItem::setIcon ( const QIcon &  icon)

Sets the icon of the page widget item.

Parameters
iconIcon of the page widget item.

References changed(), and icon.

◆ setName()

void Digikam::DConfigDlgWdgItem::setName ( const QString &  name)

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

References changed(), and name.

◆ toggled

void Digikam::DConfigDlgWdgItem::toggled ( bool  checked)
signal

This signal is emitted whenever the user checks or unchecks the item of

See also
setChecked() is called.

Referenced by setChecked().

◆ widget()

Property Documentation

◆ checkable

bool Digikam::DConfigDlgWdgItem::checkable
readwrite

Referenced by setCheckable().

◆ checked

bool Digikam::DConfigDlgWdgItem::checked
readwrite

Referenced by setChecked().

◆ enabled

bool Digikam::DConfigDlgWdgItem::enabled
readwrite

This property holds whether the item is enabled. It dis-/enables both the widget and the item in the list-/treeview.

Referenced by setEnabled().

◆ header

QString Digikam::DConfigDlgWdgItem::header
readwrite

◆ icon

QIcon Digikam::DConfigDlgWdgItem::icon
readwrite

◆ name

QString Digikam::DConfigDlgWdgItem::name
readwrite

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