Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TRequestFileSystemEntityDialogState
Inherited By:
None.
Purpose:
TRequestNewFileDialogState is a class that represents the state of an new-file-request dialog.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Derive from TRequestNewFileDialogState and override Accept/Cancel/Verify to create customized dialog behavior.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
virtual bool Verify (TPathName & pathName, TFileSystemEntity & entity, TText & errorMessage)
Interface Category:
API.
Purpose:
Verifies that the specified file system entity does not exist.
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 does not exist. Returns false if it does exist.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TRequestNewFileDialogState::PermitReplacementOfFileSystemEntity
virtual bool PermitReplacementOfFileSystemEntity (TPathName & pathName, TStandardText & replacementMessage)
Interface Category:
API.
Purpose:
Determines if the specified entity exists to indicate the entity can be replaced.
Calling Context:
Called by HandleAcceptButton.
Parameters:
- TPathName & pathName -The pathname.
- TStandardText & replacementMessage -Filled in with a suitable replacement prompt if true is returned.
Return Value:
Returns true if the specified entity exists.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Deriving classes may override this member function to provide a customized policy for file replacement.
- TRequestNewFileDialogState ()
- TRequestNewFileDialogState (const TRequestNewFileDialogState & 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:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TRequestNewFileDialogState ;
virtual ~ TRequestNewFileDialogState ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
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.
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.
Copyright©1995 Taligent,Inc. All rights reserved.