DzContentFile Class Reference
[Content Access Objects]

Represents a file in the content library. More...

Inheritance diagram for DzContentFile:

QObject DzRefCountedItem Object List of all members.

Properties

Boolean canDelete
Boolean canRename
String companionPath
String fullPath
Boolean hasCompanionScript
Pixmap icon
Boolean isNative
Boolean isScript
String label
String name
Pixmap smallIcon

Methods

Boolean deleteFile ()
DzContentFolder getFolder ()
DzContentFile getNext ()
void reloadIcon ()
Boolean rename (String newName)

Detailed Description

Represents a file in the content library.

Represents a file in the content library that can be loaded/imported. Also provides functionality for moving the file to a new location, renaming the file, and deleting the file from the library.

See also:
DzContentFolder


Member Function Documentation

bool DzContentFile::deleteFile (  ) 

Removes this file from its content folder. The default implementation of this function deletes the content file and any associated thumbnail image from the disk, so use with care!

Returns:
true if the file was removed successfully.

DzContentFolder DzContentFile::getFolder (  ) 

Returns:
The current parent folder of this file

DzContentFile DzContentFile::getNext (  ) 

Returns:
The current parent folder of this file

void DzContentFile::reloadIcon (  ) 

Force the file to reload its icon.

bool DzContentFile::rename ( String  newName  ) 

Rename the file to the given name.

Parameters:
name The new name for the file.
Returns:
true if the file was successfully renamed.


Member Data Documentation

bool DzContentFile::canDelete

Whether or not the file can be deleted (Read Only)

bool DzContentFile::canRename

Whether or not the file can be renamed (Read Only)

DzContentFile::companionPath

The path of the companion script for non-native files (Read Only)

DzContentFile::fullPath

The full path of the file (Read Only)

bool DzContentFile::hasCompanionScript

Whether or not a non-native file has a companion DAZ Script file (Read Only)

DzContentFile::icon

The icon for the file (Read Only)

bool DzContentFile::isNative

Whether or not the file is a DAZ Studio native content file (Read Only)

bool DzContentFile::isScript

Whether or not the file is a DAZ Script file (Read Only)

DzContentFile::label

The label of the file, as displayed to the user (Read Only)

DzContentFile::name

The name of the file (Read Only)

Reimplemented from QObject.

DzContentFile::smallIcon

The small icon for the file (Read Only)


Generated on Thu Sep 24 12:21:11 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.