KisOptionCollectionWidgetWithHeader Class Reference

Wrapper class around a KisOptionCollectionWidget that also provide a header with a title label and an optional primary widget. More...

#include <KisOptionCollectionWidget.h>

Inheritance diagram for KisOptionCollectionWidgetWithHeader:

Classes
struct	Private

Public Member Functions
void	appendWidget (const QString &id, QWidget *widget)
	Insert the given widget with the given id at the end of the list. The list widget takes ownership of the inserted widget.
bool	containsWidget (const QString &id) const
	Get if the list contains a widget with the given id.
QWidget *	findWidget (const QString &path) const
	Get the widget that is at the given path. The path must be a forward slash separated list of ids. If the list contains some other KisOptionCollectionWidget or KisOptionCollectionWidgetWithHeader, and they do as well, then they form a hierarchy tree, so the path is searched recursively through all those child widgets.
template<typename T >
T	findWidgetAs (const QString &path) const
	Get the widget that is at the given path casted to some other class.
void	insertWidget (int index, const QString &id, QWidget *widget)
	Insert the given widget with the given id at the given position. The list widget takes ownership of the inserted widget.
	KisOptionCollectionWidgetWithHeader (const QString &title, QWidget *parent=nullptr)
QSize	minimumSizeHint () const override
int	numberOfVisibleWidgets () const
	Get the number of visible widgets in the list.
QWidget *	primaryWidget () const
	Get the primary widget.
template<typename T >
T	primaryWidgetAs () const
	Get the primary widget casted to some other class.
void	removePrimaryWidget ()
	Remove the primary widget. This also destroys it.
void	removeWidget (const QString &id)
	Remove the widget that has the given id from the list. This also destroys the widget.
void	removeWidget (int index)
	Remove the widget that is at the given position from the list. This also destroys the widget.
void	setOrientation (Qt::Orientation orientation, bool recursive=false)
	Set the orientation of the list of widgets.
void	setPrimaryWidget (QWidget *widget)
	Set the primary widget. The list widget takes ownership of it.
void	setPrimaryWidgetVisible (bool visible)
	Set the visibility of the primary widget. Use this function instead of the widget one directly to get better visual results.
void	setSeparatorsVisible (bool visible)
	Set the visibility of the separators.
void	setWidgetsMargin (int margin)
	Set the margins of the widgets. This allows to indent the widgets with respect to the separators. The separators themselves are not changed.
void	setWidgetVisible (const QString &id, bool visible)
	Set the visibility of the widget that has the given id.
void	setWidgetVisible (int index, bool visible)
	Set the visibility of the widget that is at the given position.
int	size () const
	Get the number of widgets in the list.
QWidget *	takePrimaryWidget ()
	Remove the primary widget. The widget is returned instead of being destroyed.
QWidget *	takeWidget (const QString &id)
	Remove the widget that has the given id from the list. The widget is returned instead of being destroyed.
QWidget *	takeWidget (int index)
	Remove the widget that is at the given position from the list. The widget is returned instead of being destroyed.
QWidget *	widget (const QString &id) const
	Get the widget with the given id.
QWidget *	widget (int index) const
	Get the widget that is at the given position.
template<typename T >
T	widgetAs (const QString &id) const
	Get the widget with the given id casted to some other class.
template<typename T >
T	widgetAs (int index) const
	Get the widget that is at the given position casted to some other class.
int	widgetIndexFromId (const QString &id) const
	Get the index of the widget that has the given id.
	~KisOptionCollectionWidgetWithHeader () override

Protected Member Functions
void	resizeEvent (QResizeEvent *) override

Private Attributes
QScopedPointer< Private >	m_d

Friends
class	KisOptionCollectionWidget

Detailed Description

Wrapper class around a KisOptionCollectionWidget that also provide a header with a title label and an optional primary widget.

Definition at line 164 of file KisOptionCollectionWidget.h.

