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

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

#include <hdicoreImageIDs.h>

Inheritance diagram for hdi::core::ImageIDs:
Inheritance graph
[legend]

Public Member Functions

 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.
 
ImageIDsoperator= (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 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.
 

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 image PNGI resource IDs, such that app UI brightness changes can be properly handled.

Constructor & Destructor Documentation

◆ ImageIDs() [1/5]

hdi::core::ImageIDs::ImageIDs ( )

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

Author
GW
Date
02/2015

◆ ImageIDs() [2/5]

hdi::core::ImageIDs::ImageIDs ( const ImageIDs img_)

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

Author
GW
Date
02/2015
Parameters
img_ImageIDs object to copy values from

◆ ImageIDs() [3/5]

hdi::core::ImageIDs::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.

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

◆ ImageIDs() [4/5]

hdi::core::ImageIDs::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.

Author
GW
Date
02/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.

◆ ImageIDs() [5/5]

hdi::core::ImageIDs::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.

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.

◆ ~ImageIDs()

virtual hdi::core::ImageIDs::~ImageIDs ( )
virtual

Destructs an ImageIDs object.

Author
GW
Date
02/2015

Member Function Documentation

◆ operator!=()

bool hdi::core::ImageIDs::operator!= ( const ImageIDs rhs_) const

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

Author
GW
Date
02/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=()

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

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

Author
GW
Date
02/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::ImageIDs::operator== ( const ImageIDs rhs_) const

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

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

◆ darkID_3to2x

int16_t hdi::core::ImageIDs::darkID_3to2x

ID of the PNGI resource that should be used when the UI is dark in color at 1.5x resolution.

Note
Ignored by all Mac versions

◆ lightID_3to2x

int16_t hdi::core::ImageIDs::lightID_3to2x

ID of the PNGI resource that should be used when the UI is light in color at 1.5x resolution.

Note
Ignored by all Mac versions

◆ noneID

const int16_t hdi::core::ImageIDs::noneID = 0
static

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

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