KoGroupButton Class Reference

#include <KoGroupButton.h>

Inheritance diagram for KoGroupButton:

Public Types
enum	GroupPosition { NoGroup , GroupLeft , GroupRight , GroupCenter }

Public Member Functions
KoGroupButton::GroupPosition	groupPosition () const
	KoGroupButton (GroupPosition position, QWidget *parent=0)
	KoGroupButton (QWidget *parent=0)
	Private (KoGroupButton *qq, const GroupPosition position)
void	setGroupPosition (KoGroupButton::GroupPosition groupPosition)
	~KoGroupButton () override
Public Member Functions inherited from KisHighlightedToolButton
void	changeEvent (QEvent *event) override
	KisHighlightedToolButton (QWidget *parent=0)

Public Attributes
GroupPosition	groupPosition

Protected Member Functions
void	paintEvent (QPaintEvent *event) override
Protected Member Functions inherited from KisHighlightedToolButton
void	checkStateSet () override
void	nextCheckState () override

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 thin tool button which can be visually grouped with other buttons.

The group can thus look like one solid bar: ( button1 | button2 | button3 )

For grouping layout can be used. For exclusive checkable behaviour assign QButtonGroup on the buttons.

Definition at line 16 of file KoGroupButton.cpp.

Member Enumeration Documentation

GroupPosition

enum KoGroupButton::GroupPosition

Position of the button within the button group what affects the appearance.

Enumerator
NoGroup	No particular position, gives the button unchanged appearance.
GroupLeft	The button is at the left of the group, so it would have rounded the left part.
GroupRight	The button is at the right of the group, so it would have rounded the right part.
GroupCenter	The button is on the center of the group, so it would have separators on both sides.

Definition at line 31 of file KoGroupButton.h.

                       {
        NoGroup,     
        GroupLeft,   
        GroupRight,  
        GroupCenter  
    };

Constructor & Destructor Documentation

KoGroupButton() [1/2]

KoGroupButton::KoGroupButton ( GroupPosition position, QWidget * parent = 0 )

explicit

Definition at line 28 of file KoGroupButton.cpp.

    : KisHighlightedToolButton(parent), d(new Private(this, position))
{
}

KoGroupButton() [2/2]

KoGroupButton::KoGroupButton ( QWidget * parent = 0 )

explicit

Creates button with no NoGroup position.

Definition at line 33 of file KoGroupButton.cpp.

    : KisHighlightedToolButton(parent), d(new Private(this, NoGroup))
{
}

~KoGroupButton()

KoGroupButton::~KoGroupButton ( )

override

Definition at line 38 of file KoGroupButton.cpp.

{
    delete d;
}

References d.

Member Function Documentation

groupPosition()

KoGroupButton::GroupPosition KoGroupButton::groupPosition

(

)

const

paintEvent()

void KoGroupButton::paintEvent ( QPaintEvent * event )

overrideprotected

Todo

make specific fixes for styles such as Cleanlooks if there's practical no alternative

Definition at line 53 of file KoGroupButton.cpp.

{
    if (groupPosition() == NoGroup) {
        QToolButton::paintEvent(event);
        return;
    }
    QStylePainter painter(this);
    QStyleOptionToolButton opt;
    initStyleOption(&opt);
    QStyleOptionToolButton panelOpt = opt;
 
    // Panel
    QRect& panelRect = panelOpt.rect;
    switch (groupPosition()) {
    case GroupLeft:
        panelRect.setWidth(panelRect.width() * 2);
        break;
    case GroupCenter:
        panelRect.setLeft(panelRect.left() - panelRect.width());
        panelRect.setWidth(panelRect.width() * 3);
        break;
    case GroupRight:
        panelRect.setLeft(panelRect.left() - panelRect.width());
        break;
    case NoGroup:
        Q_ASSERT(0);
    }
    if (autoRaise()) {
        if (!isChecked() && !isDown() && !(panelOpt.state & QStyle::State_MouseOver)) {
            // Use 'pushed' appearance for all buttons, but those that are not really pushed
            // are drawn with less contrast and are toned down.
            panelOpt.state |= (QStyle::State_On | QStyle::State_Sunken);
            QPalette panelPal(panelOpt.palette);
            QColor c;
            c = panelPal.color(QPalette::Button);
            c.setAlpha(50);
            panelPal.setColor(QPalette::Button, c);
            c = panelPal.color(QPalette::Window);
            c.setAlpha(50);
            panelPal.setColor(QPalette::Window, c);
            panelOpt.palette = panelPal;
            painter.setOpacity(0.5);
        }
    } else {
 
        if (!isChecked() && !isDown() && !(panelOpt.state & QStyle::State_MouseOver)) {
 
        } else {
            // only highlight the selected item
            panelOpt.state |= (QStyle::State_On | QStyle::State_Sunken);
            QPalette panelPal(panelOpt.palette);
            QColor c;
            c = panelPal.color(QPalette::Button);
            c.setAlpha(50);
            panelPal.setColor(QPalette::Button, c);
            c = panelPal.color(QPalette::Window);
            c.setAlpha(50);
            panelPal.setColor(QPalette::Window, c);
            panelOpt.palette = panelPal;
            painter.setOpacity(0.5);
        }
    }
 
 
    painter.drawPrimitive(QStyle::PE_PanelButtonTool, panelOpt);
    painter.setOpacity(1.0);
 
    // Separator
    const int y1 = opt.rect.top() + 1;
    const int y2 = opt.rect.bottom() - 1;
    painter.setOpacity(0.4);
    if (d->groupPosition != GroupRight) {
        const int x = opt.rect.right();
        painter.setPen(QPen(opt.palette.color(QPalette::Dark), 0));
        painter.drawLine(x, y1, x, y2);
    }
    painter.setOpacity(1.0);
 
    // Text
    painter.drawControl(QStyle::CE_ToolButtonLabel, opt);
 
    // Filtering message on tooltip text for CJK to remove accelerators.
    // Quoting ktoolbar.cpp:
    // """
    // CJK languages use more verbose accelerator marker: they add a Latin
    // letter in parenthesis, and put accelerator on that. Hence, the default
    // removal of ampersand only may not be enough there, instead the whole
    // parenthesis construct should be removed. Provide these filtering i18n
    // messages so that translators can use Transcript for custom removal.
    // """
    if (!actions().isEmpty()) {
        QAction* action = actions().first();
        setToolTip(i18nc("@info:tooltip of custom triple button", "%1", action->toolTip()));
    }
}

References d, GroupCenter, GroupLeft, groupPosition, GroupRight, and NoGroup.

Private()

KoGroupButton::Private ( KoGroupButton * qq, const GroupPosition position )

inline

Definition at line 19 of file KoGroupButton.cpp.

                                                             : groupPosition(position)
    {
        // Make the policy closer to QPushButton's default but horizontal shouldn't be Fixed,
        // otherwise spacing gets broken
        qq->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Fixed);
    }

setGroupPosition()

void KoGroupButton::setGroupPosition

(

KoGroupButton::GroupPosition

groupPosition

)

Definition at line 43 of file KoGroupButton.cpp.

{
    d->groupPosition = groupPosition;
}

References d, and groupPosition.

Member Data Documentation

d

Private* const KoGroupButton::d

private

Definition at line 56 of file KoGroupButton.h.

groupPosition

GroupPosition KoGroupButton::groupPosition

readwrite

Definition at line 25 of file KoGroupButton.cpp.

---

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

• libs/widgetutils/KoGroupButton.cpp
• libs/widgetutils/KoGroupButton.h