KisSelectionOptions Class Reference

#include <kis_selection_options.h>

Inheritance diagram for KisSelectionOptions:

Classes
class	Private

Public Types
enum	ReferenceLayers { CurrentLayer , AllLayers , ColorLabeledLayers }

Signals
void	actionChanged (SelectionAction action)
void	antiAliasSelectionChanged (bool antiAliasSelection)
void	featherSelectionChanged (int featherSelection)
void	growSelectionChanged (int growSelection)
void	modeChanged (SelectionMode mode)
void	referenceLayersChanged (ReferenceLayers referenceLayers)
void	selectedColorLabelsChanged ()
void	stopGrowingAtDarkestPixelChanged (bool stopGrowingAtDarkestPixel)

Public Member Functions
SelectionAction	action () const
bool	antiAliasSelection () const
int	featherSelection () const
int	growSelection () const
	KisSelectionOptions (QWidget *parent=nullptr)
SelectionMode	mode () const
ReferenceLayers	referenceLayers () const
QList< int >	selectedColorLabels () const
void	setAction (SelectionAction newAction)
void	setActionSectionVisible (bool visible)
void	setAdjustmentsSectionVisible (bool visible)
void	setAntiAliasSelection (bool newAntiAliasSelection)
void	setFeatherSelection (int newFeatherSelection)
void	setGrowSelection (int newGrowSelection)
void	setMode (SelectionMode newMode)
void	setModeSectionVisible (bool visible)
void	setReferenceLayers (ReferenceLayers newReferenceLayers)
void	setReferenceSectionVisible (bool visible)
void	setSelectedColorLabels (const QList< int > &newSelectedColorLabels)
void	setStopGrowingAtDarkestPixel (bool newStopGrowingAtDarkestPixel)
void	setStopGrowingAtDarkestPixelButtonVisible (bool visible)
bool	stopGrowingAtDarkestPixel () const
void	updateActionButtonToolTip (SelectionAction action, const QKeySequence &shortcut)
	~KisSelectionOptions () override
Public Member Functions inherited from KisOptionCollectionWidget
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

Definition at line 17 of file kis_selection_options.h.

Member Enumeration Documentation

ReferenceLayers

enum KisSelectionOptions::ReferenceLayers

Enumerator
CurrentLayer
AllLayers
ColorLabeledLayers

Definition at line 22 of file kis_selection_options.h.

{ CurrentLayer, AllLayers, ColorLabeledLayers };

Constructor & Destructor Documentation

KisSelectionOptions()

KisSelectionOptions::KisSelectionOptions

(

QWidget *

parent = nullptr

)

