NDEVR
API Documentation
NDEVRIconEngineabstract

Used to render any icons or fetch any pixmaps within the software. More...

Inheritance diagram for NDEVRIconEngine:
[legend]
Collaboration diagram for NDEVRIconEngine:
[legend]

Public Member Functions

 NDEVRIconEngine (const UUID &id)
 Constructs an icon engine with the given unique identifier.
virtual bool canProcess (const StringView &icon, const IconThemeSettings &theme, QIcon::Mode mode) const =0
 Checks whether this engine can render the specified icon.
virtual QIcon createIcon (const StringView &icon, const IconThemeSettings &theme, QIcon::Mode mode=QIcon::Mode::Normal)=0
 Creates a QIcon for the specified icon resource and theme.
UUID id () const
 Returns the unique identifier for this icon engine.

Detailed Description

Used to render any icons or fetch any pixmaps within the software.


More rendering engines can be added to create QIcon or QPixmap objects for given resources.

Definition at line 108 of file QTIconManager.h.

Constructor & Destructor Documentation

◆ NDEVRIconEngine()

NDEVRIconEngine::NDEVRIconEngine ( const UUID & id)
inline

Constructs an icon engine with the given unique identifier.

Parameters
[in]idUnique identifier for this engine.

Definition at line 115 of file QTIconManager.h.

References id().

Member Function Documentation

◆ canProcess()

virtual bool NDEVRIconEngine::canProcess ( const StringView & icon,
const IconThemeSettings & theme,
QIcon::Mode mode ) const
nodiscardpure virtual

Checks whether this engine can render the specified icon.

Parameters
[in]iconThe icon resource identifier.
[in]themeThe icon theme settings.
[in]modeThe icon mode.
Returns
True if this engine can process the icon.

Implemented in SVGIconEngine.

◆ createIcon()

virtual QIcon NDEVRIconEngine::createIcon ( const StringView & icon,
const IconThemeSettings & theme,
QIcon::Mode mode = QIcon::Mode::Normal )
nodiscardpure virtual

Creates a QIcon for the specified icon resource and theme.

Parameters
[in]iconThe icon resource identifier.
[in]themeThe icon theme settings to apply.
[in]modeThe icon mode (Normal, Disabled, Active, Selected).
Returns
The rendered QIcon.

Implemented in SVGIconEngine.

◆ id()

UUID NDEVRIconEngine::id ( ) const
inlinenodiscard

Returns the unique identifier for this icon engine.

Returns
The engine UUID.

Definition at line 138 of file QTIconManager.h.

Referenced by NDEVRIconEngine().


The documentation for this class was generated from the following file: