ofxMessage.h File Reference

#include "ofxCore.h"

Include dependency graph for ofxMessage.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OfxMessageSuiteV1
	The OFX suite that allows a plug-in to pass messages back to a user. The V2 suite extends on this in a backwards compatible manner. More...
struct	OfxMessageSuiteV2
	The OFX suite that allows a plug-in to pass messages back to a user. More...
Defines
#define	kOfxMessageSuite   "OfxMessageSuite"
#define	kOfxMessageFatal   "OfxMessageFatal"
	String used to type fatal error messages.
#define	kOfxMessageError   "OfxMessageError"
	String used to type error messages.
#define	kOfxMessageWarning   "OfxMessageWarning"
	String used to type warning messages.
#define	kOfxMessageMessage   "OfxMessageMessage"
	String used to type simple ordinary messages.
#define	kOfxMessageLog   "OfxMessageLog"
	String used to type log messages.
#define	kOfxMessageQuestion   "OfxMessageQuestion"
	String used to type yes/no messages.
Typedefs
typedef struct OfxMessageSuiteV1	OfxMessageSuiteV1
	The OFX suite that allows a plug-in to pass messages back to a user. The V2 suite extends on this in a backwards compatible manner.
typedef struct OfxMessageSuiteV2	OfxMessageSuiteV2
	The OFX suite that allows a plug-in to pass messages back to a user.

---

Detailed Description

This file contains the Host API for end user message communication.

Definition in file ofxMessage.h.

---

Define Documentation

#define kOfxMessageError   "OfxMessageError"

String used to type error messages.

Ordinary error messages should be posted when there is an error in operation that is recoverable by user intervention.

Definition at line 54 of file ofxMessage.h.

Referenced by OFX::mapMessageTypeEnumToString(), and tuttle::host::Host::vmessage().

#define kOfxMessageFatal   "OfxMessageFatal"

String used to type fatal error messages.

Fatal error messages should only be posted by a plugin when it can no longer continue operation.

Definition at line 47 of file ofxMessage.h.

Referenced by OFX::mapMessageTypeEnumToString(), and tuttle::host::Host::vmessage().

#define kOfxMessageLog   "OfxMessageLog"

String used to type log messages.

Log messages are written out to a log and not to the end user.

Definition at line 72 of file ofxMessage.h.

Referenced by OFX::mapMessageTypeEnumToString(), and tuttle::host::Host::vmessage().

#define kOfxMessageMessage   "OfxMessageMessage"

String used to type simple ordinary messages.

Ordinary messages simply convey information from the plugin directly to the user.

Definition at line 66 of file ofxMessage.h.

Referenced by OFX::mapMessageTypeEnumToString().

#define kOfxMessageQuestion   "OfxMessageQuestion"

String used to type yes/no messages.

The host is to enter a modal state which waits for the user to respond yes or no. The OfxMessageSuiteV1::message function which posted the message will only return after the user responds. When asking a question, the OfxStatus code returned by the message function will be,

• kOfxStatReplyYes - if the user replied 'yes' to the question
• kOfxStatReplyNo - if the user replied 'no' to the question
• some error code if an error was encounterred

It is an error to post a question message if the plugin is not in an interactive session.

Definition at line 85 of file ofxMessage.h.

Referenced by OFX::mapMessageTypeEnumToString(), and tuttle::host::Host::vmessage().

#define kOfxMessageSuite   "OfxMessageSuite"

Definition at line 40 of file ofxMessage.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectHost::fetchSuite(), and OFX::Private::loadAction().

#define kOfxMessageWarning   "OfxMessageWarning"

String used to type warning messages.

Warnings indicate states that allow for operations to proceed, but are not necessarily optimal.

Definition at line 60 of file ofxMessage.h.

---

Typedef Documentation

typedef struct OfxMessageSuiteV1 OfxMessageSuiteV1

The OFX suite that allows a plug-in to pass messages back to a user. The V2 suite extends on this in a backwards compatible manner.

typedef struct OfxMessageSuiteV2 OfxMessageSuiteV2

The OFX suite that allows a plug-in to pass messages back to a user.

This extends OfxMessageSuiteV1, and should be considered a replacement to version 1.

Note that this suite has been extended in backwards compatible manner, so that a host can return this struct for both V1 and V2.