fbtool.h File Reference

Declaration for the FBTool class. More...

#include <kaydaradef.h>
#include <fbcontrols/fbcontrols.h>

Go to the source code of this file.

Classes
class	FBTool
	Tool class. More...
Defines
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
#define	FBRegisterTool(ClassName, Label, Description, IconFilename)
	Register a tool.
#define	FBToolDeclare(ClassName, Parent)
	Tool class declaration.
#define	FBToolImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	Tool class implementation.
Enumerations
enum	FBToolPossibleDockPosition {   kFBToolPossibleDockPosNone = 0, kFBToolPossibleDockPosTop = (1 << 0), kFBToolPossibleDockPosLeft = (1 << 1), kFBToolPossibleDockPosRight = (1 << 2),   kFBToolPossibleDockPosBottom = (1 << 3) }
Functions
	FB_FORWARD (FBFbxObject)
	__FB_FORWARD (FBTool)

---

Detailed Description

Declaration for the FBTool class.

Definition in file fbtool.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 fbtool.h.

#define FBRegisterTool	(		ClassName,
			Label,
			Description,
			IconFilename
	)

Search for all occurrences

Value:

static HIObject RegisterTool##ClassName( HIObject pOwner,char * pName,void * pData) \
    {\
        ClassName *Class = new ClassName( Label ); \
        if( Class->FBCreate() ) {\
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"UI/Tools",Label,Description,RegisterTool##ClassName, false, IconFilename );\
    }

Register a tool.

Parameters:

ClassName	Name of tool class to register.
Label	Short description of tool.
Description	Long description of tool.
IconFilename	Filename of associated icon.

Definition at line 66 of file fbtool.h.

#define FBToolDeclare	(		ClassName,
			Parent
	)

Search for all occurrences

Value:

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

Tool class declaration.

Parameters:

ClassName	Name of tool class to declare.
Parent	Name of tool class parent class.

Definition at line 86 of file fbtool.h.

#define FBToolImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Search for all occurrences

Tool class implementation.

Parameters:

ThisComponent

Tool class to implement.

Definition at line 95 of file fbtool.h.

---

Enumeration Type Documentation

enum FBToolPossibleDockPosition

Search for all occurrences

Enumerator:

kFBToolPossibleDockPosNone	Search for all occurrences
kFBToolPossibleDockPosTop	Search for all occurrences
kFBToolPossibleDockPosLeft	Search for all occurrences
kFBToolPossibleDockPosRight	Search for all occurrences
kFBToolPossibleDockPosBottom	Search for all occurrences

Definition at line 101 of file fbtool.h.

{
    kFBToolPossibleDockPosNone = 0, 
    kFBToolPossibleDockPosTop = (1 << 0),   
    kFBToolPossibleDockPosLeft = (1 << 1),
    kFBToolPossibleDockPosRight = (1 << 2),
    kFBToolPossibleDockPosBottom = (1 << 3),
};

---

Function Documentation

FB_FORWARD

(

FBFbxObject

)

Search for all occurrences

__FB_FORWARD

(

FBTool

)

Search for all occurrences