• Skip to content
  • Skip to link menu
KDE 3.5 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

KDECore

KIconEffect Class Reference

Applies effects to icons. More...

#include <kiconeffect.h>

List of all members.


Public Types

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

Public Member Functions

QPixmap apply (QPixmap src, int effect, float value, const QColor rgb, const QColor rgb2, bool trans) const
QPixmap apply (QPixmap src, int effect, float value, const QColor rgb, bool trans) const
QPixmap apply (QPixmap src, int group, int state) const
QImage apply (QImage src, int effect, float value, const QColor rgb, const QColor rgb2, bool trans) const
QImage apply (QImage src, int effect, float value, const QColor rgb, bool trans) const
QImage apply (QImage src, int group, int state) const
QImage doublePixels (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)
static void visualActivate (QWidget *widget, QRect rect)

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 34 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
Enumerator:
NoEffect 
ToGray 
Colorize 
ToGamma 
DeSaturate 
ToMonochrome 
Since:
3.4
LastEffect 

Definition at line 55 of file kiconeffect.h.


Constructor & Destructor Documentation

KIconEffect::KIconEffect (  ) 

Create a new KIconEffect.

Definition at line 49 of file kiconeffect.cpp.

KIconEffect::~KIconEffect (  ) 

Definition at line 55 of file kiconeffect.cpp.


Member Function Documentation

QPixmap KIconEffect::apply ( QPixmap  src,
int  effect,
float  value,
const QColor  rgb,
const QColor  rgb2,
bool  trans 
) const

Since:
3.4

Definition at line 251 of file kiconeffect.cpp.

QPixmap KIconEffect::apply ( 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 245 of file kiconeffect.cpp.

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

Applies an effect to a pixmap.

Parameters:
src The pixmap.
group The group for the icon, see KIcon::Group
state The icon's state, see KIcon::States
Returns:
A pixmap with the effect applied.

Definition at line 229 of file kiconeffect.cpp.

QImage KIconEffect::apply ( QImage  src,
int  effect,
float  value,
const QColor  rgb,
const QColor  rgb2,
bool  trans 
) const

Since:
3.4

Definition at line 193 of file kiconeffect.cpp.

QImage KIconEffect::apply ( 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 188 of file kiconeffect.cpp.

QImage KIconEffect::apply ( 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 KIcon::Group
state The icon's state, see KIcon::States
Returns:
An image with the effect applied.

Definition at line 172 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 tinted
value Strength of the effect. 0 <= value <= 1

Definition at line 304 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 395 of file kiconeffect.cpp.

QImage KIconEffect::doublePixels ( QImage  src  )  const

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

Parameters:
src the image.
Returns:
the scaled image.

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

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

Definition at line 137 of file kiconeffect.cpp.

void KIconEffect::init (  ) 

Rereads configuration.

Definition at line 61 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 589 of file kiconeffect.cpp.

void KIconEffect::semiTransparent ( QPixmap &  pixmap  )  [static]

Renders a pixmap semi-transparent.

Parameters:
pixmap The pixmap

Definition at line 509 of file kiconeffect.cpp.

void KIconEffect::semiTransparent ( QImage &  image  )  [static]

Renders an image semi-transparent.

Parameters:
image The image

Definition at line 435 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 413 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 282 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 painted
black The color with which the black parts of image are painted
value Strength of the effect. 0 <= value <= 1
Since:
3.4

Definition at line 345 of file kiconeffect.cpp.

void KIconEffect::visualActivate ( QWidget *  widget,
QRect  rect 
) [static]

Provides visual feedback to show activation of an icon on a widget.

Not strictly an 'icon effect', but in practice that's what it looks like.

This method does nothing if the global 'Visual feedback on activation' option is not activated (See kcontrol/Peripherals/Mouse).

Parameters:
widget The widget on which the effect should be painted
rect This rectangle defines the effect's borders

Definition at line 704 of file kiconeffect.cpp.


The documentation for this class was generated from the following files:
  • kiconeffect.h
  • kiconeffect.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal