KisOptionCollectionWidget Class Reference

Class providing a list of widgets with some addons such as separators, orientation or individual widget visibility. More...

#include <KisOptionCollectionWidget.h>

Inheritance diagram for KisOptionCollectionWidget:

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.
	KisOptionCollectionWidget (QWidget *parent=nullptr)
int	numberOfVisibleWidgets () const
	Get the number of visible widgets in the list.
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	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. Use this function instead of the widget's one directly to get better visual results.
void	setWidgetVisible (int index, bool visible)
	Set the visibility of the widget that is at the given position. Use this function instead of the widget's one directly to get better visual results.
int	size () const
	Get the number of widgets in the list.
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.
	~KisOptionCollectionWidget () override

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Class providing a list of widgets with some addons such as separators, orientation or individual widget visibility.

Definition at line 19 of file KisOptionCollectionWidget.h.

Constructor & Destructor Documentation

KisOptionCollectionWidget()

KisOptionCollectionWidget::KisOptionCollectionWidget

(

QWidget *

parent = nullptr

)

Definition at line 304 of file KisOptionCollectionWidget.cpp.

    : QWidget(parent)
    , m_d(new Private(this))
{
    QBoxLayout *layoutMain = new QBoxLayout(QBoxLayout::TopToBottom);
    layoutMain->setSpacing(5);
    layoutMain->setContentsMargins(0, 0, 0, 0);
    setLayout(layoutMain);
}

~KisOptionCollectionWidget()

KisOptionCollectionWidget::~KisOptionCollectionWidget ( )

override

Definition at line 314 of file KisOptionCollectionWidget.cpp.

{}

Member Function Documentation

appendWidget()

void KisOptionCollectionWidget::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 350 of file KisOptionCollectionWidget.cpp.

{
    insertWidget(m_d->widgetWrappers.size(), id, widget);
}

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

containsWidget()

bool KisOptionCollectionWidget::containsWidget

(

const QString &

id

)

const

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

Definition at line 322 of file KisOptionCollectionWidget.cpp.

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

References m_d.

findWidget()

QWidget * KisOptionCollectionWidget::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 337 of file KisOptionCollectionWidget.cpp.

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

References m_d.

findWidgetAs()

template<typename T >

T KisOptionCollectionWidget::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 76 of file KisOptionCollectionWidget.h.

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

insertWidget()

void KisOptionCollectionWidget::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 342 of file KisOptionCollectionWidget.cpp.

{
    if (containsWidget(id)) {
        return;
    }
    m_d->insertWidget(index, id, widget);
}

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

numberOfVisibleWidgets()

int KisOptionCollectionWidget::numberOfVisibleWidgets

(

)

const

Get the number of visible widgets in the list.

Definition at line 469 of file KisOptionCollectionWidget.cpp.

{
    return layout()->count();
}

removeWidget() [1/2]

void KisOptionCollectionWidget::removeWidget

(

const QString &

id

)

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

Definition at line 360 of file KisOptionCollectionWidget.cpp.

{
    removeWidget(widgetIndexFromId(id));
}

References removeWidget(), and widgetIndexFromId().

removeWidget() [2/2]

void KisOptionCollectionWidget::removeWidget

(

int

index

)

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

Definition at line 355 of file KisOptionCollectionWidget.cpp.

{
    delete takeWidget(index);
}

References takeWidget().

setOrientation()

void KisOptionCollectionWidget::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 438 of file KisOptionCollectionWidget.cpp.

{
    if (orientation == m_d->orientation) {
        return;
    }
    m_d->orientation = orientation;
    for (KisOptionCollectionWidgetWrapper *widgetWrapper : m_d->widgetWrappers) {
        widgetWrapper->setOrientation(orientation);
        if (recursive) {
            KisOptionCollectionWidget *optionCollectionWidget =
                qobject_cast<KisOptionCollectionWidget*>(widgetWrapper->widget());
            if (optionCollectionWidget) {
                optionCollectionWidget->setOrientation(orientation, true);
                continue;
            }
            KisOptionCollectionWidgetWithHeader *optionCollectionWidgetWithHeader =
                qobject_cast<KisOptionCollectionWidgetWithHeader*>(widgetWrapper->widget());
            if (optionCollectionWidgetWithHeader) {
                optionCollectionWidgetWithHeader->setOrientation(orientation, true);
            }
        }
    }
    QBoxLayout *layoutMain = dynamic_cast<QBoxLayout*>(layout());
    layoutMain->setDirection(orientation == Qt::Vertical ? QBoxLayout::TopToBottom : QBoxLayout::LeftToRight);
}

References m_d, setOrientation(), and KisOptionCollectionWidgetWithHeader::setOrientation().

