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

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

#include <hdicoreEntryValue.h>

Public Member Functions

 ImageIDs ()
 Constructs a new Images object with default values (i.e. 0, meaning "no image") More...
 
 ImageIDs (const ImageIDs &img_)
 Constructs a new ImageIDs object with the same values as an existing object. More...
 
 ImageIDs (const int16_t light_, const int16_t dark_)
 Constructs a new ImageIDs object from light and dark image IDs for all resolutions. More...
 
 ImageIDs (const int16_t light_, const int16_t light2x_, const int16_t light3x_, const int16_t dark_, const int16_t dark2x_, const int16_t dark3x_)
 Constructs a new ImageIDs object from light and dark image IDs individually for each resolution. More...
 
 ~ImageIDs ()
 Destructs an ImageIDs object. More...
 
ImageIDsoperator= (const ImageIDs &rhs_)
 Overloaded assignment operator to copy values from one ImageIDs object to another. More...
 
bool operator== (const ImageIDs &rhs_) const
 Overloaded equality operator to compare two ImageIDs objects with one another. More...
 
bool operator!= (const ImageIDs &rhs_) const
 Overloaded equality operator to compare two ImageIDs objects with one another. More...
 

Public Attributes

int16_t lightID
 ID of the PNGI resource that should be used when the UI is light in color.
 
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 darkID
 ID of the PNGI resource that should be used when the UI is dark in color.
 
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.
 

Detailed Description

Stores both a light and dark image PNGI resource ID, such that Illustrator UI brightness changes can be properly handled.

Constructor & Destructor Documentation

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

Constructs a new Images object with default values (i.e. 0, meaning "no image")

Author
GW
Date
02/2015
hdi::core::EntryValue::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
hdi::core::EntryValue::ImageIDs::ImageIDs ( const int16_t  light_,
const int16_t  dark_ 
)

Constructs a new ImageIDs object from light and dark image IDs for all resolutions.

Author
GW
Date
02/2015
Parameters
light_Light UI resource ID
dark_Dark UI resource ID
hdi::core::EntryValue::ImageIDs::ImageIDs ( const int16_t  light_,
const int16_t  light2x_,
const int16_t  light3x_,
const int16_t  dark_,
const int16_t  dark2x_,
const int16_t  dark3x_ 
)

Constructs a new ImageIDs object from light and dark image IDs individually for each resolution.

Author
GW
Date
02/2015
Parameters
light_Light UI resource ID
light2x_Light UI resource ID at 2x
light3x_Light UI resource ID at 3x
dark_Dark UI resource ID
dark2x_Dark UI resource ID
dark3x_Dark UI resource ID
hdi::core::EntryValue::ImageIDs::~ImageIDs ( )

Destructs an ImageIDs object.

Author
GW
Date
02/2015

Member Function Documentation

bool hdi::core::EntryValue::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 differing image IDs
ImageIDs& hdi::core::EntryValue::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_
bool hdi::core::EntryValue::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