Constructor & Destructor Documentation

KisOptionCollectionWidgetWithHeader()

KisOptionCollectionWidgetWithHeader::KisOptionCollectionWidgetWithHeader	(	const QString &	title,
		QWidget *	parent = nullptr )

Definition at line 474 of file KisOptionCollectionWidget.cpp.

    : QWidget(parent)
    , m_d(new Private(this))
{
    m_d->label = new QLabel(title, this);
    
    m_d->layoutPrimaryWidget = new QBoxLayout(QBoxLayout::LeftToRight);
    m_d->layoutPrimaryWidget->setSpacing(0);
    m_d->layoutPrimaryWidget->setContentsMargins(0, 0, 0, 0);
 
    m_d->layoutHeader = new QBoxLayout(QBoxLayout::LeftToRight);
    m_d->layoutHeader->setSpacing(10);
    m_d->layoutHeader->setContentsMargins(0, 0, 0, 0);
    m_d->layoutHeader->addWidget(m_d->label, 0);
 
    m_d->widgetCollection = new KisOptionCollectionWidget(this);
    m_d->widgetCollection->setWidgetsMargin(0);
    m_d->widgetCollection->setVisible(false);
 
    m_d->layoutWidgets = new QBoxLayout(QBoxLayout::TopToBottom);
    m_d->layoutWidgets->setSpacing(0);
    m_d->layoutWidgets->setContentsMargins(5, 0, 0, 0);
    m_d->layoutWidgets->addWidget(m_d->widgetCollection);
 
    QBoxLayout *layoutMain = new QBoxLayout(QBoxLayout::TopToBottom);
    layoutMain->setSpacing(5);
    layoutMain->setContentsMargins(0, 0, 0, 0);
    layoutMain->addLayout(m_d->layoutHeader, 0);
    
    setLayout(layoutMain);
}

References KisOptionCollectionWidget, and m_d.

~KisOptionCollectionWidgetWithHeader()

KisOptionCollectionWidgetWithHeader::~KisOptionCollectionWidgetWithHeader ( )

override

Definition at line 507 of file KisOptionCollectionWidget.cpp.

{}

Member Function Documentation

appendWidget()

void KisOptionCollectionWidgetWithHeader::appendWidget	(	const QString &	id,
		QWidget *	widget )

Insert the given widget with the given id at the end of the list. The list widget takes ownership of the inserted widget.

Definition at line 648 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->appendWidget(id, widget);
    m_d->adjustWidgetCollection();
}

References m_d, and widget().

containsWidget()

bool KisOptionCollectionWidgetWithHeader::containsWidget

(

const QString &

id

)

const

Get if the list contains a widget with the given id.

Definition at line 622 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->containsWidget(id);
}

References m_d.

findWidget()

QWidget * KisOptionCollectionWidgetWithHeader::findWidget

(

const QString &

path

)

const

Get the widget that is at the given path. The path must be a forward slash separated list of ids. If the list contains some other KisOptionCollectionWidget or KisOptionCollectionWidgetWithHeader, and they do as well, then they form a hierarchy tree, so the path is searched recursively through all those child widgets.

Definition at line 637 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->findWidget(path);
}

References m_d.

findWidgetAs()

template<typename T >

T KisOptionCollectionWidgetWithHeader::findWidgetAs ( const QString & path ) const

inline

Get the widget that is at the given path casted to some other class.

See also

findWidget

Definition at line 253 of file KisOptionCollectionWidget.h.

    {
        return qobject_cast<T>(findWidget(path));
    }

insertWidget()

void KisOptionCollectionWidgetWithHeader::insertWidget	(	int	index,
		const QString &	id,
		QWidget *	widget )

Insert the given widget with the given id at the given position. The list widget takes ownership of the inserted widget.

Definition at line 642 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->insertWidget(index, id, widget);
    m_d->adjustWidgetCollection();
}

