KoToolBoxDocker Class Reference

#include <KoToolBoxDocker_p.h>

Inheritance diagram for KoToolBoxDocker:

Public Member Functions
	KoToolBoxDocker (KoToolBox *toolBox)
QString	observerName () override
void	setCanvas (KoCanvasBase *canvas) override
	reimplemented from KoCanvasObserverBase
void	setViewManager (KisViewManager *viewManager) override
	reimplemented from KisMainwindowObserver
void	unsetCanvas () override
Public Member Functions inherited from KisMainwindowObserver
	KisMainwindowObserver ()
	~KisMainwindowObserver () override
Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()
KoCanvasBase *	observedCanvas () const
void	setObservedCanvas (KoCanvasBase *canvas)
void	unsetObservedCanvas ()
virtual	~KoCanvasObserverBase ()

Protected Slots
void	updateFloating (bool)
void	updateToolBoxOrientation (Qt::DockWidgetArea area)

Protected Member Functions
void	contextMenuEvent (QContextMenuEvent *event) override
void	resizeEvent (QResizeEvent *event) override

Private Member Functions
void	changeLayoutDir (Qt::LayoutDirection)
void	setToolBoxOrientation (Qt::Orientation orientation)
void	updateLayoutDir ()

Private Attributes
QMenu *	m_contextMenu {nullptr}
Qt::DockWidgetArea	m_dockArea {Qt::NoDockWidgetArea}
Qt::LayoutDirection	m_layoutDir
KoToolBoxScrollArea *	m_scrollArea
KoToolBox *	m_toolBox

Detailed Description

Definition at line 23 of file KoToolBoxDocker_p.h.

Constructor & Destructor Documentation

KoToolBoxDocker()

KoToolBoxDocker::KoToolBoxDocker ( KoToolBox * toolBox )

explicit

Definition at line 25 of file KoToolBoxDocker.cpp.

    : QDockWidget(i18n("Toolbox"))
    , m_toolBox(toolBox)
    , m_scrollArea(new KoToolBoxScrollArea(toolBox, this))
{
    setWidget(m_scrollArea);
 
    QLabel *w = new QLabel(" ", this);
    w->setFrameShape(QFrame::StyledPanel);
    w->setFrameShadow(QFrame::Raised);
    w->setFrameStyle(QFrame::Panel | QFrame::Raised);
    QFont font = qApp->font();
    font.setPointSizeF(font.pointSizeF() * 0.9);
    int titleSize = QFontMetrics(font).height();
    w->setMinimumSize(titleSize, titleSize);
    setTitleBarWidget(w);
 
    KConfigGroup cfg =  KSharedConfig::openConfig()->group("KoToolBox");
    const int layoutDirUnchecked = cfg.readEntry<int>("layoutDir", Qt::LayoutDirectionAuto);
    switch (layoutDirUnchecked) {
    case Qt::LayoutDirectionAuto:
    case Qt::LeftToRight:
    case Qt::RightToLeft:
        m_layoutDir = static_cast<Qt::LayoutDirection>(layoutDirUnchecked);
        break;
    default:
        m_layoutDir = Qt::LayoutDirectionAuto;
        break;
    }
    updateLayoutDir();
 
    connect(this, SIGNAL(dockLocationChanged(Qt::DockWidgetArea)),
            this, SLOT(updateToolBoxOrientation(Qt::DockWidgetArea)));
    connect(this, SIGNAL(topLevelChanged(bool)),
            this, SLOT(updateFloating(bool)));
}

References connect(), m_layoutDir, m_scrollArea, updateFloating(), updateLayoutDir(), and updateToolBoxOrientation().

Member Function Documentation

changeLayoutDir()

void KoToolBoxDocker::changeLayoutDir ( Qt::LayoutDirection dir )

private

Definition at line 114 of file KoToolBoxDocker.cpp.

