#include <KoToolDocker.h>

Inheritance diagram for KoToolDocker:

Public Slots
bool	hasOptionWidget ()

void	setOptionWidgets (const QList< QPointer< QWidget > > &optionWidgetList)

void	slotScrollerStateChange (QScroller::State state)

Public Member Functions
	KoToolDocker (QWidget *parent=0)

void	locationChanged (Qt::DockWidgetArea area)

	Private (KoToolDocker *dock)

void	recreateLayout (const QList< QPointer< QWidget > > &optionWidgetList)

void	resetWidgets ()

void	resetWidgets ()

void	setCanvas (KoCanvasBase *canvas) override
	reimplemented

void	unsetCanvas () override

	~KoToolDocker () override

	~Private ()

Public Member Functions inherited from KoCanvasObserverBase
	KoCanvasObserverBase ()

KoCanvasBase *	observedCanvas () const

virtual QString	observerName ()

void	setObservedCanvas (KoCanvasBase *canvas)

void	unsetObservedCanvas ()

virtual	~KoCanvasObserverBase ()

Public Attributes
QSet< QWidget * >	currentAuxWidgets

QList< QPointer< QWidget > >	currentWidgetList

Qt::DockWidgetArea	dockingArea {Qt::NoDockWidgetArea}

QWidget *	hiderWidget {nullptr}

QGridLayout *	housekeeperLayout {nullptr}

QBoxLayout *	housekeeperMainLayout {nullptr}

QWidget *	housekeeperWidget {nullptr}

KoToolDocker *	q {nullptr}

QScrollArea *	scrollArea {nullptr}

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

The tool docker shows the tool option widget associated with the current tool and the current canvas.

Definition at line 20 of file KoToolDocker.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KoToolDocker::~Private ( )

inline

Hider widget is not part of any widget hierarchy (which is intentional due to bug 447522), so we need to delete it manually

Definition at line 28 of file KoToolDocker.cpp.

               {
        delete hiderWidget;
    }

◆ KoToolDocker()

KoToolDocker::KoToolDocker ( QWidget * parent = 0 )

explicit

Definition at line 147 of file KoToolDocker.cpp.

    : QDockWidget(i18n("Tool Options"), parent),
      d(new Private(this))
{
    connect(this, SIGNAL(dockLocationChanged(Qt::DockWidgetArea)), this, SLOT(locationChanged(Qt::DockWidgetArea)));
 
    d->housekeeperWidget = new QWidget();
    d->housekeeperLayout = new QGridLayout;
    d->housekeeperLayout->setContentsMargins(4,4,4,0);
    d->housekeeperLayout->setSizeConstraint(QLayout::SetMinAndMaxSize);
    d->housekeeperMainLayout =
        new QBoxLayout(QBoxLayout::TopToBottom, d->housekeeperWidget);
    d->housekeeperMainLayout->setContentsMargins(0, 0, 0, 0);
    d->housekeeperMainLayout->setSpacing(0);
    d->housekeeperMainLayout->addLayout(d->housekeeperLayout, 0);
    d->housekeeperMainLayout->addStretch(1);
 
    d->hiderWidget = new QWidget();
    d->hiderWidget->setVisible(false);
 
    d->scrollArea = new QScrollArea();
    d->scrollArea->setWidget(d->housekeeperWidget);
    d->scrollArea->setFrameShape(QFrame::NoFrame);
    d->scrollArea->setWidgetResizable(true);
    d->scrollArea->setFocusPolicy(Qt::NoFocus);
 
    QScroller *scroller = KisKineticScroller::createPreconfiguredScroller(d->scrollArea);
    if( scroller ) {
        connect(scroller, SIGNAL(stateChanged(QScroller::State)), this, SLOT(slotScrollerStateChange(QScroller::State)));
    }
 
    setWidget(d->scrollArea);
}

References connect(), KisKineticScroller::createPreconfiguredScroller(), d, locationChanged(), and slotScrollerStateChange().

◆ ~KoToolDocker()

KoToolDocker::~KoToolDocker ( )

override

Definition at line 181 of file KoToolDocker.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ hasOptionWidget

