DzFileProperty Class Reference
[Property Objects]

A static (non-animatable) string property that holds a file path. Attempts to save and restore as relative path when possible. More...

Inheritance diagram for DzFileProperty:

DzStringProperty DzProperty DzBase QObject Object List of all members.

Enumerations

enum  FileType { FileSave, FileOpen, Dir }

Constructors

 DzFileProperty (String name, Boolean isUserProperty)

Methods

String getFilter ()
FileType getType ()
void setFilter (String filter)
void setType (Number type)

Signals

void filterChanged ()
 Signature: "filterChanged()"

Detailed Description

A static (non-animatable) string property that holds a file path. Attempts to save and restore as relative path when possible.


Member Enumeration Documentation

enum DzFileProperty::FileType

The type of file dialog that will used when the user browses for the file.

Enumerator:
FileSave  The user will be prompted with a 'Save As' type dialog when browsing for a file.
FileOpen  The user will be prompted with an 'Open' type dialog when browsing for a file.
Dir  The user will be prompted with a 'Select Folder' type dialog when browsing for a directory.


Constructor & Destructor Documentation

DzFileProperty::DzFileProperty ( String  name,
Boolean  isUserProperty 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
name The name of this property.
isUserProperty If true, create a user property. User properties are properties that can be added/deleted by users.


Member Function Documentation

void DzFileProperty::filterChanged (  )  [signal]

Signature: "filterChanged()"

Emitted when the filter for the property changes.

String DzFileProperty::getFilter (  ) 

Gets the filter value.

FileType DzFileProperty::getType (  ) 

Gets the file type.

void DzFileProperty::setFilter ( String  filter  ) 

Sets the filter value. It should be in the form "FilterName (*.ext1 *.ext2 *.ext3)". If this property is of type SaveFile, and if the save file is not given an extention by the user, then the first extention listed will be added to the filename. The filter is not checked if setValue() is used.

void DzFileProperty::setType ( Number  type  ) 

Sets the file type.

Parameters:
type The new file type for the property. Must be one of the FileType values: FileSave, FileOpen, or Dir.


Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.