FBAssetFolder Class Reference

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

Inheritance diagram for FBAssetFolder:

[legend]

List of all members.

---

Detailed Description

Class representing a folder stored in a version control database.

Public Member Functions
	FBAssetFolder (str pName)
	Constructor.
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.
bool	FBCreate ()
	Open Reality Creation function.
FBAssetItem	GetChild (int pIndex)
	Get the child at index pIndex.
int	GetChildCount ()
	Get the number of items in this folder.
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.

---

Constructor & Destructor Documentation

FBAssetFolder

(

str

pName

)

Constructor.

Parameters:

pName

Name of Command.

---

Member Function Documentation

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:

	pLocalPath	The full path to the file on the local disk.
	pComment	Comment to be applied for the operation.
	pCheckOut	Whether the file should be checked out or not.
	pSilent	If pSilent is set to true, no dialog will be displayed by this method.

Returns:

An HFBAssetfile 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:

	pName	Name of the folder to be created.
	pComment	Comment to be applied for the operation.
	pSilent	If pSilent is set to true, no dialog will be displayed by this method.

Returns:

An HFBAssetFolder object representing the newly added folder.

bool FBCreate

(

)

Open Reality Creation function.

Returns:

Outcome of creation (true/false).

Reimplemented from FBComponent.

FBAssetItem GetChild

(

int

pIndex

)

Get the child at index pIndex.

Returns:

The child at pIndex, or NULL if the index was out of range.

int GetChildCount

(

)

Get the number of items in this folder.

Returns:

The number of items in this folder.

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.

---