Class: TRequestTextDialogState

Declaration: CommonDialogs.h

Taxonomy Categories:

Member Functions:

Accept
Cancel
Verify
TRequestTextDialogState
~TRequestTextDialogState
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TRequestTextDialogState is a class that represents the state of an request-text dialog.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from TRequestTextDialogState and override Accept/Cancel/Verify to create customized dialog behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRequestTextDialogState::Accept

virtual void Accept (const TText & text)

Interface Category:

API.

Purpose:

Accepts the dialog's offer. The default implementation does nothing.

Calling Context:

Called when the dialog's offer is accepted.

Parameters:

const TText & text -The editable text from the dialog.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Deriving classes should provide an implementation for this member function.

Member Function: TRequestTextDialogState::Cancel

virtual void Cancel (const TText & text)

Interface Category:

API.

Purpose:

Accepts the dialog's offer. The default implementation does nothing.

Calling Context:

Called when the dialog's offer is accepted.

Parameters:

const TText & text -The editable text from the dialog.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Deriving classes should provide an implementation for this member function.

Member Function: TRequestTextDialogState::Verify

virtual bool Verify (const TText & textFromUser, TText & errorMessage)

Interface Category:

API.

Purpose:

Verifies the text input is valid. Returns true if the text input is valid. Returns false if the input is not valid and fills in errorMessage with a description of the error. The default implementation always returns true.

Calling Context:

Called by HandleAcceptButton.

Parameters:

const TText & textFromUser -The text from the user.
TText & errorMessage -Filled in with an error message if the text the user entered was invalid.

Return Value:

Returns true if the text input is valid. Returns false if the input is not valid.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Deriving classes should provide an implementation for this member function.

Member Function: TRequestTextDialogState::TRequestTextDialogState

TRequestTextDialogState ()
TRequestTextDialogState (const TRequestTextDialogState & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TRequestTextDialogState suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TRequestTextDialogState & source -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestTextDialogState::~TRequestTextDialogState

virtual ~ TRequestTextDialogState ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestTextDialogState::operator>>=

TStream & operator >>=(TStream & destination) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & destination -The destination stream.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestTextDialogState::operator<<=

TStream & operator <<= (TStream & source)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & source -The source stream.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the version of the flattened object is not supported.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.