Public Member Functions

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:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBAssetFolder (const char *pName, HIObject pObject=NULL)
 Constructor.
 IObject_Declare (K_IMPLEMENTATION)
virtual bool FBCreate ()
 Open Reality Creation function.
virtual int GetChildCount () const =0
 Get the number of items in this folder.
virtual FBAssetItemGetChild (int pIndex)=0
 Get the child at index pIndex.
virtual FBAssetFileGetFile (const FBString &pName)=0
 Get a file present in this folder by using it's name.
virtual FBAssetFolderGetFolder (const FBString &pName)=0
 Get a folder present in this folder by using it's name.
virtual FBAssetFileAddFile (const FBString &pLocalPath, const FBString &pComment="", bool pCheckOut=false, bool pSilent=false)=0
 Add a specified file into the database.
virtual FBAssetFolderAddFolder (const FBString &pName, const FBString &pComment="", bool pSilent=false)=0
 Add a folder in the database.

Constructor & Destructor Documentation

FBAssetFolder ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

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

Member Function Documentation

IObject_Declare ( K_IMPLEMENTATION  )
virtual bool FBCreate ( ) [virtual]

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented from FBComponent.

virtual int GetChildCount ( ) const [pure virtual]

Get the number of items in this folder.

Returns:
The number of items in this folder.
virtual FBAssetItem* GetChild ( int  pIndex) [pure virtual]

Get the child at index pIndex.

Returns:
The child at pIndex, or NULL if the index was out of range.
virtual FBAssetFile* GetFile ( const FBString pName) [pure virtual]

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 FBAssetFolder* GetFolder ( const FBString pName) [pure virtual]

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 FBAssetFile* AddFile ( const FBString pLocalPath,
const FBString pComment = "",
bool  pCheckOut = false,
bool  pSilent = false 
) [pure virtual]

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.
virtual FBAssetFolder* AddFolder ( const FBString pName,
const FBString pComment = "",
bool  pSilent = false 
) [pure virtual]

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.

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

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