DCStyleIcons Class

Detailed Description

This class is used to load and manage icons generated by the DCMake.exe utility. These resources are typically created by exporting design assets from Figma or Adobe XD and converting them into an optimized XML/FastInfoset format (usually with a .design extension) for use within Qt-based applications.

DCStyleIcons allows for theme-aware icon retrieval, provides access to the full list of available icon identifiers, and manages how icons are scaled via aspect ratio settings.

Component Structure

To ensure proper integration, each icon in the Figma or Adobe XD file must be defined as a Component. These components can include various States and Variants to support standard Qt icon functionality:

• QIcon::State: Component variants can map to On and Off states.
• QIcon::Mode: Different visual representations can be provided for Normal, Disabled, Active, and Selected modes.

When used in a Qt application, these components are rendered via a custom QIconEngine. This engine ensures that the icon scales dynamically, honoring the layout and constraint settings defined within the original Figma or Adobe XD design.

Resource Generation

To generate the .design file required by this class from a Figma source, use the following command:

DCMake.exe -i "ui_assets.fig" -o "ui_assets.design" -c -f online

Usage Example

The following example demonstrates how to load a resource file and retrieve a specific icon for a button:

DCStyleIcons styleIcons(":/resources/ui_assets.design");

// Retrieve a standard icon
QIcon homeIcon = styleIcons.icon("home_action");
myButton->setIcon(homeIcon);

// Retrieve a theme-specific version of an icon
QIcon darkSearchIcon = styleIcons.icon("search", "dark_theme");