KCapacityBar Class

Member Function Documentation

[explicit, since 5.24] KCapacityBar::KCapacityBar(QWidget *parent = nullptr)

Constructs a capacity bar with DrawTextOutline as draw text mode.

parent The parent of the widget.

This function was introduced in 5.24.

[explicit] KCapacityBar::KCapacityBar(KCapacityBar::DrawTextMode drawTextMode, QWidget *parent = nullptr)

Capacity bar constructor.

drawTextMode If any text set, whether to draw it into the capacity bar or not.

parent The parent of the widget.

int KCapacityBar::barHeight() const

Returns the preferred height of the capacity bar.

See also setBarHeight().

bool KCapacityBar::continuous() const

Returns whether the fill of the capacity bar should be continuous or block-based.

See also setContinuous().

void KCapacityBar::drawCapacityBar(QPainter *p, const QRect &rect) const

This method allows you to draw the widget, directly, for example on item delegates. You only need the painter object and the rect where this widget should be drawn.

[since 6.12] void KCapacityBar::drawCapacityBar(QPainter *p, const QRect &rect, QStyle::State state) const

This method allows you to draw the widget, directly, for example on item delegates. You need the painter object and the rect where this widget should be drawn, and the state that it should be painted in.

For example, when in a selected delegate, setting the correct state ensures that the bar keeps sufficient contrast to the selection color.

This function was introduced in 6.12.

KCapacityBar::DrawTextMode KCapacityBar::drawTextMode() const

The way text is drawn, inside the capacity bar or outside of it

See also setDrawTextMode().

bool KCapacityBar::fillFullBlocks() const

Returns whether the last block shown can be cut off when necessary.

See also setFillFullBlocks().

Qt::Alignment KCapacityBar::horizontalTextAlignment() const

Returns the horizontal alignment for the text that will be drawn.

See also setHorizontalTextAlignment().

void KCapacityBar::setBarHeight(int barHeight)

Sets the height (in pixels) of the bar.

barHeight The preferred height (in pixels) of the capacity bar.

See also barHeight().

void KCapacityBar::setContinuous(bool continuous)

Sets whether the fill of the capacity bar should be continuous or in block mode.

continuous If true, the fill of the capacity bar is done in a continuous way. In other case, the fill is done with separated blocks.

See also continuous().

void KCapacityBar::setDrawTextMode(KCapacityBar::DrawTextMode mode)

Set the way text is drawn if any is set

mode If any text set, whether to draw it into the capacity bar or not.

See also drawTextMode().

void KCapacityBar::setFillFullBlocks(bool fillFullBlocks)

When the capacity bar is non-continuous, sets whether the last block shown should be drawn full or can be cut off (depending on the capacity bar width, and the value set on it).

fillFullBlocks If true, the last block drawn will be fully filled, on other case, the last block drawn could be cut off.

Its value is true by default.

See also fillFullBlocks(), setContinuous, and continuous.

void KCapacityBar::setHorizontalTextAlignment(Qt::Alignment textAlignment)

If the capacity bar is in outline text mode, draw the text with textAlignment alignment.

textAlignment Sets the horizontal alignment for the text if the capacity bar is in outline text mode.

See also horizontalTextAlignment().

void KCapacityBar::setText(const QString &text)

Sets the text for the capacity bar.

text The text that the capacity bar will show.

This is an empty string by default.

See also text().

void KCapacityBar::setValue(int value)

Capacity bar fill value.

value This parameter can take values from 0 to 100.

Its value is 0 by default.

See also value().

QString KCapacityBar::text() const

Returns the text that the capacity bar will show.

See also setText().

int KCapacityBar::value() const

Returns the fill value of the capacity bar.

See also setValue().