{
    KConfigGroup cfg = KSharedConfig::openConfig()->group("KoToolBox");
    cfg.writeEntry<int>("layoutDir", dir);
    m_layoutDir = dir;
    updateLayoutDir();
}

References m_layoutDir, and updateLayoutDir().

contextMenuEvent()

void KoToolBoxDocker::contextMenuEvent ( QContextMenuEvent * event )

overrideprotected

Definition at line 138 of file KoToolBoxDocker.cpp.

{
    if (!m_contextMenu) {
        m_contextMenu = new QMenu(this);
        m_contextMenu->addSection(i18n("Icon Size"));
        m_toolBox->setupIconSizeMenu(m_contextMenu);
 
        m_contextMenu->addSection(i18nc("Toolbox layout", "Layout"));
        QActionGroup *layoutActionGroup = new QActionGroup(m_contextMenu);
 
        QAction *layoutAuto = m_contextMenu->addAction(i18nc("@item:inmenu Toolbox layout direction", "&Automatic"));
        layoutAuto->setActionGroup(layoutActionGroup);
        layoutAuto->setCheckable(true);
        connect(layoutAuto, &QAction::triggered, this, [this]() {
            changeLayoutDir(Qt::LayoutDirectionAuto);
        });
 
        QAction *layoutLtr = m_contextMenu->addAction(i18nc("@item:inmenu Toolbox layout direction", "&Left-to-right"));
        layoutLtr->setActionGroup(layoutActionGroup);
        layoutLtr->setCheckable(true);
        connect(layoutLtr, &QAction::triggered, this, [this]() {
            changeLayoutDir(Qt::LeftToRight);
        });
 
        QAction *layoutRtl = m_contextMenu->addAction(i18nc("@item:inmenu Toolbox layout direction", "&Right-to-left"));
        layoutRtl->setActionGroup(layoutActionGroup);
        layoutRtl->setCheckable(true);
        connect(layoutRtl, &QAction::triggered, this, [this]() {
            changeLayoutDir(Qt::RightToLeft);
        });
 
        switch (m_layoutDir) {
        case Qt::LayoutDirectionAuto:
            layoutAuto->setChecked(true);
            break;
        case Qt::LeftToRight:
            layoutLtr->setChecked(true);
            break;
        case Qt::RightToLeft:
            layoutRtl->setChecked(true);
            break;
        }
    }
 
    m_contextMenu->exec(event->globalPos());
}

References changeLayoutDir(), connect(), m_contextMenu, m_layoutDir, m_toolBox, and KoToolBox::setupIconSizeMenu().

observerName()

QString KoToolBoxDocker::observerName ( )

inlineoverridevirtual

Reimplemented from KoCanvasObserverBase.

Definition at line 32 of file KoToolBoxDocker_p.h.

{ return "KoToolBoxDocker"; }

resizeEvent()

void KoToolBoxDocker::resizeEvent ( QResizeEvent * event )

overrideprotected

Definition at line 76 of file KoToolBoxDocker.cpp.

{
    QDockWidget::resizeEvent(event);
    if (isFloating()) {
        if (width() > height()) {
            setToolBoxOrientation(Qt::Horizontal);
        } else {
            setToolBoxOrientation(Qt::Vertical);
        }
    }
}

References setToolBoxOrientation().

setCanvas()

void KoToolBoxDocker::setCanvas ( KoCanvasBase * canvas )

overridevirtual

reimplemented from KoCanvasObserverBase

Implements KoCanvasObserverBase.

Definition at line 62 of file KoToolBoxDocker.cpp.

{
    Q_UNUSED(canvas);
}

setToolBoxOrientation()

void KoToolBoxDocker::setToolBoxOrientation ( Qt::Orientation orientation )

private

Definition at line 122 of file KoToolBoxDocker.cpp.

{
    if (orientation == Qt::Horizontal) {
        setFeatures(features() | QDockWidget::DockWidgetVerticalTitleBar);
        m_scrollArea->setOrientation(Qt::Horizontal);
    } else {
        setFeatures(features() & ~QDockWidget::DockWidgetVerticalTitleBar);
        m_scrollArea->setOrientation(Qt::Vertical);
    }
}

