Declaration for the FBAssetMng class. More...

#include
<kaydaradef.h>

#include <fbsdk/fbcomponent.h>

Classes
class	FBAssetItem
	Base class for all managed assets. More...
class	FBAssetFile
	Class representing a file stored in a version control database. More...
class	FBAssetFolder
	Class representing a folder stored in a version control database. More...
class	FBAssetMng
	Used to access asset manager functionity to get files locally or from a server. More...
Defines
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FBRegisterAssetFile(UniqueNameStr, ClassName, Label, Desc, IconFilename)
	AssetFile class registration.
#define	FBAssetFileDeclare(ClassName, Parent)
	AssetFile class declaration.
#define	FBAssetFileImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	AssetFile class implementation.
#define	FBRegisterAssetFolder(UniqueNameStr, ClassName, Label, Desc, IconFilename)
	AssetFolder class registration.
#define	FBAssetFolderDeclare(ClassName, Parent)
	AssetFolder class declaration.
#define	FBAssetFolderImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	AssetFolder class implementation.
#define	FBRegisterAssetMng(UniqueNameStr, ClassName, Label, Desc, IconFilename)
	Asset manager class registration.
#define	FBAssetMngDeclare(ClassName, Parent)
	Asset manager class declaration.
#define	FBAssetMngImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Asset manager class implementation.
Enumerations
enum	FBAssetMngMenuOptions { kMenuOpenFromDatabase = 1<<0, kMenuAddToDatabase = 1<<1, kMenuUploadToDatabase = 1<<2, kMenuGetLatest = 1<<3, kMenuCheckIn = 1<<4, kMenuCheckOut = 1<<5, kMenuUndoCheckOut = 1<<6, kMenuShowHistory = 1<<7, kMenuShowProperties = 1<<8, kMenuShowExplorer = 1<<9, kMenuShowReferenceMng = 1<<10, kMenuShowSettings = 1<<11, kMenuEnable = 1<<12, kMenuFileAll = kMenuOpenFromDatabase \| kMenuAddToDatabase \| kMenuUploadToDatabase, kMenuSourceControlAll, kMenuSourceControlMin, kMenuAll = 0xFFFFFFFF }
	Show or hide version control menu items. More...
enum	FBAssetMngFileOptions { kFileCheckOutOnLoad = 1<<0, kFileCheckOutOnLoad_Ask = 1<<1, kFileUploadOnSave = 1<<2, kFileUploadOnSave_Ask = 1<<3, kFileAddOnNewSave = 1<<4, kFileAddOnNewSave_Ask = 1<<5, kFileCheckInOnClose = 1<<6, kFileCheckInOnClose_Ask = 1<<7, kFileOptionsAll = 0xFFFFFFFF }
	Behavior of the application when working with managed files. More...
Functions
	__FB_FORWARD (FBAssetItem)
	__FB_FORWARD (FBAssetFile)
	__FB_FORWARD (FBAssetFolder)
	__FB_FORWARD (FBAssetMng)
	FB_DEFINE_COMPONENT (FBSDK_DLL, AssetMng)

Detailed Description

Declaration for the FBAssetMng class.

Definition in file fbassetmng.h.

Define Documentation

#define FBSDK_DLL K_DLLIMPORT

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbassetmng.h.

#define FBRegisterAssetFile	(	UniqueNameStr,
		ClassName,
		Label,
		Desc,
		IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterAssetFile##ClassName( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->Name = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Asset/AssetItem/AssetFile",Label,Desc,RegisterAssetFile##ClassName, true, IconFilename );  \
    }

AssetFile class registration.

Parameters:

UniqueNameStr	Unique name.
ClassName	AssetFile class name.
Label	Short description.
Desc	Long description.
IconFilename	Name of the icon file to use.

Definition at line 153 of file fbassetmng.h.

#define FBAssetFileDeclare	(	ClassName,
		Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

AssetFile class declaration.

Parameters:

ClassName	AssetFile class name.
Parent	Class parent.

Definition at line 174 of file fbassetmng.h.

#define FBAssetFileImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Search for all occurrences

AssetFile class implementation.

Parameters:

ThisComponent Class to implement.

Definition at line 183 of file fbassetmng.h.

#define FBRegisterAssetFolder	(	UniqueNameStr,
		ClassName,
		Label,
		Desc,
		IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterAssetFolder##ClassName( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->Name = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Asset/AssetItem/AssetFolder",Label,Desc,RegisterAssetFolder##ClassName, true, IconFilename );  \
    }

AssetFolder class registration.

Parameters:

UniqueNameStr	Unique name.
ClassName	AssetFolder class name.
Label	Short description.
Desc	Long description.
IconFilename	Name of the icon file to use.

Definition at line 235 of file fbassetmng.h.

#define FBAssetFolderDeclare	(	ClassName,
		Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

AssetFolder class declaration.

Parameters:

ClassName	AssetFolder class name.
Parent	Class parent.

Definition at line 256 of file fbassetmng.h.

#define FBAssetFolderImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Search for all occurrences

AssetFolder class implementation.

Parameters:

ThisComponent Class to implement.

Definition at line 265 of file fbassetmng.h.

#define FBRegisterAssetMng	(	UniqueNameStr,
		ClassName,
		Label,
		Desc,
		IconFilename
	)

Search for all occurrences

Value:

