KoToolBoxLayout Class Reference

#include <KoToolBoxLayout_p.h>

Inheritance diagram for KoToolBoxLayout:

Public Member Functions
void	addItem (QLayoutItem *) override
void	addSection (Section *section)
int	count () const override
bool	hasHeightForWidth () const override
int	heightForWidth (int width) const override
bool	isCompact ()
QLayoutItem *	itemAt (int i) const override
	KoToolBoxLayout (QWidget *parent)
QSize	minimumSize () const override
void	setCompact (bool state)
void	setGeometry (const QRect &rect) override
void	setOrientation (Qt::Orientation orientation)
QSize	sizeHint () const override
QLayoutItem *	takeAt (int i) override
int	widthForHeight (int height) const
	~KoToolBoxLayout () override

Private Member Functions
int	doLayout (const QRect &rect, bool notDryRun) const

Private Attributes
bool	m_compact
Qt::Orientation	m_orientation
QList< QWidgetItem * >	m_sections

Detailed Description

Definition at line 257 of file KoToolBoxLayout_p.h.

Constructor & Destructor Documentation

KoToolBoxLayout()

KoToolBoxLayout::KoToolBoxLayout ( QWidget * parent )

inlineexplicit

Definition at line 260 of file KoToolBoxLayout_p.h.

        : QLayout(parent)
        , m_orientation(Qt::Vertical)
        , m_compact(false)
    {
        setSpacing(6);
    }

~KoToolBoxLayout()

KoToolBoxLayout::~KoToolBoxLayout ( )

inlineoverride

Definition at line 268 of file KoToolBoxLayout_p.h.

    {
        qDeleteAll( m_sections );
        m_sections.clear();
    }

Member Function Documentation

addItem()

void KoToolBoxLayout::addItem ( QLayoutItem * )

inlineoverride

Definition at line 308 of file KoToolBoxLayout_p.h.

    {
        Q_ASSERT(0); // don't let anything else be added. (code depends on this!)
    }

addSection()

void KoToolBoxLayout::addSection ( Section * section )

inline

Definition at line 294 of file KoToolBoxLayout_p.h.

    {
        addChildWidget(section);
 
        QList<QWidgetItem*>::iterator iterator = m_sections.begin();
        int defaults = 2; // skip the first two as they are the 'main' and 'dynamic' sections.
        while (iterator != m_sections.end()) {
            if (--defaults < 0 && static_cast<Section*> ((*iterator)->widget())->name() > section->name())
                break;
            ++iterator;
        }
        m_sections.insert(iterator, new QWidgetItem(section));
    }

References Section::name().

count()

int KoToolBoxLayout::count ( ) const

inlineoverride

Definition at line 320 of file KoToolBoxLayout_p.h.

{ return m_sections.count(); }

doLayout()

int KoToolBoxLayout::doLayout ( const QRect & rect, bool notDryRun ) const

inlineprivate

Definition at line 390 of file KoToolBoxLayout_p.h.

    {
        // nothing to do?
        if (m_sections.isEmpty()) {
            return 0;
        }
 
        // the names of the variables assume a vertical orientation,
        // but all calculations are done based on the real orientation
        const bool isVertical = m_orientation == Qt::Vertical;
        const bool isLeftToRight = parentWidget()->isLeftToRight();
 
        const QSize iconSize = static_cast<Section*> (m_sections.first()->widget())->iconSize();
 
        const int maxWidth = isVertical ? rect.width() : rect.height();
        // using min 1 as width to e.g. protect against div by 0 below
        const int iconWidth = qMax(1, isVertical ? iconSize.width() : iconSize.height());
        const int iconHeight = qMax(1, isVertical ? iconSize.height() : iconSize.width());
 
        const Section::Separators separator = m_compact ?
            Section::SeparatorNone
        : isVertical ?
            Section::SeparatorTop
        :
            Section::SeparatorLeft;
 
        const int maxColumns = qMax(1, (maxWidth / iconWidth));
 
        int y = 0;
        int offset = 0;
        bool firstSection = true;
        foreach (QWidgetItem *wi, m_sections) {
            Section *section = static_cast<Section*> (wi->widget());
            const int buttonCount = section->visibleButtonCount();
            if (buttonCount == 0) {
                // move out of view, not perfect TODO: better solution
                if (notDryRun) {
                    section->setGeometry(1000, 1000, 0, 0);
                }
                continue;
            }
 
            // in compact mode, the previous section's offset is this section's onset
            const int onset = m_compact ? offset : 0;
            const int usedColumns = onset + buttonCount;
            offset = usedColumns % maxColumns;
 
            // rows needed for the buttons (calculation gets the ceiling value of the plain div)
            const int neededRowCount = ((usedColumns - 1) / maxColumns) + 1;
 
            if (firstSection) {
                firstSection = false;
            } else {
                if (m_compact) {
                    // start on a new row if the current row is full
                    y += (onset == 0) ? iconHeight : 0;
                } else {
                    // start on a new row, set separator
                    y += iconHeight + spacing();
                }
                if (notDryRun) {
                    section->setOnset(onset);
                    section->setSeparator(separator);
                }
            }
 
            if (notDryRun) {
                const int onW = onset * iconWidth;
                const int offW = offset * iconWidth;
                const int width = maxColumns * iconWidth;
                const int height = neededRowCount * iconHeight;
 
                QRect geometry;
                QRegion mask;
                if (isVertical) {
                    mask = QRegion(0, 0, width, height);
                    if (isLeftToRight) {
                        geometry = QRect(0, y, width, height);
 
                        // mask onset and offset regions
                        // so that they don't block mouse events to other sections
                        mask -= QRegion(0, 0, onW, iconHeight);
                        if (offset != 0) {
                            mask -= QRegion(offW, height - iconHeight, width - offW, iconHeight);
                        }
                    } else {
                        geometry = QRect(rect.width() - width, y, width, height);
                        mask -= QRegion(width - onW, 0, onW, iconHeight);
                        if (offset != 0) {
                            mask -= QRegion(0, height - iconHeight, width - offW, iconHeight);
                        }
                    }
                } else {
                    mask = QRegion(0, 0, height, width);
                    if (isLeftToRight) {
                        geometry = QRect(y, 0, height, width);
                        mask -= QRegion(0, 0, iconHeight, onW);
                        if (offset != 0) {
                            mask -= QRegion(height - iconHeight, offW, iconHeight, width - offW);
                        }
                    } else {
                        geometry = QRect(rect.width() - y - height, 0, height, width);
                        mask -= QRegion(height - iconHeight, 0, iconHeight, onW);
                        if (offset != 0) {
                            mask -= QRegion(0, offW, iconHeight, width - offW);
                        }
                    }
                }
                section->setGeometry(geometry);
                section->setMask(mask);
            }
 
            // advance by all but the last used row
            y += (neededRowCount - 1) * iconHeight;
        }
 
        // cache total height (or width), adding the iconHeight for the current row
        return y + iconHeight;
    }