bool KoToolDocker::hasOptionWidget ( )

slot

Returns whether the docker has an option widget attached

Definition at line 186 of file KoToolDocker.cpp.

{
    return !d->currentWidgetList.isEmpty();
}

References d.

◆ locationChanged()

void KoToolDocker::locationChanged ( Qt::DockWidgetArea area )

inline

Definition at line 139 of file KoToolDocker.cpp.

    {
        dockingArea = area;
        recreateLayout(currentWidgetList);
    }

◆ Private()

KoToolDocker::Private ( KoToolDocker * dock )

inline

Definition at line 23 of file KoToolDocker.cpp.

        : q(dock)
    {
    }

◆ recreateLayout()

void KoToolDocker::recreateLayout ( const QList< QPointer< QWidget > > & optionWidgetList )

inline

Definition at line 51 of file KoToolDocker.cpp.

    {
        Q_FOREACH (QPointer<QWidget> widget, currentWidgetList) {
            if (!widget.isNull() && widget && hiderWidget) {
                widget->setParent(hiderWidget);
            }
        }
        qDeleteAll(currentAuxWidgets);
        currentAuxWidgets.clear();
 
        currentWidgetList = optionWidgetList;
 
        // need to unstretch row that have previously been stretched
        housekeeperLayout->setRowStretch(housekeeperLayout->rowCount()-1, 0);
 
        int cnt = 0;
        QFrame *s;
        QLabel *l;
        switch (dockingArea) {
        case Qt::TopDockWidgetArea:
        case Qt::BottomDockWidgetArea:
            housekeeperMainLayout->setDirection(QBoxLayout::LeftToRight);
            housekeeperMainLayout->setStretch(0, 1);
            housekeeperMainLayout->setStretch(1, 0);
            housekeeperLayout->setHorizontalSpacing(2);
            housekeeperLayout->setVerticalSpacing(0);
            Q_FOREACH (QPointer<QWidget> widget, currentWidgetList) {
                if (widget.isNull() || widget->objectName().isEmpty()) {
                    continue;
                }
                if (!widget->windowTitle().isEmpty()) {
                    housekeeperLayout->addWidget(
                        l = new QLabel(widget->windowTitle()),
                        0,
                        2 * cnt);
                    currentAuxWidgets.insert(l);
                }
                housekeeperLayout->addWidget(widget, 1, 2 * cnt);
                widget->show();
                if (widget != currentWidgetList.last()) {
                    housekeeperLayout->addWidget(s = new QFrame(),
                                                 0,
                                                 2 * cnt + 1,
                                                 2,
                                                 1);
                    s->setFrameShape(QFrame::VLine);
                    currentAuxWidgets.insert(s);
                }
                cnt++;
            }
            break;
        case Qt::NoDockWidgetArea:
        case Qt::LeftDockWidgetArea:
        case Qt::RightDockWidgetArea: {
            housekeeperMainLayout->setDirection(QBoxLayout::TopToBottom);
            housekeeperMainLayout->setStretch(0, 0);
            housekeeperMainLayout->setStretch(1, 1);
            housekeeperLayout->setHorizontalSpacing(0);
            housekeeperLayout->setVerticalSpacing(2);
            Q_FOREACH (QPointer<QWidget> widget, currentWidgetList) {
                if (widget.isNull() || widget->objectName().isEmpty()) {
                    continue;
                }
                if (!widget->windowTitle().isEmpty()) {
                    housekeeperLayout->addWidget(
                        l = new QLabel(widget->windowTitle()),
                        cnt++,
                        0);
                    currentAuxWidgets.insert(l);
                }
                housekeeperLayout->addWidget(widget, cnt++, 0);
                widget->show();
                if (widget != currentWidgetList.last()) {
                    housekeeperLayout->addWidget(s = new QFrame(), cnt++, 0);
                    s->setFrameStyle(QFrame::HLine | QFrame::Sunken);
                    currentAuxWidgets.insert(s);
                }
            }
            break;
        }
        default:
            break;
        }
 
        housekeeperLayout->setSizeConstraint(QLayout::SetMinAndMaxSize);
        housekeeperLayout->invalidate();
    }

