DzFileFilter Class Reference
[File Input and Output Objects]

Encapsulates one or more file filters to be chosen from in a file dialogs. More...

Inheritance diagram for DzFileFilter:

QObject Object List of all members.

Methods

void addExtension (String extension)
void addExtensions (Array extensions)
Number getDefaultFilter ()
String getExtension (Number filterIdx, Number extensionIdx)
String getFilterDescription (Number filterIdx)
Number getNumExtensions (Number filterIdx)
Number getNumFilters ()
void newFilter (String description)
void setDefaultFilter (Number filterIdx)

Constructors



 DzFileFilter (String description, Array extensions)
 DzFileFilter (String description, String extension)
 DzFileFilter ()

Detailed Description

Encapsulates one or more file filters to be chosen from in a file dialogs.

For each group of files that you want to make available to the user, create a new filter with the newFilter() call, then add one or more file extensions to be accepted by the filter.

Constructor & Destructor Documentation

DzFileFilter::DzFileFilter (  ) 

Default Constructor.

DzFileFilter::DzFileFilter ( String  description,
String  extension 
)

Creates a new file filter and adds a filter with the given description and extension.

Parameters:
description The description of the filter.
extension The extension for the filter.

DzFileFilter::DzFileFilter ( String  description,
Array  extensions 
)

Creates a new file filter and adds a filter with the given description and extensions.

Parameters:
description The description of the filter.
extensions The list of extensions for the filter.

Member Function Documentation

void DzFileFilter::addExtension ( String  extension  ) 

Adds a file extension to the current filter.

Parameters:
extension A file extension that this filter will open/save e.g. "daz"

void DzFileFilter::addExtensions ( Array  extensions  ) 

Adds file extensions to the current filter.

Parameters:
extensions A list of file extensions that this filter will open/save

Number DzFileFilter::getDefaultFilter (  ) 

Returns:
The default filter index, returns -1 if no default is set.

String DzFileFilter::getExtension ( Number  filterIdx,
Number  extensionIdx 
)

Parameters:
filterIdx The index of the filter to return an extension for.
extensionIdx The index of the extension to return.
Returns:
The extension of the filter at the given index.

String DzFileFilter::getFilterDescription ( Number  filterIdx  ) 

Parameters:
filterIdx The index of the filter to return a description for.
Returns:
The description of the filter at the given index.

Number DzFileFilter::getNumExtensions ( Number  filterIdx  ) 

Parameters:
filterIdx The index of the filter to get the number of extensions for.
Returns:
The number of extensions in the filter at the given index.

Number DzFileFilter::getNumFilters (  ) 

Returns:
The number of filters.

void DzFileFilter::newFilter ( String  description  ) 

Starts a new filter with the given description.

Parameters:
description The description of files this filter will open/save e.g. "DAZ Studio files"

void DzFileFilter::setDefaultFilter ( Number  filterIdx  ) 

Sets the default filter index - by default this is 0.

Parameters:
filterIdx The index of the filter to become the default - if the index is invalid the default is not changed.

Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.