Contains the user interface components for the SDK. More...

#include <kaydaradef.h>
#include <fbxsdk/fbxsdk_nsbegin.h>
#include <fbxsdk/fbxsdk_nsend.h>
#include <fbsdk/fbcomponent.h>

Classes
class	FBVisualComponent
	Visual Component base class. More...

struct	FBVisualComponent::__Region
	Region information structure. More...

struct	FBVisualComponent::__Region::__Ratio
	Structure for attachment ratio. More...

struct	FBVisualComponent::__Region::__AttachType
	Structure for attachment types. More...

struct	FBVisualComponent::__Region::__AttachTo
	Structure for attachment components. More...

struct	FBVisualComponent::__Region::__Pos
	Structure for absolute positions. More...

struct	FBVisualComponent::__Border
	Border information structure. More...

class	FBEventInput
	Input event class. More...

class	FBEventTransaction
	Transaction event. More...

class	FBEventDragAndDrop
	Drag and drop interface. More...

class	FBEventShow
	Show event class. More...

class	FBEventActivate
	Activation event. More...

class	FBEventExpose
	Event sent when a control needs to be displayed. More...

class	FBEventResize
	Event sent to a control that resizes. More...

class	FBEventMenu
	Menu event. More...

class	FBMenuItem
	Menu Item. More...

class	FBLayout
	Used to build the user interface. More...

class	FBTabPanel
	Tab panel. More...

class	FBButton
	Used to create and manage buttons in a user interface. More...

class	FBArrowButton
	Creates a button which opens a layout to display content. More...

class	FBScrollBox
	Scroll Box. More...

class	FBLabel
	Text label. More...

class	FBImageContainer
	Image. More...

class	FBEdit
	Text edit box. More...

class	FBEditNumber
	Number edit box. More...

class	FBEditColor
	Color edit widget. More...

class	FBEditVector
	Vector edit widget. More...

class	FBEventDblClick
	Input event class. More...

class	FBList
	List of items. More...

class	FBSlider
	Slider. More...

class	FBLayoutRegion
	Layout region. More...

class	FBThermometer
	Thermometer. More...

class	FBSpreadPart
	Spreadsheet part. More...

class	FBSpreadCell
	Spreadsheet cell. More...

class	FBSpreadRow
	Spreadsheet row. More...

class	FBSpreadColumn
	Spreadsheet column. More...

class	FBSpread
	Base spreadsheet class. More...

class	FBEventSpread
	Spreadsheet event. More...

class	FBVisualContainer
	Used to create a container for a tool UI. More...

class	FBEditTimeCode

class	FBEventTree
	FBTree node event. More...

class	FBEventTreeSelect
	FBTree selection event. More...

class	FBTreeNode
	A node in the tree view. More...

class	FBPropertyListTreeNode
	PropertyList of nodes in the tree view. More...

class	FBTree
	Tree list view. More...

class	FBView
	Generic view. More...

class	FBProgress
	Progress bar. More...

class	FBPopup
	Popup window. More...

class	FBFilePopup
	File Popup (for open/save). More...

class	FBFolderPopup
	Folder Popup (for selecting a directory). More...

class	FBMemo
	Multi-line text input. More...

class	FBWebView
	Web viewer. More...

class	FBFCurveEditor
	FCurve editor. More...

class	FBFCurveEditorEvent
	This class is used when receiving a callback about an interaction that the user has done in the FCurve Editor. More...

class	FBFCurveEditorUtility
	FBFCurveEditor Utility class Utility class allowing different operations on a FBFCurveEditor or on the main FCurveEditor. More...

class	FBPropertyConnectionEditor
	Property Connection Editor. More...

class	FBEditProperty
	Property editor widget. More...

class	FBEditPropertyModern
	Property editor widget. More...

class	FBBrowsingProperty
	Property browsing. More...

class	FBWidgetHolder
	Native Widget Holder (can be used to embed native Qt Widget inside MoBu UI elements) A Widget holder provides a bridge to instantiate a Native Qt widget into MB framework. More...

class	FBPlotPopup
	Plot Popup (for setting options only). More...

class	FBPropertyViewList
	FBProperty View List. More...

class	FBPropertyViewDefinition
	FBProperty View. More...

class	FBPropertyViewManager
	FBProperty View Manager. More...

Macros
#define	FBSDK_DLL K_DLLEXPORT
	FBSDKDLL_ K_DLLEXPORT.

#define	SPLIT_WIDTH 10
	SPLIT_WIDTH.

#define	FBRegisterControl(ClassName, Path, Label, Description, IconFilename)
	Register a control.

#define	FBMenuItemDeclare(ClassName, Parent)
	Menu Item class declaration.

#define	FBMenuItemImplementation(ClassName)
	Menu item class implementation.

#define	FBRegisterMenuItem(ClassName)
	Menu item registration.

#define	FBMenuItemActivation(ClassName)
	Menu item activation.

#define	FBMenuItemHandle(ClassName, Handle) Handle = ClassName::g##ClassName
	Get the handle of a menu item.

Enumerations
enum	FBOrientation { kFBHorizontal , kFBVertical }
	General directions for UI components. More...

