KDEUI
KIconEffect Class Reference
Applies effects to icons. More...
#include <kiconeffect.h>
Public Types | |
enum | Effects { NoEffect, ToGray, Colorize, ToGamma, DeSaturate, ToMonochrome, LastEffect } |
Public Member Functions | |
QPixmap | apply (const QPixmap &src, int effect, float value, const QColor &rgb, const QColor &rgb2, bool trans) const |
QPixmap | apply (const QPixmap &src, int effect, float value, const QColor &rgb, bool trans) const |
QPixmap | apply (const QPixmap &src, int group, int state) const |
QImage | apply (const QImage &src, int effect, float value, const QColor &rgb, const QColor &rgb2, bool trans) const |
QImage | apply (const QImage &src, int effect, float value, const QColor &rgb, bool trans) const |
QImage | apply (const QImage &src, int group, int state) const |
QImage | doublePixels (const QImage &src) const |
QString | fingerprint (int group, int state) const |
bool | hasEffect (int group, int state) const |
void | init () |
KIconEffect () | |
~KIconEffect () | |
Static Public Member Functions | |
static void | colorize (QImage &image, const QColor &col, float value) |
static void | deSaturate (QImage &image, float value) |
static void | overlay (QImage &src, QImage &overlay) |
static void | semiTransparent (QPixmap &pixmap) |
static void | semiTransparent (QImage &image) |
static void | toGamma (QImage &image, float value) |
static void | toGray (QImage &image, float value) |
static void | toMonochrome (QImage &image, const QColor &black, const QColor &white, float value) |
Detailed Description
Applies effects to icons.
This class applies effects to icons depending on their state and group. For example, it can be used to make all disabled icons in a toolbar gray.
- See also:
- KIcon
Definition at line 44 of file kiconeffect.h.
Member Enumeration Documentation
enum KIconEffect::Effects |
This is the enumeration of all possible icon effects.
Note that 'LastEffect' is no valid icon effect but only used internally to check for invalid icon effects.
- NoEffect: Don't apply any icon effect
- ToGray: Tints the icon gray
- Colorize: Tints the icon with an other color
- ToGamma: Change the gamma value of the icon
- DeSaturate: Reduce the saturation of the icon
- ToMonochrome: Produces a monochrome icon
Definition at line 65 of file kiconeffect.h.
Constructor & Destructor Documentation
KIconEffect::KIconEffect | ( | ) |
Create a new KIconEffect.
Definition at line 64 of file kiconeffect.cpp.
KIconEffect::~KIconEffect | ( | ) |
Definition at line 70 of file kiconeffect.cpp.
Member Function Documentation
QPixmap KIconEffect::apply | ( | const QPixmap & | src, | |
int | effect, | |||
float | value, | |||
const QColor & | rgb, | |||
const QColor & | rgb2, | |||
bool | trans | |||
) | const |
Definition at line 269 of file kiconeffect.cpp.
QPixmap KIconEffect::apply | ( | const QPixmap & | src, | |
int | effect, | |||
float | value, | |||
const QColor & | rgb, | |||
bool | trans | |||
) | const |
Applies an effect to a pixmap.
- Parameters:
-
src The pixmap. effect The effect to apply, one of KIconEffect::Effects. value Strength of the effect. 0 <= value
<= 1.rgb Color parameter for effects that need one. trans Add Transparency if trans = true.
- Returns:
- A pixmap with the effect applied.
Definition at line 262 of file kiconeffect.cpp.
QPixmap KIconEffect::apply | ( | const QPixmap & | src, | |
int | group, | |||
int | state | |||
) | const |
Applies an effect to a pixmap.
- Parameters:
-
src The pixmap. group The group for the icon, see KIconLoader::Group state The icon's state, see KIconLoader::States
- Returns:
- A pixmap with the effect applied.
Definition at line 246 of file kiconeffect.cpp.
QImage KIconEffect::apply | ( | const QImage & | src, | |
int | effect, | |||
float | value, | |||
const QColor & | rgb, | |||
const QColor & | rgb2, | |||
bool | trans | |||
) | const |
Definition at line 208 of file kiconeffect.cpp.
QImage KIconEffect::apply | ( | const QImage & | src, | |
int | effect, | |||
float | value, | |||
const QColor & | rgb, | |||
bool | trans | |||
) | const |
Applies an effect to an image.
- Parameters:
-
src The image. effect The effect to apply, one of KIconEffect::Effects. value Strength of the effect. 0 <= value
<= 1.rgb Color parameter for effects that need one. trans Add Transparency if trans = true.
- Returns:
- An image with the effect applied.
Definition at line 201 of file kiconeffect.cpp.
QImage KIconEffect::apply | ( | const QImage & | src, | |
int | group, | |||
int | state | |||
) | const |
Applies an effect to an image.
The effect to apply depends on the group
and state
parameters, and is configured by the user.
- Parameters:
-
src The image. group The group for the icon, see KIconLoader::Group state The icon's state, see KIconLoader::States
- Returns:
- An image with the effect applied.
Definition at line 185 of file kiconeffect.cpp.
void KIconEffect::colorize | ( | QImage & | image, | |
const QColor & | col, | |||
float | value | |||
) | [static] |
Colorizes an image with a specific color.
- Parameters:
-
image The image col The color with which the image
is tintedvalue Strength of the effect. 0 <= value
<= 1
Definition at line 378 of file kiconeffect.cpp.
void KIconEffect::deSaturate | ( | QImage & | image, | |
float | value | |||
) | [static] |
Desaturates an image.
- Parameters:
-
image The image value Strength of the effect. 0 <= value
<= 1
Definition at line 476 of file kiconeffect.cpp.
QImage KIconEffect::doublePixels | ( | const QImage & | src | ) | const |
Returns an image twice as large, consisting of 2x2 pixels.
- Parameters:
-
src the image.
- Returns:
- the scaled image.
Definition at line 641 of file kiconeffect.cpp.
QString KIconEffect::fingerprint | ( | int | group, | |
int | state | |||
) | const |
Returns a fingerprint for the effect by encoding the given group
and state
into a QString.
This is useful for caching.
- Parameters:
-
group the group, see KIconLoader::Group state the state, see KIconLoader::States
- Returns:
- the fingerprint of the given
group+
state
Definition at line 155 of file kiconeffect.cpp.
bool KIconEffect::hasEffect | ( | int | group, | |
int | state | |||
) | const |
Tests whether an effect has been configured for the given icon group.
- Parameters:
-
group the group to check, see KIconLoader::Group state the state to check, see KIconLoader::States
- Returns:
- true if an effect is configured for the given
group
instate
, otherwise false.
- See also:
- KIconLoader::Group KIconLoader::States
Definition at line 150 of file kiconeffect.cpp.
void KIconEffect::init | ( | ) |
Rereads configuration.
Definition at line 75 of file kiconeffect.cpp.
void KIconEffect::overlay | ( | QImage & | src, | |
QImage & | overlay | |||
) | [static] |
Overlays an image with an other image.
- Parameters:
-
src The image overlay The image to overlay src
with
Definition at line 690 of file kiconeffect.cpp.
void KIconEffect::semiTransparent | ( | QPixmap & | pixmap | ) | [static] |
Renders a pixmap semi-transparent.
- Parameters:
-
pixmap The pixmap
Definition at line 611 of file kiconeffect.cpp.
void KIconEffect::semiTransparent | ( | QImage & | image | ) | [static] |
Renders an image semi-transparent.
- Parameters:
-
image The image
Definition at line 516 of file kiconeffect.cpp.
void KIconEffect::toGamma | ( | QImage & | image, | |
float | value | |||
) | [static] |
Changes the gamma value of an image.
- Parameters:
-
image The image value Strength of the effect. 0 <= value
<= 1
Definition at line 497 of file kiconeffect.cpp.
void KIconEffect::toGray | ( | QImage & | image, | |
float | value | |||
) | [static] |
Tints an image gray.
- Parameters:
-
image The image value Strength of the effect. 0 <= value
<= 1
Definition at line 348 of file kiconeffect.cpp.
void KIconEffect::toMonochrome | ( | QImage & | image, | |
const QColor & | black, | |||
const QColor & | white, | |||
float | value | |||
) | [static] |
Produces a monochrome icon with a given foreground and background color.
- Parameters:
-
image The image white The color with which the white parts of image
are paintedblack The color with which the black parts of image
are paintedvalue Strength of the effect. 0 <= value
<= 1
Definition at line 416 of file kiconeffect.cpp.
The documentation for this class was generated from the following files: