hdi::core::SVGWithRolloverIDs Class Reference

Allows for image rollover support. More...

#include <hdicoreSVGIDs.h>

Inheritance diagram for hdi::core::SVGWithRolloverIDs:

Collaboration diagram for hdi::core::SVGWithRolloverIDs:

Public Member Functions
	SVGWithRolloverIDs ()
	Default SVGWithRolloverIDs constructor, setting all ID values to noneID.
	SVGWithRolloverIDs (const SVGWithRolloverIDs &ids_)
	SVGWithRolloverIDs copy constructor, using values from an existing object.
	SVGWithRolloverIDs (const int16_t light2x_, const int16_t dark2x_)
	Constructs a SVGWithRolloverIDs object from light and dark image IDs (without any rollovers).
	SVGWithRolloverIDs (const int16_t light2x_, const int16_t lightOver2x_, const int16_t dark2x_, const int16_t darkOver2x_)
	Constructs a SVGWithRolloverIDs object from light-UI, light-UI rollover, dark-UI, and dark-UI resource IDs.
virtual	~SVGWithRolloverIDs ()
	SVGWithRolloverIDs destructor.
SVGWithRolloverIDs &	operator= (const SVGWithRolloverIDs &rhs_)
	Overloaded assignment operator to copy values from one SVGWithRolloverIDs object to another.
bool	operator== (const SVGWithRolloverIDs &rhs_) const
	Overloaded equality operator to compare two SVGWithRolloverIDs objects with one another.
bool	operator!= (const SVGWithRolloverIDs &rhs_) const
	Overloaded inequality operator to compare two SVGWithRolloverIDs objects with one another.
Public Member Functions inherited from hdi::core::SVGIDs
	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	lightOverID_2x
	ID of the SVG resource that should be used for rollover when the UI is light in color (and Adobe expects the native resolution to be 2x).
int16_t	darkOverID_2x
	ID of the SVG resource that should be used for rollover when the UI is dark in color (and Adobe expects the native resolution to be 2x).
Public Attributes inherited from hdi::core::SVGIDs
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).

Additional Inherited Members
Static Public Attributes inherited from hdi::core::SVGIDs
static const int16_t	noneID = 0
	Default image ID to indicate that no image has been set.

Detailed Description

Allows for image rollover support.

Constructor & Destructor Documentation

SVGWithRolloverIDs() [1/4]

hdi::core::SVGWithRolloverIDs::SVGWithRolloverIDs

(

)

Default SVGWithRolloverIDs constructor, setting all ID values to noneID.

Author

GW

Date

10/2018

SVGWithRolloverIDs() [2/4]

hdi::core::SVGWithRolloverIDs::SVGWithRolloverIDs

(

const SVGWithRolloverIDs &

ids_

)

SVGWithRolloverIDs copy constructor, using values from an existing object.

Author

GW

Date

10/2018

Parameters

ids_	Existing SVGWithRolloverIDs object to copy values from

SVGWithRolloverIDs() [3/4]

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

Constructs a SVGWithRolloverIDs object from light and dark image IDs (without any rollovers).

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.

SVGWithRolloverIDs() [4/4]

hdi::core::SVGWithRolloverIDs::SVGWithRolloverIDs	(	const int16_t	light2x_,
		const int16_t	lightOver2x_,
		const int16_t	dark2x_,
		const int16_t	darkOver2x_ )

Constructs a SVGWithRolloverIDs object from light-UI, light-UI rollover, dark-UI, and dark-UI resource IDs.

Author

GW

Date

10/2018

Parameters

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

Note

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

~SVGWithRolloverIDs()

virtual hdi::core::SVGWithRolloverIDs::~SVGWithRolloverIDs ( )

virtual

SVGWithRolloverIDs destructor.

Author

GW

Date

10/2018

Member Function Documentation

operator!=()

bool hdi::core::SVGWithRolloverIDs::operator!=

(

const SVGWithRolloverIDs &

rhs_

)

const

Overloaded inequality operator to compare two SVGWithRolloverIDs 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=()

SVGWithRolloverIDs & hdi::core::SVGWithRolloverIDs::operator=

(

const SVGWithRolloverIDs &

rhs_

)

Overloaded assignment operator to copy values from one SVGWithRolloverIDs 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::SVGWithRolloverIDs::operator==

(

const SVGWithRolloverIDs &

rhs_

)

const

Overloaded equality operator to compare two SVGWithRolloverIDs 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