KoToolBox Class Reference

#include <KoToolBox_p.h>

Inheritance diagram for KoToolBox:

Classes
class	Private

Public Slots
bool	isCompact ()
void	setActiveTool (KoCanvasController *canvas)
void	setButtonsVisible (const QList< QString > &codes)
void	setCompact (bool)
void	setFloating (bool v)
void	setOrientation (Qt::Orientation orientation)
	Set the orientation of the layout to orientation.
KoToolBoxLayout *	toolBoxLayout () const

Public Member Functions
void	applyIconSize ()
	KoToolBox ()
	constructor
void	setViewManager (KisViewManager *viewManager)
	~KoToolBox () override

Protected Member Functions
void	changeEvent (QEvent *event) override
void	paintEvent (QPaintEvent *event) override

Private Slots
void	setCurrentLayer (const KoCanvasController *canvas, const KoShapeLayer *newLayer)
void	slotContextIconSize ()
	set the icon size for all the buttons
void	toolAdded (KoToolAction *toolAction, KoCanvasController *canvas)
	add a tool post-initialization. The tool will also be activated.

Private Member Functions
void	addButton (KoToolAction *toolAction)
void	setupIconSizeMenu (QMenu *menu)

Private Attributes
Private *const	d

Friends
class	KoToolBoxDocker

Detailed Description

KoToolBox is a dock widget that can order tools according to type and priority.

The ToolBox is a container for tool buttons which are themselves divided into sections.

Adding buttons using addButton() will allow you to show those buttons. You should connect the button to your handling method yourself.

The unique property of this toolbox is that it can be shown horizontal as well as vertical, rotating in a smart way to show the buttons optimally.

See also

KoToolManager

Definition at line 39 of file KoToolBox_p.h.

Constructor & Destructor Documentation

KoToolBox()

KoToolBox::KoToolBox ( )

explicit

constructor

Definition at line 86 of file KoToolBox.cpp.

    : d(new Private)
{
    d->layout = new KoToolBoxLayout(this);
    // add defaults
    d->addSection(new Section(this), "main");
    d->addSection(new Section(this), "dynamic");
 
    d->buttonGroup = new QButtonGroup(this);
 
    // Get screen the widget exists in, but fall back to primary screen if invalid.
    const int widgetsScreen = KisPortingUtils::getScreenNumberForWidget(QApplication::activeWindow());
    const int primaryScreen = 0; //In QT, primary screen should always be the first index of QGuiApplication::screens()
    const int screen = (widgetsScreen >= 0 && widgetsScreen < QGuiApplication::screens().size()) ? widgetsScreen : primaryScreen;
    const int toolbuttonSize = buttonSize(screen);
    KConfigGroup cfg =  KSharedConfig::openConfig()->group("KoToolBox");
    d->iconSize = cfg.readEntry("iconSize", toolbuttonSize);
 
    Q_FOREACH (KoToolAction *toolAction, KoToolManager::instance()->toolActionList()) {
        addButton(toolAction);
    }
 
    applyIconSize();
 
    // Update visibility of buttons
    setButtonsVisible(QList<QString>());
 
    setCompact(cfg.readEntry<bool>("compact", false));
 
    connect(KoToolManager::instance(), SIGNAL(changedTool(KoCanvasController*)),
            this, SLOT(setActiveTool(KoCanvasController*)));
    connect(KoToolManager::instance(), SIGNAL(currentLayerChanged(const KoCanvasController*,const KoShapeLayer*)),
            this, SLOT(setCurrentLayer(const KoCanvasController*,const KoShapeLayer*)));
    connect(KoToolManager::instance(), SIGNAL(toolCodesSelected(QList<QString>)), this, SLOT(setButtonsVisible(QList<QString>)));
    connect(KoToolManager::instance(),
            SIGNAL(addedTool(KoToolAction*,KoCanvasController*)),
            this, SLOT(toolAdded(KoToolAction*,KoCanvasController*)));
 
}

References addButton(), KoToolBox::Private::addSection(), applyIconSize(), KoToolBox::Private::buttonGroup, buttonSize(), d, KisPortingUtils::getScreenNumberForWidget(), KoToolBox::Private::iconSize, KoToolManager::instance(), KoToolBox::Private::layout, setActiveTool(), setButtonsVisible(), setCompact(), setCurrentLayer(), and toolAdded().

~KoToolBox()

KoToolBox::~KoToolBox ( )

override

Definition at line 126 of file KoToolBox.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addButton()

