Class: TRequestNewDirectoryDialogState

Declaration: CommonDialogs.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRequestFileSystemEntityDialogState

Inherited By:

None.

Purpose:

TRequestNewDirectoryDialogState represents the state of a dialog that requests a new directory name.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

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

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRequestNewDirectoryDialogState::TRequestNewDirectoryDialogState

TRequestNewDirectoryDialogState ()
TRequestNewDirectoryDialogState (bool permitReplacement)
TRequestNewDirectoryDialogState (const TRequestNewDirectoryDialogState & source)

Interface Category:

API.

Purpose:

Default constructor. Replacement of existing directories is not allowed.
Constructs a TRequestNewDirectoryDialogState. Replacement of existing directories is based on the value of permitReplacement.
Copy constructor.

Calling Context:

Called to create a TRequestNewDirectoryDialogState suitable for streaming into.
Called to create a TRequestNewDirectoryDialogState and specify whether or not replacement of directories is allowed.
Called to copy an object.

Parameters:

Takes no parameters.
bool permitReplacement -If set to true, the replacement of existing directories will be allowed.
const TRequestNewDirectoryDialogState & 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: TRequestNewDirectoryDialogState::Verify

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

Interface Category:

API.

Purpose:

Determines if the new directory was successfully created. Returns false if the new directory could not be created. If false is returned, errorMessage will be filled in with a description of the error.

Calling Context:

Called by HandleAcceptButton.

Parameters:

TPathName & pathName -The pathname of the new directory.
TFileSystemEntity & entity -Filled in with the entity of the pathname.
TText & errorMessage -Filled in with an error message if false is returned.

Return Value:

Returns true if the new directory was successfully created. Returns false if the new directory could not be created.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRequestNewDirectoryDialogState::PermitReplacementOfFileSystemEntity

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

Interface Category:

API.

Purpose:

Determines if the specified directory exists and directory replacement is allowed. If true is returned, replacementMessage is filled in with a replacement prompt suitable for display to the user. False is returned if the directory does not exist or if directory replacement is not allowed.

Calling Context:

Called by HandleAcceptButton.

Parameters:

TPathName & pathName -The directory to replace.
TStandardText & replacementMessage -The replacement prompt for displaying to the user.

Return Value:

Returns true if the specified directory exists and directory replacement is allowed. False is returned if the directory does not exist or if directory replacement is not allowed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Deriving classes may override this member function to provide customized directory replacement policy.

Member Function: TRequestNewDirectoryDialogState::~

TRequestNewDirectoryDialogState ; virtual ~ TRequestNewDirectoryDialogState ()

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: TRequestNewDirectoryDialogState::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: TRequestNewDirectoryDialogState::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 no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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