hdi::core::SVGIDs Class Reference

Stores both light and dark SVG resource IDs, such that app UI brightness changes can be properly handled. More...

#include <hdicoreSVGIDs.h>

Inheritance diagram for hdi::core::SVGIDs:

Public Member Functions
	SVGIDs ()
	Constructs a new SVGIDs object with default values (i.e. noneID).
	SVGIDs (const SVGIDs &svg_)
	Constructs a new SVGIDs object with the same values as an existing object.
	SVGIDs (const int16_t light2x_, const int16_t dark2x_)
	Constructs a new SVGIDs object from light and dark image IDs.
virtual	~SVGIDs ()
	Destructs a SVGIDs object.
SVGIDs &	operator= (const SVGIDs &rhs_)
	Overloaded assignment operator to copy values from one SVGIDs object to another.
bool	operator== (const SVGIDs &rhs_) const
	Overloaded equality operator to compare two SVGIDs objects with one another.
bool	operator!= (const SVGIDs &rhs_) const
	Overloaded inequality operator to compare two SVGIDs objects with one another.

Public Attributes
int16_t	lightID_2x
	ID of the SVG resource that should be used when the UI is light in color (and Adobe expects the native resolution to be 2x).
int16_t	darkID_2x
	ID of the SVG resource that should be used when the UI is dark in color (and Adobe expects the native resolution to be 2x).

Static Public Attributes
static const int16_t	noneID = 0
	Default image ID to indicate that no image has been set.

Detailed Description

Stores both light and dark SVG resource IDs, such that app UI brightness changes can be properly handled.

Constructor & Destructor Documentation

SVGIDs() [1/3]

hdi::core::SVGIDs::SVGIDs

(

)

Constructs a new SVGIDs object with default values (i.e. noneID).

Author

GW

Date

10/2018

SVGIDs() [2/3]

hdi::core::SVGIDs::SVGIDs

(

const SVGIDs &

svg_

)

Constructs a new SVGIDs object with the same values as an existing object.

Author

GW

Date

10/2018

Parameters

svg_	SVGIDs object to copy values from

SVGIDs() [3/3]

hdi::core::SVGIDs::SVGIDs	(	const int16_t	light2x_,
		const int16_t	dark2x_ )

Constructs a new SVGIDs object from light and dark image IDs.

Author

GW

Date

10/2018

Parameters

light2x_	Light UI resource ID at 2x native resolution
dark2x_	Dark UI resource ID at 2x native resolution

Note

SVG resource IDs from 0-5000 are reserved for hdi_core.

~SVGIDs()

virtual hdi::core::SVGIDs::~SVGIDs ( )

virtual

Destructs a SVGIDs object.

Author

GW

Date

10/2018

Member Function Documentation

operator!=()

bool hdi::core::SVGIDs::operator!=

(

const SVGIDs &

rhs_

)

const

Overloaded inequality operator to compare two SVGIDs objects with one another.

Author

GW

Date

10/2018

Parameters

rhs_	Righthand side of the comparison

Returns

true if the lefthand side and righthand side of the comparison have the differing image IDs

operator=()

SVGIDs & hdi::core::SVGIDs::operator=

(

const SVGIDs &

rhs_

)

Overloaded assignment operator to copy values from one SVGIDs object to another.

Author

GW

Date

10/2018

Parameters

rhs_	Righthand side of the assignment

Returns

The lefthand side of the assignment, but with its values updated to match rhs_

operator==()

bool hdi::core::SVGIDs::operator==

(

const SVGIDs &

rhs_

)

const

Overloaded equality operator to compare two SVGIDs objects with one another.

Author

GW

Date

10/2018

Parameters

rhs_	Righthand side of the comparison

Returns

true if the lefthand side and righthand side of the comparison have the same image IDs

Member Data Documentation

noneID

const int16_t hdi::core::SVGIDs::noneID = 0

static

Default image ID to indicate that no image has been set.

Warning

Do not use 0 as your own SVG image ID!