HIObject RegisterAssetMng##ClassName( HIObject /*pOwner*/,char * pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->Name = UniqueNameStr; \
        Class->Description = Desc; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Asset/AssetMng",Label,Desc,RegisterAssetMng##ClassName, false, IconFilename ); \
    }

Asset manager class registration.

Parameters:

UniqueNameStr	Unique name.
ClassName	Asset manager class name.
Label	Short description.
Desc	Long description.
IconFilename	Name of the icon file to use.

Definition at line 339 of file fbassetmng.h.

#define FBAssetMngDeclare	(	ClassName,
		Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

Asset manager class declaration.

Parameters:

ClassName	Asset manager class name.
Parent	Class parent.

Definition at line 361 of file fbassetmng.h.

#define FBAssetMngImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Search for all occurrences

Asset manager class implementation.

Parameters:

ThisComponent Class to implement.

Definition at line 370 of file fbassetmng.h.

Enumeration Type Documentation

enum FBAssetMngMenuOptions

Search for all occurrences

Show or hide version control menu items.

Let you specify which functionalities will be available from the menus.

Enumerator:

kMenuOpenFromDatabase	File -> Open from database. Search for all occurrences
kMenuAddToDatabase	File -> Add to database. Search for all occurrences
kMenuUploadToDatabase	File -> Upload to database. Search for all occurrences
kMenuGetLatest	Version Control -> Get Latest. Search for all occurrences
kMenuCheckIn	Version Control -> Check In. Search for all occurrences
kMenuCheckOut	Version Control -> Check Out. Search for all occurrences
kMenuUndoCheckOut	Version Control -> Undo Check Out. Search for all occurrences
kMenuShowHistory	Version Control -> Show History. Search for all occurrences
kMenuShowProperties	Version Control -> Show Properties. Search for all occurrences
kMenuShowExplorer	Version Control -> Show Explorer. Search for all occurrences
kMenuShowReferenceMng	Version Control -> Show Reference Manager. Search for all occurrences
kMenuShowSettings	Version Control -> Show Settings. Search for all occurrences
kMenuEnable	Version Control -> Disable Version Control Integration. Search for all occurrences
kMenuFileAll	Support all elements from the File menu. Search for all occurrences
kMenuSourceControlAll	Support all elements from the Version Control menu. Search for all occurrences
kMenuSourceControlMin	Support only the basics functionalities. Search for all occurrences
kMenuAll	Support everything. Search for all occurrences

Definition at line 380 of file fbassetmng.h.

                                {   
    kMenuOpenFromDatabase   = 1<<0,     
    kMenuAddToDatabase      = 1<<1,     
    kMenuUploadToDatabase   = 1<<2,     
    kMenuGetLatest          = 1<<3,     
    kMenuCheckIn            = 1<<4,     
    kMenuCheckOut           = 1<<5,     
    kMenuUndoCheckOut       = 1<<6,     
    kMenuShowHistory        = 1<<7,     
    kMenuShowProperties     = 1<<8,     
    kMenuShowExplorer       = 1<<9,     
    kMenuShowReferenceMng   = 1<<10,    
    kMenuShowSettings       = 1<<11,    
    kMenuEnable             = 1<<12,    

    kMenuFileAll            = kMenuOpenFromDatabase | kMenuAddToDatabase | kMenuUploadToDatabase,

    kMenuSourceControlAll   = kMenuGetLatest | kMenuCheckIn | kMenuCheckOut | kMenuUndoCheckOut |
                              kMenuShowHistory | kMenuShowProperties | kMenuShowExplorer |
                              kMenuShowReferenceMng | kMenuShowSettings | kMenuEnable,

    kMenuSourceControlMin   =  kMenuGetLatest | kMenuCheckIn | kMenuCheckOut | kMenuUndoCheckOut |
                               kMenuShowSettings | kMenuEnable,

    kMenuAll                = 0xFFFFFFFF
};

enum FBAssetMngFileOptions

Search for all occurrences

Behavior of the application when working with managed files.

Enumerator:

kFileCheckOutOnLoad	Check out file automatically on load. Search for all occurrences
kFileCheckOutOnLoad_Ask	Ask for checkout on load. Search for all occurrences
kFileUploadOnSave	Upload file automatically on save. Search for all occurrences
kFileUploadOnSave_Ask	Ask for upload on save. Search for all occurrences
kFileAddOnNewSave	Add new file automatically on save. Search for all occurrences
kFileAddOnNewSave_Ask	Ask for adding new file on save. Search for all occurrences
kFileCheckInOnClose	Check in file automatically when closing it. Search for all occurrences
kFileCheckInOnClose_Ask	Ask for check in file when closing it. Search for all occurrences
kFileOptionsAll	Search for all occurrences

Definition at line 414 of file fbassetmng.h.

                            {
    kFileCheckOutOnLoad     = 1<<0,     
    kFileCheckOutOnLoad_Ask = 1<<1,     
    kFileUploadOnSave       = 1<<2,     
    kFileUploadOnSave_Ask   = 1<<3,     
    kFileAddOnNewSave       = 1<<4,     
    kFileAddOnNewSave_Ask   = 1<<5,     
    kFileCheckInOnClose     = 1<<6,     
    kFileCheckInOnClose_Ask = 1<<7,     
    kFileOptionsAll         = 0xFFFFFFFF
};