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

Describes the text, color, location, etc. of a notification. More...

#include <hdicoreNotificationHub.h>

Collaboration diagram for hdi::core::NotificationHub::Notification:
Collaboration graph
[legend]

Public Types

enum  LocationType { UnknownLocType = 0, PinPointLocType = 10, PointLocType = 20 }
 Describes the type of location that a notification should be displayed.
 
typedef Font NFont
 

Public Member Functions

 Notification ()
 Constructs a Notification object with default values (and an empty text value; be sure to set the text member if you intend to use an object constructor with this default ctor) More...
 
 Notification (const Notification &n_)
 Constructs a Notification object from an existing Notification object (copy ctor) More...
 
 Notification (const std::string &text_, const BoundsPinPointType pinPt_=TopRightPinPoint, const Color &textCol_=Color::black(), const bool border_=true, const Color &borderCol_=Color::black(), const NFont font_=NFontDefault, const double duration_=2.0)
 Constructs a Notification object that should be displayed at a pin point of the current document. More...
 
 Notification (const std::string &text_, const Point &point_, const Color &textCol_=Color::black(), const bool border_=true, const Color &borderCol_=Color::black(), const NFont font_=NFontDefault, const double duration_=2.0)
 Constructs a Notification object that should be displayed at a specific point on the current document. More...
 
virtual ~Notification ()
 Destructs a Notification object. More...
 
Notificationoperator= (const Notification &rhs_)
 Overloaded Notification assignment operator; copies values from one Notification object into another. More...
 
LocationType locationType () const
 Gets the location type for the notification. More...
 
BoundsPinPointType pinPoint () const
 Gets the pin point for the notification. More...
 
void setPinPoint (const BoundsPinPointType pinPt_)
 Sets the pin point for the notification. More...
 
Point point () const
 Gets the point for the notification. More...
 
void setPoint (const Point &pt_)
 Sets the point for the notification. More...
 

Public Attributes

std::string text
 Stores the text that should be displayed in the notification, as UTF-8.
 
Color textColor
 Stores the text color for the notification.
 
NFont font
 Stores the font for the notification.
 
bool border
 Stores whether the notification should have a border.
 
Color borderColor
 Stores the border color for the notification.
 
double duration
 Stores the duration, in seconds, that the notification should be displayed.
 

Detailed Description

Describes the text, color, location, etc. of a notification.

Constructor & Destructor Documentation

hdi::core::NotificationHub::Notification::Notification ( )

Constructs a Notification object with default values (and an empty text value; be sure to set the text member if you intend to use an object constructor with this default ctor)

Author
GW
Date
04/2014
hdi::core::NotificationHub::Notification::Notification ( const Notification n_)

Constructs a Notification object from an existing Notification object (copy ctor)

Author
GW
Date
04/2014
Parameters
n_Existing object to copy values from
hdi::core::NotificationHub::Notification::Notification ( const std::string &  text_,
const BoundsPinPointType  pinPt_ = TopRightPinPoint,
const Color textCol_ = Color::black(),
const bool  border_ = true,
const Color borderCol_ = Color::black(),
const NFont  font_ = NFontDefault,
const double  duration_ = 2.0 
)

Constructs a Notification object that should be displayed at a pin point of the current document.

Author
GW
Date
04/2014
Parameters
text_Text value for the notification, as UTF-8
pinPt_Location that the notification should be displayed
textCol_Color for the text
border_Whether to display a border around the text
borderCol_Color for the border
duration_Number of seconds that the notification should be displayed before automatically disappearing
hdi::core::NotificationHub::Notification::Notification ( const std::string &  text_,
const Point point_,
const Color textCol_ = Color::black(),
const bool  border_ = true,
const Color borderCol_ = Color::black(),
const NFont  font_ = NFontDefault,
const double  duration_ = 2.0 
)

Constructs a Notification object that should be displayed at a specific point on the current document.

Author
GW
Date
04/2014
Parameters
text_Text value for the notification, as UTF-8
point_Location that the notification should be displayed
textCol_Color for the text
border_Whether to display a border around the text
borderCol_Color for the border
duration_Number of seconds that the notification should be displayed before automatically disappearing
virtual hdi::core::NotificationHub::Notification::~Notification ( )
virtual

Destructs a Notification object.

Author
GW
Date
04/2014

Member Function Documentation

LocationType hdi::core::NotificationHub::Notification::locationType ( ) const

Gets the location type for the notification.

Author
GW
Date
04/2014
Returns
PinPointLocType or PointLocType
Notification& hdi::core::NotificationHub::Notification::operator= ( const Notification rhs_)

Overloaded Notification assignment operator; copies values from one Notification object into another.

Author
GW
Date
04/2014
Parameters
rhs_Righthand side of the assignment operator; object to copy values from
Returns
The lefthand side of the
BoundsPinPointType hdi::core::NotificationHub::Notification::pinPoint ( ) const

Gets the pin point for the notification.

Author
GW
Date
04/2014
Returns
Current pin point setting (only valid if locationType() is PinPointLocType)
Point hdi::core::NotificationHub::Notification::point ( ) const

Gets the point for the notification.

Author
GW
Date
04/2014
Returns
Current point setting (only valid if locationType() is PointLocType)
void hdi::core::NotificationHub::Notification::setPinPoint ( const BoundsPinPointType  pinPt_)

Sets the pin point for the notification.

Author
GW
Date
04/2014
Parameters
pinPt_New pin point location for the notification
Note
Also sets the location type to PinPointLocType
void hdi::core::NotificationHub::Notification::setPoint ( const Point pt_)

Sets the point for the notification.

Author
GW
Date
04/2014
Parameters
pt_New point location for the notification
Note
Also sets the location type to PointLocType