fbcontrols/fbcontrols.h File Reference

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

File 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.

Namespaces

 ORSDK2019
 

Macros

#define FBSDK_DLL   K_DLLEXPORT
 FBSDKDLL_ K_DLLEXPORT. More...
 
#define SPLIT_WIDTH   10
 SPLIT_WIDTH. More...
 
#define FBRegisterControl(ClassName, Path, Label, Description, IconFilename)
 Register a control. More...
 
#define FBMenuItemDeclare(ClassName, Parent)
 Menu Item class declaration. More...
 
#define FBMenuItemImplementation(ClassName)
 Menu item class implementation. More...
 
#define FBRegisterMenuItem(ClassName)
 Menu item registration. More...
 
#define FBMenuItemActivation(ClassName)
 Menu item activation. More...
 
#define FBMenuItemHandle(ClassName, Handle)   Handle = ClassName::g##ClassName
 Get the handle of a menu item. More...
 

Typedefs

typedef IKtLayoutRegion * HIKtLayoutRegion
 
typedef IKtObject * HIKtObject
 
typedef IKtView * HIKtView
 

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 }
 FCurve editor. More...
 
enum  FBPropertyViewType { kFBViewGlobal = 0, kFBViewByObjectType, kFBViewByObject }
 Property view set type. More...
 

Functions

class __attribute__ ((visibility("default"))) FBPropertyListTreeNode
 FBTree selection event. More...
 

Variables

class kFBPT_object FBPropertyBaseLayout
 
class kFBPT_object FBPropertyBaseVisualComponent
 
class kFBPT_object FBPropertyBaseView
 
class kFBPT_object FBPropertyBaseTreeNode
 
class kFBPT_object FBPropertyBaseFBVisualComponent
 
class __attribute__((visibility("default"))) FBFolderPopup const char * pMessage
 
class __attribute__((visibility("default"))) FBFolderPopup const char const char * pButton1Str
 
class __attribute__((visibility("default"))) FBFolderPopup const char const char const char * pButton2Str = ((void *)0)
 
class __attribute__((visibility("default"))) FBFolderPopup const char const char const char const char * pButton3Str = ((void *)0)
 
class __attribute__((visibility("default"))) FBFolderPopup const char const char const char const char int pDefaultButton =0
 
class __attribute__((visibility("default"))) FBFolderPopup const char const char const char const char int int pScrolledMessage =0)
 
const char const char const char const char const char * pCheckBoxStr
 
const char const char const char const char const char boolpCheckBoxValue
 
const char void * pValue
 
const char void FBPopupInputType pValueType
 
const char void FBPopupInputType const char const char const char int bool pLastButtonCancel = true )
 

Macro Definition Documentation

#define FBMenuItemActivation (   ClassName)
Value:
ClassName::g##ClassName = new ClassName; \
ClassName::g##ClassName->Activate()

Menu item activation.

Parameters
ClassNameMenu item class to activate.
+ Examples:

Definition at line 661 of file fbcontrols.h.

#define FBMenuItemDeclare (   ClassName,
  Parent 
)
Value:
FBClassDeclare( ClassName,Parent ); \
public: \
ClassName():Parent() { FBClassInit; FBCreate(); } \
static ClassName* g##ClassName; \
private:
#define FBClassInit
Class initialization.
Definition: fbdefines.h:64
#define FBClassDeclare(Name, Parent)
Class declaration.
Definition: fbdefines.h:85

Menu Item class declaration.

Parameters
ClassNameName of menu item class to declare.
ParentName of menu item class's parent class.
+ Examples:

Definition at line 632 of file fbcontrols.h.

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

Get the handle of a menu item.

Parameters
ClassNameMenu item class to get a handle for.
Return values
HandleHandle to the menu item.
+ Examples:

Definition at line 669 of file fbcontrols.h.

#define FBMenuItemImplementation (   ClassName)
Value:
FBClassImplementation( ClassName ) \
ClassName* ClassName::g##ClassName = nullptr
#define FBClassImplementation(Name)
Class implementation.
Definition: fbdefines.h:71

Menu item class implementation.

Parameters
ClassNameMenu item class to implement.
+ Examples:

Definition at line 642 of file fbcontrols.h.

#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
ClassNameControl class name to register.
PathInternal path to store control.
LabelShort description of control.
DescriptionLong description of control.
IconFilenameFilename of associated icon.
Warning
The application path to specify is not a directory structure path.

Definition at line 92 of file fbcontrols.h.

#define FBRegisterMenuItem (   ClassName)
Value:
HIObject RegisterMenuItem##ClassName( HIObject /*pOwner*/,const char * /*pName*/,void * /*pData*/) \
{\
return NULL;\
}\
FBLibraryModule( ClassName ) \
{ \
}
#define NULL
Definition: kaydara.h:179

Menu item registration.

Parameters
ClassNameMenu item class to register.
+ Examples:

Definition at line 649 of file fbcontrols.h.

#define FBSDK_DLL   K_DLLEXPORT

FBSDKDLL_ K_DLLEXPORT.

Definition at line 50 of file fbcontrols.h.

#define SPLIT_WIDTH   10

SPLIT_WIDTH.

Definition at line 82 of file fbcontrols.h.

Typedef Documentation

typedef IKtLayoutRegion* HIKtLayoutRegion

Definition at line 61 of file fbcontrols.h.

typedef IKtObject* HIKtObject

Definition at line 62 of file fbcontrols.h.

typedef IKtView* HIKtView

Definition at line 63 of file fbcontrols.h.

Go to the source code of this file.