Contents

KIconEffect Class

Applies effects to icons. More...

Header: #include <KIconEffect>
CMake: find_package(KF6 REQUIRED COMPONENTS IconThemes)
target_link_libraries(mytarget PRIVATE KF6::IconThemes)

Static Public Members

void colorize(QImage &image, const QColor &col, float value)
void deSaturate(QImage &image, float value)
void overlay(QImage &src, QImage &overlay)
void semiTransparent(QImage &image)
void semiTransparent(QPixmap &pixmap)
(since 6.5) void toActive(QImage &image)
(since 6.5) void toActive(QPixmap &pixmap)
(since 6.5) void toDisabled(QImage &image)
(since 6.5) void toDisabled(QPixmap &pixmap)
void toGamma(QImage &image, float value)
void toGray(QImage &image, float value)
void toMonochrome(QImage &image, const QColor &black, const QColor &white, float value)

Detailed Description

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.

Various Effects applied to an image

See also QIcon::fromTheme.

Member Function Documentation

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

Colorizes an image with a specific color.

image The image

col The color with which the image is tinted

value Strength of the effect. 0 <= value <= 1

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

Desaturates an image.

image The image

value Strength of the effect. 0 <= value <= 1

[static] void KIconEffect::overlay(QImage &src, QImage &overlay)

Overlays an image with an other image.

src The image

overlay The image to overlay src with

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

Renders an image semi-transparent.

image The image

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

Renders a pixmap semi-transparent.

pixmap The pixmap

[static, since 6.5] void KIconEffect::toActive(QImage &image)

Applies an effect for an icon that is in an 'active' state

image The image

This function was introduced in 6.5.

[static, since 6.5] void KIconEffect::toActive(QPixmap &pixmap)

Applies an effect for an icon that is in an 'active' state

pixmap The image

This function was introduced in 6.5.

[static, since 6.5] void KIconEffect::toDisabled(QImage &image)

Applies a disabled effect

image The image

This function was introduced in 6.5.

[static, since 6.5] void KIconEffect::toDisabled(QPixmap &pixmap)

Applies a disabled effect

pixmap The image

This function was introduced in 6.5.

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

Changes the gamma value of an image.

image The image

value Strength of the effect. 0 <= value <= 1

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

Tints an image gray.

image The image

value Strength of the effect. 0 <= value <= 1

[static] void KIconEffect::toMonochrome(QImage &image, const QColor &black, const QColor &white, float value)

Produces a monochrome icon with a given foreground and background color

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