setSeparatorsVisible()

void KisOptionCollectionWidget::setSeparatorsVisible

(

bool

visible

)

Set the visibility of the separators.

Definition at line 427 of file KisOptionCollectionWidget.cpp.

{
    if (visible == m_d->showSeparators) {
        return;
    }
    m_d->showSeparators = visible;
    QBoxLayout *layoutMain = dynamic_cast<QBoxLayout*>(layout());
    layoutMain->setSpacing(visible ? 0 : 5);
    m_d->adjustSeparators();
}

References m_d.

setWidgetsMargin()

void KisOptionCollectionWidget::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 416 of file KisOptionCollectionWidget.cpp.

{
    if (margin == m_d->widgetsMargin) {
        return;
    }
    m_d->widgetsMargin = margin;
    for (KisOptionCollectionWidgetWrapper *widgetWrapper : m_d->widgetWrappers) {
        widgetWrapper->setWidgetMargin(margin);
    }
}

References m_d.

setWidgetVisible() [1/2]

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

Set the visibility of the widget that has the given id. Use this function instead of the widget's one directly to get better visual results.

Definition at line 411 of file KisOptionCollectionWidget.cpp.

{
    setWidgetVisible(widgetIndexFromId(id), visible);
}

References setWidgetVisible(), and widgetIndexFromId().

setWidgetVisible() [2/2]

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

Set the visibility of the widget that is at the given position. Use this function instead of the widget's one directly to get better visual results.

Definition at line 379 of file KisOptionCollectionWidget.cpp.

{
    KisOptionCollectionWidgetWrapper *widgetWrapper = m_d->widgetWrappers[index];
 
    QBoxLayout *layoutMain = dynamic_cast<QBoxLayout*>(layout());
    KIS_SAFE_ASSERT_RECOVER_RETURN(layoutMain);
 
    if (visible) {
        if (layoutMain->indexOf(widgetWrapper) != -1) {
            return;
        }
        int indexLayout;
        for (indexLayout = 0; indexLayout < layoutMain->count(); ++indexLayout) {
            const QWidget *prevWidget = layoutMain->itemAt(indexLayout)->widget();
            const int prevIndex = widgetIndexFromId(prevWidget->property("id").toString());
            if (prevIndex >= index) {
                break;
            }
        }
        layoutMain->insertWidget(indexLayout, widgetWrapper);
        widgetWrapper->setVisible(true);
    } else {
        if (layoutMain->indexOf(widgetWrapper) == -1) {
            return;
        }
        layoutMain->takeAt(layoutMain->indexOf(widgetWrapper));
        widgetWrapper->setVisible(false);
    }
 
    m_d->adjustSeparators();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, and widgetIndexFromId().

size()

int KisOptionCollectionWidget::size

(

)

const

Get the number of widgets in the list.

Definition at line 464 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widgetWrappers.size();
}

References m_d.

takeWidget() [1/2]

QWidget * KisOptionCollectionWidget::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 374 of file KisOptionCollectionWidget.cpp.

{
    return takeWidget(widgetIndexFromId(id));
}

References takeWidget(), and widgetIndexFromId().

takeWidget() [2/2]

QWidget * KisOptionCollectionWidget::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 365 of file KisOptionCollectionWidget.cpp.

{
    QWidget* widget = m_d->widgetWrappers[index]->widget();
    widget->setParent(nullptr);
    m_d->widgetWrappers.removeAt(index);
    m_d->adjustSeparators();
    return widget;
}

References m_d, and widget().

widget() [1/2]

QWidget * KisOptionCollectionWidget::widget

(

const QString &

id

)

const

Get the widget with the given id.

Definition at line 332 of file KisOptionCollectionWidget.cpp.

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

References m_d.

widget() [2/2]

QWidget * KisOptionCollectionWidget::widget

(

int

index

)

const

Get the widget that is at the given position.

Definition at line 327 of file KisOptionCollectionWidget.cpp.

{
    return m_d->widget(index);
}

References m_d.

widgetAs() [1/2]

template<typename T >

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

inline

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

Definition at line 57 of file KisOptionCollectionWidget.h.

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

widgetAs() [2/2]

template<typename T >

T KisOptionCollectionWidget::widgetAs ( int index ) const

inline

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

Definition at line 44 of file KisOptionCollectionWidget.h.

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

widgetIndexFromId()

int KisOptionCollectionWidget::widgetIndexFromId

(

const QString &

id

)

const

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

Definition at line 317 of file KisOptionCollectionWidget.cpp.

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

References m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisOptionCollectionWidget::m_d

private

Definition at line 157 of file KisOptionCollectionWidget.h.

---

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

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