enum	FBInputType { kFBKeyPress , kFBKeyRelease , kFBButtonPress , kFBButtonRelease , kFBMotionNotify , kFBButtonDoubleClick , kFBMouseEnter , kFBMouseLeave , kFBMouseWheelNotify , kFBDragging , kFBDropping , kFBKeyPressRaw , kFBKeyReleaseRaw , kFBUnknownInput }
	Types of input events. More...

enum	FBInputModifier { kFBKeyNone = 0 , kFBKeyShift = 1 << 0 , kFBKeyCtrl = 1 << 1 , kFBKeyAlt = 1 << 2 }
	Input Modifiers (Ctrl, Alt, Shift). More...

enum	FBInputKey { kFBKeyReturn = 0x0D , kFBKeyBackSpace = 0x08 , kFBKeyTab = 0x09 , kFBKeyEscape = 0x1B , kFBKeyPageUp = 0x121 , kFBKeyPageDown = 0x122 , kFBKeyEnd = 0x123 , kFBKeyHome = 0x124 , kFBKeyLeft = 0x125 , kFBKeyUp = 0x126 , kFBKeyRight = 0x127 , kFBKeyDown = 0x128 , kFBKeyIns = 0x12D , kFBKeyDel = 0x12E , kFBKeyF1 = 0x170 , kFBKeyF2 = 0x171 , kFBKeyF3 = 0x172 , kFBKeyF4 = 0x173 , kFBKeyF5 = 0x174 , kFBKeyF6 = 0x175 , kFBKeyF7 = 0x176 , kFBKeyF8 = 0x177 , kFBKeyF9 = 0x178 , kFBKeyF10 = 0x179 , kFBKeyF11 = 0x17A , kFBKeyF12 = 0x17B }
	Keyboard inputs. More...

enum	FBColorIndex { kFBColorIndexBackground , kFBColorIndexBackground1 , kFBColorIndexForeground , kFBColorIndexForeground1 , kFBColorIndexForeground2 , kFBColorIndexAlternate1 , kFBColorIndexAlternate2 , kFBColorIndexHighlight , kFBColorIndexShadow , kFBColorIndexWhite , kFBColorIndexBlack , kFBColorIndexLtGray , kFBColorIndexGray , kFBColorIndexDkGray , kFBColorIndexRed , kFBColorIndexGreen , kFBColorIndexBlue , kFBColorIndexStdButton1 , kFBColorIndexStdButton2 , kFBColorIndexFlatButtonActive1 , kFBColorIndexFlatButtonActive2 , kFBColorIndexFlatButtonPassive1 , kFBColorIndexFlatButtonPassive2 , kFBColorIndexStdCheckboxClear1 , kFBColorIndexStdCheckboxClear2 , kFBColorIndexStdCheckboxAmbig1 , kFBColorIndexStdCheckboxAmbig2 , kFBColorIndexStdCheckboxDisabled1 , kFBColorIndexStdCheckboxDisabled2 , kFBColorIndexStdField1 , kFBColorIndexStdField2 , kFBColorIndexStdScrollActive1 , kFBColorIndexStdScrollActive2 , kFBColorIndexStdScrollPassive1 , kFBColorIndexStdScrollPassive2 , kFBColorIndexStdScrollCursor , kFBColorIndexStdListBg1 , kFBColorIndexStdListBgSelected1 , kFBColorIndexStdListBgSelected2 , kFBColorIndexStdListBgFocusSelected1 , kFBColorIndexStdListText , kFBColorIndexStdListTextSelected , kFBColorIndexStdListTextDragover , kFBColorIndexStdListLine , kFBColorIndexStdTabActive1 , kFBColorIndexStdTabActive2 , kFBColorIndexStdTabPassive1 , kFBColorIndexStdTabPassive2 , kFBColorIndexFlatTabBg1 , kFBColorIndexFlatTabTextSelected , kFBColorIndexDisabled1 , kFBColorIndexDisabled2 , kFBColorIndexSelected , kFBColorIndexTimelineOutside , kFBColorIndexTimelineOutside1 , kFBColorIndexTimelineCenter , kFBColorIndexTimelineCenter1 , kFBColorIndexTimelineCenter2 , kFBColorIndexTimelineShadow , kFBColorIndexTimelineHighlight , kFBColorIndexTimelineManipulator , kFBColorIndexStdListBgFocusSelected2 , kFBColorIndexTreeBgTitle , kFBColorIndexTreeBgSubtitle , kFBColorIndexTreeBgSubtitleLine , kFBColorIndexTreeBgNode , kFBColorIndexTreeEditboxBg , kFBColorIndexTreeSplitter , kFBColorIndexTreeKeyingGroup , kFBColorIndexTreeOddRow , kFBColorIndexTreeSelect , kFBColorIndexTreeKeyingSelect , kFBColorIndexDkGreen , kFBColorIndexSize }
	FBColor. More...

enum	FBAttachType { kFBAttachLeft , kFBAttachRight , kFBAttachTop , kFBAttachBottom , kFBAttachWidth , kFBAttachHeight , kFBAttachCenter , kFBAttachNone }
	Types of attachments between UI regions. More...

