KisUtilityTitleBar Class Reference

A special utility titlebar with a title and controls, as well as a central area for adding frequently used widgets. More...

#include <kis_utility_title_bar.h>

Inheritance diagram for KisUtilityTitleBar:

Public Slots
void	setLocked (bool locked)

Public Member Functions
void	dockWidgetTitleChanged (const QString &title)
void	featuresChanged (QDockWidget::DockWidgetFeatures features)
	KisUtilityTitleBar (QLabel *title, QWidget *parent=nullptr)
	KisUtilityTitleBar (QWidget *parent=nullptr)
	Private (KisUtilityTitleBar *thePublic)
void	setWidgetArea (QWidget *widgetArea)
QSize	sizeHint () const override
void	toggleFloating ()
void	topLevelChanged (bool topLevel)
void	updateButtonSizes ()
void	updateIcons ()
QWidget *	widgetArea ()
	~KisUtilityTitleBar ()

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

Protected Attributes
Private *const	d
const int	SPACING_UNIT = 16
QHBoxLayout *	widgetAreaLayout

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

A special utility titlebar with a title and controls, as well as a central area for adding frequently used widgets.

As a general design philosophy, we should try to reserve titlebar widgets for things that are simple to use, frequently tweaked, and core to the artists' workflow.

Definition at line 30 of file kis_utility_title_bar.h.

Constructor & Destructor Documentation

KisUtilityTitleBar() [1/2]

KisUtilityTitleBar::KisUtilityTitleBar

(

QWidget *

parent = nullptr

)

Definition at line 19 of file kis_utility_title_bar.cpp.

    : KisUtilityTitleBar(new QLabel(i18n("Title"), parent), parent)
{
}

KisUtilityTitleBar() [2/2]

KisUtilityTitleBar::KisUtilityTitleBar	(	QLabel *	title,
		QWidget *	parent = nullptr )

Definition at line 24 of file kis_utility_title_bar.cpp.

    : QWidget(parent), d(new Private(this))
{
    // Set up main layout..
    d->mainLayout = new QHBoxLayout(this);
    QMargins margins = d->mainLayout->contentsMargins();
    margins.setTop(0);
    margins.setBottom(0);
    margins.setLeft(0);
    d->mainLayout->setContentsMargins(margins);
    d->mainLayout->setSpacing(0);
 
    // Set up lock button
    d->lockButton = new KoDockWidgetTitleBarButton(this);
    d->lockButton->setCheckable(true);
    d->lockButton->setIcon(kisIcon("docker_lock_a"));
    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->lockButton->setFixedSize(QSize(22,22));
 
    d->mainLayout->addWidget(d->lockButton);
 
    // Set up title..
    d->mainLayout->addWidget(title);
 
    //QSpacerItem *spacerItem = new QSpacerItem(SPACING_UNIT * 2, 0);
    d->mainLayout->addSpacing(SPACING_UNIT * 2);
    // Set up widget area..
    QWidget *widgetArea = new QWidget(this);
    widgetAreaLayout = new QHBoxLayout(widgetArea);
    widgetAreaLayout->setSpacing(0);
    widgetAreaLayout->setContentsMargins(0,0,0,0);
    d->mainLayout->addWidget(widgetArea);
 
//     mainLayout->addSpacing(SPACING_UNIT * 2);
    d->mainLayout->insertSpacing(4, SPACING_UNIT * 2 );
 
    {   // Controls/Decorations..
        QWidget *widget = new QWidget(this);
 
        QHBoxLayout *sublayout = new QHBoxLayout(widget);
        sublayout->setSpacing(0);
        sublayout->setContentsMargins(0,0,0,0);
 
        QDockWidget *dockWidget = qobject_cast<QDockWidget*>(parentWidget());
 
        {   // Float button...
            QIcon floatIcon = kisIcon("docker_float");
            d->floatButton = new QPushButton(floatIcon, "", this);
            d->floatButton->setFlat(true);
            connect(d->floatButton, &QPushButton::clicked, dockWidget, [dockWidget](){
                dockWidget->setFloating(!dockWidget->isFloating());
            } );
            sublayout->addWidget(d->floatButton);
        }
 
        {   // Close button...
            QIcon closeIcon = kisIcon("docker_close");
            d->closeButton = new QPushButton(closeIcon, "", this);
            d->closeButton->setFlat(true);
            connect(d->closeButton, SIGNAL(clicked(bool)), dockWidget, SLOT(close()));
            sublayout->addWidget(d->closeButton);
        }
 
        d->mainLayout->addWidget(widget);
    }
}

References connect(), d, floatIcon, kisIcon, setLocked(), SPACING_UNIT, widgetArea(), and widgetAreaLayout.

~KisUtilityTitleBar()

KisUtilityTitleBar::~KisUtilityTitleBar

(

)

Definition at line 149 of file kis_utility_title_bar.cpp.

{
    delete d;
}

References d.

Member Function Documentation

