DzContentFolder Class Reference

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

Inheritance diagram for DzContentFolder:

DzBase QObject Object List of all members.

Enumerations



enum  FolderType { NATIVE_TYPE, POSER_TYPE, IMPORT_TYPE }

Properties

Boolean canAddSubFolder
Boolean canDelete
Boolean canRename
Boolean filesAreLoaded
String folderName
Boolean foldersAreLoaded
FolderType folderType
String fullPath
Pixmap icon
Boolean isBuiltInContentFolder
String label

Methods

Boolean addSubFolder (String folderName)
Boolean canMoveFile (DzContentFile file)
Boolean copyFile (DzContentFile file)
Boolean deleteFolder ()
DzContentFile getFirstFile ()
DzContentFolder getFirstFolder ()
DzContentFile getFirstHiddenFile ()
DzContentFolder getFirstHiddenFolder ()
DzContentFolder getNext ()
DzContentFolder getParent ()
Boolean hasSubFolders ()
Boolean moveFile (DzContentFile file)
Boolean refresh (Boolean reloadIcons=false)
Boolean rename (String newName)

Signals

void addedFolder (DzContentFolder newFolder)
 Signature: "addedFolder(DzContentFolder*)"
void fileListChanged ()
 Signature: "fileListChanged()"
void folderListChanged ()
 Signature: "folderListChanged()"
void removedFolder (DzContentFolder folder)
 Signature: "removedFolder(DzContentFolder*)"

Detailed Description

Represents a folder in the content library.

Represents a folder in the content library that holds DzContentFile objects as well as other DzContentFolder objects.

See also:
DzContentMgr::getContentDirectory(), DzContentMgr::getImportDirectory(), DzContentMgr::getPoserDirectory(), DzContentMgr::findBaseDirectory()


Member Enumeration Documentation

enum DzContentFolder::FolderType

The possible types of content folders

Enumerator:
NATIVE_TYPE  Folder containing native content
POSER_TYPE  Folder containing Poser content
IMPORT_TYPE  Folder containing other importable content


Member Function Documentation

DzContentFolder::addedFolder ( DzContentFolder  newFolder  )  [signal]

Signature: "addedFolder(DzContentFolder*)"

Emitted when a new folder is added.

Parameters:
newFolder The folder that was added.

Boolean DzContentFolder::addSubFolder ( String  folderName  ) 

Adds a new subfolder with the given name to this folder.

Parameters:
folderName The name of the new sub folder.
Returns:
true if the new subfolder was created successfully.

Boolean DzContentFolder::canMoveFile ( DzContentFile  file  ) 

Returns:
true if the file is a type that can be moved or copied to this folder.
Parameters:
file The file to test for moving

Boolean DzContentFolder::copyFile ( DzContentFile  file  ) 

Copies the given content file to this folder.

Parameters:
file The file to copy to this folder.
Returns:
true if the file was copied successfully.

Boolean DzContentFolder::deleteFolder (  ) 

Removes this content folder. The default implementation of this function deletes all files and subfolders in this directory from the disk, so use with care!

Returns:
true if the file was removed successfully.

void DzContentFolder::fileListChanged (  )  [signal]

Signature: "fileListChanged()"

Emitted when the file list has changed.

void DzContentFolder::folderListChanged (  )  [signal]

Signature: "folderListChanged()"

Emitted when a folder is added or removed.

DzContentFile DzContentFolder::getFirstFile (  ) 

Returns:
First file in this folder.

DzContentFolder DzContentFolder::getFirstFolder (  ) 

Returns:
First sub-folder.

DzContentFile DzContentFolder::getFirstHiddenFile (  ) 

Returns:
First hidden file in this folder.

DzContentFolder DzContentFolder::getFirstHiddenFolder (  ) 

Returns:
First hidden folder.

DzContentFolder DzContentFolder::getNext (  ) 

Returns:
Next sibling folder.

DzContentFolder DzContentFolder::getParent (  ) 

Returns:
The current parent of this folder

Boolean DzContentFolder::hasSubFolders (  ) 

Returns:
True if this folder has subfolders, false otherwise.

Boolean DzContentFolder::moveFile ( DzContentFile  file  ) 

Moves the given content file to this folder.

Parameters:
file The file to move to this folder
Returns:
true if the file was moved successfully.

Boolean DzContentFolder::refresh ( Boolean  reloadIcons = false  ) 

Checks for changes in sub folders and files (if loaded).

Parameters:
reloadIcons If true, the icons will be reloaded from disk.
Returns:
true if a change in subfolders was found, and the tree needs to be reloaded.

DzContentFolder::removedFolder ( DzContentFolder  folder  )  [signal]

Signature: "removedFolder(DzContentFolder*)"

Emitted when a folder is removed.

Parameters:
folder The folder that was removed.

Boolean DzContentFolder::rename ( String  newName  ) 

Rename the folder to the given name.

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


Member Data Documentation

bool DzContentFolder::canAddSubFolder

Whether or not a sub folder can be added in this folder (Read Only)

bool DzContentFolder::canDelete

Whether or not this folder can be deleted (Read Only)

bool DzContentFolder::canRename

Whether or not this folder can be renamed (Read Only)

bool DzContentFolder::filesAreLoaded

Whether or not the files of this folder are loaded (Read Only)

String DzContentFolder::folderName

The name of the folder (Read Only)

bool DzContentFolder::foldersAreLoaded

Whether or not the subfolders of this folder are loaded (Read Only)

FolderType DzContentFolder::folderType

The type of the folder (Read Only)

String DzContentFolder::fullPath

The full path of the folder (Read Only)

Pixmap DzContentFolder::icon

The icon of the folder (Read Only)

bool DzContentFolder::isBuiltInContentFolder

Whether or not this folder is a built-in content folder (Read Only)

String DzContentFolder::label

The label of the folder as it is displayed to the user (Read Only)


Generated on Thu Sep 24 12:21:11 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.