fbtool.h File Reference

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

File Description

Declaration for the FBTool class.

Definition in file fbtool.h.

Classes
class	FBTool
	Tool class. More...

Namespaces
	ORSDK2018

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...
#define	FBRegisterTool(ClassName, Label, Description, IconFilename)
	Register a tool. More...
#define	FBToolDeclare(ClassName, Parent)
	Tool class declaration. More...
#define	FBToolImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	Tool class implementation. More...

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

Functions
bool	FBPopNormalTool (const char *pToolName, bool pSetFocus=true)
	This function is used to bring up a specific tool in the GUI. More...
FBTool *	FBShowToolByName (const char *pToolName, bool pResizeWnd=true)
	This function will show a specific tool in the GUI. More...
FBTool *	FBShowTool (FBTool *pTool, bool pResizeWnd=true)
	This function will show a specific tool in the GUI. More...
bool	FBCloseToolByName (const char *pToolName)
	This function will close a specific tool in the GUI. More...
bool	FBCloseTool (FBTool *pTool)
	This function will close a specific tool in the GUI. More...
void	FBDestroyToolByName (const char *pToolName)
	This function will destroy a specific tool in the GUI. More...
void	FBDestroyTool (FBTool *pTool)
	This function will destroy a specific tool in the GUI. More...
void	FBSetToolSizeByName (const char *pToolName, int pWidth, int pHeight)
	This function will set the size of a specific tool in the GUI. More...
void	FBSetToolSize (FBTool *pTool, int pWidth, int pHeight)
	This function will set the size of a specific tool in the GUI. More...
void	FBGetToolSizeByName (const char *pToolName, int &pWidth, int &pHeight)
	This function will get the size of a specific tool in the GUI. More...
void	FBGetToolSize (FBTool *pTool, int &pWidth, int &pHeight)
	This function will get the size of a specific tool in the GUI. More...
void	FBSetToolPositionByName (const char *pToolName, int pPosX, int pPosY)
	This function will set the position of a specific tool. More...
void	FBSetToolPosition (FBTool *pTool, int pPosX, int pPosY)
	This function will set the position of a specific tool. More...
void	FBGetToolPositionByName (const char *pToolName, int &pPosX, int &pPosY)
	This function will get the position of a specific tool. More...
void	FBGetToolPosition (FBTool *pTool, int &pPosX, int &pPosY)
	This function will get the position of a specific tool. More...

Macro Definition Documentation

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

Value:

static HIObject RegisterTool##ClassName( HIObject pOwner,const 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.

Examples:

Definition at line 66 of file fbtool.h.

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbtool.h.

#define FBToolDeclare	(		ClassName,
			Parent
	)

Value:

FBClassDeclare( ClassName,Parent ); \
public: \
    ClassName(const 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.

Examples:

Definition at line 86 of file fbtool.h.

#define FBToolImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Tool class implementation.

Parameters

ThisComponent

Tool class to implement.

Examples:

Definition at line 95 of file fbtool.h.

Go to the source code of this file.