◆ resetWidgets() [1/2]

void KoToolDocker::resetWidgets ( )

inline

Definition at line 44 of file KoToolDocker.cpp.

    {
        currentWidgetList.clear();
        qDeleteAll(currentAuxWidgets);
        currentAuxWidgets.clear();
    }

◆ resetWidgets() [2/2]

void KoToolDocker::resetWidgets ( )

◆ setCanvas()

void KoToolDocker::setCanvas ( KoCanvasBase * canvas )

overridevirtual

reimplemented

Implements KoCanvasObserverBase.

Definition at line 207 of file KoToolDocker.cpp.

{
    setEnabled(canvas != 0);
}

References Private::canvas.

◆ setOptionWidgets

void KoToolDocker::setOptionWidgets ( const QList< QPointer< QWidget > > & optionWidgetList )

slot

Update the option widgets to the argument one, removing the currently set widget.

Definition at line 191 of file KoToolDocker.cpp.

{
    d->recreateLayout(optionWidgetList);
}

References d.

◆ slotScrollerStateChange

void KoToolDocker::slotScrollerStateChange ( QScroller::State state )

slot

Definition at line 196 of file KoToolDocker.cpp.

{
    KisKineticScroller::updateCursor(d->scrollArea, state);
}

References d, and KisKineticScroller::updateCursor().

◆ unsetCanvas()

void KoToolDocker::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 212 of file KoToolDocker.cpp.

{
    setEnabled(false);
}

Member Data Documentation

◆ currentAuxWidgets

QSet<QWidget *> KoToolDocker::currentAuxWidgets

Definition at line 35 of file KoToolDocker.cpp.

◆ currentWidgetList

QList<QPointer<QWidget> > KoToolDocker::currentWidgetList

Definition at line 34 of file KoToolDocker.cpp.

◆ d

Private* const KoToolDocker::d

private

Definition at line 52 of file KoToolDocker.h.

◆ dockingArea

Qt::DockWidgetArea KoToolDocker::dockingArea {Qt::NoDockWidgetArea}

Definition at line 42 of file KoToolDocker.cpp.

42{Qt::NoDockWidgetArea};

◆ hiderWidget

QWidget* KoToolDocker::hiderWidget {nullptr}

Definition at line 37 of file KoToolDocker.cpp.

37{nullptr}; // non current widgets are hidden by being children of this

◆ housekeeperLayout

QGridLayout* KoToolDocker::housekeeperLayout {nullptr}

Definition at line 39 of file KoToolDocker.cpp.

39{nullptr};

◆ housekeeperMainLayout

QBoxLayout* KoToolDocker::housekeeperMainLayout {nullptr}

Definition at line 40 of file KoToolDocker.cpp.

40{nullptr};

◆ housekeeperWidget

QWidget* KoToolDocker::housekeeperWidget {nullptr}

Definition at line 38 of file KoToolDocker.cpp.

38{nullptr};

◆ q

KoToolDocker* KoToolDocker::q {nullptr}

Definition at line 41 of file KoToolDocker.cpp.

41{nullptr};

◆ scrollArea

QScrollArea* KoToolDocker::scrollArea {nullptr}

Definition at line 36 of file KoToolDocker.cpp.

36{nullptr};

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

libs/widgets/KoToolDocker.cpp
libs/widgets/KoToolDocker.h

Public Slots

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ KoToolDocker()

◆ ~KoToolDocker()

Member Function Documentation

◆ hasOptionWidget

◆ locationChanged()

◆ Private()

◆ recreateLayout()

◆ resetWidgets() [1/2]

◆ resetWidgets() [2/2]

◆ setCanvas()

◆ setOptionWidgets

◆ slotScrollerStateChange

◆ unsetCanvas()

Member Data Documentation

◆ currentAuxWidgets

◆ currentWidgetList

◆ d

◆ dockingArea

◆ hiderWidget

◆ housekeeperLayout

◆ housekeeperMainLayout

◆ housekeeperWidget

◆ q

◆ scrollArea