Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
hdi::core::ImageWithRolloverIDs Class Reference

Allows for image rollover support. More...

#include <hdicoreImageIDs.h>

Inheritance diagram for hdi::core::ImageWithRolloverIDs:
Inheritance graph
[legend]
Collaboration diagram for hdi::core::ImageWithRolloverIDs:
Collaboration graph
[legend]

Public Member Functions

 ImageWithRolloverIDs ()
 Default ImageWithRolloverIDs constructor, setting all ID values to noneID.
 
 ImageWithRolloverIDs (const ImageWithRolloverIDs &ids_)
 ImageWithRolloverIDs copy constructor, using values from an existing object.
 
 ImageWithRolloverIDs (const int16_t light_, const int16_t lightOver_, const int16_t dark_, const int16_t darkOver_)
 Constructs an ImageWithRolloverIDs object from light-UI, light-UI rollover, dark-UI, and dark-UI resource IDs; sets all higher resolutions to noneID.
 
 ImageWithRolloverIDs (const int16_t light_, const int16_t light3to2x_, const int16_t light2x_, const int16_t dark_, const int16_t dark3to2x_, const int16_t dark2x_)
 Creates an ImageWithRolloverIDs object from light-UI and dark-UI resource IDs for all supported resolutions at 2x and below (without any rollovers)
 
 ImageWithRolloverIDs (const int16_t light_, const int16_t light3to2x_, const int16_t light2x_, const int16_t light3x_, const int16_t light4x_, const int16_t dark_, const int16_t dark3to2x_, const int16_t dark2x_, const int16_t dark3x_, const int16_t dark4x_)
 Creates an ImageWithRolloverIDs object from light-UI and dark-UI resource IDs for all supported resolutions (without any rollovers)
 
 ImageWithRolloverIDs (const int16_t light_, const int16_t light3to2x_, const int16_t light2x_, const int16_t dark_, const int16_t dark3to2x_, const int16_t dark2x_, const int16_t lightOver_, const int16_t lightOver3to2x_, const int16_t lightOver2x_, const int16_t darkOver_, const int16_t darkOver3to2x_, const int16_t darkOver2x_)
 Creates an ImageWithRolloverIDs object from light-UI and dark-UI resource IDs for all supported resolutions at 2x and below.
 
 ImageWithRolloverIDs (const int16_t light_, const int16_t light3to2x_, const int16_t light2x_, const int16_t light3x_, const int16_t light4x_, const int16_t dark_, const int16_t dark3to2x_, const int16_t dark2x_, const int16_t dark3x_, const int16_t dark4x_, const int16_t lightOver_, const int16_t lightOver3to2x_, const int16_t lightOver2x_, const int16_t lightOver3x_, const int16_t lightOver4x_, const int16_t darkOver_, const int16_t darkOver3to2x_, const int16_t darkOver2x_, const int16_t darkOver3x_, const int16_t darkOver4x_)
 Creates an ImageWithRolloverIDs object from light-UI and dark-UI resource IDs for all supported resolutions.
 
virtual ~ImageWithRolloverIDs ()
 ImageWithRolloverIDs destructor.
 
ImageWithRolloverIDs & operator= (const ImageWithRolloverIDs &rhs_)
 Overloaded assignment operator to copy values from one ImageWithRolloverIDs object to another.
 
bool operator== (const ImageWithRolloverIDs &rhs_) const
 Overloaded equality operator to compare two ImageWithRolloverIDs objects with one another.
 
bool operator!= (const ImageWithRolloverIDs &rhs_) const
 Overloaded inequality operator to compare two ImageWithRolloverIDs objects with one another.
 
- Public Member Functions inherited from hdi::core::ImageIDs
 ImageIDs ()
 Constructs a new ImageIDs object with default values (i.e. noneID)
 
 ImageIDs (const ImageIDs &img_)
 Constructs a new ImageIDs object with the same values as an existing object.
 
 ImageIDs (const int16_t light_, const int16_t dark_)
 Constructs a new ImageIDs object from light and dark image IDs, setting all higher resolutions to noneID.
 
 ImageIDs (const int16_t light_, const int16_t light3to2x_, const int16_t light2x_, const int16_t dark_, const int16_t dark3to2x_, const int16_t dark2x_)
 Constructs a new ImageIDs object from light and dark image IDs individually for each resolution at 2x and below.
 
 ImageIDs (const int16_t light_, const int16_t light3to2x_, const int16_t light2x_, const int16_t light3x_, const int16_t light4x_, const int16_t dark_, const int16_t dark3to2x_, const int16_t dark2x_, const int16_t dark3x_, const int16_t dark4x_)
 Constructs a new ImageIDs object from light and dark image IDs individually for each resolution.
 
virtual ~ImageIDs ()
 Destructs an ImageIDs object.
 
ImageIDs & operator= (const ImageIDs &rhs_)
 Overloaded assignment operator to copy values from one ImageIDs object to another.
 
bool operator== (const ImageIDs &rhs_) const
 Overloaded equality operator to compare two ImageIDs objects with one another.
 