Definition at line 152 of file kis_selection_options.cc.

    : KisOptionCollectionWidget(parent)
    , m_d(new Private)
{
    m_d->q = this;
    // Create widgets
    m_d->optionButtonStripMode = new KisOptionButtonStrip;
    m_d->optionButtonStripMode->addButton(
        KisIconUtils::loadIcon("select-pixel"));
    m_d->optionButtonStripMode->addButton(
        KisIconUtils::loadIcon("select-shape"));
    m_d->optionButtonStripMode->button(0)->setChecked(true);
 
    m_d->optionButtonStripAction = new KisOptionButtonStrip;
    m_d->optionButtonStripAction->addButton(
        KisIconUtils::loadIcon("selection_replace"));
    m_d->optionButtonStripAction->addButton(
        KisIconUtils::loadIcon("selection_intersect"));
    m_d->optionButtonStripAction->addButton(
        KisIconUtils::loadIcon("selection_add"));
    m_d->optionButtonStripAction->addButton(
        KisIconUtils::loadIcon("selection_subtract"));
    m_d->optionButtonStripAction->addButton(
        KisIconUtils::loadIcon("selection_symmetric_difference"));
    m_d->optionButtonStripAction->button(0)->setChecked(true);
 
    m_d->checkBoxAntiAliasSelection = new QCheckBox(
        i18nc("The anti-alias checkbox in fill tool options", "Anti-aliasing"));
    KisOptionCollectionWidget *containerGrowSelection = new KisOptionCollectionWidget;
    m_d->sliderGrowSelection = new KisSliderSpinBox;
    m_d->sliderGrowSelection->setPrefix(
        i18nc("The 'grow/shrink' spinbox prefix in selection tools options",
              "Grow: "));
    m_d->sliderGrowSelection->setRange(-400, 400);
    m_d->sliderGrowSelection->setSoftRange(-40, 40);
    m_d->sliderGrowSelection->setSuffix(i18n(" px"));
    m_d->buttonStopGrowingAtDarkestPixel = new QToolButton;
    m_d->buttonStopGrowingAtDarkestPixel->setAutoRaise(true);
    m_d->buttonStopGrowingAtDarkestPixel->setCheckable(true);
    m_d->buttonStopGrowingAtDarkestPixel->setIcon(KisIconUtils::loadIcon("stop-at-boundary"));
    containerGrowSelection->appendWidget("sliderGrowSelection", m_d->sliderGrowSelection);
    containerGrowSelection->appendWidget("buttonStopGrowingAtDarkestPixel", m_d->buttonStopGrowingAtDarkestPixel);
    containerGrowSelection->setOrientation(Qt::Horizontal);
    containerGrowSelection->setWidgetVisible("buttonStopGrowingAtDarkestPixel", false);
    m_d->sliderFeatherSelection = new KisSliderSpinBox;
    m_d->sliderFeatherSelection->setPrefix(
        i18nc("The 'feather' spinbox prefix in selection tools options",
              "Feather: "));
    m_d->sliderFeatherSelection->setRange(0, 400);
    m_d->sliderFeatherSelection->setSoftRange(0, 40);
    m_d->sliderFeatherSelection->setSuffix(i18n(" px"));
 
    m_d->optionButtonStripReference = new KisOptionButtonStrip;
    m_d->optionButtonStripReference->addButton(
        KisIconUtils::loadIcon("current-layer"));
    m_d->optionButtonStripReference->addButton(
        KisIconUtils::loadIcon("all-layers"));
    m_d->optionButtonStripReference->addButton(KisIconUtils::loadIcon("tag"));
    m_d->optionButtonStripReference->button(0)->setChecked(true);
    m_d->widgetLabels = new KisColorLabelSelectorWidget;
    m_d->widgetLabels->setExclusive(false);
    m_d->widgetLabels->setButtonSize(20);
    m_d->widgetLabels->setButtonWrapEnabled(true);
    m_d->widgetLabels->setMouseDragEnabled(true);
 
    // Set the tooltips
    m_d->optionButtonStripMode->button(0)->setToolTip(
        i18nc("@info:tooltip", "Pixel Selection"));
    m_d->optionButtonStripMode->button(1)->setToolTip(
        i18nc("@info:tooltip", "Vector Selection"));
 
    m_d->optionButtonStripAction->button(0)->setToolTip(
        i18nc("@info:tooltip", "Replace"));
    m_d->optionButtonStripAction->button(1)->setToolTip(
        i18nc("@info:tooltip", "Intersect"));
    m_d->optionButtonStripAction->button(2)->setToolTip(
        i18nc("@info:tooltip", "Add"));
    m_d->optionButtonStripAction->button(3)->setToolTip(
        i18nc("@info:tooltip", "Subtract"));
    m_d->optionButtonStripAction->button(4)->setToolTip(
        i18nc("@info:tooltip", "Symmetric Difference"));
 
    m_d->checkBoxAntiAliasSelection->setToolTip(
        i18n("Smooths the edges of the selection"));
    m_d->sliderGrowSelection->setToolTip(
        i18n("Grow or shrink the selection by the set amount"));
    m_d->buttonStopGrowingAtDarkestPixel->setToolTip(
        i18n("Stop growing at the darkest and/or most opaque pixels"));
    m_d->sliderFeatherSelection->setToolTip(
        i18n("Blur the selection by the set amount"));
 
    m_d->optionButtonStripReference->button(0)->setToolTip(
        i18n("Select regions found from the active layer"));
    m_d->optionButtonStripReference->button(1)->setToolTip(
        i18n("Select regions found from the merging of all layers"));
    m_d->optionButtonStripReference->button(2)->setToolTip(
        i18n("Select regions found from the merging of layers with specific color labels"));
 
    // Construct the option widget
    setSeparatorsVisible(true);
 
    KisOptionCollectionWidgetWithHeader *sectionMode =
        new KisOptionCollectionWidgetWithHeader(
            i18nc("The 'mode' section label in selection tools options",
                  "Mode"));
    sectionMode->setPrimaryWidget(m_d->optionButtonStripMode);
    appendWidget("sectionMode", sectionMode);
 
    KisOptionCollectionWidgetWithHeader *sectionAction =
        new KisOptionCollectionWidgetWithHeader(
            i18nc("The 'action' section label in selection tools options",
                  "Action"));
    sectionAction->setPrimaryWidget(m_d->optionButtonStripAction);
    appendWidget("sectionAction", sectionAction);
 
    KisOptionCollectionWidgetWithHeader *sectionReference =
        new KisOptionCollectionWidgetWithHeader(
            i18nc("The 'reference' section label in selection tools options",
                  "Reference"));
    sectionReference->setPrimaryWidget(m_d->optionButtonStripReference);
    sectionReference->appendWidget("widgetLabels", m_d->widgetLabels);
    sectionReference->setWidgetVisible("widgetLabels", false);
    appendWidget("sectionReference", sectionReference);
 
    KisOptionCollectionWidgetWithHeader *sectionAdjustments =
        new KisOptionCollectionWidgetWithHeader(
            i18nc("The 'adjustments' section label in selection tools options",
                  "Adjustments"));
    sectionAdjustments->appendWidget("checkBoxAntiAliasSelection",
                                     m_d->checkBoxAntiAliasSelection);
    sectionAdjustments->appendWidget("containerGrowSelection", containerGrowSelection);
    sectionAdjustments->appendWidget("sliderFeather",
                                     m_d->sliderFeatherSelection);
    appendWidget("sectionAdjustments", sectionAdjustments);
 
    // Make connections
    connect(m_d->optionButtonStripMode,
            QOverload<int, bool>::of(&KisOptionButtonStrip::buttonToggled),
            [this](int i, int c) {
                m_d->on_optionButtonStripMode_buttonToggled(i, c);
            });
    connect(m_d->optionButtonStripAction,
            QOverload<int, bool>::of(&KisOptionButtonStrip::buttonToggled),
            [this](int i, int c) {
                m_d->on_optionButtonStripAction_buttonToggled(i, c);
            });
    connect(m_d->checkBoxAntiAliasSelection,
            SIGNAL(toggled(bool)),
            SIGNAL(antiAliasSelectionChanged(bool)));
    connect(m_d->sliderGrowSelection,
            SIGNAL(valueChanged(int)),
            SIGNAL(growSelectionChanged(int)));
    connect(m_d->buttonStopGrowingAtDarkestPixel,
            SIGNAL(toggled(bool)),
            SIGNAL(stopGrowingAtDarkestPixelChanged(bool)));
    connect(m_d->sliderFeatherSelection,
            SIGNAL(valueChanged(int)),
            SIGNAL(featherSelectionChanged(int)));
    connect(m_d->optionButtonStripReference,
            QOverload<int, bool>::of(&KisOptionButtonStrip::buttonToggled),
            [this](int i, int c) {
                m_d->on_optionButtonStripReference_buttonToggled(i, c);
            });
    connect(m_d->widgetLabels,
            SIGNAL(selectionChanged()),
            SIGNAL(selectedColorLabelsChanged()));
}

