KIconEffect

Search for usage in LXR

#include <KIconEffect>

Public Types

enum  Effects {
  NoEffect, ToGray, Colorize, ToGamma,
  DeSaturate, ToMonochrome, LastEffect
}
 

Public Member Functions

 KIconEffect ()
 
 KIconEffect (const KIconEffect &)=delete
 
QImage apply (const QImage &src, int group, int state) const
 
QImage apply (const QImage &src, int effect, float value, const QColor &rgb, bool trans) const
 
QImage apply (const QImage &src, int effect, float value, const QColor &rgb, const QColor &rgb2, bool trans) const
 
QPixmap apply (const QPixmap &src, int group, int state) const
 
QPixmap apply (const QPixmap &src, int effect, float value, const QColor &rgb, bool trans) const
 
QPixmap apply (const QPixmap &src, int effect, float value, const QColor &rgb, const QColor &rgb2, bool trans) const
 
QImage doublePixels (const QImage &src) const
 
QString fingerprint (int group, int state) const
 
bool hasEffect (int group, int state) const
 
void init ()
 
KIconEffectoperator= (const KIconEffect &)=delete
 

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 (QImage &image)
 
static void semiTransparent (QPixmap &pixmap)
 
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.

kiconeffect-apply.png
Various Effects applied to an image
See also
QIcon::fromTheme

Definition at line 39 of file kiconeffect.h.

Member Enumeration Documentation

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: Do not apply any icon effect
  • ToGray: Tints the icon gray
  • Colorize: Tints the icon with a specific color
  • ToGamma: Change the gamma value of the icon
  • DeSaturate: Reduce the saturation of the icon
  • ToMonochrome: Produces a monochrome icon

Definition at line 67 of file kiconeffect.h.

Constructor & Destructor Documentation

KIconEffect::KIconEffect ( )

Create a new KIconEffect.

You will most likely never have to use this to create a new KIconEffect yourself, as you can use the KIconEffect provided by the global KIconLoader (which itself is accessible by KIconLoader::global()) through its iconEffect() function.

Definition at line 49 of file kiconeffect.cpp.

Member Function Documentation

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
srcThe image.
groupThe group for the icon, see KIconLoader::Group
stateThe icon's state, see KIconLoader::States
Returns
An image with the effect applied.

Definition at line 173 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
srcThe image.
effectThe effect to apply, one of KIconEffect::Effects.
valueStrength of the effect. 0 <= value <= 1.
rgbColor parameter for effects that need one.
transAdd Transparency if trans = true.
Returns
An image with the effect applied.

Definition at line 186 of file kiconeffect.cpp.

QPixmap KIconEffect::apply ( const QPixmap src,
int  group,
int  state 
) const

Applies an effect to a pixmap.

Parameters
srcThe pixmap.
groupThe group for the icon, see KIconLoader::Group
stateThe icon's state, see KIconLoader::States
Returns
A pixmap with the effect applied.

Definition at line 226 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
srcThe pixmap.
effectThe effect to apply, one of KIconEffect::Effects.
valueStrength of the effect. 0 <= value <= 1.
rgbColor parameter for effects that need one.
transAdd Transparency if trans = true.
Returns
A pixmap with the effect applied.

Definition at line 239 of file kiconeffect.cpp.

void KIconEffect::colorize ( QImage image,
const QColor col,
float  value 
)
static

Colorizes an image with a specific color.

Parameters
imageThe image
colThe color with which the image is tinted
valueStrength of the effect. 0 <= value <= 1

Definition at line 336 of file kiconeffect.cpp.

void KIconEffect::deSaturate ( QImage image,
float  value 
)
static

Desaturates an image.

Parameters
imageThe image
valueStrength of the effect. 0 <= value <= 1

Definition at line 433 of file kiconeffect.cpp.

QImage KIconEffect::doublePixels ( const QImage src) const

Returns an image twice as large, consisting of 2x2 pixels.

Parameters
srcthe image.
Returns
the scaled image.

Definition at line 561 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
groupthe group, see KIconLoader::Group
statethe state, see KIconLoader::States
Returns
the fingerprint of the given group+state

Definition at line 143 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
groupthe group to check, see KIconLoader::Group
statethe state to check, see KIconLoader::States
Returns
true if an effect is configured for the given group in state, otherwise false.
See also
KIconLoader::Group KIconLoader::States

Definition at line 133 of file kiconeffect.cpp.

void KIconEffect::init ( )

Rereads configuration.

Definition at line 57 of file kiconeffect.cpp.

void KIconEffect::overlay ( QImage src,
QImage overlay 
)
static

Overlays an image with an other image.

Parameters
srcThe image
overlayThe image to overlay src with

Definition at line 604 of file kiconeffect.cpp.

void KIconEffect::semiTransparent ( QImage image)
static

Renders an image semi-transparent.

Parameters
imageThe image

Definition at line 470 of file kiconeffect.cpp.

void KIconEffect::semiTransparent ( QPixmap pixmap)
static

Renders a pixmap semi-transparent.

Parameters
pixmapThe pixmap

Definition at line 554 of file kiconeffect.cpp.

void KIconEffect::toGamma ( QImage image,
float  value 
)
static

Changes the gamma value of an image.

Parameters
imageThe image
valueStrength of the effect. 0 <= value <= 1

Definition at line 454 of file kiconeffect.cpp.

void KIconEffect::toGray ( QImage image,
float  value 
)
static

Tints an image gray.

Parameters
imageThe image
valueStrength of the effect. 0 <= value <= 1

Definition at line 306 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
imageThe image
whiteThe color with which the white parts of image are painted
blackThe color with which the black parts of image are painted
valueStrength of the effect. 0 <= value <= 1

Definition at line 373 of file kiconeffect.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed May 12 2021 22:41:21 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.