void KoToolBox::addButton ( KoToolAction * toolAction )

private

Add a button to the toolbox. The buttons should all be added before the first showing since adding will not really add them to the UI until setup() is called.

Parameters

toolAction

the action of the tool

See also

setup()

Definition at line 157 of file KoToolBox.cpp.

{
    KoToolBoxButton *button = new KoToolBoxButton(toolAction, this);
 
    d->buttons << button;
 
    QString sectionToBeAddedTo;
    const QString section = toolAction->section();
    if (section.contains(qApp->applicationName())) {
        sectionToBeAddedTo = "main";
    } else if (section.contains("main")) {
        sectionToBeAddedTo = "main";
    }  else if (section.contains("dynamic")) {
        sectionToBeAddedTo = "dynamic";
    } else {
        sectionToBeAddedTo = section;
    }
 
    Section *sectionWidget = d->sections.value(sectionToBeAddedTo);
    if (sectionWidget == 0) {
        sectionWidget = new Section(this);
        d->addSection(sectionWidget, sectionToBeAddedTo);
    }
    sectionWidget->addButton(button, toolAction->priority());
 
    d->buttonGroup->addButton(button);
    d->buttonsByToolId.insert(toolAction->id(), button);
 
    d->visibilityCodes.insert(button, toolAction->visibilityCode());
}

References Section::addButton(), KoToolBox::Private::addSection(), button(), KoToolBox::Private::buttonGroup, KoToolBox::Private::buttons, KoToolBox::Private::buttonsByToolId, d, KoToolAction::id(), KoToolAction::priority(), KoToolAction::section(), KoToolBox::Private::sections, KoToolAction::visibilityCode(), and KoToolBox::Private::visibilityCodes.

applyIconSize()

void KoToolBox::applyIconSize

(

)

Definition at line 131 of file KoToolBox.cpp.

{
    Q_FOREACH (QToolButton *button, d->buttons) {
        button->setIconSize(QSize(d->iconSize, d->iconSize));
    }
 
    Q_FOREACH (Section *section, d->sections.values())  {
        section->setButtonSize(QSize(d->iconSize + BUTTON_MARGIN,  d->iconSize + BUTTON_MARGIN));
    }
}

References button(), BUTTON_MARGIN, KoToolBox::Private::buttons, d, KoToolBox::Private::iconSize, KoToolBox::Private::sections, and Section::setButtonSize().

changeEvent()

void KoToolBox::changeEvent ( QEvent * event )

overrideprotected

Definition at line 288 of file KoToolBox.cpp.

{
    QWidget::changeEvent(event);
    if (event->type() == QEvent::PaletteChange) {
        Q_FOREACH (QToolButton *button, d->buttons) {
            KoToolBoxButton* toolBoxButton = qobject_cast<KoToolBoxButton*>(button);
            if (toolBoxButton) {
                toolBoxButton->setHighlightColor();
            }
        }
    }
}

References button(), KoToolBox::Private::buttons, d, and KoToolBoxButton::setHighlightColor().

isCompact

bool KoToolBox::isCompact ( )

slot

Definition at line 315 of file KoToolBox.cpp.

{
    return d->layout->isCompact();
}

References d, KoToolBoxLayout::isCompact(), and KoToolBox::Private::layout.

paintEvent()

void KoToolBox::paintEvent ( QPaintEvent * event )

overrideprotected

Definition at line 244 of file KoToolBox.cpp.

{
    QPainter painter(this);
 
    const QList<Section*> sections = d->sections.values();
    int halfSpacing = layout()->spacing();
    if (halfSpacing > 0) {
        halfSpacing /= 2;
    }
    for(auto iterator = sections.begin(); iterator != sections.end(); ++iterator) {
        Section *section = *iterator;
        if (section->separators() == Section::SeparatorNone) {
            continue;
        }
 
        QStyleOption styleoption;
        styleoption.palette = palette();
 
        if (section->separators() & Section::SeparatorTop) {
            int y = section->y() - halfSpacing;
            styleoption.state = QStyle::State_None;
            styleoption.rect = QRect(section->x(), y-1, section->width(), 2);
 
            style()->drawPrimitive(QStyle::PE_IndicatorToolBarSeparator, &styleoption, &painter);
        }
 
        if (section->separators() & Section::SeparatorLeft && section->isLeftToRight()) {
            int x = section->x() - halfSpacing;
            styleoption.state = QStyle::State_Horizontal;
            styleoption.rect = QRect(x-1, section->y(), 2, section->height());
 
            style()->drawPrimitive(QStyle::PE_IndicatorToolBarSeparator, &styleoption, &painter);
        } else if (section->separators() & Section::SeparatorLeft && section->isRightToLeft()) {
            int x = section->x() + section->width() + halfSpacing;
            styleoption.state = QStyle::State_Horizontal;
            styleoption.rect = QRect(x-1, section->y(), 2, section->height());
 
            style()->drawPrimitive(QStyle::PE_IndicatorToolBarSeparator, &styleoption, &painter);
        }
    }
 
    painter.end();
}