References m_d, and widget().

minimumSizeHint()

QSize KisOptionCollectionWidgetWithHeader::minimumSizeHint ( ) const

override

Definition at line 510 of file KisOptionCollectionWidget.cpp.

{
    if (m_d->orientation == Qt::Horizontal) {
        return QWidget::minimumSizeHint();
    }
 
    const QSize widgetListMinimumSizeHint = m_d->layoutWidgets->minimumSize();
    // label.width + primaryWidget.size + 10px spacing + 4px extra (just in case)
    const int minimumHeaderWidth = m_d->label->minimumSizeHint().width() +
                                   (m_d->primaryWidget ? m_d->primaryWidget->minimumSizeHint().width() + 10 + 4 : 0);
    const QSize headerMinimumSizeHint =
        QSize(
            qMax(
                m_d->label->minimumSizeHint().width(),
                m_d->primaryWidget ? m_d->layoutPrimaryWidget->minimumSize().width() : 0
            ),
            width() < minimumHeaderWidth
            ? m_d->label->minimumSizeHint().height() +
              (m_d->primaryWidget && m_d->primaryWidget->isVisible()
                ? m_d->layoutPrimaryWidget->minimumSize().height() + m_d->layoutHeader->spacing() : 0)
            : qMax(
                m_d->label->minimumSizeHint().height(),
                m_d->primaryWidget && m_d->primaryWidget->isVisible()
                    ? m_d->layoutPrimaryWidget->minimumSize().height() : 0
              )
        );
 
    return
        QSize(
            qMax(widgetListMinimumSizeHint.width(), headerMinimumSizeHint.width()),
            headerMinimumSizeHint.height() +
                (m_d->widgetCollection->numberOfVisibleWidgets() > 0 ? widgetListMinimumSizeHint.height() + layout()->spacing() : 0)
        );
}

References m_d.

numberOfVisibleWidgets()

int KisOptionCollectionWidgetWithHeader::numberOfVisibleWidgets

(

)

const

Get the number of visible widgets in the list.

Definition at line 720 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->numberOfVisibleWidgets();
}

References m_d.

primaryWidget()

QWidget * KisOptionCollectionWidgetWithHeader::primaryWidget

(

)

const

Get the primary widget.

Definition at line 545 of file KisOptionCollectionWidget.cpp.

{
    return m_d->primaryWidget;
}

References m_d.

primaryWidgetAs()

template<typename T >

T KisOptionCollectionWidgetWithHeader::primaryWidgetAs ( ) const

inline

Get the primary widget casted to some other class.

Definition at line 181 of file KisOptionCollectionWidget.h.

    {
        return qobject_cast<T>(primaryWidget());
    }

removePrimaryWidget()

void KisOptionCollectionWidgetWithHeader::removePrimaryWidget

(

)

Remove the primary widget. This also destroys it.

Definition at line 575 of file KisOptionCollectionWidget.cpp.

{
    if (!m_d->primaryWidget) {
        return;
    }
    delete takePrimaryWidget();
}

References m_d, and takePrimaryWidget().

removeWidget() [1/2]

void KisOptionCollectionWidgetWithHeader::removeWidget

(

const QString &

id

)

Remove the widget that has the given id from the list. This also destroys the widget.

Definition at line 660 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->removeWidget(id);
    m_d->adjustWidgetCollection();
}

References m_d.

removeWidget() [2/2]

void KisOptionCollectionWidgetWithHeader::removeWidget

(

int

index

)

Remove the widget that is at the given position from the list. This also destroys the widget.

Definition at line 654 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->removeWidget(index);
    m_d->adjustWidgetCollection();
}

References m_d.

resizeEvent()

void KisOptionCollectionWidgetWithHeader::resizeEvent ( QResizeEvent * )

overrideprotected

Definition at line 725 of file KisOptionCollectionWidget.cpp.

{
    m_d->adjustPrimaryWidget();
}

