C++ API reference

This section is generated from the public headers with Doxygen and rendered in Sphinx with Breathe.

At the moment, the public headers are only lightly annotated. The generated pages are therefore best treated as a structural API map until richer inline Doxygen comments are added.

Theme API

class ThemeOptions

Public Functions

ThemeOptions()

ThemeOptions is the canonical input structure used by ThemeBuilder.

Current support level:

  • sourceColor: consumed

  • mode: consumed

  • contrast: consumed (minimal post-generation adjustment pass)

  • expressive: persisted but currently not consumed by ThemeBuilder

  • useMaterialColorUtilities: persisted but currently not consumed by ThemeBuilder

class ColorScheme
class TypographyScale
class ShapeScale
class ElevationScale
class MotionTokens
class StateLayer
class Theme
class ThemeBuilder
class ThemeManager : public QObject

Core widget API

class QtMaterialControl : public QtMaterial::QtMaterialWidget

Subclassed by QtMaterial::QtMaterialInputControl, QtMaterial::QtMaterialListItem, QtMaterial::QtMaterialSurface

class QtMaterialAbstractButton : public QAbstractButton

Subclassed by QtMaterial::QtMaterialIconButton, QtMaterial::QtMaterialSelectionControl, QtMaterial::QtMaterialTextButton

Buttons API

class QtMaterialTextButton : public QtMaterial::QtMaterialAbstractButton

Subclassed by QtMaterial::QtMaterialFilledButton, QtMaterial::QtMaterialOutlinedButton

class QtMaterialFilledButton : public QtMaterial::QtMaterialTextButton

Subclassed by QtMaterial::QtMaterialElevatedButton, QtMaterial::QtMaterialExtendedFab, QtMaterial::QtMaterialFab, QtMaterial::QtMaterialFilledTonalButton

class QtMaterialIconButton : public QtMaterial::QtMaterialAbstractButton

Guidance for maintainers

When you add new public classes, expose them here only after:

  1. the header is installed from include/

  2. the class is part of the supported public API

  3. the header has at least a short Doxygen brief explaining purpose and ownership