Icon

This section documents the classes and helper functions used to create, style, and compose icons within the user interface. It covers icon styling infrastructure as well as utility functions for generating composite icons, overlays, and badge-enhanced variants used throughout the application and its plugins.

Classes

Functions

QIcon mv::gui::createIcon(const QPixmap &pixmap, const QList<QSize> &pixmapSizes = defaultIconPixmapSizes)

Convenience function to create icon from a pixmap and for pixmapSizes.

Parameters:

  • pixmap – Source pixmap

  • pixmapSizes – Pixmap size in the icon

Returns:

Icon

QIcon mv::gui::createOverlayIcon(const QIcon &icon, const QPixmap &overlay)

Convenience function to overlay icon pixmap(s) with an overlay pixmap.

Parameters:

  • icon – Source icon

  • overlay – Overlay pixmap

Returns:

Overlay icon

QIcon mv::gui::combineIcons(const QIcon &iconA, const QIcon &iconB)

Draws iconB on top of iconA.

Parameters:

  • iconA – Icon A

  • iconB – Icon B (overlays iconA)

Returns:

Combined icon

QIcon mv::gui::createPluginIcon(const QString &characters)

Convenience function to create a plugin icon, which consists of maximum of four characters laid out in a grid.

Parameters:

characters – Characters

Returns:

Plugin icon

QIcon mv::gui::combineIconsHorizontally(const QVector<QIcon> &icons)

Combines two (or more) icons into a horizontal icon.

Parameters:

icons – Vector of input icons (need to be the same height)

Returns:

Combined icon

Warning

doxygenfunction: Unable to resolve function “mv::gui::createNumberBadgeOverlayPixmap” with arguments None in doxygen xml output for project “ManiVault” from directory: /home/docs/checkouts/readthedocs.org/user_builds/manivault/checkouts/1.4.2/docs/_doxygen/xml. Potential matches: 

- QPixmap createNumberBadgeOverlayPixmap(const util::Badge &widgetActionBadge)
- QPixmap createNumberBadgeOverlayPixmap(std::uint32_t number, const QColor &backgroundColor, const QColor &foregroundColor)
QIcon mv::gui::createIconWithNumberBadgeOverlay(const QIcon &icon, const util::Badge &widgetActionBadge, std::uint32_t iconMargin = 0)

Overlays icon with a number badge in color and with alignment.

Parameters:

  • icon – Icon to overlay

  • widgetActionBadge – Widget action badge configuration

  • iconMargin – Icon margin

Returns:

Icon with badge overlay