FBAssetFolder Class Reference


Detailed Description

Class representing a folder stored in a version control database.

Inheritance diagram for FBAssetFolder:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 IObject_Declare (K_IMPLEMENTATION)
bool FBCreate ()
 Open Reality Creation function.
int GetChildCount ()
 Get the number of items in this folder.
FBAssetItem GetChild (int pIndex)
 Get the child at index pIndex.
FBAssetFile GetFile (str pName)
 Get a file present in this folder by using it's name.
FBAssetFolder GetFolder (str pName)
 Get a folder present in this folder by using it's name.
FBAssetFile AddFile (str pLocalPath, str pComment="", bool pCheckOut=False, bool pSilent=False)
 Add a specified file into the database.
FBAssetFolder AddFolder (str pName, str pComment="", bool pSilent=False)
 Add a folder in the database.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of Command.
pObjectInternal parent object to own FBComponent (default is NULL).

Reimplemented from FBAssetItem.

IObject_Declare ( K_IMPLEMENTATION  )
bool FBCreate ( )

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

int GetChildCount ( )

Get the number of items in this folder.

Returns:
The number of items in this folder.
FBAssetItem GetChild ( int  pIndex)

Get the child at index pIndex.

Returns:
The child at pIndex, or NULL if the index was out of range.
FBAssetFile GetFile ( str  pName)

Get a file present in this folder by using it's name.

Returns:
The file with the given name, or NULL if it was not found.
FBAssetFolder GetFolder ( str  pName)

Get a folder present in this folder by using it's name.

Returns:
The folder with the given name, or NULL if it was not found.
FBAssetFile AddFile ( str  pLocalPath,
str  pComment = "",
bool  pCheckOut = False,
bool  pSilent = False 
)

Add a specified file into the database.

It will be added in this folder.

Parameters:
pLocalPathThe full path to the file on the local disk.
pCommentComment to be applied for the operation.
pCheckOutWhether the file should be checked out or not.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns:
An FBAssetfile* object representing the newly added file.
FBAssetFolder AddFolder ( str  pName,
str  pComment = "",
bool  pSilent = False 
)

Add a folder in the database.

It will be added in this folder.

Parameters:
pNameName of the folder to be created.
pCommentComment to be applied for the operation.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns:
An FBAssetFolder* object representing the newly added folder.

FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder
FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder FBAssetFolder