TSLAPP6ASelector Class Reference

Detailed Description

The TSLAPP6ASelector class should be used for all interactions with the symbol selector dialog box.

The actual MFC dialog is created in the class constructor. You can check that this has been created successfully by calling the valid method straight after construction.

Check the TSLErrorStack::lastError() method for a description of the problem.

Public Member Functions
	TSLAPP6ASelector (TSLAPP6ARequest *client, bool helpRequired=true, HWND parent=0)
	~TSLAPP6ASelector ()
void	enableMultipleSelection (bool enable=true)
void	forceUpdate ()
bool	isVisible ()
void	showWindow (bool show=true)
Int	getListSize ()
bool	getSelectedSymbol (TSLAPP6ASymbol &symbol, Int index)
bool	valid ()

Constructor & Destructor Documentation

TSLAPP6ASelector()

TSLAPP6ASelector::TSLAPP6ASelector	(	TSLAPP6ARequest *	client,
		bool	helpRequired = true,
		HWND	parent = 0 )

Default Constructor.

The first parameter should be a pointer to a TSLAPP6ARequest derived class that will receive the update messages from the Palette.

If the helpRequired flag is true then a help button will be displayed on each page and the click action will be sent via a TSLAPP6ARequest::onHelp() call.

The HWND parameter should be used to specify a handle to the parent window. This is equivalent to CWnd in a normal MFC Dialog class.

~TSLAPP6ASelector()

TSLAPP6ASelector::~TSLAPP6ASelector

(

)

Destructor.

Member Function Documentation

enableMultipleSelection()

void TSLAPP6ASelector::enableMultipleSelection

(

bool

enable = true

)

This method allows the multiple selection functionality of the symbol selector to be switched off.

Parameters

enable

A boolean value indicating whether the multiple selection mode should be on or off.

Returns

void.

forceUpdate()

void TSLAPP6ASelector::forceUpdate

(

)

Forces the Properties to call the TSLAPP6ARequest::onSelectorUpdate() method, passing any symbols that the user may have selected.

getListSize()

Int TSLAPP6ASelector::getListSize

(

)

Use this method to find out how many symbols to the user has selected in the dialog.

Returns

An integer value indicating the number of selected symbols.

getSelectedSymbol()

bool TSLAPP6ASelector::getSelectedSymbol	(	TSLAPP6ASymbol &	symbol,
		Int	index )

Use this method to populate the symbol passed in the parameter with the values from the symbol selector. The index value allows multiple symbols to be retrieved from the dialog.

Parameters

symbol	A TSLAPP6ASymbol object to populate.
index	The index of symbol to query. This value must be less than that returned from getListSize().

Returns

true if successful, false otherwise.

isVisible()

bool TSLAPP6ASelector::isVisible

(

)

Use this method to query the visibility of the dialog.

Returns

True if the dialog is currently visible, false otherwise.

showWindow()

void TSLAPP6ASelector::showWindow

(

bool

show = true

)

Shows or hides the dialog depending on the value of 'show'. This method does nothing if you try to hide an already hidden window.

Parameters

show	A boolean value which determines whether the resulting window will be hidden or visible.

valid()

bool TSLAPP6ASelector::valid

(

)

The dialog is created when the class is constructed, therefore it is not possible to returns a value to indicate whether this was successful or not. This method returns true if the palette was successfully created.

Check the TSLErrorStack for a description is this returns false.

Returns

True if the dialog created successfully, false otherwise.