Member Function Documentation

[explicit] ImageSet::ImageSet(QObject *parent = nullptr)

Default constructor. parent the parent object

[explicit] ImageSet::ImageSet(const QString &imageSetName, const QString &basePath = {}, QObject *parent = nullptr)

This method constructs a theme which will be a custom theme instance of imageSetName.

imageSetName the name of the theme to create basePath base path for the theme to look for svgs. if empty, the default will be used. parent the parent object

QString ImageSet::basePath() const

This method returns the base path of the theme where the SVGs will be looked for.

See also setBasePath().

[signal] void ImageSet::basePathChanged(const QString &basePath)

This signal is emitted when the user changes the base path of the image set.

bool ImageSet::currentImageSetHasImage(const QString &name) const

This method checks whether this theme contains an image with the given name.

name the name of the file in the theme directory (without the ".svg" part or a leading slash)

Returns true if the image exists for this theme

QString ImageSet::filePath(const QString &name) const

This method returns the path for a generic file in the current theme.

The theme can also ship any generic file, such as configuration files.

name the name of the file in the theme directory (without a leading slash)

Returns the full path to the requested file for the current theme

QString ImageSet::imagePath(const QString &name) const

This method returns the path for an SVG image in the current theme.

name the name of the file in the theme directory (without the ".svg" part or a leading slash).

Returns the full path to the requested file for the current theme

[signal] void ImageSet::imageSetChanged(const QString &basePath)

This signal is emitted when the user makes changes to the theme.

Rendered images, colors, etc. should be updated at this point. However, SVGs should *not* be repainted in response to this signal; connect to Svg::repaintNeeded() instead for that, as SVG objects need repainting not only when imageSetChanged() is emitted; moreover SVG objects connect to and respond appropriately to imageSetChanged() internally, emitting Svg::repaintNeeded() at an appropriate time.

QString ImageSet::imageSetName() const

This method returns the name of the current theme.

See also setImageSetName().

KPluginMetaData ImageSet::metadata() const

This method returns the plugin metadata for this theme.

Metadata contains information such as name, description, author, website, and url.

QStringList ImageSet::selectors() const

This method returns the current selectors in order of preference.

See also setSelectors().

void ImageSet::setBasePath(const QString &basePath)

This method sets a base path for the theme to look for SVGs.

It can be a path relative to QStandardPaths::GenericDataLocation or an absolute path.

basePath the base path

See also basePath().

void ImageSet::setCacheLimit(int kbytes)

This method sets the maximum size of the cache (in kilobytes).

If cache gets bigger than the limit, then some entries are removed. Setting cache limit to 0 disables automatic cache size limiting.

Note that the cleanup might not be done immediately, so the cache might temporarily (for a few seconds) grow bigger than the limit.

void ImageSet::setImageSetName(const QString &imageSetName)

This method sets the current theme.

See also imageSetName().

void ImageSet::setSelectors(const QStringList &selectors)

This method sets the file selectors.

The theme can have different svgs with the same name for different situations and platforms. The Plasma desktop for instance uses "opaque" or "translucent" based on presence of compositing and KWin blur effects. Other uses may be platform, like android-specific graphics.

selectors selectors in order of preference

See also selectors().

void ImageSet::setUseGlobalSettings(bool useGlobal)

This method sets whether the theme should follow the global settings or use application-specific settings.

useGlobal pass in true to follow the global settings

See also useGlobalSettings().

bool ImageSet::useGlobalSettings() const

This method returns whether the global settings are followed.

If application-specific settings are being used, it returns false.

See also setUseGlobalSettings().