References KisOptionButtonStrip::addButton(), antiAliasSelectionChanged(), KisOptionCollectionWidget::appendWidget(), KisOptionCollectionWidgetWithHeader::appendWidget(), KisOptionButtonStrip::buttonToggled(), connect(), featherSelectionChanged(), growSelectionChanged(), KisOptionCollectionWidget::KisOptionCollectionWidget(), KisIconUtils::loadIcon(), m_d, selectedColorLabelsChanged(), KisColorLabelSelectorWidget::setExclusive(), KisOptionCollectionWidget::setOrientation(), KisOptionCollectionWidgetWithHeader::setPrimaryWidget(), KisSliderSpinBox::setRange(), KisOptionCollectionWidget::setSeparatorsVisible(), KisOptionCollectionWidget::setWidgetVisible(), KisOptionCollectionWidgetWithHeader::setWidgetVisible(), and stopGrowingAtDarkestPixelChanged().

~KisSelectionOptions()

KisSelectionOptions::~KisSelectionOptions ( )

override

Definition at line 320 of file kis_selection_options.cc.

{
}

Member Function Documentation

action()

SelectionAction KisSelectionOptions::action

(

)

const

Definition at line 330 of file kis_selection_options.cc.

{
    return m_d->buttonIndexToAction(
        m_d->optionButtonStripAction->checkedButtonIndex());
}

References m_d.

actionChanged

void KisSelectionOptions::actionChanged ( SelectionAction action )

signal

antiAliasSelection()

bool KisSelectionOptions::antiAliasSelection

(

)

const

Definition at line 336 of file kis_selection_options.cc.

{
    return m_d->checkBoxAntiAliasSelection->isChecked();
}

References m_d.

antiAliasSelectionChanged

void KisSelectionOptions::antiAliasSelectionChanged ( bool antiAliasSelection )

signal

featherSelection()

