KStatefulBrush Class Reference

#include <kcolorscheme.h>

Public Member Functions
QBrush	brush (const QPalette &) const
QBrush	brush (const QWidget *) const
QBrush	brush (QPalette::ColorGroup) const
	KStatefulBrush ()
	KStatefulBrush (const KStatefulBrush &)
	KStatefulBrush (const QBrush &, const QBrush &background, KSharedConfigPtr=KSharedConfigPtr())
	KStatefulBrush (const QBrush &, KSharedConfigPtr=KSharedConfigPtr())
	KStatefulBrush (KColorScheme::ColorSet, KColorScheme::BackgroundRole, KSharedConfigPtr=KSharedConfigPtr())
	KStatefulBrush (KColorScheme::ColorSet, KColorScheme::DecorationRole, KSharedConfigPtr=KSharedConfigPtr())
	KStatefulBrush (KColorScheme::ColorSet, KColorScheme::ForegroundRole, KSharedConfigPtr=KSharedConfigPtr())
KStatefulBrush &	operator= (const KStatefulBrush &)
	~KStatefulBrush ()

Private Attributes
class KStatefulBrushPrivate *	d

Detailed Description

A container for a "state-aware" brush.

KStatefulBrush provides an easy and safe way to store a color for use in a user interface. It is "safe" both in that it will make it easy to deal with widget states in a correct manner, and that it insulates you against changes in QPalette::ColorGroup.

Basically, a stateful brush is used to cache a particular "color" from the KDE system palette (usually, one which does not live in QPalette). When you are ready to draw using the brush, you use the current state to retrieve the appropriate brush.

Stateful brushes can also be used to apply state effects to arbitrary brushes, for example when working with a application specific user-defined color palette.

Note

As of Qt 4.3, QPalette::ColorGroup is missing a state for disabled widgets in an inactive window. Hopefully Trolltech will fix this bug, at which point KColorScheme and KStatefulBrush will be updated to recognize the new state. Using KStatefulBrush will allow your application to inherit these changes "for free", without even recompiling.

Definition at line 453 of file kcolorscheme.h.

Constructor & Destructor Documentation

KStatefulBrush() [1/7]

KStatefulBrush::KStatefulBrush ( )

explicit

Construct a "default" stateful brush. For such an instance, all overloads of KStatefulBrush::brush will return a default brush (i.e. QBrush()).

Definition at line 600 of file kcolorscheme.cpp.

{
    d = new KStatefulBrushPrivate[3];
}

References d.

KStatefulBrush() [2/7]

KStatefulBrush::KStatefulBrush ( KColorScheme::ColorSet set, KColorScheme::ForegroundRole role, KSharedConfigPtr config = KSharedConfigPtr() )

explicit

Construct a stateful brush from given color set and foreground role, using the colors from the given KConfig (if null, the system colors are used).

Definition at line 605 of file kcolorscheme.cpp.

{
    d = new KStatefulBrushPrivate[3];
    d[0] = KColorScheme(QPalette::Active,   set, config).foreground(role);
    d[1] = KColorScheme(QPalette::Disabled, set, config).foreground(role);
    d[2] = KColorScheme(QPalette::Inactive, set, config).foreground(role);
}

References d, and KColorScheme::foreground().

KStatefulBrush() [3/7]

KStatefulBrush::KStatefulBrush ( KColorScheme::ColorSet set, KColorScheme::BackgroundRole role, KSharedConfigPtr config = KSharedConfigPtr() )

explicit

Construct a stateful brush from given color set and background role, using the colors from the given KConfig (if null, the system colors are used).

Definition at line 614 of file kcolorscheme.cpp.

{
    d = new KStatefulBrushPrivate[3];
    d[0] = KColorScheme(QPalette::Active,   set, config).background(role);
    d[1] = KColorScheme(QPalette::Disabled, set, config).background(role);
    d[2] = KColorScheme(QPalette::Inactive, set, config).background(role);
}

References KColorScheme::background(), and d.

KStatefulBrush() [4/7]

KStatefulBrush::KStatefulBrush ( KColorScheme::ColorSet set, KColorScheme::DecorationRole role, KSharedConfigPtr config = KSharedConfigPtr() )

explicit

Construct a stateful brush from given color set and decoration role, using the colors from the given KConfig (if null, the system colors are used).

Definition at line 623 of file kcolorscheme.cpp.

{
    d = new KStatefulBrushPrivate[3];
    d[0] = KColorScheme(QPalette::Active,   set, config).decoration(role);
    d[1] = KColorScheme(QPalette::Disabled, set, config).decoration(role);
    d[2] = KColorScheme(QPalette::Inactive, set, config).decoration(role);
}

