DzSaveFilterMgr Class Reference
[Manager Objects, File Input and Output Objects]

Manager of all scene setting save filter classes. More...

Inheritance diagram for DzSaveFilterMgr:

List of all members.

Enumerations
enum	ScriptFileMode { UseExtension, TextScriptFile, DAZScriptFile, EncDAZScriptFile }
Methods
DzError	doSave (Number filterIndex, String dir="")
Number	findFilter (String className)
DzSaveFilter	getFilter (Number i)
String	getFilterName (Number i)
Number	getNumFilters ()
String	getSavePath ()
DzError	writeFile (ScriptFileMode mode, String fileName, String filterName="")

---

Detailed Description

Manager of all scene setting save filter classes.

There is only one instance of this manager in an application. This instance is created and owned by DzApp. Don't create an instance of this class, but rather request a pointer to it from DzApp via DzApp::getSaveFilterMgr().

---

Member Enumeration Documentation

enum DzSaveFilterMgr::ScriptFileMode

Save mode for saving the script to file.

Enumerator:

UseExtension	If the file name extension is .dsb, the file is saved as DAZScriptFile, otherwise as TextScriptFile
TextScriptFile	Plain text file - no Unicode support
DAZScriptFile	Binary DAZ file format - supports Unicode characters
EncDAZScriptFile	Encrypted Binary DAZ file format - supports Unicode characters

---

Member Function Documentation

DzError DzSaveFilterMgr::doSave	(	Number	filterIndex,
		String	dir = ""
	)

Save the scene contents to a file with the given save filter. Propmts the user for a file to save to.

Parameters:

	filterIndex	The index of the save filter class to use.
	dir	The directory to start the file dialog in, if empty, the current load/save directory is used.

Returns:

DZ_NO_ERROR if the file export was successfull.

Number DzSaveFilterMgr::findFilter

(

String

className

)

Parameters:

className

The class name of the save filter to find.

Returns:

The index of the save filter with the given class name.

DzSaveFilter DzSaveFilterMgr::getFilter

(

Number

i

)

Parameters:

i

The index of the save filter to get.

Returns:

A new instance of the i'th exporter in the list.

String DzSaveFilterMgr::getFilterName

(

Number

i

)

Parameters:

i

The index of the save filter to get the name of.

Returns:

The name of the i'th filter.

int DzSaveFilterMgr::getNumFilters

(

)

Returns:

The number of save filters currently supported.

String DzSaveFilterMgr::getSavePath

(

)

Returns:

Last directory that files were saved to.

DzError DzSaveFilterMgr::writeFile	(	ScriptFileMode	mode,
		String	fileName,
		String	filterName = ""
	)

Save the scene contents to a file with the given save filter.

Parameters:

	mode	The file mode for saving the script
	fileName	The name of the file to export to.
	filterName	Optional argument. Class name of the filter to use, or no argument to show a choose filter dialog.

Returns:

DZ_NO_ERROR if the file export was successfull.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.