dockWidgetTitleChanged()

void KisUtilityTitleBar::dockWidgetTitleChanged

(

const QString &

title

)

featuresChanged()

void KisUtilityTitleBar::featuresChanged

(

QDockWidget::DockWidgetFeatures

features

)

Private()

KisUtilityTitleBar::Private ( KisUtilityTitleBar * thePublic )

inline

Definition at line 27 of file kis_utility_title_bar_p.h.

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

setLocked

void KisUtilityTitleBar::setLocked ( bool locked )

slot

Definition at line 106 of file kis_utility_title_bar.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);
        QLayoutItem *spacingItem = d->mainLayout->itemAt(4);
        d->mainLayout->removeItem(spacingItem);
    }
    else {
        d->mainLayout->insertSpacing(4, SPACING_UNIT * 2 );
        q->setFeatures(d->features);
    }
 
    q->toggleViewAction()->setEnabled(!locked);
    d->closeButton->setEnabled(!locked);
    d->closeButton->setVisible(!locked);
 
    d->floatButton->setEnabled(!locked);
    d->floatButton->setVisible(!locked);
 
 
    d->updateIcons();
    q->setProperty("Locked", locked);
}

References d, locked, and SPACING_UNIT.

setWidgetArea()

void KisUtilityTitleBar::setWidgetArea

(

QWidget *

widgetArea

)

Definition at line 98 of file kis_utility_title_bar.cpp.

                                                          {
    QHBoxLayout *layout = dynamic_cast<QHBoxLayout*>(this->layout());
    KIS_SAFE_ASSERT_RECOVER_RETURN(layout);
    // It's the third widget;
    //     title, spacer, widgetArea, spacer, float/close
    layout->insertWidget(2, widgetArea);
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, and widgetArea().

sizeHint()

QSize KisUtilityTitleBar::sizeHint ( ) const

inlineoverride

Definition at line 38 of file kis_utility_title_bar.h.

    {
        return QSize(32, 32);
    }

toggleFloating()

void KisUtilityTitleBar::toggleFloating

(

)

topLevelChanged()

void KisUtilityTitleBar::topLevelChanged

(

bool

topLevel

)

updateButtonSizes()

void KisUtilityTitleBar::updateButtonSizes

(

)

updateIcons()

void KisUtilityTitleBar::updateIcons

(

)

widgetArea()

QWidget * KisUtilityTitleBar::widgetArea

(

)

Definition at line 94 of file kis_utility_title_bar.cpp.

                                        {
    return widgetAreaLayout->parentWidget();
}

References widgetAreaLayout.

Member Data Documentation

closeButton

QPushButton* KisUtilityTitleBar::closeButton {nullptr}

Definition at line 36 of file kis_utility_title_bar_p.h.

{nullptr};

d

Private* const KisUtilityTitleBar::d

protected

Definition at line 55 of file kis_utility_title_bar.h.

features

QDockWidget::DockWidgetFeatures KisUtilityTitleBar::features

Definition at line 41 of file kis_utility_title_bar_p.h.

floatButton

QPushButton* KisUtilityTitleBar::floatButton {nullptr}

Definition at line 37 of file kis_utility_title_bar_p.h.

{nullptr};

floatIcon

QIcon KisUtilityTitleBar::floatIcon

Definition at line 34 of file kis_utility_title_bar_p.h.

lockButton

QAbstractButton* KisUtilityTitleBar::lockButton {nullptr}

Definition at line 38 of file kis_utility_title_bar_p.h.

{nullptr};

locked

bool KisUtilityTitleBar::locked {false}

Definition at line 40 of file kis_utility_title_bar_p.h.

{false};

lockIcon

QIcon KisUtilityTitleBar::lockIcon

Definition at line 34 of file kis_utility_title_bar_p.h.

mainLayout

QHBoxLayout* KisUtilityTitleBar::mainLayout

Definition at line 35 of file kis_utility_title_bar_p.h.

removeIcon

QIcon KisUtilityTitleBar::removeIcon

Definition at line 34 of file kis_utility_title_bar_p.h.

SPACING_UNIT

const int KisUtilityTitleBar::SPACING_UNIT = 16

protected

Definition at line 52 of file kis_utility_title_bar.h.

thePublic

KisUtilityTitleBar* KisUtilityTitleBar::thePublic {nullptr}

Definition at line 33 of file kis_utility_title_bar_p.h.

{nullptr};

titleLabel

KSqueezedTextLabel* KisUtilityTitleBar::titleLabel {nullptr}

Definition at line 39 of file kis_utility_title_bar_p.h.

{nullptr};

widgetAreaLayout

QHBoxLayout* KisUtilityTitleBar::widgetAreaLayout

protected

Definition at line 50 of file kis_utility_title_bar.h.

---

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

• libs/ui/widgets/kis_utility_title_bar.h
• libs/ui/widgets/kis_utility_title_bar_p.h
• libs/ui/widgets/kis_utility_title_bar.cpp