TSLAPP6ARequest Class Reference

Detailed Description

The TSLAPP6ARequest class should be used as a callback method for the palette, properties and selector dialogs to call into the client application.

Normally the owner of the dialogs should simply derive from this class and provide implementations of the required methods. Pass the 'this' pointer in the dialog constructor to receive the callbacks.

The constructor is declared protected to prevent aggregation.

Public Member Functions
virtual	~TSLAPP6ARequest ()
virtual bool	onHelp (TSLBitMask flags, bool help, bool f1)
virtual void	onPaletteClose (TSLBitMask flags)
virtual void	onPaletteSave (TSLBitMask flags, const char *filename, const char *paletteName)
virtual void	onPaletteLoad (TSLBitMask flags, const char *filename, const char *paletteName)
virtual bool	onPaletteUpdate (TSLBitMask flags, const TSLAPP6ASymbol *symbol)
virtual void	onPropertiesClose (TSLBitMask flags)
virtual void	onPropertiesOpening (TSLBitMask flags)
virtual bool	onPropertiesUpdate (TSLBitMask flags, const TSLAPP6ASymbol *symbol)
virtual void	onSelectorClose (TSLBitMask flags)
virtual bool	onSelectorUpdate (TSLBitMask flags, const TSLAPP6ASymbol *symbol)
TSLAPP6AHelper *	getAPP6AHelper ()

Protected Member Functions
	TSLAPP6ARequest ()

Protected Attributes
TSLAPP6AHelper *	m_helper

Constructor & Destructor Documentation

~TSLAPP6ARequest()

virtual TSLAPP6ARequest::~TSLAPP6ARequest ( )

virtual

Destructor.

TSLAPP6ARequest()

TSLAPP6ARequest::TSLAPP6ARequest ( )

protected

Protected Constructor.

This class cannot be instantiated directly, you must derive from this class.

Member Function Documentation

getAPP6AHelper()

TSLAPP6AHelper * TSLAPP6ARequest::getAPP6AHelper ( )

inline

This function returns the TSLAPP6AHelper object that the operation will use. The client application needs to set up the helper object with the APP6A or 2525B configuration file and set the m_helper member to point to it during their derived classes construction.

Return Value: Pointer to TSLAPP6AHelper object.

Note: It is necessary to set the m_helper member returned by this function to a TSLAPP6AHelper object in order for the Editor SDK APP6A classes to function correctly. It is recommended that the client application creates a single instance of the TSLAPP6AHelper object and maintains this and then cleans it up on termination of the application after destructing any Editor SDK APP6A objects.

onHelp()

virtual bool TSLAPP6ARequest::onHelp ( TSLBitMask flags, bool help, bool f1 )

virtual

This method is called by the application if the user clicks the help button, or presses the F1 key.

Flag Values:

APP6A_HELP_PALETTE: Indicates that the help button was clicked in the Palette dialog.

APP6A_HELP_PROPERTIES: Indicates that the help button was clicked in the Properties dialog.

APP6A_HELP_SELECTOR: Indicates that the help button was clicked in the Selector dialog.

Return Value:

Normally return true to this method, unless and error occurs.

onPaletteClose()

virtual void TSLAPP6ARequest::onPaletteClose ( TSLBitMask flags )

virtual

Indicates that the user has closed the palette window, the client application can then perform the appropriate action.

Flag Values:

No current values; included for extensibility.

onPaletteLoad()

virtual void TSLAPP6ARequest::onPaletteLoad ( TSLBitMask flags, const char * filename, const char * paletteName )

virtual

This method is called by the palette when the user loads a palette.

Flag Values:

None.

Parameters

filename	The location where the palette is being loaded from.
paletteName	The name of the palette being loaded.

onPaletteSave()

virtual void TSLAPP6ARequest::onPaletteSave ( TSLBitMask flags, const char * filename, const char * paletteName )

virtual

This method is called by the palette when the user saves a palette.

Flag Values:

None.

Parameters

filename	The location where the palette is being saved.
paletteName	The name of the palette being saved.

onPaletteUpdate()

virtual bool TSLAPP6ARequest::onPaletteUpdate ( TSLBitMask flags, const TSLAPP6ASymbol * symbol )

virtual

This method is called when a new symbol is added to the palette, or selections are made. It allows the client to keep track of what is happening in the palette.

Flag Values:

APP6A_PAL_UPDATING: Indicates that a new symbol has been added to the palette.

APP6A_PAL_SELECTION: Indicates that the user has made a selection in the palette.

Return Value:

Return true to this method unless an error occurs. If this method receives a false return value processing will stop as soon as possible.

onPropertiesClose()

virtual void TSLAPP6ARequest::onPropertiesClose ( TSLBitMask flags )

virtual

Indicates that the user has closed the properties window, the client application can then perform the appropriate action.

Flag Values:

APP6A_PROPS_OK: Indicates that the user has clicked the OK button.

APP6A_PROPS_CANCEL: Indicates that the user has clicked the cancel button.

onPropertiesOpening()

virtual void TSLAPP6ARequest::onPropertiesOpening ( TSLBitMask flags )

virtual

Indicates that the user has opened the properties window, the client application can then perform the appropriate action.

Flag Values:

None

onPropertiesUpdate()

virtual bool TSLAPP6ARequest::onPropertiesUpdate ( TSLBitMask flags, const TSLAPP6ASymbol * symbol )

virtual

This method allows the client application to respond to changes in the symbol properties dialog.

Flag Values:

APP6A_PROPS_UPDATING: Indicates that the properties dialog is updating, usually as the result of a forceUpdate() call.

APP6A_PROPS_OK: Indicates that the user has clicked the OK button.

APP6A_PROPS_APPLY: Indicates that the user has clicked the APPLY button.

APP6A_PROPS_CANCEL: Indicates that the user has clicked the CANCEL button.

APP6A_PROPS_UNDO: Indicates that the user has clicked the UNDO button.

Return Value:

Return true to this method unless an error occurs. If this method receives a false return value processing will stop as soon as possible.

onSelectorClose()

virtual void TSLAPP6ARequest::onSelectorClose ( TSLBitMask flags )

virtual

Indicates that the user has closed the selector window, the client application can then perform the appropriate action.

Flag Values:

No current values; included for extensibility.

onSelectorUpdate()

virtual bool TSLAPP6ARequest::onSelectorUpdate ( TSLBitMask flags, const TSLAPP6ASymbol * symbol )

virtual

This method allows the client application to respond to changes in the symbol selector dialog.

The selector dialog may pass multiple symbols to the client at once.

Flag Values:

APP6A_FIRST: Indicates that this is the first symbol in the list to be sent to the client.

APP6A_LAST: Indicates that this is the last symbol in the list to be sent to the client.

APP6A_FIRST_AND_LAST: Sent when only one symbol is selected in the dialog.

Return Value:

Return true to this method unless an error occurs. If this method receives a false return value processing will stop as soon as possible and no more symbols will be sent.

Member Data Documentation

m_helper

TSLAPP6AHelper* TSLAPP6ARequest::m_helper

protected

Data Members for Class Attributes