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

Allows notifications to be presented to the user in the form of text annotations on the current document. When notifications are drawn at a pin point location, they will automatically "stack" atop one another to maintain readability. More...

#include <hdicoreNotificationHub.h>

Classes

struct  DisplayMessage
 Structure that can actually be passed to the NotificationHub.aip plugin. More...
 
struct  Notification
 Describes the text, color, location, etc. of a notification. More...
 

Public Types

typedef std::auto_ptr< NotificationNotificationAP
 

Public Member Functions

bool display (const Notification &n_)
 Sends a notification to the NotificationHub.aip plugin to be displayed. More...
 

Static Public Member Functions

static NotificationHubinstance ()
 Allows access to the singleton notificiation hub instance object. More...
 

Static Public Attributes

static const std::string caller
 
static const std::string displaySelector
 

Friends

class Plugin
 

Detailed Description

Allows notifications to be presented to the user in the form of text annotations on the current document. When notifications are drawn at a pin point location, they will automatically "stack" atop one another to maintain readability.

Note
Requires the Hot Door NotificationHub.aip plug-in file to be installed. Without it, this class does nothing.

Member Function Documentation

bool hdi::core::NotificationHub::display ( const Notification n_)

Sends a notification to the NotificationHub.aip plugin to be displayed.

Author
GW
Date
04/2014
Parameters
n_Notification to be displayed; if its text member is empty then nothing will happen
Returns
true if the notification message was sent, false otherwise
static NotificationHub* hdi::core::NotificationHub::instance ( )
static

Allows access to the singleton notificiation hub instance object.

Author
GW
Date
04/2014
Returns
The notification hub instance object, or NULL if the NotificationHub.aip file is not installed (though it does not have to be named as such)