References m_d.

setOrientation()

void KisOptionCollectionWidgetWithHeader::setOrientation	(	Qt::Orientation	orientation,
		bool	recursive = false )

Set the orientation of the list of widgets.

Parameters

recursive

If set to true and the list contains some KisOptionCollectionWidget or KisOptionCollectionWidgetWithHeader, then the orientation of those child widgets is also set, with the same recursive value

Definition at line 702 of file KisOptionCollectionWidget.cpp.

{
    if (orientation == m_d->orientation) {
        return;
    }
    m_d->orientation = orientation;
    m_d->adjustPrimaryWidget();
    m_d->widgetCollection->setOrientation(orientation, recursive);
    m_d->layoutWidgets->setDirection(orientation == Qt::Vertical ? QBoxLayout::TopToBottom : QBoxLayout::LeftToRight);
    QBoxLayout *layoutMain = dynamic_cast<QBoxLayout*>(layout());
    layoutMain->setDirection(orientation == Qt::Vertical ? QBoxLayout::TopToBottom : QBoxLayout::LeftToRight);
}

References m_d.

setPrimaryWidget()

void KisOptionCollectionWidgetWithHeader::setPrimaryWidget

(

QWidget *

widget

)

Set the primary widget. The list widget takes ownership of it.

Definition at line 550 of file KisOptionCollectionWidget.cpp.

{
    if (widget == m_d->primaryWidget) {
        return;
    }
    const bool wasPrimaryWidgetVisible =
        m_d->primaryWidget ? m_d->primaryWidget->isVisible() : true;
    removePrimaryWidget();
    if (!widget) {
        return;
    }
    m_d->primaryWidget = widget;
    widget->setParent(this);
    m_d->layoutPrimaryWidget->insertWidget(0, widget);
 
    if (!wasPrimaryWidgetVisible) {
        widget->setVisible(false);
        return;
    }
 
    m_d->layoutHeader->insertLayout(1, m_d->layoutPrimaryWidget, 1);
    widget->setVisible(true);
    m_d->adjustPrimaryWidget();
}

References m_d, removePrimaryWidget(), and widget().

setPrimaryWidgetVisible()

void KisOptionCollectionWidgetWithHeader::setPrimaryWidgetVisible

(

bool

visible

)

Set the visibility of the primary widget. Use this function instead of the widget one directly to get better visual results.

Definition at line 597 of file KisOptionCollectionWidget.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(m_d->primaryWidget);
 
    if (visible) {
        if (m_d->layoutHeader->count() == 2) {
            return;
        }
        m_d->layoutHeader->insertLayout(1, m_d->layoutPrimaryWidget, 1);
        m_d->primaryWidget->setVisible(true);
        m_d->adjustPrimaryWidget();
    } else {
        if (m_d->layoutHeader->count() == 1) {
            return;
        }
        m_d->layoutHeader->takeAt(1);
        m_d->primaryWidget->setVisible(false);
    }
}

References KIS_ASSERT_RECOVER_RETURN, and m_d.

setSeparatorsVisible()

void KisOptionCollectionWidgetWithHeader::setSeparatorsVisible

(

bool

visible

)

Set the visibility of the separators.

Definition at line 697 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->setSeparatorsVisible(visible);
}

References m_d.

setWidgetsMargin()

void KisOptionCollectionWidgetWithHeader::setWidgetsMargin

(

int

margin

)

Set the margins of the widgets. This allows to indent the widgets with respect to the separators. The separators themselves are not changed.

Definition at line 692 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->setWidgetsMargin(margin);
}

References m_d.

setWidgetVisible() [1/2]

void KisOptionCollectionWidgetWithHeader::setWidgetVisible	(	const QString &	id,
		bool	visible )

Set the visibility of the widget that has the given id.

Definition at line 686 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->setWidgetVisible(id, visible);
    m_d->adjustWidgetCollection();
}