enum	FBBorderStyle { kFBNoBorder , kFBStandardBorder , kFBEmbossBorder , kFBEmbossSmoothBorder , kFBEmbossEdgeSmoothBorder , kFBEmbossSmoothEdgeBorder , kFBStandardSmoothBorder , kFBStandardEdgeSmoothBorder , kFBStandardSmoothEdgeBorder , kFBHighlightBorder , kFBPickingBorder }
	Different border types available. More...

enum	FBDragAndDropState { kFBDragAndDropBegin , kFBDragAndDropDrag , kFBDragAndDropDrop , kFBDragAndDropEnd , kFBDragOnEmpty , kFBDragOnEmptyDrop }
	State of Drag and Drop. More...

enum	FBMenuItemType { kFBMenuItemMotionImport , kFBMenuItemSceneImport , kFBMenuItemMotionExport , kFBMenuItemSceneExport }
	Types of menu items available. More...

enum	FBButtonStyle { kFBPushButton , kFBBitmapButton , kFBRadioButton , kFB2States , kFBCheckbox =kFB2States , kFBBitmap2States }
	Style of buttons. More...

enum	FBButtonState { kFBButtonState0 , kFBButtonState1 }
	Possible button states. More...

enum	FBTextJustify { kFBTextJustifyLeft , kFBTextJustifyRight , kFBTextJustifyCenter }
	Text justification styles. More...

enum	FBTextStyle { kFBTextStyleNone = 0 , kFBTextStyleBold = 1 << 0 , kFBTextStyleItalic = 1 << 1 , kFBTextStyleUnderlined = 1 << 2 }
	Text appearance styles. More...

enum	FBButtonLook { kFBLookNormal , kFBLookColorChange , kFBLookPush , kFBLookFlat , kFBLookAlphaBackground =99 }
	Button look. More...

enum	FBListStyle { kFBDropDownList , kFBVerticalList }
	List style or direction. More...

enum	FBCellStyle { kFBCellStyleDefault , kFBCellStyleString , kFBCellStyleDouble , kFBCellStyleInteger , kFBCellStyleButton , kFBCellStyle2StatesButton , kFBCellStyle3StatesButton , kFBCellStyleMenu , kFBCellStyleVoid , kFBCellStyleView , kFBCellStyleTime }
	Different styles of spreadsheet cell styles. More...

enum	FBIconPosition { kFBIconLeft , kFBIconTop }
	Different icon positions possible. More...

enum	FBEventTreeWhy { kFBEventTreeExpand , kFBEventTreeCollapse , kFBEventTreeHideNode , kFBEventTreeUnhideNode }
	Tree node different event type. More...

enum	FBFilePopupStyle { kFBFilePopupOpen , kFBFilePopupSave }
	Different types of file popup windows. More...

enum	FBPopupInputType { kFBPopupBool , kFBPopupChar , kFBPopupString , kFBPopupInt , kFBPopupFloat , kFBPopupDouble , kFBPopupPassword }
	User input types for a popup. More...

enum	FBFCurveEditorEventType { kFBUnspecified , kFBGhostKeep , kFBGhostSwap , kFBGhostClear }
	This enum indicates what event happened in the FCurve Editor. More...

enum	FBPropertyViewType { kFBViewGlobal = 0 , kFBViewByObjectType , kFBViewByObject }
	Property view set type. More...

