KoDockWidgetTitleBar Class Reference

A custom title bar for dock widgets. More...

#include <KoDockWidgetTitleBar.h>

Inheritance diagram for KoDockWidgetTitleBar:

Public Slots
void	setLocked (bool locked)

Public Member Functions
void	dockWidgetTitleChanged (const QString &title)
void	featuresChanged (QDockWidget::DockWidgetFeatures features)
	KoDockWidgetTitleBar (QDockWidget *dockWidget)
	Private (KoDockWidgetTitleBar *thePublic)
void	toggleFloating ()
void	topLevelChanged (bool topLevel)
void	updateButtonSizes ()
void	updateIcons ()
void	updateIcons ()
	~KoDockWidgetTitleBar () override

Public Attributes
QAbstractButton *	closeButton {nullptr}
QDockWidget::DockWidgetFeatures	features
QAbstractButton *	floatButton {nullptr}
QIcon	floatIcon
QAbstractButton *	lockButton {nullptr}
bool	locked {false}
QIcon	lockIcon
QIcon	removeIcon
KoDockWidgetTitleBar *	thePublic {nullptr}
KSqueezedTextLabel *	titleLabel {nullptr}

Protected Member Functions
void	paintEvent (QPaintEvent *event) override
	reimplemented from QWidget
void	resizeEvent (QResizeEvent *event) override
	reimplemented from QWidget

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

A custom title bar for dock widgets.

Allow customization such as hidden text.

See also

KoDockWidgetTitleBarButton

Definition at line 19 of file KoDockWidgetTitleBar.h.

Constructor & Destructor Documentation

KoDockWidgetTitleBar()

KoDockWidgetTitleBar::KoDockWidgetTitleBar ( QDockWidget * dockWidget )

explicit

Definition at line 36 of file KoDockWidgetTitleBar.cpp.

        : QWidget(dockWidget), d(new Private(this))
{
    d->floatIcon = kisIcon("docker_float");
    d->floatButton = new KoDockWidgetTitleBarButton(this);
    d->floatButton->setIcon(d->floatIcon);
    connect(d->floatButton, SIGNAL(clicked()), SLOT(toggleFloating()));
    d->floatButton->setVisible(true);
    d->floatButton->setToolTip(i18nc("@info:tooltip", "Float Docker"));
    d->floatButton->setStyleSheet("border: 0");
 
    d->removeIcon = kisIcon("docker_close");
    d->closeButton = new KoDockWidgetTitleBarButton(this);
    d->closeButton->setIcon(d->removeIcon);
    connect(d->closeButton, SIGNAL(clicked()), dockWidget, SLOT(close()));
    d->closeButton->setVisible(true);
    d->closeButton->setToolTip(i18nc("@info:tooltip", "Close Docker"));   
    d->closeButton->setStyleSheet("border: 0"); // border makes the header busy looking (appears on some OSs)
 
    d->lockIcon = kisIcon("docker_lock_a");
    d->lockButton = new KoDockWidgetTitleBarButton(this);
    d->lockButton->setCheckable(true);
    d->lockButton->setIcon(d->lockIcon);
    connect(d->lockButton, SIGNAL(toggled(bool)), SLOT(setLocked(bool)));
    d->lockButton->setVisible(true);
    d->lockButton->setToolTip(i18nc("@info:tooltip", "Lock Docker"));
    d->lockButton->setStyleSheet("border: 0");
 
    d->updateButtonSizes();
 
    d->titleLabel = new KSqueezedTextLabel(this);
    d->titleLabel->setTextElideMode(Qt::ElideRight);
    d->titleLabel->setText(dockWidget->windowTitle());
 
    QHBoxLayout *layout = new QHBoxLayout(this);
    layout->setContentsMargins(2, 0, 2, 0);
    layout->setSpacing(SPACING);
    layout->addWidget(d->lockButton);
    layout->addWidget(d->titleLabel, 1);
    layout->addWidget(d->floatButton);
    layout->addWidget(d->closeButton);
 
    connect(dockWidget, SIGNAL(featuresChanged(QDockWidget::DockWidgetFeatures)), SLOT(featuresChanged(QDockWidget::DockWidgetFeatures)));
    connect(dockWidget, SIGNAL(topLevelChanged(bool)), SLOT(topLevelChanged(bool)));
    connect(dockWidget, SIGNAL(windowTitleChanged(const QString &)), SLOT(dockWidgetTitleChanged(const QString &)));
 
    d->featuresChanged(QDockWidget::NoDockWidgetFeatures);
}

References connect(), d, dockWidgetTitleChanged(), featuresChanged(), kisIcon, setLocked(), SPACING, toggleFloating(), and topLevelChanged().

~KoDockWidgetTitleBar()

KoDockWidgetTitleBar::~KoDockWidgetTitleBar ( )

override

Definition at line 85 of file KoDockWidgetTitleBar.cpp.

{
    delete d;
}

References d.

Member Function Documentation

dockWidgetTitleChanged()

void KoDockWidgetTitleBar::dockWidgetTitleChanged

(

const QString &

title

)

featuresChanged()

void KoDockWidgetTitleBar::featuresChanged

(

QDockWidget::DockWidgetFeatures

features

)

paintEvent()

void KoDockWidgetTitleBar::paintEvent ( QPaintEvent * event )

overrideprotected

reimplemented from QWidget

Definition at line 90 of file KoDockWidgetTitleBar.cpp.

