Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
hdi::core::Widget::ImageIDs Struct Reference

Allows for support of multiple PNGI resource IDs for a light-themed UI, dark-themed UI, rollovers, etc. More...

#import <hdicoreWidget.h>

Protected Member Functions

() - ImageIDs
 Default ImageIDs constructor, setting all ID values to noneID. More...
 
() - ImageIDs
 ImageIDs copy constructor, using values from an existing object. More...
 
() - ImageIDs
 Constructs an ImageIDs object from light-UI, light-UI rollover, and dark-UI resource IDs. More...
 
() - ImageIDs
 Creates an ImageIDs object from light-UI and dark-UI resource IDs for all supported resolutions (without any rollovers) More...
 
() - ImageIDs
 Creates an ImageIDs object from light-UI and dark-UI resource IDs for all supported resolutions. More...
 
() - ~ImageIDs
 ImageIDs destructor. More...
 
(ImageIDs &) - operator=
 Overloaded assignment operator to copy values from one ImageIDs object to another. More...
 
(bool) - operator==
 Overloaded equality operator to compare two ImageIDs objects with one another. More...
 
(bool) - operator!=
 Overloaded equality operator to compare two ImageIDs objects with one another. More...
 

Protected Attributes

int16_t lightID
 PNGI resource ID for the 1x image variant for Illustrator's light-themed UI.
 
int16_t lightID_2x
 PNGI resource ID for the 2x image variant for Illustrator's light-themed UI.
 
int16_t lightID_3x
 PNGI resource ID for the 3x image variant for Illustrator's light-themed UI.
 
int16_t darkID
 PNGI resource ID for the 1x image variant for Illustrator's dark-themed UI.
 
int16_t darkID_2x
 PNGI resource ID for the 2x image variant for Illustrator's dark-themed UI.
 
int16_t darkID_3x
 PNGI resource ID for the 3x image variant for Illustrator's dark-themed UI.
 
int16_t lightOverID
 PNGI resource ID for the 1x rollover image variant for Illustrator's light-themed UI.
 
int16_t lightOverID_2x
 PNGI resource ID for the 2x rollover image variant for Illustrator's light-themed UI.
 
int16_t lightOverID_3x
 PNGI resource ID for the 3x rollover image variant for Illustrator's light-themed UI.
 
int16_t darkOverID
 PNGI resource ID for the 1x rollover image variant for Illustrator's dark-themed UI.
 
int16_t darkOverID_2x
 PNGI resource ID for the 2x rollover image variant for Illustrator's dark-themed UI.
 
int16_t darkOverID_3x
 PNGI resource ID for the 3x rollover image variant for Illustrator's dark-themed UI.
 

Static Protected Attributes

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

Detailed Description

Allows for support of multiple PNGI resource IDs for a light-themed UI, dark-themed UI, rollovers, etc.

Constructor & Destructor Documentation

- core:

Default ImageIDs constructor, setting all ID values to noneID.

Author
GW
Date
03/2015
- core: (const ImageIDs &)  ids_

ImageIDs copy constructor, using values from an existing object.

Author
GW
Date
03/2015
Parameters
ids_Existing ImageIDs object to copy values from
- core: (const int16_t)  light_
(const int16_t)  lightOver_
(const int16_t)  dark_ 

Constructs an ImageIDs object from light-UI, light-UI rollover, and dark-UI resource IDs.

Author
GW
Date
03/2015
Parameters
light_Light UI resource ID
lightOver_Light UI rollover resource ID
dark_Dark UI resource ID
- core: (const int16_t)  light_
(const int16_t)  light2x_
(const int16_t)  light3x_
(const int16_t)  dark_
(const int16_t)  dark2x_
(const int16_t)  dark3x_ 

Creates an ImageIDs object from light-UI and dark-UI resource IDs for all supported resolutions (without any rollovers)

Author
GW
Date
03/2015
- core: (const int16_t)  light_
(const int16_t)  light2x_
(const int16_t)  light3x_
(const int16_t)  dark_
(const int16_t)  dark2x_
(const int16_t)  dark3x_
(const int16_t)  lightOver_
(const int16_t)  lightOver2x_
(const int16_t)  lightOver3x_
(const int16_t)  darkOver_
(const int16_t)  darkOver2x_
(const int16_t)  darkOver3x_ 

Creates an ImageIDs object from light-UI and dark-UI resource IDs for all supported resolutions.

Author
GW
Date
03/2015
- core:

ImageIDs destructor.

Author
GW
Date
03/2015

Method Documentation

- (bool) core: (const ImageIDs &)  rhs_ const

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

Author
GW
Date
03/2015
Parameters
rhs_Righthand side of the comparison
Returns
true if the lefthand side and righthand side of the comparison have the differing image IDs
- (ImageIDs&) core: (const ImageIDs &)  rhs_

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

Author
GW
Date
03/2015
Parameters
rhs_Righthand side of the assignment
Returns
The lefthand side of the assignment, but with its values updated to match rhs_
- (bool) core: (const ImageIDs &)  rhs_ const

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

Author
GW
Date
03/2015
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

+ (const int16_t) core: = 0
staticprotected

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

Warning
Do not use 0 as your own PNGI image ID!