bool operator!= (const ImageIDs &rhs_) const
 Overloaded inequality operator to compare two ImageIDs objects with one another.
 

Public Attributes

int16_t lightOverID
 PNGI resource ID for the 1x rollover image variant for the app's light-themed UI.
 
int16_t lightOverID_3to2x
 PNGI resource ID for the 1.5x rollover image variant for the app's light-themed UI.
 
int16_t lightOverID_2x
 PNGI resource ID for the 2x rollover image variant for the app'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 lightOverID_4x
 PNGI resource ID for the 4x rollover image variant for Illustrator's light-themed UI.
 
int16_t darkOverID
 PNGI resource ID for the 1x rollover image variant for the app's dark-themed UI.
 
int16_t darkOverID_3to2x
 PNGI resource ID for the 1.5x rollover image variant for the app's dark-themed UI.
 
int16_t darkOverID_2x
 PNGI resource ID for the 2x rollover image variant for the app's dark-themed UI.
 
int16_t darkOverID_3x
 PNGI resource ID for the 3x rollover image variant for Illustrator's dark-themed UI.
 
int16_t darkOverID_4x
 PNGI resource ID for the 4x rollover image variant for Illustrator's dark-themed UI.
 
- Public Attributes inherited from hdi::core::ImageIDs
int16_t lightID
 ID of the PNGI resource that should be used when the UI is light in color.
 
int16_t lightID_3to2x
 ID of the PNGI resource that should be used when the UI is light in color at 1.5x resolution.
 
int16_t lightID_2x
 ID of the PNGI resource that should be used when the UI is light in color at 2x resolution.
 
int16_t lightID_3x
 ID of the PNGI resource that should be used when the UI is light in color at 3x resolution.
 
int16_t lightID_4x
 ID of the PNGI resource that should be used when the UI is light in color at 4x resolution.
 
int16_t darkID
 ID of the PNGI resource that should be used when the UI is dark in color.
 
int16_t darkID_3to2x
 ID of the PNGI resource that should be used when the UI is dark in color at 1.5x resolution.
 
int16_t darkID_2x
 ID of the PNGI resource that should be used when the UI is dark in color at 2x resolution.
 
int16_t darkID_3x
 ID of the PNGI resource that should be used when the UI is dark in color at 3x resolution.
 
int16_t darkID_4x
 ID of the PNGI resource that should be used when the UI is dark in color at 4x resolution.
 

Additional Inherited Members

- Static Public Attributes inherited from hdi::core::ImageIDs
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