References d, and KColorScheme::decoration().

KStatefulBrush() [5/7]

KStatefulBrush::KStatefulBrush ( const QBrush & brush, KSharedConfigPtr config = KSharedConfigPtr() )

explicit

Construct a stateful background brush from a specified QBrush (or QColor, via QBrush's implicit constructor). The various states are determined from the base QBrush (which fills in the Active state) according to the same rules used to build stateful color schemes from the system color scheme. The state effects from the given KConfig are used (if null, the system state effects are used).

Definition at line 632 of file kcolorscheme.cpp.

{
    if (!config) {
        config = KSharedConfig::openConfig();
    }
    d = new KStatefulBrushPrivate[3];
    d[0] = brush;
    d[1] = StateEffects(QPalette::Disabled, config).brush(brush);
    d[2] = StateEffects(QPalette::Inactive, config).brush(brush);
}

References StateEffects::brush(), brush(), and d.

KStatefulBrush() [6/7]

KStatefulBrush::KStatefulBrush ( const QBrush & brush, const QBrush & background, KSharedConfigPtr config = KSharedConfigPtr() )

explicit

Construct a stateful foreground/decoration brush from a specified QBrush (or QColor, via QBrush's implicit constructor). The various states are determined from the base QBrush (which fills in the Active state) according to the same rules used to build stateful color schemes from the system color scheme. The state effects from the given KConfig are used (if null, the system state effects are used).

Parameters

brush	The foreground brush
background	The background brush (or color) corresponding to the KColorScheme::NormalBackground role and QPalette::Active state for this foreground/decoration color.
config	The configuration.

Definition at line 643 of file kcolorscheme.cpp.

{
    if (!config) {
        config = KSharedConfig::openConfig();
    }
    d = new KStatefulBrushPrivate[3];
    d[0] = brush;
    d[1] = StateEffects(QPalette::Disabled, config).brush(brush, background);
    d[2] = StateEffects(QPalette::Inactive, config).brush(brush, background);
}

References StateEffects::brush(), brush(), and d.

KStatefulBrush() [7/7]

KStatefulBrush::KStatefulBrush

(

const KStatefulBrush &

other

)

Construct a copy of another KStatefulBrush.

Definition at line 655 of file kcolorscheme.cpp.

{
    d = new KStatefulBrushPrivate[3];
    d[0] = other.d[0];
    d[1] = other.d[1];
    d[2] = other.d[2];
}

References d.

~KStatefulBrush()

KStatefulBrush::~KStatefulBrush

(

)

Destructor

Definition at line 663 of file kcolorscheme.cpp.

{
    delete[] d;
}

References d.

Member Function Documentation

brush() [1/3]

QBrush KStatefulBrush::brush

(

const QPalette &

pal

)

const

Retrieve the brush, using a QPalette reference to determine the correct state. Use when your painting code has easy access to the QPalette that it is supposed to be using. The state used in this instance is the currentColorGroup of the palette.

Definition at line 688 of file kcolorscheme.cpp.

{
    return brush(pal.currentColorGroup());
}

References brush().

brush() [2/3]

QBrush KStatefulBrush::brush

(

const QWidget *

widget

)

const

Retrieve the brush, using a QWidget pointer to determine the correct state. Use when you have a pointer to the widget that you are painting. The state used is the current state of the widget.

Note

If you pass an invalid widget, you will get a default brush (i.e. QBrush()).

Definition at line 693 of file kcolorscheme.cpp.

{
    if (widget) {
        return brush(widget->palette());
    } else {
        return QBrush();
    }
}

References brush().

brush() [3/3]

QBrush KStatefulBrush::brush

(

QPalette::ColorGroup

state

)

const

Retrieve the brush for the specified widget state. This is used when you know explicitly what state is wanted. Otherwise one of overloads is often more convenient.

Definition at line 676 of file kcolorscheme.cpp.

{
    switch (state) {
    case QPalette::Inactive:
        return d[2];
    case QPalette::Disabled:
        return d[1];
    default:
        return d[0];
    }
}

References d.

operator=()

KStatefulBrush & KStatefulBrush::operator=

(

const KStatefulBrush &

other

)

Standard assignment operator

Definition at line 668 of file kcolorscheme.cpp.

{
    d[0] = other.d[0];
    d[1] = other.d[1];
    d[2] = other.d[2];
    return *this;
}

References d.

Member Data Documentation

d

class KStatefulBrushPrivate* KStatefulBrush::d

private

Definition at line 552 of file kcolorscheme.h.

---

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

• libs/widgetutils/config/kcolorscheme.h
• libs/widgetutils/config/kcolorscheme.cpp