A QIcon that paints a filled shape (square, circle, triangle or cross) on demand, at whatever size and device-pixel ratio Qt asks for. More...

#include <themed_shape_icon.h>

Inheritance diagram for ThemedShapeIcon:

Classes
struct	PaletteColor
	Entry `index` of the theme's graph palette, see ThemeManager::graphColor(). Resolved on every paint. More...

Public Types
enum	Shape { Square , Circle , Triangle , Cross }

Public Member Functions
	ThemedShapeIcon (Shape shape, const QColor &fill, const QColor &outline, const QString &glyph=QString())
	ThemedShapeIcon (Shape shape, const QColor &fill, ThemeManager::ThemeToken outline_token, const QString &glyph=QString())
	Theme-tracking variant: `outline_token` is resolved on every paint, e.g. ThemeManager::PaletteText.
	ThemedShapeIcon (Shape shape, PaletteColor fill, ThemeManager::ThemeToken outline_token)
	Legend variant: fill and outline are both resolved on every paint, so the icon tracks a plot series that uses ThemeManager::graphColor(`fill.index`).
	ThemedShapeIcon (Shape, const QColor &, QPalette::ColorRole, const QString &=QString())=delete

Detailed Description

A QIcon that paints a filled shape (square, circle, triangle or cross) on demand, at whatever size and device-pixel ratio Qt asks for.

Meant for colour legends and colour pickers: the fill carries the data colour (a graph series, a colouring rule), the outline separates it from the surface it sits on. The fill is either a fixed colour or an entry of the theme's graph palette; the outline is either a fixed colour or a ThemeManager token. Palette entries and tokens are resolved on every paint, so the icon follows theme and light/dark changes the way ThemedIcon does, and a legend icon keeps matching a plot series drawn with the same palette index.

The given outline colour is a starting point. Where it is too close to the fill (a black outline on a dark series colour, a white one on a pale series colour) it is moved until it reaches the active non-text ratio (ColorMath::activeRatios()) against the fill; a glyph is lifted to the active readable-text ratio. Colours that already contrast enough are drawn as given.

Nothing is rasterised ahead of time. paint() draws vectors with the caller's painter; pixmap requests render into a transparent pixmap of the requested size times the device-pixel ratio. QIcon::Disabled draws the shape in grey and dims it to the same opacity as the other theme icons.

Member Enumeration Documentation

◆ Shape

enum ThemedShapeIcon::Shape

Enumerator
Square	Filled square; the shape normally given a glyph.
Circle	Filled circle.
Triangle	Filled, pointing up.
Cross	Diagonal cross, drawn as a filled band.

Constructor & Destructor Documentation

◆ ThemedShapeIcon() [1/2]

ThemedShapeIcon::ThemedShapeIcon	(	Shape	shape,
		const QColor &	fill,
		const QColor &	outline,
		const QString &	glyph = QString() )

Parameters

shape	Shape to draw.
fill	Fill colour; its alpha is respected.
outline	Base outline and glyph colour, adapted to the fill where it lacks contrast; its alpha is respected otherwise.
glyph	Optional short text (e.g. a number), centred.

◆ ThemedShapeIcon() [2/2]

ThemedShapeIcon::ThemedShapeIcon	(	Shape	,
		const QColor &	,
		QPalette::ColorRole	,
		const QString &	= QString() )

delete

A palette role is not a colour. Without this, an unscoped QPalette::ColorRole would convert to QRgb and then to a nearly transparent QColor without any warning.

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

/builds/wireshark/wireshark/ui/qt/utils/themes/themed_shape_icon.h
/builds/wireshark/wireshark/ui/qt/utils/themes/themed_shape_icon.cpp

Classes