KDE 4.9 PyKDE API Reference

- KDE's Python API

# KStatefulBrush Class Reference

`from PyKDE4.kdeui import *`

## 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) in the way you would have used a QColor in KDE3. 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.

## Methods

| __init__ (self)
| __init__ (self, KColorScheme.ColorSet a0, KColorScheme.ForegroundRole a1, KSharedPtr<KSharedConfig> a2=KSharedConfigPtr())
| __init__ (self, KColorScheme.ColorSet a0, KColorScheme.BackgroundRole a1, KSharedPtr<KSharedConfig> a2=KSharedConfigPtr())
| __init__ (self, KColorScheme.ColorSet a0, KColorScheme.DecorationRole a1, KSharedPtr<KSharedConfig> a2=KSharedConfigPtr())
| __init__ (self, QBrush a0, KSharedPtr<KSharedConfig> a1=KSharedConfigPtr())
| __init__ (self, QBrush a0, QBrush background, KSharedPtr<KSharedConfig> a2=KSharedConfigPtr())
| __init__ (self, KStatefulBrush a0)
QBrush | brush (self, QPalette::ColorGroup a0)
QBrush | brush (self, QPalette a0)
QBrush | brush (self, QWidget a0)

## Method Documentation

__init__ | ( |  | self ) |

Construct a copy of another KStatefulBrush.

__init__ | ( | self, |
|  | KColorScheme.ColorSet | a0,
|  | KColorScheme.ForegroundRole | a1,
|  | KSharedPtr<KSharedConfig> | a2=KSharedConfigPtr()
| ) |  |  |

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).

__init__ | ( | self, |
|  | KColorScheme.ColorSet | a0,
|  | KColorScheme.BackgroundRole | a1,
|  | KSharedPtr<KSharedConfig> | a2=KSharedConfigPtr()
| ) |  |  |

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).

__init__ | ( | self, |
|  | KColorScheme.ColorSet | a0,
|  | KColorScheme.DecorationRole | a1,
|  | KSharedPtr<KSharedConfig> | a2=KSharedConfigPtr()
| ) |  |  |

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).

__init__ | ( | self, |
|  | QBrush | a0,
|  | KSharedPtr<KSharedConfig> | a1=KSharedConfigPtr()
| ) |  |  |

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).

__init__ | ( | self, |
|  | QBrush | a0,
|  | QBrush | background,
|  | KSharedPtr<KSharedConfig> | a2=KSharedConfigPtr()
| ) |  |  |

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:

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

__init__ | ( | self, |
|  | KStatefulBrush | a0
| ) |  |  |

Construct a copy of another KStatefulBrush.

QBrush brush | ( | self, |
|  | QPalette::ColorGroup | a0
| ) |  |  |

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. <tt>QBrush()</tt>).

QBrush brush | ( | self, |
|  | QPalette | a0
| ) |  |  |

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. <tt>QBrush()</tt>).

QBrush brush | ( | self, |
|  | QWidget | a0
| ) |  |  |

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. <tt>QBrush()</tt>).