DzInFile Class Reference
[File Input and Output Objects]

Class for reading native files. More...

Inheritance diagram for DzInFile:

QObject Object List of all members.

Methods

void close ()
Boolean exists ()
DzAuthor getAuthor ()
String getAuthorComment ()
String getFilename ()
String getFiletype ()
Number getVersion ()
Boolean isMerge ()
DzError open ()

Constructors

 DzInFile (String filename)

Signals

void readFinished ()
 Signature: "readFinished()"
void unableToFindFile (String file)
 Signature: "unableToFindFile(const QString&)"

Detailed Description

Class for reading native files.

A utility class used for accessing and reading data from the native file format.


Constructor & Destructor Documentation

DzInFile::DzInFile ( String  filename  ) 

Constructor.


Member Function Documentation

void DzInFile::close (  ) 

Called by the framework. Finishes up reading and close the file.

Boolean DzInFile::exists (  ) 

Checks for existence of the file.

Returns:
true if the file exists, otherwise false.

DzAuthor DzInFile::getAuthor (  ) 

Returns:
A pointer to the author of the file if the file was saved with authorship information, otherwise NULL. This object is owned by the file, do not delete it.

String DzInFile::getAuthorComment (  ) 

Returns:
The comment (if any) saved by the author of the file.

String DzInFile::getFilename (  ) 

Returns:
The filename of the file we're currently reading.

String DzInFile::getFiletype (  ) 

Returns:
The type of the file that is currently being read.

Number DzInFile::getVersion (  ) 

Returns:
The software version that the current file was originally written from.

Boolean DzInFile::isMerge (  ) 

Returns:
true if this file-load operation is a merge, false if it is an open operation.

DzError DzInFile::open (  ) 

Called by he framework. Opens the file for reading.

Returns:
DZ_NO_ERROR on success, otherwise an error code.

void DzInFile::readFinished (  )  [signal]

Signature: "readFinished()"

Emitted when after the file has been read entirely and the its contents loaded.

DzInFile::unableToFindFile ( String  file  )  [signal]

Signature: "unableToFindFile(const QString&)"

Emitted when a file for a storable cannot be found.


Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.