References m_scrollArea, and KoToolBoxScrollArea::setOrientation().

setViewManager()

void KoToolBoxDocker::setViewManager ( KisViewManager * viewManager )

overridevirtual

reimplemented from KisMainwindowObserver

Implements KisMainwindowObserver.

Definition at line 71 of file KoToolBoxDocker.cpp.

{
    m_toolBox->setViewManager(viewManager);
}

References m_toolBox, and KoToolBox::setViewManager().

unsetCanvas()

void KoToolBoxDocker::unsetCanvas ( )

overridevirtual

Re-implement to notify the observer that its canvas is no longer among the living. The daisies, it is pushing up. This means you don't have to disconnect, it's dead.

The old canvas should be deleted already, so if you stored a pointer to it, don't touch!

Note that currently there is a bug where in certain specific circumstances unsetCanvas can be called when it shouldn't, see for example KWStatisticsDocker for a workaround for this problem.

Implements KoCanvasObserverBase.

Definition at line 67 of file KoToolBoxDocker.cpp.

{
}

updateFloating

void KoToolBoxDocker::updateFloating ( bool v )

protectedslot

Definition at line 133 of file KoToolBoxDocker.cpp.

{
    m_toolBox->setFloating(v);
}

References m_toolBox, KoToolBox::setFloating(), and v.

updateLayoutDir()

void KoToolBoxDocker::updateLayoutDir ( )

private

Definition at line 99 of file KoToolBoxDocker.cpp.

{
    if (m_layoutDir == Qt::LayoutDirectionAuto) {
        if (m_dockArea == Qt::RightDockWidgetArea) {
            m_scrollArea->setLayoutDirection(Qt::RightToLeft);
        } else if (m_dockArea == Qt::LeftDockWidgetArea) {
            m_scrollArea->setLayoutDirection(Qt::LeftToRight);
        } else {
            m_scrollArea->unsetLayoutDirection();
        }
    } else {
        m_scrollArea->setLayoutDirection(m_layoutDir);
    }
}

References m_dockArea, m_layoutDir, and m_scrollArea.

updateToolBoxOrientation

void KoToolBoxDocker::updateToolBoxOrientation ( Qt::DockWidgetArea area )

protectedslot

Definition at line 88 of file KoToolBoxDocker.cpp.

{
    m_dockArea = area;
    updateLayoutDir();
    if (area == Qt::TopDockWidgetArea || area == Qt::BottomDockWidgetArea) {
        setToolBoxOrientation(Qt::Horizontal);
    } else {
        setToolBoxOrientation(Qt::Vertical);
    }
}

References m_dockArea, setToolBoxOrientation(), and updateLayoutDir().

Member Data Documentation

m_contextMenu

QMenu* KoToolBoxDocker::m_contextMenu {nullptr}

private

Definition at line 52 of file KoToolBoxDocker_p.h.

{nullptr};

m_dockArea

Qt::DockWidgetArea KoToolBoxDocker::m_dockArea {Qt::NoDockWidgetArea}

private

Definition at line 53 of file KoToolBoxDocker_p.h.

{Qt::NoDockWidgetArea};

m_layoutDir

Qt::LayoutDirection KoToolBoxDocker::m_layoutDir

private

Definition at line 54 of file KoToolBoxDocker_p.h.

m_scrollArea

KoToolBoxScrollArea* KoToolBoxDocker::m_scrollArea

private

Definition at line 51 of file KoToolBoxDocker_p.h.

m_toolBox

KoToolBox* KoToolBoxDocker::m_toolBox

private

Definition at line 50 of file KoToolBoxDocker_p.h.

---

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

• libs/ui/toolbox/KoToolBoxDocker_p.h
• libs/ui/toolbox/KoToolBoxDocker.cpp