◆ ImageWithRolloverIDs() [1/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( )

Default ImageWithRolloverIDs constructor, setting all ID values to noneID.

Author
GW
Date
03/2015

◆ ImageWithRolloverIDs() [2/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( const ImageWithRolloverIDs &  ids_)

ImageWithRolloverIDs copy constructor, using values from an existing object.

Author
GW
Date
03/2015
Parameters
ids_Existing ImageWithRolloverIDs object to copy values from

◆ ImageWithRolloverIDs() [3/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( const int16_t  light_,
const int16_t  lightOver_,
const int16_t  dark_,
const int16_t  darkOver_ 
)

Constructs an ImageWithRolloverIDs object from light-UI, light-UI rollover, dark-UI, and dark-UI resource IDs; sets all higher resolutions to noneID.

Author
GW
Date
03/2015
Parameters
light_Light UI resource ID
lightOver_Light UI rollover resource ID
dark_Dark UI resource ID
darkOver_Dark UI rollover resource ID
Note
PNGI resource IDs from 0-5000 are reserved for hdi_core.

◆ ImageWithRolloverIDs() [4/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( const int16_t  light_,
const int16_t  light3to2x_,
const int16_t  light2x_,
const int16_t  dark_,
const int16_t  dark3to2x_,
const int16_t  dark2x_ 
)

Creates an ImageWithRolloverIDs object from light-UI and dark-UI resource IDs for all supported resolutions at 2x and below (without any rollovers)

Author
GW
Date
03/2015
Parameters
light_Light UI resource ID
light3to2x_Light UI resource ID at 1.5x
light2x_Light UI resource ID at 2x
dark_Dark UI resource ID
dark3to2x_Dark UI resource ID at 1.5x
dark2x_Dark UI resource ID at 2x
Note
PNGI resource IDs from 0-5000 are reserved for hdi_core.

◆ ImageWithRolloverIDs() [5/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( const int16_t  light_,
const int16_t  light3to2x_,
const int16_t  light2x_,
const int16_t  light3x_,
const int16_t  light4x_,
const int16_t  dark_,
const int16_t  dark3to2x_,
const int16_t  dark2x_,
const int16_t  dark3x_,
const int16_t  dark4x_ 
)

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

Author
GW
Date
08/2018
Parameters
light_Light UI resource ID
light3to2x_Light UI resource ID at 1.5x
light2x_Light UI resource ID at 2x
light3x_Light UI resource ID at 3x
light4x_Light UI resource ID at 4x
dark_Dark UI resource ID
dark3to2x_Dark UI resource ID at 1.5x
dark2x_Dark UI resource ID at 2x
dark3x_Dark UI resource ID at 3x
dark4x_Dark UI resource ID at 4x
Note
PNGI resource IDs from 0-5000 are reserved for hdi_core.

◆ ImageWithRolloverIDs() [6/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( const int16_t  light_,
const int16_t  light3to2x_,
const int16_t  light2x_,
const int16_t  dark_,
const int16_t  dark3to2x_,
const int16_t  dark2x_,
const int16_t  lightOver_,
const int16_t  lightOver3to2x_,
const int16_t  lightOver2x_,
const int16_t  darkOver_,
const int16_t  darkOver3to2x_,
const int16_t  darkOver2x_ 
)

Creates an ImageWithRolloverIDs object from light-UI and dark-UI resource IDs for all supported resolutions at 2x and below.

Author
GW
Date
03/2015
Parameters
light_Light UI resource ID
light3to2x_Light UI resource ID at 1.5x
light2x_Light UI resource ID at 2x
dark_Dark UI resource ID
dark3to2x_Dark UI resource ID at 1.5x
dark2x_Dark UI resource ID at 2x
lightOver_Light rollover UI resource ID
lightOver3to2x_Light rollover UI resource ID at 1.5x
lightOver2x_Light rollover UI resource ID at 2x
darkOver_Dark rollover UI resource ID
darkOver3to2x_Dark rollover UI resource ID at 1.5x
dark2Overx_Dark rollover UI resource ID at 2x
Note
PNGI resource IDs from 0-5000 are reserved for hdi_core.

◆ ImageWithRolloverIDs() [7/7]

hdi::core::ImageWithRolloverIDs::ImageWithRolloverIDs ( const int16_t  light_,
const int16_t  light3to2x_,
const int16_t  light2x_,
const int16_t  light3x_,
const int16_t  light4x_,
const int16_t  dark_,
const int16_t  dark3to2x_,
const int16_t  dark2x_,
const int16_t  dark3x_,
const int16_t  dark4x_,
const int16_t  lightOver_,
const int16_t  lightOver3to2x_,
const int16_t  lightOver2x_,
const int16_t  lightOver3x_,
const int16_t  lightOver4x_,
const int16_t  darkOver_,
const int16_t  darkOver3to2x_,
const int16_t  darkOver2x_,
const int16_t  darkOver3x_,
const int16_t  darkOver4x_ 
)

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

Author
GW
Date
08/2018
Parameters
light_Light UI resource ID
light3to2x_Light UI resource ID at 1.5x
light2x_Light UI resource ID at 2x
light3x_Light UI resource ID at 3x
light4x_Light UI resource ID at 4x
dark_Dark UI resource ID
dark3to2x_Dark UI resource ID at 1.5x
dark2x_Dark UI resource ID at 2x
dark3x_Dark UI resource ID at 3x
dark4x_Dark UI resource ID at 4x
lightOver_Light rollover UI resource ID
lightOver3to2x_Light rollover UI resource ID at 1.5x
lightOver2x_Light rollover UI resource ID at 2x
lightOver3x_Light rollover UI resource ID at 3x
lightOver4x_Light rollover UI resource ID at 4x
darkOver_Dark rollover UI resource ID
darkOver3to2x_Dark rollover UI resource ID at 1.5x
darkOver2x_Dark rollover UI resource ID at 2x
darkOver3x_Dark rollover UI resource ID at 3x
darkOver4x_Dark rollover UI resource ID at 4x
Note
PNGI resource IDs from 0-5000 are reserved for hdi_core.

◆ ~ImageWithRolloverIDs()

virtual hdi::core::ImageWithRolloverIDs::~ImageWithRolloverIDs ( )
virtual

ImageWithRolloverIDs destructor.

Author
GW
Date
03/2015

Member Function Documentation

◆ operator!=()

bool hdi::core::ImageWithRolloverIDs::operator!= ( const ImageWithRolloverIDs &  rhs_) const

Overloaded inequality operator to compare two ImageWithRolloverIDs 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

◆ operator=()

ImageWithRolloverIDs & hdi::core::ImageWithRolloverIDs::operator= ( const ImageWithRolloverIDs &  rhs_)

Overloaded assignment operator to copy values from one ImageWithRolloverIDs 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_

◆ operator==()

bool hdi::core::ImageWithRolloverIDs::operator== ( const ImageWithRolloverIDs &  rhs_) const

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

◆ darkOverID_3to2x

int16_t hdi::core::ImageWithRolloverIDs::darkOverID_3to2x

PNGI resource ID for the 1.5x rollover image variant for the app's dark-themed UI.

Note
Ignored by all Mac versions

◆ lightOverID_3to2x

int16_t hdi::core::ImageWithRolloverIDs::lightOverID_3to2x

PNGI resource ID for the 1.5x rollover image variant for the app's light-themed UI.

Note
Ignored by all Mac versions
Generated by doxygen 1.9.6