messiah_message.h


Provides time related information and manipulation.

Version:
1.1
Date:
6/07/03


Return Codes

These codes are returned from fxMessageSend() to indicate what buttons were pressed by the user to dismiss a message box. The FX_MESSAGE_OK macro is dual purpose and is also used as a Message Box Type flag.


#define FX_MESSAGE_NO
 Indicates that the user pressed the 'No' button.

#define FX_MESSAGE_YES
 Indicates that the user pressed the 'Yes' button.

#define FX_MESSAGE_CANCEL
 Indicates that the user pressed the 'Cancel' button.

#define FX_MESSAGE_OK

Message Box Type Flags

Use these flags to indicate the type of message box you want to display. Note that FX_MESSAGE_OK is also included in this list as it is a dual purpose macro. These flags are mutually exclusive.


#define FX_MESSAGE_OKCANCEL
 Flag indicating a message box with 'Ok' and 'Cancel' buttons.

#define FX_MESSAGE_YESNO
 Flag indicating a message box with 'Yes' and 'No' buttons.

#define FX_MESSAGE_YESNOCANCEL
 Flag indicating a message box with 'Yes', 'No' and 'Cancel' buttons.


Message Type Flags

Use these flags to indicate the type of message you are sending. For example if your message is meant to indicate some fatal error send it as an FX_MESSAGE_ERROR. Messiah will display messages differently depending on the type and the context in which it is displayed. These flags are mutually exclusive.


#define FX_MESSAGE_INFO
 Flag indicating that this message is providing information.

#define FX_MESSAGE_WARNING
 Flag indicating that this message is providing a warning.

#define FX_MESSAGE_ERROR
 Flag indicating that this message indicates an error.

#define FX_MESSAGE_QUESTION
 Flag indicating that this message asks a question in which a response is requested.


Message Directive Flags

These flags are not mutually exclusive.


#define FX_MESSAGE_POST
 Post a message box.

#define FX_MESSAGE_NOPORT
 Do not write to messiah's message port.

#define FX_MESSAGE_NOLOG
 Do not write to the log file.

#define FX_MESSAGE_IMMEDIATE
 Update message port right now.


API Functions



FXint fxMessageSend (FXentity ID, FXchar *title, FXint flags, FXchar *message, FXchar *description)
 Display a message to the message port and/or as a message box.

FXint fxMessageProgress (FXentity ID, FXint progress, FXint flags, FXchar *message)
 Display a message and a progress bar in messiah's message port.


Define Documentation

#define FX_MESSAGE_OK
 

Indicates that the user pressed the 'No' button Also a flag indicating a message box with only an 'Ok' button


Function Documentation

FXint fxMessageProgress FXentity    ID,
FXint    progress,
FXint    flags,
FXchar   message
 

Display a message and a progress bar in messiah's message port.

Parameters:
ID [in] ?
progress [in] Progress bar position (0 - 100)
flags [in] ...
message [in] message to display.
This function will display a message in messiah's message port, behind it will be a progress bar. You will call this function several times with different progress values to provide the user with feedback on potentially long calculations (e.g. when responding to O_EXIT_SETUP for an effect).

FXint fxMessageSend FXentity    ID,
FXchar   title,
FXint    flags,
FXchar   message,
FXchar   description
 

Display a message to the message port and/or as a message box.

Parameters:
ID [in] ?
title [in] String to appear in a message box's title bar (Message Box type messages only)
flags [in] One or more FX_MESSAGE_* flags indicating the way the message is to be displayed
message [in] The message to display
description [in] An extended description of the message
Return values:
FX_TRUE on success
FX_FALSE on failure
value of button pressed in a message box
Use this function to send a message to the user. Depending on the flags argument the message will either be sent to messiah's message port (lower right of the display) or as a message box. If you send the message as a message box then you can determine which button the user pressed to dismiss it by this function's return value. For example, if you set the flags argument to FX_MESSAGE_YESNOCANCEL then you would get a message box that displayed three buttons labeled 'Yes', 'No' and 'Cancel'. If the user pressed the 'Cancel' button then this function would return FX_MESSAGE_CANCEL.


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

Last Updated on Thu Jul 10 04:49:37 2003