References d, palette, KoToolBox::Private::sections, Section::SeparatorLeft, Section::SeparatorNone, Section::separators(), and Section::SeparatorTop.

setActiveTool

void KoToolBox::setActiveTool ( KoCanvasController * canvas )

slot

Set the new active button based on the currently active tool.

Parameters

canvas

the currently active canvas.

Definition at line 188 of file KoToolBox.cpp.

{
    Q_UNUSED(canvas);
 
    QString id = KoToolManager::instance()->activeToolId();
    KoToolBoxButton *button = d->buttonsByToolId.value(id);
    if (button) {
        button->setChecked(true);
        button->setHighlightColor();
        if (d->selectedButton) {
            d->selectedButton->setHighlightColor();
        }
        d->selectedButton = button;
    }
    else {
        warnWidgets << "KoToolBox::setActiveTool(" << id << "): no such button found";
    }
}

References KoToolManager::activeToolId(), button(), KoToolBox::Private::buttonsByToolId, d, KoToolManager::instance(), KoToolBox::Private::selectedButton, KoToolBoxButton::setHighlightColor(), and warnWidgets.

setButtonsVisible

void KoToolBox::setButtonsVisible ( const QList< QString > & codes )

slot

Show only the dynamic buttons that have a code from parameter codes. The toolbox allows buttons to be optionally registered with a visibilityCode. This code can be passed here and all buttons that have that code are shown. All buttons that have another visibility code registered are hidden.

Parameters

codes

a list of all the codes to show.

Definition at line 207 of file KoToolBox.cpp.

{
    Q_FOREACH (QToolButton *button, d->visibilityCodes.keys()) {
        QString code = d->visibilityCodes.value(button);
 
        if (code.startsWith(QLatin1String("flake/"))) {
            continue;
        }
 
        if (code.endsWith( QLatin1String( "/always"))) {
            button->setVisible(true);
            button->setEnabled(true);
        }
        else if (code.isEmpty()) {
            button->setVisible(true);
            button->setEnabled( codes.count() != 0 );
        }
        else {
            button->setVisible( codes.contains(code) );
        }
    }
    layout()->invalidate();
    update();
}

References button(), d, and KoToolBox::Private::visibilityCodes.

setCompact

void KoToolBox::setCompact ( bool state )

slot

Definition at line 310 of file KoToolBox.cpp.

{
    d->layout->setCompact(state);
}

References d, KoToolBox::Private::layout, and KoToolBoxLayout::setCompact().

setCurrentLayer

void KoToolBox::setCurrentLayer ( const KoCanvasController * canvas, const KoShapeLayer * newLayer )

privateslot

Definition at line 232 of file KoToolBox.cpp.

{
    Q_UNUSED(canvas);
    const bool enabled = layer == 0 || (layer->isShapeEditable() && layer->isVisible());
    foreach (QToolButton *button, d->visibilityCodes.keys()) {
        if (d->visibilityCodes[button].endsWith( QLatin1String( "/always") ) ) {
            continue;
        }
        button->setEnabled(enabled);
    }
}

References button(), d, KoShape::isShapeEditable(), KoShape::isVisible(), and KoToolBox::Private::visibilityCodes.

setFloating

void KoToolBox::setFloating ( bool v )

slot

Definition at line 320 of file KoToolBox.cpp.

{
    d->floating = v;
}

References d, KoToolBox::Private::floating, and v.

setOrientation

void KoToolBox::setOrientation ( Qt::Orientation orientation )

slot

Set the orientation of the layout to orientation.

Definition at line 301 of file KoToolBox.cpp.

{
    d->layout->setOrientation(orientation);
    QTimer::singleShot(0, this, SLOT(update()));
    Q_FOREACH (Section* section, d->sections) {
        section->setOrientation(orientation);
    }
}

References d, KoToolBox::Private::layout, KoToolBox::Private::sections, Section::setOrientation(), and KoToolBoxLayout::setOrientation().