References iconSize(), Section::SeparatorLeft, Section::SeparatorNone, Section::SeparatorTop, Section::setOnset(), Section::setSeparator(), and Section::visibleButtonCount().

hasHeightForWidth()

bool KoToolBoxLayout::hasHeightForWidth ( ) const

inlineoverride

Definition at line 328 of file KoToolBoxLayout_p.h.

    {
        // return true;
        return m_orientation == Qt::Vertical;
    }

heightForWidth()

int KoToolBoxLayout::heightForWidth ( int width ) const

inlineoverride

Definition at line 334 of file KoToolBoxLayout_p.h.

    {
        if (m_orientation == Qt::Vertical) {
            const int height = doLayout(QRect(0, 0, width, 0), false);
            return height;
        } else {
    #if 0
            const int iconHeight = static_cast<Section*> (m_sections[0]->widget())->iconSize().height();
            for (int i = 1; i <= 10; i++) {
                const int testWidth = doLayout(QRect(0, 0, 0, iconHeight * i), false);
                if (testWidth <= width) {
                    return iconHeight * i;
                }
            }
            // Return a huge height
            return 65535;
    #endif
            return -1;
        }
    }

References iconSize().

isCompact()

bool KoToolBoxLayout::isCompact ( )

inline

Definition at line 384 of file KoToolBoxLayout_p.h.

    {
        return m_compact;
    }

itemAt()

QLayoutItem * KoToolBoxLayout::itemAt ( int i ) const

inlineoverride

Definition at line 313 of file KoToolBoxLayout_p.h.

    {
        return m_sections.value(i);
    }

minimumSize()

QSize KoToolBoxLayout::minimumSize ( ) const

inlineoverride

Definition at line 286 of file KoToolBoxLayout_p.h.

    {
        if (m_sections.isEmpty())
            return QSize();
        QSize oneIcon = static_cast<Section*> (m_sections[0]->widget())->iconSize();
        return oneIcon;
    }

References iconSize().

setCompact()

void KoToolBoxLayout::setCompact ( bool state )

inline

Definition at line 376 of file KoToolBoxLayout_p.h.

    {
        m_compact = state;
        foreach (QWidgetItem *wi, m_sections) {
            wi->widget()->layout()->invalidate();
        }
    }

setGeometry()

void KoToolBoxLayout::setGeometry ( const QRect & rect )

inlineoverride

Definition at line 322 of file KoToolBoxLayout_p.h.

    {
        QLayout::setGeometry(rect);
        doLayout(rect, true);
    }

setOrientation()

void KoToolBoxLayout::setOrientation ( Qt::Orientation orientation )

inline

Definition at line 370 of file KoToolBoxLayout_p.h.

    {
        m_orientation = orientation;
        invalidate();
    }

sizeHint()

QSize KoToolBoxLayout::sizeHint ( ) const

inlineoverride

Definition at line 274 of file KoToolBoxLayout_p.h.

    {
        // Prefer showing two rows/columns by default
        QSize twoIcons = static_cast<Section*> (m_sections[0]->widget())->iconSize() * 2;
        const int length = doLayout(QRect(QPoint(), twoIcons), false);
        if (m_orientation == Qt::Vertical) {
            return QSize(twoIcons.width(), length);
        } else {
            return QSize(length, twoIcons.height());
        }
    }

References iconSize(), and length().

takeAt()

QLayoutItem * KoToolBoxLayout::takeAt ( int i )

inlineoverride

Definition at line 318 of file KoToolBoxLayout_p.h.

{ return m_sections.takeAt(i); }

widthForHeight()

int KoToolBoxLayout::widthForHeight ( int height ) const

inline

For calculating the width from height by KoToolBoxScrollArea. QWidget doesn't actually support trading width for height, so it needs to be handled specifically.

Definition at line 360 of file KoToolBoxLayout_p.h.

    {
        if (m_orientation == Qt::Horizontal) {
            const int width = doLayout(QRect(0, 0, 0, height), false);
            return width;
        } else {
            return -1;
        }
    }

Member Data Documentation

m_compact

bool KoToolBoxLayout::m_compact

private

Definition at line 512 of file KoToolBoxLayout_p.h.

m_orientation

Qt::Orientation KoToolBoxLayout::m_orientation

private

Definition at line 511 of file KoToolBoxLayout_p.h.

m_sections

QList<QWidgetItem*> KoToolBoxLayout::m_sections

private

Definition at line 510 of file KoToolBoxLayout_p.h.

---

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

• libs/ui/toolbox/KoToolBoxLayout_p.h