Functions
	K_FORWARD (IKtLayoutRegion)

	K_FORWARD (IKtObject)

	K_FORWARD (IKtView)

	FB_DEFINE_COMPONENT (K_DLLEXPORT, Layout)

	FB_DEFINE_COMPONENT (K_DLLEXPORT, VisualComponent)

	FB_DEFINE_COMPONENT (K_DLLEXPORT, View)

	FB_DEFINE_COMPONENT (K_DLLEXPORT, TreeNode)

	FB_DEFINE_ENUM (K_DLLEXPORT, Orientation)

	FB_DEFINE_ENUM (K_DLLEXPORT, InputType)

	FB_DEFINE_ENUM (K_DLLEXPORT, InputModifier)

	FB_DEFINE_ENUM (K_DLLEXPORT, InputKey)

	__FB_FORWARD (FBLayout)

	__FB_FORWARD (FBVisualComponent)

	FB_FORWARD (FBStringList)

	FB_DEFINE_COMPONENT (K_DLLEXPORT, FBVisualComponent)

	FB_DEFINE_ENUM (K_DLLEXPORT, AttachType)

	FB_DEFINE_ENUM (K_DLLEXPORT, BorderStyle)

	__FB_FORWARD (FBEventInput)

	__FB_FORWARD (FBEventTransaction)

	__FB_FORWARD (FBEventDragAndDrop)

	FB_DEFINE_ENUM (K_DLLEXPORT, DragAndDropState)

	__FB_FORWARD (FBEventShow)

	__FB_FORWARD (FBEventActivate)

	__FB_FORWARD (FBEventExpose)

	__FB_FORWARD (FBEventResize)

	__FB_FORWARD (FBEventMenu)

	__FB_FORWARD (FBMenuItem)

	FB_DEFINE_ENUM (K_DLLEXPORT, MenuItemType)

	__FB_FORWARD (FBTabPanel)

	__FB_FORWARD (FBButton)

	FB_DEFINE_ENUM (K_DLLEXPORT, ButtonStyle)

	FB_DEFINE_ENUM (K_DLLEXPORT, TextJustify)

	FB_DEFINE_ENUM (K_DLLEXPORT, TextStyle)

	FB_DEFINE_ENUM (K_DLLEXPORT, ButtonLook)

	__FB_FORWARD (FBArrowButton)

	__FB_FORWARD (FBScrollBox)

	__FB_FORWARD (FBLabel)

	__FB_FORWARD (FBImageContainer)

	__FB_FORWARD (FBEdit)

	__FB_FORWARD (FBEditNumber)

	__FB_FORWARD (FBEditColor)

	__FB_FORWARD (FBEditVector)

	__FB_FORWARD (FBEventDblClick)

	__FB_FORWARD (FBList)

	FB_DEFINE_ENUM (K_DLLEXPORT, ListStyle)

	__FB_FORWARD (FBSlider)

	__FB_FORWARD (FBLayoutRegion)

	__FB_FORWARD (FBThermometer)

	__FB_FORWARD (FBSpread)

	FB_DEFINE_ENUM (K_DLLEXPORT, CellStyle)

	__FB_FORWARD (FBSpreadPart)

	__FB_FORWARD (FBSpreadCell)

	__FB_FORWARD (FBSpreadRow)

	__FB_FORWARD (FBSpreadColumn)

	__FB_FORWARD (FBEventSpread)

	__FB_FORWARD (FBVisualContainer)

	__FB_FORWARD (FBImage)

	FB_DEFINE_ENUM (K_DLLEXPORT, IconPosition)

	__FB_FORWARD (FBEditTimeCode)

	__FB_FORWARD (FBTreeNode)

	__FB_FORWARD (FBTree)

	__FB_FORWARD (FBEventTree)

	FB_DEFINE_ENUM (K_DLLEXPORT, EventTreeWhy)

	__FB_FORWARD (FBEventTreeSelect)

	__FB_FORWARD (FBView)

	__FB_FORWARD (FBProgress)

	__FB_FORWARD (FBPopup)

	__FB_FORWARD (FBFilePopup)

	FB_DEFINE_ENUM (K_DLLEXPORT, FilePopupStyle)

	__FB_FORWARD (FBFolderPopup)

K_DLLEXPORT int	FBMessageBox (const char pBoxTitle, const char pMessage, const char pButton1Str, const char pButton2Str=NULL, const char *pButton3Str=NULL, int pDefaultButton=0, int pScrolledMessage=0)
	Dialog popup box.

K_DLLEXPORT int	FBMessageBoxWithCheck (const char pBoxTitle, const char pMessage, const char pButton1Str, const char pButton2Str, const char pButton3Str, const char pCheckBoxStr, bool &pCheckBoxValue, int pDefaultButton=0, int pScrolledMessage=0)
	Dialog popup box with a check box.

K_DLLEXPORT int	FBMessageBoxGetUserValue (const char pBoxTitle, const char pMessage, void pValue, FBPopupInputType pValueType, const char pButton1Str, const char pButton2Str=NULL, const char pButton3Str=NULL, int pDefaultButton=0, bool pLastButtonCancel=true)
	Dialog popup box to get user input.

	__FB_FORWARD (FBMemo)

	__FB_FORWARD (FBWebView)

	__FB_FORWARD (FBFCurveEditor)

	FB_DEFINE_ENUM (K_DLLEXPORT, FCurveEditorEventType)

	__FB_FORWARD (FBFCurveEditorUtility)

	__FB_FORWARD (FBPropertyConnectionEditor)

	__FB_FORWARD (FBEditProperty)

	__FB_FORWARD (FBEditPropertyModern)

	__FB_FORWARD (FBBrowsingProperty)

	__FB_FORWARD (FBWidgetHolder)

	FB_FORWARD (FBPlotOptions)

	__FB_FORWARD (FBPlotPopup)

	FB_FORWARD (FBPropertyViewList)

	FB_FORWARD (FBPropertyViewDefinition)

	__FB_FORWARD (FBPropertyViewManager)

Detailed Description

Contains the user interface components for the SDK.

All of the user interface elements available for use with the SDK are defined in this file. These elements (for the most part) derive from the FBVisualComponent base class and provide the functionality required to develop an interface for a plugin.

Definition in file fbcontrols.h.

Macro Definition Documentation

◆ FBMenuItemActivation

#define FBMenuItemActivation ( ClassName )

Value:

ClassName::g##ClassName = new ClassName; \

ClassName::g##ClassName->Activate()

Menu item activation.

Parameters

ClassName Menu item class to activate.

Definition at line 661 of file fbcontrols.h.

◆ FBMenuItemDeclare

#define FBMenuItemDeclare	(	ClassName,
		Parent
	)

Value:

    FBClassDeclare( ClassName,Parent ); \
public: \
    ClassName():Parent() { FBClassInit; FBCreate(); } \
    static ClassName* g##ClassName; \
private:

Menu Item class declaration.

Parameters

ClassName	Name of menu item class to declare.
Parent	Name of menu item class's parent class.

Definition at line 632 of file fbcontrols.h.

◆ FBMenuItemHandle