{
    QStylePainter p(this);
 
    QDockWidget *q = qobject_cast<QDockWidget*>(parentWidget());
 
    int fw = q->isFloating() ? q->style()->pixelMetric(QStyle::PM_DockWidgetFrameWidth, 0, q) : 0;
    int mw = q->style()->pixelMetric(QStyle::PM_DockWidgetTitleMargin, 0, q);
 
    QStyleOptionDockWidget titleOpt;
    titleOpt.initFrom(q);
 
    QSize lockButtonSize(0,0);
    if (d->lockButton->isVisible()) {
        lockButtonSize = d->lockButton->size();
    }
 
    // To improve the look with Fusion which has weird 13x15 button sizes
    int fusionTextOffset = 0;
    QRect styleTestRect = q->style()->subElementRect(QStyle::SE_DockWidgetFloatButton, &titleOpt, q);
    if (styleTestRect.width() < 16) {
        fusionTextOffset = d->lockButton->x();
    }
 
    titleOpt.rect = QRect(QPoint(fw + mw + lockButtonSize.width() + fusionTextOffset, 0),
                          QSize(geometry().width() - (fw * 2) -  mw - lockButtonSize.width(), geometry().height()));
    // We don't print the title text here. Instead, we have a QLabel.
    //   titleOpt.title = q->windowTitle();
    // FIXME: Maybe we just shouldn't use a QStylePainter at all?
    titleOpt.title = QString();
    titleOpt.closable = hasFeature(q, QDockWidget::DockWidgetClosable);
    titleOpt.floatable = hasFeature(q, QDockWidget::DockWidgetFloatable);
    p.drawControl(QStyle::CE_DockWidgetTitle, titleOpt);
}

References d, hasFeature(), and p.

Private()

KoDockWidgetTitleBar::Private ( KoDockWidgetTitleBar * thePublic )

inline

Definition at line 29 of file KoDockWidgetTitleBar_p.h.

        : thePublic(thePublic)
        , locked(false)
    {
    }

resizeEvent()

void KoDockWidgetTitleBar::resizeEvent ( QResizeEvent * event )

overrideprotected

reimplemented from QWidget

Definition at line 125 of file KoDockWidgetTitleBar.cpp.

{
    QDockWidget *q = qobject_cast<QDockWidget*>(parentWidget());
 
    if (q->isFloating() || (width() < (d->closeButton->width() + d->floatButton->width() + d->lockButton->width()) + 32)) {
        d->lockButton->setVisible(false);
    } else {
        d->lockButton->setVisible(true);
    }
}

References d.

setLocked

void KoDockWidgetTitleBar::setLocked ( bool locked )

slot

Definition at line 136 of file KoDockWidgetTitleBar.cpp.

{
    QDockWidget *q = qobject_cast<QDockWidget*>(parentWidget());
 
    d->locked = locked;
    d->lockButton->blockSignals(true);
    d->lockButton->setChecked(locked);
    d->lockButton->blockSignals(false);
 
    if (locked) {
        d->features = q->features();
        q->setFeatures(QDockWidget::NoDockWidgetFeatures);
    }
    else {
        q->setFeatures(d->features);
    }
 
    q->toggleViewAction()->setEnabled(!locked);
    d->closeButton->setEnabled(!locked);
    d->floatButton->setEnabled(!locked);
    d->floatButton->setVisible(!locked);
 
    d->updateIcons();
    q->setProperty("Locked", locked);
}

References d, and locked.

toggleFloating()

void KoDockWidgetTitleBar::toggleFloating

(

)

topLevelChanged()

void KoDockWidgetTitleBar::topLevelChanged

(

bool

topLevel

)

updateButtonSizes()

void KoDockWidgetTitleBar::updateButtonSizes

(

)

updateIcons() [1/2]

void KoDockWidgetTitleBar::updateIcons

(

)

Definition at line 162 of file KoDockWidgetTitleBar.cpp.

{
    d->updateIcons();
}

References d.

updateIcons() [2/2]

void KoDockWidgetTitleBar::updateIcons

(

)

Member Data Documentation

closeButton

QAbstractButton* KoDockWidgetTitleBar::closeButton {nullptr}

Definition at line 37 of file KoDockWidgetTitleBar_p.h.

{nullptr};

d

Private* const KoDockWidgetTitleBar::d

private

Definition at line 41 of file KoDockWidgetTitleBar.h.

features

QDockWidget::DockWidgetFeatures KoDockWidgetTitleBar::features

Definition at line 42 of file KoDockWidgetTitleBar_p.h.

floatButton

QAbstractButton* KoDockWidgetTitleBar::floatButton {nullptr}

Definition at line 38 of file KoDockWidgetTitleBar_p.h.

{nullptr};

floatIcon

QIcon KoDockWidgetTitleBar::floatIcon

Definition at line 36 of file KoDockWidgetTitleBar_p.h.

lockButton

QAbstractButton* KoDockWidgetTitleBar::lockButton {nullptr}

Definition at line 39 of file KoDockWidgetTitleBar_p.h.

{nullptr};

locked

bool KoDockWidgetTitleBar::locked {false}

Definition at line 41 of file KoDockWidgetTitleBar_p.h.

{false};

lockIcon

QIcon KoDockWidgetTitleBar::lockIcon

Definition at line 36 of file KoDockWidgetTitleBar_p.h.

removeIcon

QIcon KoDockWidgetTitleBar::removeIcon

Definition at line 36 of file KoDockWidgetTitleBar_p.h.

thePublic

KoDockWidgetTitleBar* KoDockWidgetTitleBar::thePublic {nullptr}

Definition at line 35 of file KoDockWidgetTitleBar_p.h.

{nullptr};

titleLabel

KSqueezedTextLabel* KoDockWidgetTitleBar::titleLabel {nullptr}

Definition at line 40 of file KoDockWidgetTitleBar_p.h.

{nullptr};

---

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

• libs/widgets/KoDockWidgetTitleBar.h
• libs/widgets/KoDockWidgetTitleBar_p.h
• libs/widgets/KoDockWidgetTitleBar.cpp