Class: TRequestFileSystemEntityDialogState

Declaration: CommonDialogs.h

Taxonomy Categories:

Member Functions:

Verify
PermitReplacementOfFileSystemEntity
Accept
Cancel
TRequestFileSystemEntityDialogState
~TRequestFileSystemEntityDialogState
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TRequestExistingDirectoryDialogState TRequestExistingFileDialogState TRequestNewDirectoryDialogState TRequestNewFileDialogState TRequestVolumeDialogState

Purpose:

TRequestFileSystemEntityDialogState is a class that represents the state of a file system entity dialog.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive classes from TRequestFileSystemEntityDialogState and override Accept/Cancel/Verify member functions to create customized dialog behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRequestFileSystemEntityDialogState::Verify

virtual bool Verify (TPathName & pathName, TFileSystemEntity & entity, TText & errorMessage)

Interface Category:

API.

Purpose:

Verifies that the specified file system entity exists or can be created.

Calling Context:

Called by HandleAcceptButton.

Parameters:

TPathName & pathName -The pathname.
TFileSystemEntity & entity -The entity.
TText & errorMessage -Filled in with an error message if the entity is not valid.

Return Value:

Returns true if the specified file system entity exists or can be created. Returns false if it does not exist or cannot be created.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestFileSystemEntityDialogState::PermitReplacementOfFileSystemEntity

virtual bool PermitReplacementOfFileSystemEntity (TPathName & pathName, TStandardText & replacementMessage)

Interface Category:

API.

Purpose:

Returns true if the specified entity may be replaced. The default implementation always returns false.

Calling Context:

Called by HandleAcceptButton.

Parameters:

TPathName & pathName -The pathname.
TStandardText & replacementMessage -Filled in with a replacement prompt if true is returned.

Return Value:

Always returns false.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Deriving classes may override this member function to define the policy of replacing file system entities.

Member Function: TRequestFileSystemEntityDialogState::Accept

virtual void Accept (const TFileSystemEntity & entity)

Interface Category:

API.

Purpose:

Accepts the specified file system entity. The default implementation does nothing.

Calling Context:

Called when the accept button is pressed. Called By TDialogView::HandleViewAction.

Parameters:

const TFileSystemEntity & entity -The file system entity 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: TRequestFileSystemEntityDialogState::Cancel

virtual void Cancel ()

Interface Category:

API.

Purpose:

Cancels the dialog. The default implementation does nothing.

Calling Context:

Called when the cancel button is pressed. Called by TDialogView::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: TRequestFileSystemEntityDialogState::TRequestFileSystemEntityDialogState

TRequestFileSystemEntityDialogState ()
TRequestFileSystemEntityDialogState (const TRequestFileSystemEntityDialogState & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

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

virtual ~ TRequestFileSystemEntityDialogState ()

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: TRequestFileSystemEntityDialogState::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: TRequestFileSystemEntityDialogState::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 from which the object streams itself.

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.