Detailed Description

The Default Action System interface.

This interface allows for associating default actions to be taken by the system (3ds Max) when certain predefined events occur, and managing these associations. Note that the default actions are carried out only when the system is runing in quiet mode, i.e. no dialogs are displayed.

See also:: LogSys

#include <DefaultActions.H>

Inheritance diagram for DefaultActionSys:

[legend]

List of all members.

Public Member Functions
virtual BOOL	GetAction (DWORD eventID, DWORD &action)=0
	Retrieves the action associated with an event.
virtual BOOL	SetAction (DWORD eventID, DWORD action, MCHAR title=NULL, DWORD oldAction=NULL)=0
	Sets the default action and descriptive title for an event.
virtual BOOL	DeleteAction (DWORD eventID)=0
	Deletes the specified default action event.
virtual int	GetActionCount ()=0
	Retrieves the number of events registered with the Default Action System.
virtual MSTR	GetActionTitle (DWORD eventID)=0
	Retrieves the title of the specified event.
virtual MSTR	GetActionTitleByIndex (int index)=0
	Retrieves the title of an event specified by its index in the Default Action System.
virtual DWORD	GetActionIDByIndex (int index)=0
	Retrieves the id of an event specified by its index in the Default Action System.
virtual BOOL	LogEntry (DWORD eventID, MCHAR *message)=0
	Logs a message for the specified event.
virtual void	MsgLogClear (DWORD eventID)=0
	Clears logged messages.
virtual int	GetMsgLogCount (DWORD eventID)=0
	Retrieves the number of logged messages.
virtual MSTR	GetMsgLogMsg (DWORD eventID, int index)=0
	Retrives a specified logged message.
virtual DWORD	GetMsgLogID (int index)=0
	Retrieves the event for a logged message.
virtual int	SetMsgLogMaxCount (int count)=0
	Sets the total maximum number of messages that can be logged with the Default Action Sustem.

Member Function Documentation

virtual BOOL GetAction	(	DWORD	eventID,
		DWORD &	action
	)		`[pure virtual]`

Search for all occurrences

Retrieves the action associated with an event.

Parameters:

[in]	eventID	Identifier of a predefined event or a user defined one.
[out]	action	If an action was specified for the given event, it is returned through this argument. The default action value for events which have not had an action set is DEFAULTACTIONS_LOGTOFILE The returned value can be a combination of the following predefined actions

Returns:: - TRUE if an action was specified for the given event, otherwise FALSE.

virtual BOOL SetAction	(	DWORD	eventID,
		DWORD	action,
		MCHAR *	title = `NULL`,
		DWORD *	oldAction = `NULL`
	)		`[pure virtual]`

Search for all occurrences

Sets the default action and descriptive title for an event.

Parameters:

[in]	eventID	Identifier of a predefined event or a user defined one.
[in]	action	The actions to be taken when the specified event occurs.
[in]	title	The event's title. Appears in the log file or dialog displaying the messages associated with the event.
[in,out]	oldAction	The old action value can be returned via this argument

Returns:: Returns TRUE if a default action was previously associated with the event

virtual BOOL DeleteAction ( DWORD eventID ) [pure virtual]

Search for all occurrences

Deletes the specified default action event.

Parameters:

[in] eventID Identifier of a predefined event or a user defined one.

Returns:: Returns TRUE if the event was found and deleted

virtual int GetActionCount ( ) [pure virtual]

Search for all occurrences

Retrieves the number of events registered with the Default Action System.

Returns:: The number of events registered with the Default Action System.

virtual MSTR GetActionTitle ( DWORD eventID ) [pure virtual]

Search for all occurrences

Retrieves the title of the specified event.

Parameters:

[in] eventID Identifier of a predefined event or a user defined one.

Returns:: The title of the specified event, or an empty string if the event is not found.

virtual MSTR GetActionTitleByIndex ( int index ) [pure virtual]

Search for all occurrences

Retrieves the title of an event specified by its index in the Default Action System.

Parameters:

[in] index The index of an event registered with the Default Action System

Returns:: The title of the event at the specified index, or an empty string if there's no event with the specified index.

virtual DWORD GetActionIDByIndex ( int index ) [pure virtual]

Search for all occurrences

Retrieves the id of an event specified by its index in the Default Action System.

Parameters:

[in] index The index of an event registered with the Default Action System

Returns:: The id of the event at the specified index.

virtual BOOL LogEntry	(	DWORD	eventID,
		MCHAR *	message
	)		`[pure virtual]`

Search for all occurrences

Logs a message for the specified event.

Parameters:

[in]	eventID	Identifier of a predefined event or a user defined one
[in]	message	The message to log for the specified event. The message is kept within the Defautl Action System. Use GetMsgLogMsg to retrieve messages logged for an event.

Returns:: Returns TRUE if message was successfully logged.

virtual void MsgLogClear ( DWORD eventID ) [pure virtual]

Search for all occurrences

Clears logged messages.

Parameters:

[in] eventID Identifier of a predefined or a user defined event. If eventID is 0, all messages are deleted, otherwise only messages for the specific event are deleted.

virtual int GetMsgLogCount ( DWORD eventID ) [pure virtual]

Search for all occurrences

Retrieves the number of logged messages.

Parameters:

[in] eventID Identifier of a predefined or a user defined event. If eventID is 0, all messages are counted, otherwise only messages for the specific event are counted.

Returns:: The number of messages

virtual MSTR GetMsgLogMsg	(	DWORD	eventID,
		int	index
	)		`[pure virtual]`

Search for all occurrences

Retrives a specified logged message.

Parameters:

[in]	eventID	Identifier of a predefined or a user defined event.
[in]	index	The index of a logged message to be retrieved.

Returns:: The message logged for the specified event, found at the specified index.

virtual DWORD GetMsgLogID ( int index ) [pure virtual]

Search for all occurrences

Retrieves the event for a logged message.

Parameters:

[in] index The index of a message logged with the Default Action System.

Returns:: The id of the event for which the message at the specified index was logged.

virtual int SetMsgLogMaxCount ( int count ) [pure virtual]

Search for all occurrences

Sets the total maximum number of messages that can be logged with the Default Action Sustem.

Parameters:

[in] count The maximum number of messages that can be logged.

Returns:: The previous maximum number of messages.

DefaultActionSys Class Reference

Detailed Description

Public Member Functions

Member Function Documentation