References m_d.

setWidgetVisible() [2/2]

void KisOptionCollectionWidgetWithHeader::setWidgetVisible	(	int	index,
		bool	visible )

Set the visibility of the widget that is at the given position.

Definition at line 680 of file KisOptionCollectionWidget.cpp.

{
    m_d->widgetCollection->setWidgetVisible(index, visible);
    m_d->adjustWidgetCollection();
}

References m_d.

size()

int KisOptionCollectionWidgetWithHeader::size

(

)

const

Get the number of widgets in the list.

Definition at line 715 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->size();
}

References m_d.

takePrimaryWidget()

QWidget * KisOptionCollectionWidgetWithHeader::takePrimaryWidget

(

)

Remove the primary widget. The widget is returned instead of being destroyed.

Definition at line 583 of file KisOptionCollectionWidget.cpp.

{
    QWidget *widget = m_d->primaryWidget;
    if (!widget) {
        return nullptr;
    }
    m_d->primaryWidget = nullptr;
    widget->setParent(nullptr);
    m_d->layoutHeader->takeAt(1);
    m_d->adjustPrimaryWidget();
    return widget;
 
}

References m_d, and widget().

takeWidget() [1/2]

QWidget * KisOptionCollectionWidgetWithHeader::takeWidget

(

const QString &

id

)

Remove the widget that has the given id from the list. The widget is returned instead of being destroyed.

Definition at line 673 of file KisOptionCollectionWidget.cpp.

{
    QWidget *w =  m_d->widgetCollection->takeWidget(id);
    m_d->adjustWidgetCollection();
    return w;
}

References m_d.

takeWidget() [2/2]

QWidget * KisOptionCollectionWidgetWithHeader::takeWidget

(

int

index

)

Remove the widget that is at the given position from the list. The widget is returned instead of being destroyed.

Definition at line 666 of file KisOptionCollectionWidget.cpp.

{
    QWidget *w = m_d->widgetCollection->takeWidget(index);
    m_d->adjustWidgetCollection();
    return w;
}

References m_d.

widget() [1/2]

QWidget * KisOptionCollectionWidgetWithHeader::widget

(

const QString &

id

)

const

Get the widget with the given id.

Definition at line 632 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->widget(id);
}

References m_d.

widget() [2/2]

QWidget * KisOptionCollectionWidgetWithHeader::widget

(

int

index

)

const

Get the widget that is at the given position.

Definition at line 627 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->widget(index);
}

References m_d.

widgetAs() [1/2]

template<typename T >

T KisOptionCollectionWidgetWithHeader::widgetAs ( const QString & id ) const

inline

Get the widget with the given id casted to some other class.

Definition at line 234 of file KisOptionCollectionWidget.h.

    {
        return qobject_cast<T>(widget(id));
    }

widgetAs() [2/2]

template<typename T >

T KisOptionCollectionWidgetWithHeader::widgetAs ( int index ) const

inline

Get the widget that is at the given position casted to some other class.

Definition at line 221 of file KisOptionCollectionWidget.h.

    {
        return qobject_cast<T>(widget(index));
    }

widgetIndexFromId()

int KisOptionCollectionWidgetWithHeader::widgetIndexFromId

(

const QString &

id

)

const

Get the index of the widget that has the given id.

Definition at line 617 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetCollection->widgetIndexFromId(id);
}

References m_d.

Friends And Related Symbol Documentation

KisOptionCollectionWidget

friend class KisOptionCollectionWidget

friend

Definition at line 334 of file KisOptionCollectionWidget.h.

Member Data Documentation

m_d

QScopedPointer<Private> KisOptionCollectionWidgetWithHeader::m_d

private

Definition at line 333 of file KisOptionCollectionWidget.h.

---

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

• libs/widgetutils/KisOptionCollectionWidget.h
• libs/widgetutils/KisOptionCollectionWidget.cpp