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

Structure that can actually be passed to the NotificationHub.aip plugin. More...

#include <hdicoreNotificationHub.h>

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

Public Attributes

SPMessageData data
 Stores SuitePea message data (MUST always be the first member)
 
int16_t version
 Stores the version number of the display message (MUST always come after the data member) More...
 
char * text
 Stores the text that should be displayed in the notification. More...
 
double textColorR
 Stores the red text color channel for the notification.
 
double textColorG
 Stores the green text color channel for the notification.
 
double textColorB
 Stores the blue text color channel for the notification.
 
double textColorO
 Stores the opacity (alpha) text color channel for the notification.
 
char * fontName
 Stores the name of the font that should be used.
 
bool border
 Stores whether the notification should have a border.
 
double borderColorR
 Stores the red border color channel for the notification.
 
double borderColorG
 Stores the green border color channel for the notification.
 
double borderColorB
 Stores the blue border color channel for the notification.
 
double borderColorO
 Stores the opacity (alpha) border color channel for the notification.
 
double duration
 Stores the duration, in seconds, that the notification should be displayed.
 
bool usePoint
 Stores whether to use the point or pinPoint member (true is pointX and pointY, false is pinPoint)
 
BoundsPinPointType pinPoint
 Stores the pin point at which the notification should appear.
 
double pointX
 Stores the x-axis value for the exact point at which the notification should appear.
 
double pointY
 Stores the y-axis value for the exact point at which the notification should appear.
 

Detailed Description

Structure that can actually be passed to the NotificationHub.aip plugin.

Note
If you are using the hdi_core lib to build your plugin, it is highly recommended that you use the display() method of this class instead of attempting to message the NotificationHub.aip plugin directly.
If you are attempting to manually message the NotificationHub.aip plugin, this structure expects to be sent with the NotificationHub::caller/NotificationHub::displaySelector pair. Also, it must conform to the messaging paradigm as outlined in the ThirdPartyPlugin class.

Member Data Documentation

char* hdi::core::NotificationHub::DisplayMessage::text

Stores the text that should be displayed in the notification.

Note
Must be allocated using Illustrator::alloc() method, and subsequently freed after!
int16_t hdi::core::NotificationHub::DisplayMessage::version

Stores the version number of the display message (MUST always come after the data member)

Note
Always set to 1!