#define FBMenuItemHandle	(	ClassName,
		Handle
	)	Handle = ClassName::g##ClassName

Get the handle of a menu item.

Parameters

ClassName Menu item class to get a handle for.

Return values

Handle Handle to the menu item.

Definition at line 669 of file fbcontrols.h.

◆ FBMenuItemImplementation

#define FBMenuItemImplementation ( ClassName )

Value:

FBClassImplementation( ClassName ) \

ClassName* ClassName::g##ClassName = nullptr

FBClassImplementation

#define FBClassImplementation(Name)

Class implementation.

Definition fbdefines.h:71

Menu item class implementation.

Parameters

ClassName Menu item class to implement.

Definition at line 642 of file fbcontrols.h.

◆ FBRegisterControl

#define FBRegisterControl	(	ClassName,
		Path,
		Label,
		Description,
		IconFilename
	)

Value:

    HIObject RegisterControl##ClassName( HIObject /*pOwner*/,const char * /*pName*/,void * /*pData*/) \
{\
    ClassName *Class = new ClassName; \
    return Class->GetHIObject(); \
} \
    FBLibraryModule( ClassName )\
{\
    FBRegisterObject( ClassName,Path,Label,Description,RegisterControl##ClassName, true, IconFilename );\
    FBRegisterObject( ClassName##1,"FBSDK",Label,Description,RegisterControl##ClassName, true, IconFilename );\
}

Register a control.

Parameters

ClassName	Control class name to register.
Path	Internal path to store control.
Label	Short description of control.
Description	Long description of control.
IconFilename	Filename of associated icon.

Warning: The application path to specify is not a directory structure path.

Definition at line 92 of file fbcontrols.h.

◆ FBRegisterMenuItem

#define FBRegisterMenuItem ( ClassName )

Value:

    HIObject RegisterMenuItem##ClassName( HIObject /*pOwner*/,const char * /*pName*/,void * /*pData*/) \
{\
    return NULL;\
}\
    FBLibraryModule( ClassName )    \
{   \
}

Menu item registration.

Parameters

ClassName Menu item class to register.

Definition at line 649 of file fbcontrols.h.

◆ FBSDK_DLL

#define FBSDK_DLL K_DLLEXPORT

FBSDKDLL_ K_DLLEXPORT.

Definition at line 50 of file fbcontrols.h.

◆ SPLIT_WIDTH

#define SPLIT_WIDTH 10

SPLIT_WIDTH.

Definition at line 82 of file fbcontrols.h.

Enumeration Type Documentation

◆ FBAttachType

enum FBAttachType

Types of attachments between UI regions.

Enumerator
kFBAttachLeft	Attach to left [min(x1,x2)]
kFBAttachRight	Attach to right [max(x1,x2)]
kFBAttachTop	Attach to top [min(y1,y2)]
kFBAttachBottom	Attach to bottom [max(y1,y2)]
kFBAttachWidth	Attach to width [abs(x2-x1)]
kFBAttachHeight	Attach to height [abs(y2-y1)]
kFBAttachCenter	Attach to center [center(x1,y1,x2,y2)]
kFBAttachNone	No attachment.

Definition at line 281 of file fbcontrols.h.

◆ FBBorderStyle

enum FBBorderStyle

Different border types available.

Enumerator
kFBNoBorder	No border.
kFBStandardBorder	Standard border.
kFBEmbossBorder	Embossed border.
kFBEmbossSmoothBorder	Smooth border.
kFBEmbossEdgeSmoothBorder	Edged smooth border.
kFBEmbossSmoothEdgeBorder	Smoothed edges border.
kFBStandardSmoothBorder	Standard smooth border.
kFBStandardEdgeSmoothBorder	Standard edged smooth border.
kFBStandardSmoothEdgeBorder	Standard smoothed edges border.
kFBHighlightBorder	Highlight border.
kFBPickingBorder	Picking border.

Definition at line 294 of file fbcontrols.h.

◆ FBButtonLook

enum FBButtonLook

Button look.

Definition at line 1052 of file fbcontrols.h.

◆ FBButtonState

enum FBButtonState

Possible button states.

Currently, only two button states are possible.

Enumerator
kFBButtonState0	State is 0, usually meaning not active.
kFBButtonState1	State is 1, usually meaning active.

Definition at line 1025 of file fbcontrols.h.

◆ FBButtonStyle

enum FBButtonStyle

Style of buttons.

Warning: Not all button styles are completely functional.

Enumerator
kFBPushButton	Normal button.
kFBBitmapButton	Button with bitmap on it.
kFBRadioButton	Radio button.
kFB2States	2 state button (2 colors).
kFBCheckbox	Check box.
kFBBitmap2States	2 state button with 2 bitmaps.

Definition at line 1013 of file fbcontrols.h.

◆ FBCellStyle

enum FBCellStyle

Different styles of spreadsheet cell styles.

Enumerator
kFBCellStyleDefault	Default cell style.
kFBCellStyleString	String.
kFBCellStyleDouble	Double.
kFBCellStyleInteger	Integer.
kFBCellStyleButton	Button.
kFBCellStyle2StatesButton	2 state button.
kFBCellStyle3StatesButton	3 state button.
kFBCellStyleMenu	Menu.
kFBCellStyleVoid	Void (no value).
kFBCellStyleView	View (user definable, you need to specify the view using FBSpread::SetCellView()).
kFBCellStyleTime	Time.

Definition at line 1417 of file fbcontrols.h.

◆ FBColorIndex

enum FBColorIndex

FBColor.

Enumerator
kFBColorIndexBackground	Background color.
kFBColorIndexBackground1	Background 1 color.
kFBColorIndexForeground	Foreground color.
kFBColorIndexForeground1	Foreground 1 color.
kFBColorIndexForeground2	Foreground 2 color.
kFBColorIndexAlternate1	Alternate 1 color.
kFBColorIndexAlternate2	Alternate 2 color.
kFBColorIndexHighlight	Highlight color.
kFBColorIndexShadow	Shadow color.
kFBColorIndexWhite	White color.
kFBColorIndexBlack	Black color.
kFBColorIndexLtGray	Light Gray color.
kFBColorIndexGray	Gray color.
kFBColorIndexDkGray	Dark Gray color.
kFBColorIndexRed	Red color.
kFBColorIndexGreen	Green color.
kFBColorIndexBlue	Blue color.
kFBColorIndexStdButton1	Standard Button 1 color.
kFBColorIndexStdButton2	Standard Button 2 color.
kFBColorIndexFlatButtonActive1	Flat Button Active 1 color.
kFBColorIndexFlatButtonActive2	Flat Button Active 2 color.
kFBColorIndexFlatButtonPassive1	Flat Button Passive 1 color.
kFBColorIndexFlatButtonPassive2	Flat Button Passive 2 color.
kFBColorIndexStdCheckboxClear1	Standard Checkbox Clear 1 color.
kFBColorIndexStdCheckboxClear2	Standard Checkbox Clear 2 color.
kFBColorIndexStdCheckboxAmbig1	Standard Checkbox Ambig 1 color.
kFBColorIndexStdCheckboxAmbig2	Standard Checkbox Ambig 2 color.
kFBColorIndexStdCheckboxDisabled1	Standard Checkbox Disabled 1 color.
kFBColorIndexStdCheckboxDisabled2	Standard Checkbox Disabled 2 color.
kFBColorIndexStdField1	Standard Field 1 color.
kFBColorIndexStdField2	Standard Field 2 color.
kFBColorIndexStdScrollActive1	Standard Scroll Active 1 color.
kFBColorIndexStdScrollActive2	Standard Scroll Active 2 color.
kFBColorIndexStdScrollPassive1	Standard Scroll Passive 1 color.
kFBColorIndexStdScrollPassive2	Standard Scroll Passive 2 color.
kFBColorIndexStdScrollCursor	Standard Scroll Cursor color.
kFBColorIndexStdListBg1	Standard List Background 1 color.
kFBColorIndexStdListBgSelected1	Standard List Background Selected 1 color.
kFBColorIndexStdListBgSelected2	Standard List Background Selected 2 color.
kFBColorIndexStdListBgFocusSelected1	Standard List Background Focus Selected 1 color.
kFBColorIndexStdListText	Standard List Text color.
kFBColorIndexStdListTextSelected	Standard List Text Selected color.
kFBColorIndexStdListTextDragover	Standard List Text Dragover color.
kFBColorIndexStdListLine	Standard List Line color.
kFBColorIndexStdTabActive1	Standard Tab Active 1 color.
kFBColorIndexStdTabActive2	Standard Tab Active 1 color.
kFBColorIndexStdTabPassive1	Standard Tab Passive 1 color.
kFBColorIndexStdTabPassive2	Standard Tab Passive 1 color.
kFBColorIndexFlatTabBg1	Flat Tab Background 1 color.
kFBColorIndexFlatTabTextSelected	Flat Tab Text Selected color.
kFBColorIndexDisabled1	Disabled 1 color.
kFBColorIndexDisabled2	Disabled 2 color.
kFBColorIndexSelected	Selected color.
kFBColorIndexTimelineOutside	Timeline Outside color.
kFBColorIndexTimelineOutside1	Timeline Outside 1 color.
kFBColorIndexTimelineCenter	Timeline Center color.
kFBColorIndexTimelineCenter1	Timeline Center 1 color.
kFBColorIndexTimelineCenter2	Timeline Center 2 color.
kFBColorIndexTimelineShadow	Timeline Shadow color.
kFBColorIndexTimelineHighlight	Timeline Highlight color.
kFBColorIndexTimelineManipulator	Timeline Manipulator color.
kFBColorIndexTreeBgTitle	Tree Background Title color.
kFBColorIndexTreeBgSubtitle	Tree Background Subtitle color.
kFBColorIndexTreeBgSubtitleLine	Tree Background SubtitleLine color.
kFBColorIndexTreeBgNode	Tree Background Node color.
kFBColorIndexTreeEditboxBg	Tree Editbox Background color.
kFBColorIndexTreeSplitter	Tree Splitter color.
kFBColorIndexTreeKeyingGroup	Tree Keying Group color.
kFBColorIndexTreeOddRow	Tree Odd Row color.
kFBColorIndexTreeSelect	Tree Select color.
kFBColorIndexTreeKeyingSelect	Tree Keying Select color.
kFBColorIndexDkGreen	Dark Green color.
kFBColorIndexSize	Color Index Size color.

Definition at line 186 of file fbcontrols.h.

◆ FBDragAndDropState

enum FBDragAndDropState

State of Drag and Drop.

Enumerator
kFBDragAndDropBegin	Begin a drag and drop sequence.
kFBDragAndDropDrag	Dragging.
kFBDragAndDropDrop	Dropping.
kFBDragAndDropEnd	End of drag and drop.
kFBDragOnEmpty	Empty the drag and drop stack.
kFBDragOnEmptyDrop	Dropping empty stack.

Definition at line 498 of file fbcontrols.h.

◆ FBEventTreeWhy

enum FBEventTreeWhy

Tree node different event type.

Definition at line 1765 of file fbcontrols.h.

◆ FBFCurveEditorEventType

enum FBFCurveEditorEventType

This enum indicates what event happened in the FCurve Editor.

Enumerator
kFBUnspecified	Unspecified event.
kFBGhostKeep	Ghost Keep button pressed.
kFBGhostSwap	Ghost Swap button pressed.
kFBGhostClear	Ghost Clear button pressed.

Definition at line 2225 of file fbcontrols.h.

◆ FBFilePopupStyle

enum FBFilePopupStyle

Different types of file popup windows.

Enumerator
kFBFilePopupOpen	Open file popup (Shows 'Open Directory').
kFBFilePopupSave	Save file popup (Shows 'Save Directory').

Definition at line 2033 of file fbcontrols.h.

◆ FBIconPosition

enum FBIconPosition

Different icon positions possible.

Enumerator
kFBIconLeft	Icon on left of text.
kFBIconTop	Icon on top of text.

Definition at line 1681 of file fbcontrols.h.

◆ FBInputKey

enum FBInputKey

Keyboard inputs.

Enumerator
kFBKeyReturn	Return.
kFBKeyBackSpace	Backspace.
kFBKeyTab	Tab.
kFBKeyEscape	Escape.
kFBKeyPageUp	Page Up.
kFBKeyPageDown	Page Down.
kFBKeyEnd	End.
kFBKeyHome	Home.
kFBKeyLeft	Left.
kFBKeyUp	Up.
kFBKeyRight	Right.
kFBKeyDown	Down.
kFBKeyIns	Insert.
kFBKeyDel	Delete.
kFBKeyF1	F1.
kFBKeyF2	F2.
kFBKeyF3	F3.
kFBKeyF4	F4.
kFBKeyF5	F5.
kFBKeyF6	F6.
kFBKeyF7	F7.
kFBKeyF8	F8.
kFBKeyF9	F9.
kFBKeyF10	F10.
kFBKeyF11	F11.
kFBKeyF12	F12.

Definition at line 149 of file fbcontrols.h.

◆ FBInputModifier

enum FBInputModifier

Input Modifiers (Ctrl, Alt, Shift).

Enumerator
kFBKeyNone	No modifier.
kFBKeyShift	Shift was pressed.
kFBKeyCtrl	Control was pressed.
kFBKeyAlt	Alt was pressed.

Definition at line 141 of file fbcontrols.h.

◆ FBInputType

enum FBInputType

Types of input events.

Enumerator
kFBKeyPress	A keyboard key was pressed.
kFBKeyRelease	A keyboard key was released.
kFBButtonPress	A mouse button was pressed.
kFBButtonRelease	A mouse button was released.
kFBMotionNotify	The mouse has been moved.
kFBButtonDoubleClick	A mouse button was double clicked.
kFBMouseEnter	The mouse pointer is entering the window.
kFBMouseLeave	The mouse pointer is leaving the window.
kFBMouseWheelNotify	The mouse wheel has moved.
kFBDragging	The mouse is dragging items.
kFBDropping	The mouse is dropping items.
kFBKeyPressRaw	A keyboard key was pressed.
kFBKeyReleaseRaw	A keyboard key was released.
kFBUnknownInput	The internal event could not be translated.

Definition at line 123 of file fbcontrols.h.

◆ FBListStyle

enum FBListStyle

List style or direction.

Enumerator
kFBDropDownList	Drop down list.
kFBVerticalList	Vertical list.

Definition at line 1316 of file fbcontrols.h.

◆ FBMenuItemType

enum FBMenuItemType

Types of menu items available.

Enumerator
kFBMenuItemMotionImport	Motion Files->Import.
kFBMenuItemSceneImport	Scenes->Import.
kFBMenuItemMotionExport	Motion Files->Export.
kFBMenuItemSceneExport	Scenes->Export.

Definition at line 673 of file fbcontrols.h.

◆ FBOrientation

enum FBOrientation

General directions for UI components.

Enumerator
kFBHorizontal	Horizontal.
kFBVertical	Vertical

Definition at line 109 of file fbcontrols.h.

◆ FBPopupInputType

enum FBPopupInputType

User input types for a popup.

Enumerator
kFBPopupBool	Boolean input.
kFBPopupChar	Character input.
kFBPopupString	String input.
kFBPopupInt	Integer input.
kFBPopupFloat	Float input.
kFBPopupDouble	Double input.
kFBPopupPassword	Password input (String with '*'s).

Definition at line 2114 of file fbcontrols.h.

◆ FBPropertyViewType

enum FBPropertyViewType

Property view set type.

Enumerator
kFBViewGlobal	Global property view.
kFBViewByObjectType	Class type property view.
kFBViewByObject	Object property view.

Definition at line 2677 of file fbcontrols.h.

◆ FBTextJustify

enum FBTextJustify

Text justification styles.

Enumerator
kFBTextJustifyLeft	Left justify.
kFBTextJustifyRight	Right justify.
kFBTextJustifyCenter	Center alignment.

Definition at line 1033 of file fbcontrols.h.

◆ FBTextStyle

enum FBTextStyle

Text appearance styles.

Enumerator
kFBTextStyleNone	Normal.
kFBTextStyleBold	Bold.
kFBTextStyleItalic	Italic.
kFBTextStyleUnderlined	Underlined.

Definition at line 1042 of file fbcontrols.h.

Function Documentation

◆ FBMessageBox()

K_DLLEXPORT int FBMessageBox	(	const char *	pBoxTitle,
		const char *	pMessage,
		const char *	pButton1Str,
		const char *	pButton2Str = `NULL`,
		const char *	pButton3Str = `NULL`,
		int	pDefaultButton = `0`,
		int	pScrolledMessage = `0`
	)

Dialog popup box.

Opens a message box containing a message and up to three buttons. Waits for the user to click a button.

Parameters

pBoxTitle	Title of message box.
pMessage	Message to place in box.
pButton1Str	String for first button (Cannot be NULL).
pButton2Str	String for second button (NULL will not create a button).
pButton3Str	String for third button (NULL will not create a button).
pDefaultButton	Indicates the default (pre-selected) button (default is 0).
pScrolledMessage	Scroll message (default is 0).

Returns: The number of the button selected.

◆ FBMessageBoxGetUserValue()

K_DLLEXPORT int FBMessageBoxGetUserValue	(	const char *	pBoxTitle,
		const char *	pMessage,
		void *	pValue,
		FBPopupInputType	pValueType,
		const char *	pButton1Str,
		const char *	pButton2Str = `NULL`,
		const char *	pButton3Str = `NULL`,
		int	pDefaultButton = `0`,
		bool	pLastButtonCancel = `true`
	)

Dialog popup box to get user input.

Opens a message box, with up to three buttons, asking the user to enter data. The type of data to be entered is specified by the pValue and pValueType parameters.

Parameters

pBoxTitle	Title of message box.
pMessage	Message to place in box.

Return values

pValue Value entered by user (must correspond with pValueType).

Parameters

pValueType	Type of pointer specified in pValue.
pButton1Str	String for first button (Cannot be NULL).
pButton2Str	String for second button (NULL will not create a button).
pButton3Str	String for third button (NULL will not create a button).
pDefaultButton	Indicates the default (pre-selected) button(default=0).
pLastButtonCancel	Indicates the last button is Cancel (if more than one button) so pValue won't be updated if the last button is clicked.

Returns: The number of the button selected.

◆ FBMessageBoxWithCheck()

K_DLLEXPORT int FBMessageBoxWithCheck	(	const char *	pBoxTitle,
		const char *	pMessage,
		const char *	pButton1Str,
		const char *	pButton2Str,
		const char *	pButton3Str,
		const char *	pCheckBoxStr,
		bool &	pCheckBoxValue,
		int	pDefaultButton = `0`,
		int	pScrolledMessage = `0`
	)

Dialog popup box with a check box.

Opens a message box containing a message, up to three buttons and a check box. Waits for the user to click a button.

Parameters

pBoxTitle	Title of message box.
pMessage	Message to place in box.
pButton1Str	String for first button (Cannot be NULL).
pButton2Str	String for second button (NULL will not create a button).
pButton3Str	String for third button (NULL will not create a button).
pCheckBoxStr	Check box string (Cannot be NULL).

Return values

pCheckBoxValue Check box value.

Parameters

pDefaultButton	Indicates the default (pre-selected) button (default is 0).
pScrolledMessage	Scroll message (default is 0).

Returns: The number of the button selected.

Classes

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ FBMenuItemActivation

◆ FBMenuItemDeclare

◆ FBMenuItemHandle

◆ FBMenuItemImplementation

◆ FBRegisterControl

◆ FBRegisterMenuItem

◆ FBSDK_DLL

◆ SPLIT_WIDTH

Enumeration Type Documentation

◆ FBAttachType

◆ FBBorderStyle

◆ FBButtonLook

◆ FBButtonState

◆ FBButtonStyle

◆ FBCellStyle

◆ FBColorIndex

◆ FBDragAndDropState

◆ FBEventTreeWhy

◆ FBFCurveEditorEventType

◆ FBFilePopupStyle

◆ FBIconPosition

◆ FBInputKey

◆ FBInputModifier

◆ FBInputType

◆ FBListStyle

◆ FBMenuItemType

◆ FBOrientation

◆ FBPopupInputType

◆ FBPropertyViewType

◆ FBTextJustify

◆ FBTextStyle

Function Documentation

◆ FBMessageBox()

◆ FBMessageBoxGetUserValue()

◆ FBMessageBoxWithCheck()