int KisSelectionOptions::featherSelection

(

)

const

Definition at line 351 of file kis_selection_options.cc.

{
    return m_d->sliderFeatherSelection->value();
}

References m_d.

featherSelectionChanged

void KisSelectionOptions::featherSelectionChanged ( int featherSelection )

signal

growSelection()

int KisSelectionOptions::growSelection

(

)

const

Definition at line 341 of file kis_selection_options.cc.

{
    return m_d->sliderGrowSelection->value();
}

References m_d.

growSelectionChanged

void KisSelectionOptions::growSelectionChanged ( int growSelection )

signal

mode()

SelectionMode KisSelectionOptions::mode

(

)

const

Definition at line 324 of file kis_selection_options.cc.

{
    return m_d->buttonIndexToMode(
        m_d->optionButtonStripMode->checkedButtonIndex());
}

References m_d.

modeChanged

void KisSelectionOptions::modeChanged ( SelectionMode mode )

signal

referenceLayers()

KisSelectionOptions::ReferenceLayers KisSelectionOptions::referenceLayers

(

)

const

Definition at line 357 of file kis_selection_options.cc.

{
    return m_d->buttonIndexToReferenceLayers(
        m_d->optionButtonStripReference->checkedButtonIndex());
}

References m_d.

referenceLayersChanged

void KisSelectionOptions::referenceLayersChanged ( ReferenceLayers referenceLayers )

signal

selectedColorLabels()

QList< int > KisSelectionOptions::selectedColorLabels

(

)

const

Definition at line 363 of file kis_selection_options.cc.

{
    return m_d->widgetLabels->selection();
}

References m_d.

selectedColorLabelsChanged

void KisSelectionOptions::selectedColorLabelsChanged ( )

signal

setAction()

void KisSelectionOptions::setAction

(

SelectionAction

newAction

)

Definition at line 377 of file kis_selection_options.cc.

{
    KoGroupButton *button = m_d->optionButtonStripAction->button(
        m_d->actionToButtonIndex(newAction));
    KIS_SAFE_ASSERT_RECOVER_RETURN(button);
 
    button->setChecked(true);
}

References button(), KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

setActionSectionVisible()

void KisSelectionOptions::setActionSectionVisible

(

bool

visible

)

Definition at line 426 of file kis_selection_options.cc.

{
    setWidgetVisible("sectionAction", visible);
}

References KisOptionCollectionWidget::setWidgetVisible().

setAdjustmentsSectionVisible()

void KisSelectionOptions::setAdjustmentsSectionVisible

(

bool

visible

)

Definition at line 438 of file kis_selection_options.cc.

{
    setWidgetVisible("sectionAdjustments", visible);
}

References KisOptionCollectionWidget::setWidgetVisible().

setAntiAliasSelection()

void KisSelectionOptions::setAntiAliasSelection

(

bool

newAntiAliasSelection

)

Definition at line 386 of file kis_selection_options.cc.

{
    m_d->checkBoxAntiAliasSelection->setChecked(newAntiAliasSelection);
}

References m_d.

setFeatherSelection()

void KisSelectionOptions::setFeatherSelection

(

int

newFeatherSelection

)

Definition at line 401 of file kis_selection_options.cc.

{
    m_d->sliderFeatherSelection->setValue(newFeatherSelection);
}

References m_d.

setGrowSelection()

void KisSelectionOptions::setGrowSelection

(

int

newGrowSelection

)

Definition at line 391 of file kis_selection_options.cc.

{
    m_d->sliderGrowSelection->setValue(newGrowSelection);
}

References m_d.

setMode()

void KisSelectionOptions::setMode

(

SelectionMode

newMode

)

Definition at line 368 of file kis_selection_options.cc.

{
    KoGroupButton *button =
        m_d->optionButtonStripMode->button(m_d->modeToButtonIndex(newMode));
    KIS_SAFE_ASSERT_RECOVER_RETURN(button);
 
    button->setChecked(true);
}

References button(), KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

setModeSectionVisible()

void KisSelectionOptions::setModeSectionVisible

(

bool

visible

)

Definition at line 421 of file kis_selection_options.cc.

{
    setWidgetVisible("sectionMode", visible);
}

References KisOptionCollectionWidget::setWidgetVisible().

setReferenceLayers()

void KisSelectionOptions::setReferenceLayers

(

ReferenceLayers

newReferenceLayers

)

Definition at line 406 of file kis_selection_options.cc.

