Class: TAcceptRejectCancelDialogState

Declaration: CommonDialogs.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDialogState

Inherited By:

None.

Purpose:

TAcceptRejectCancelDialogState is a derived class from TDialogState. This customized state that represents the state of an accept-reject-cancel dialog.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive classes from TAcceptRejectCancelDialogState to create customized dialog behavior by overriding member functions: Accept, Reject, and Cancel.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAcceptRejectCancelDialogState::Reject

virtual void Reject ()

Interface Category:

API.

Purpose:

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

Calling Context:

Called when the reject button is pressed in a dialog. Called from TAcceptRejectCancelContent::HandleViewAction.

Parameters:

Takes no parameters.

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: TAcceptRejectCancelDialogState::TAcceptRejectCancelDialogState

TAcceptRejectCancelDialogState ()
TAcceptRejectCancelDialogState (const TAcceptRejectCancelDialogState & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TAcceptRejectCancelDialogState & 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: TAcceptRejectCancelDialogState::~TAcceptRejectCancelDialogState

virtual ~ TAcceptRejectCancelDialogState ()

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: TAcceptRejectCancelDialogState::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: TAcceptRejectCancelDialogState::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.