setupIconSizeMenu()

void KoToolBox::setupIconSizeMenu ( QMenu * menu )

private

Definition at line 357 of file KoToolBox.cpp.

{
    if (d->contextIconSizes.isEmpty()) {
        d->defaultIconSizeAction = menu->addAction(i18nc("@item:inmenu Icon size", "Default"),
                                                   this, SLOT(slotContextIconSize()));
 
        QActionGroup *sizeGroup = new QActionGroup(menu);
        QList<int> sizes;
        sizes << 12 << 14 << 16 << 22 << 32 << 48 << 64; //<< 96 << 128 << 192 << 256;
        Q_FOREACH (int i, sizes) {
            QAction *action = menu->addAction(i18n("%1x%2", i, i), this, SLOT(slotContextIconSize()));
            d->contextIconSizes.insert(action, i);
            action->setActionGroup(sizeGroup);
            action->setCheckable(true);
            if (d->iconSize == i) {
                action->setChecked(true);
            }
        }
    }
}

References KoToolBox::Private::contextIconSizes, d, KoToolBox::Private::defaultIconSizeAction, KoToolBox::Private::iconSize, and slotContextIconSize().

setViewManager()

void KoToolBox::setViewManager

(

KisViewManager *

viewManager

)

Definition at line 143 of file KoToolBox.cpp.

{
    KisKActionCollection *actionCollection = viewManager->actionCollection();
    Q_FOREACH(KoToolAction *toolAction, KoToolManager::instance()->toolActionList()) {
        QAction *toolQAction = actionCollection->action(toolAction->id());
        auto button = d->buttonsByToolId.find(toolAction->id());
        if (button == d->buttonsByToolId.end()) {
            qWarning() << "Toolbox is missing button for tool" << toolAction->id();
            continue;
        }
        (*button)->attachAction(toolQAction);
    }
}

References KisKActionCollection::action(), KisViewManager::actionCollection(), button(), KoToolBox::Private::buttonsByToolId, d, KoToolAction::id(), and KoToolManager::instance().

slotContextIconSize

void KoToolBox::slotContextIconSize ( )

privateslot

set the icon size for all the buttons

Definition at line 333 of file KoToolBox.cpp.

{
    QAction* action = qobject_cast<QAction*>(sender());
    if (action) {
        int iconSize = -1;
        if (action == d->defaultIconSizeAction) {
            iconSize = buttonSize(KisPortingUtils::getScreenNumberForWidget(QApplication::activeWindow()));
            QAction *action = d->contextIconSizes.key(iconSize);
            if (action) {
                action->setChecked(true);
            }
        } else if (d->contextIconSizes.contains(action)) {
            iconSize = d->contextIconSizes.value(action);
        }
        KIS_SAFE_ASSERT_RECOVER(iconSize >= 0) { iconSize = 16; }
 
        KConfigGroup cfg =  KSharedConfig::openConfig()->group("KoToolBox");
        cfg.writeEntry("iconSize", iconSize);
        d->iconSize = iconSize;
 
        applyIconSize();
    }
}

References applyIconSize(), buttonSize(), KoToolBox::Private::contextIconSizes, d, KoToolBox::Private::defaultIconSizeAction, KisPortingUtils::getScreenNumberForWidget(), KoToolBox::Private::iconSize, iconSize(), and KIS_SAFE_ASSERT_RECOVER.

toolAdded

void KoToolBox::toolAdded ( KoToolAction * toolAction, KoCanvasController * canvas )

privateslot

add a tool post-initialization. The tool will also be activated.

Definition at line 325 of file KoToolBox.cpp.

{
    Q_UNUSED(canvas);
    addButton(toolAction);
    setButtonsVisible(QList<QString>());
 
}

References addButton(), and setButtonsVisible().

toolBoxLayout

KoToolBoxLayout * KoToolBox::toolBoxLayout ( ) const

slot

Definition at line 378 of file KoToolBox.cpp.

{
    return d->layout;
}

References d, and KoToolBox::Private::layout.

Friends And Related Symbol Documentation

KoToolBoxDocker

friend class KoToolBoxDocker

friend

Definition at line 103 of file KoToolBox_p.h.

Member Data Documentation

d

Private* const KoToolBox::d

private

Definition at line 107 of file KoToolBox_p.h.

---

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

• libs/ui/toolbox/KoToolBox_p.h
• libs/ui/toolbox/KoToolBox.cpp