{
    KoGroupButton *button = m_d->optionButtonStripReference->button(
        m_d->referenceLayersToButtonIndex(newReferenceLayers));
    KIS_SAFE_ASSERT_RECOVER_RETURN(button);
 
    button->setChecked(true);
}

References button(), KIS_SAFE_ASSERT_RECOVER_RETURN, and m_d.

setReferenceSectionVisible()

void KisSelectionOptions::setReferenceSectionVisible

(

bool

visible

)

Definition at line 443 of file kis_selection_options.cc.

{
    setWidgetVisible("sectionReference", visible);
}

References KisOptionCollectionWidget::setWidgetVisible().

setSelectedColorLabels()

void KisSelectionOptions::setSelectedColorLabels

(

const QList< int > &

newSelectedColorLabels

)

Definition at line 415 of file kis_selection_options.cc.

{
    m_d->widgetLabels->setSelection(newSelectedColorLabels);
}

References m_d.

setStopGrowingAtDarkestPixel()

void KisSelectionOptions::setStopGrowingAtDarkestPixel

(

bool

newStopGrowingAtDarkestPixel

)

Definition at line 396 of file kis_selection_options.cc.

{
    m_d->buttonStopGrowingAtDarkestPixel->setChecked(newStopGrowingAtDarkestPixel);
}

References m_d.

setStopGrowingAtDarkestPixelButtonVisible()

void KisSelectionOptions::setStopGrowingAtDarkestPixelButtonVisible

(

bool

visible

)

Definition at line 431 of file kis_selection_options.cc.

{
    widgetAs<KisOptionCollectionWidgetWithHeader*>("sectionAdjustments")
        ->widgetAs<KisOptionCollectionWidget*>("containerGrowSelection")
            ->setWidgetVisible("buttonStopGrowingAtDarkestPixel", visible);
}

References KisOptionCollectionWidget::setWidgetVisible().

stopGrowingAtDarkestPixel()

bool KisSelectionOptions::stopGrowingAtDarkestPixel

(

)

const

Definition at line 346 of file kis_selection_options.cc.

{
    return m_d->buttonStopGrowingAtDarkestPixel->isChecked();
}

References m_d.

stopGrowingAtDarkestPixelChanged

void KisSelectionOptions::stopGrowingAtDarkestPixelChanged ( bool stopGrowingAtDarkestPixel )

signal

updateActionButtonToolTip()

void KisSelectionOptions::updateActionButtonToolTip	(	SelectionAction	action,
		const QKeySequence &	shortcut )

Definition at line 448 of file kis_selection_options.cc.

{
    const QString shortcutString = shortcut.toString(QKeySequence::NativeText);
    QString toolTipText;
    const int buttonIndex = m_d->actionToButtonIndex(action);
 
    switch (action) {
    case SELECTION_DEFAULT:
    case SELECTION_REPLACE:
        toolTipText = shortcutString.isEmpty()
            ? i18nc("@info:tooltip", "Replace")
            : i18nc("@info:tooltip", "Replace (%1)", shortcutString);
        break;
    case SELECTION_ADD:
        toolTipText = shortcutString.isEmpty()
            ? i18nc("@info:tooltip", "Add")
            : i18nc("@info:tooltip", "Add (%1)", shortcutString);
        break;
    case SELECTION_SUBTRACT:
        toolTipText = shortcutString.isEmpty()
            ? i18nc("@info:tooltip", "Subtract")
            : i18nc("@info:tooltip", "Subtract (%1)", shortcutString);
        break;
    case SELECTION_INTERSECT:
        toolTipText = shortcutString.isEmpty()
            ? i18nc("@info:tooltip", "Intersect")
            : i18nc("@info:tooltip", "Intersect (%1)", shortcutString);
        break;
    case SELECTION_SYMMETRICDIFFERENCE:
        toolTipText = shortcutString.isEmpty()
            ? i18nc("@info:tooltip", "Symmetric Difference")
            : i18nc("@info:tooltip",
                    "Symmetric Difference (%1)",
                    shortcutString);
        break;
    }
 
    m_d->optionButtonStripAction->button(buttonIndex)->setToolTip(toolTipText);
}

References action(), m_d, SELECTION_ADD, SELECTION_DEFAULT, SELECTION_INTERSECT, SELECTION_REPLACE, SELECTION_SUBTRACT, and SELECTION_SYMMETRICDIFFERENCE.

Member Data Documentation

m_d

QScopedPointer<Private> KisSelectionOptions::m_d

private

Definition at line 66 of file kis_selection_options.h.

---

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

• libs/ui/widgets/kis_selection_options.h
• libs/ui/widgets/kis_selection_options.cc