FBAssetFolder Class Reference

Search for all occurrences

---

Detailed Description

Class representing a folder stored in a version control database.

Definition at line 273 of file fbassetmng.h.

#include <fbassetmng.h>

Inheritance diagram for FBAssetFolder:

List of all members.

Public Member Functions
	FBAssetFolder (char *pName, HIObject pObject=NULL)
	Constructor.
	IObject_Declare (Implementation)
virtual bool	FBCreate ()
	Open Reality Creation function.
virtual int	GetChildCount () const =0
	Get the number of items in this folder.
virtual HFBAssetItem	GetChild (int pIndex)=0
	Get the child at index pIndex.
virtual HFBAssetFile	GetFile (const FBString &pName)=0
	Get a file present in this folder by using it's name.
virtual HFBAssetFolder	GetFolder (const FBString &pName)=0
	Get a folder present in this folder by using it's name.
virtual HFBAssetFile	AddFile (const FBString &pLocalPath, const FBString &pComment="", bool pCheckOut=false, bool pSilent=false)=0
	Add a specified file into the database.
virtual HFBAssetFolder	AddFolder (const FBString &pName, const FBString &pComment="", bool pSilent=false)=0
	Add a folder in the database.

---

Constructor & Destructor Documentation

FBAssetFolder	(	char *	pName,
		HIObject	pObject = NULL
	)

Constructor.

Parameters:

pName	Name of Command.
pObject	Internal parent object to own FBComponent (default is NULL).

---

Member Function Documentation

IObject_Declare

(

Implementation

)

Search for all occurrences

Reimplemented from FBComponent.

virtual bool FBCreate

(

)

[virtual]

Search for all occurrences

Open Reality Creation function.

Returns:

Outcome of creation (true/false).

Reimplemented from FBComponent.

virtual int GetChildCount

(

)

const [pure virtual]

Search for all occurrences

Get the number of items in this folder.

Returns:

The number of items in this folder.

virtual HFBAssetItem GetChild

(

int

pIndex

)

[pure virtual]

Search for all occurrences

Get the child at index pIndex.

Returns:

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

virtual HFBAssetFile GetFile

(

const FBString &

pName

)

[pure virtual]

Search for all occurrences

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.

virtual HFBAssetFolder GetFolder

(

const FBString &

pName

)

[pure virtual]

Search for all occurrences

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.

virtual HFBAssetFile AddFile	(	const FBString &	pLocalPath,
		const FBString &	pComment = "",
		bool	pCheckOut = false,
		bool	pSilent = false
	)		[pure virtual]

Search for all occurrences

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.

virtual HFBAssetFolder AddFolder	(	const FBString &	pName,
		const FBString &	pComment = "",
		bool	pSilent = false
	)		[pure virtual]

Search for all occurrences

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.

---

The documentation for this class was generated from the following file:

• fbsdk/fbassetmng.h