Used to build the user interface. More...

#include <fbcontrols.h>

Inheritance diagram for FBLayout:

[legend]

Public Types
enum	FBSplitStyle { kFBNoSplit = 0, kFBHSplit = 1, kFBVSplit = 2, kFBHVSplit = 3 }
	Type of split style (sub-division) for layout. More...

Public Member Functions
	FBLayout (HIObject pObject=NULL)
	Constructor. More...

virtual bool	AddRegion (const char pName, const char pTitle, int pX, FBAttachType pXType, const char pXRelative, float pMultX, int pY, FBAttachType pYType, const char pYRelative, float pMultY, int pW, FBAttachType pWType, const char pWRelative, float pMultW, int pH, FBAttachType pHType, const char pHRelative, float pMultH)
	Add a region to the layout. More...

virtual bool	MoveRegion (const char *pName, int pX, int pY)
	Move a region. More...

virtual bool	SizeRegion (const char *pName, int pW, int pH)
	Change a region's size. More...

virtual bool	RemoveRegion (const char *pName)
	Remove a region. More...

virtual bool	RenameRegion (const char pOldName, const char pNewName)
	Rename a region. More...

virtual bool	GetRegion (const char *pName)
	Verify if a region with pName exists. More...

virtual bool	GetRegionPositions (const char pName, bool pComputed, int pX, int pY, int pW=NULL, int *pH=NULL)
	Get region pName information (position and size) More...

virtual bool	SetControl (const char pName, FBVisualComponent pComponent)
	Set control of a region to a visual component. More...

virtual bool	SetControl (const char *pName, FBVisualComponent &pComponent)

virtual void	ClearControl (const char *pName)
	Remove a control from a region in a visual component. More...

virtual FBVisualComponent *	GetControl (const char *pName)
	Get control of a region in a visual component. More...

virtual HIKtObject	GetHIKtObject (const char *pName)
	Set or Get internal toolkit: object. More...

virtual bool	SetHIKtView (const char *pName, HIKtView pView)
	Set internal toolkit view. More...

virtual HIKtView	GetHIKtView (const char *pName)
	Get internal toolkit view. More...

virtual bool	SetView (const char pName, FBVisualComponent pComponent)
	Set view. More...

virtual bool	SetView (const char *pName, FBVisualComponent &pComponent)

virtual bool	SetBorder (const char *pName, FBBorderStyle pType, bool pShowTitle, bool pInSet, int pWidth, int pSpacing, float pMaxAngle, int pCornerRadius)
	Set border properties for a region. More...

virtual bool	SetSplitStyle (const char *pName, FBSplitStyle pRegionType)
	Set a region's splitstyle. More...

virtual FBSplitStyle	GetSplitStyle (const char *pName)
	Get a region's splitstyle. More...

virtual bool	SetRegionTitle (const char pName, const char pTitle)
	Set a region's title. More...

void	SetAutoRestructure (bool pAutoRestructure)
	Suspend all automatic layout recomputation. More...

void	Restructure (bool pNoMove)
	Force a recomputation of all region placements in the layout. More...

	IObject_Declare (override)

Public Member Functions inherited from FBVisualComponent
	FBVisualComponent (HIObject pObject)
	Constructor. More...

	IObject_Declare (override)

	ICallback_Declare (override)

virtual HIKtView	GetKtView ()
	Get internal toolkit object. More...

QWidget *	GetQWidgetAddress ()
	Get internal QWidget. More...

virtual bool	AddChild (FBVisualComponent *pChild, int pId=0)
	Add a child component. More...

virtual FBVisualComponent *	GetChild (int pId=0)
	Get a child component. More...

virtual void	Refresh (bool pNow=false)
	Refresh component. More...

virtual void	ViewExpose ()
	Exposed view callback function. More...

virtual void	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function. More...

virtual bool	IsView ()
	Is component a view? More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyEvent	OnInput
	Event: Input. More...

FBPropertyEvent	OnPaint
	Event: Paint layout. More...

FBPropertyEvent	OnIdle
	Event: Idle. More...

FBPropertyEvent	OnShow
	Event: Show layout. More...

FBPropertyEvent	OnResize
	Event: Resize layout. More...

Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region	Region

struct K_DLLEXPORT FBVisualComponent::__Border	Border

FBPropertyString	Caption
	Property: Widget caption. More...

FBPropertyBool	Visible
	Read Write Property: Is visual component visible? More...

FBPropertyBool	ReadOnly
	Read Write Property: Is visual component read only? More...

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled? More...

FBPropertyString	Hint
	Read Write Property: Hint to show. More...

FBPropertyInt	Left
	Read Write Property: Left coordinate. More...

FBPropertyInt	Top
	Read Write Property: Top coordinate. More...

FBPropertyInt	Width
	Read Write Property: Width. More...

FBPropertyInt	Height
	Read Write Property: Height. More...

FBPropertyEvent	OnEnter
	Event: On mouse enter. More...

FBPropertyEvent	OnExit
	Event: On mouse exit. More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject	GetHIKtObject ()
	Get internal toolkit object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Used to build the user interface.

Layouts manage areas of the screen called regions. Regions contain UI components such as buttons, viewers, and edit boxes. Regions are added to layouts. When a UI component is bound to a region, the region defines how big it is and how it behaves when the layout is resized.

Types of Layouts

Device
Constraint
Manipulator
Shader

A region is first defined using the FBLayout::AddRegion() function. Once a region is defined and the corresponding UI component is created, and the component is bound to its region with FBLayout::SetControl(). You can use the FBSystem::OnUIIdle() in your layout to update real-time UI components such as guages and status indicators. In Python, FBBoxLayout and FBGridLayout take care of most of the region handling. They are used to create basic control layouts for simple tools. If you have a lot of content you can use FBScrollBox to manage it. For an example, see the Python sample Scrollbox.py.* Also see the Python sample Layout.py, and the C++ sample ortooluidemo.

Definition at line 781 of file fbcontrols.h.

Member Enumeration Documentation

◆ FBSplitStyle

enum FBSplitStyle

Type of split style (sub-division) for layout.

Enumerator
kFBNoSplit	No split.
kFBHSplit	Horizontal split.
kFBVSplit	Vertical split.
kFBHVSplit	Horizontal and Vertical split.

Definition at line 786 of file fbcontrols.h.

Constructor & Destructor Documentation

◆ FBLayout()

FBLayout ( HIObject pObject = NULL )

Constructor.

Member Function Documentation

◆ AddRegion()

virtual bool AddRegion	(	const char *	pName,
		const char *	pTitle,
		int	pX,
		FBAttachType	pXType,
		const char *	pXRelative,
		float	pMultX,
		int	pY,
		FBAttachType	pYType,
		const char *	pYRelative,
		float	pMultY,
		int	pW,
		FBAttachType	pWType,
		const char *	pWRelative,
		float	pMultW,
		int	pH,
		FBAttachType	pHType,
		const char *	pHRelative,
		float	pMultH
	)

virtual

Add a region to the layout.

Parameters

pName	Name of region.
pTitle	Title to display.
pX	X: Position.
pXType	X: Type of attachment.
pXRelative	X: Item to attach to.
pMultX	X: Multiplier of relative value.
pY	Y: Position.
pYType	Y: Type of attachment.
pYRelative	Y: Item to attach to.
pMultY	Y: Multiplier of relative value.
pW	W: Width of region.
pWType	W: Type of attachment.
pWRelative	W: Item to attach to.
pMultW	W: Multiplier of relative value.
pH	H: Height of region.
pHType	H: Type of attachment.
pHRelative	H: Item to attach to.
pMultH	H: Multiplier of relative value.

Returns: Operation was successful (true or false).

◆ ClearControl()

virtual void ClearControl ( const char * pName )

virtual

Remove a control from a region in a visual component.

Parameters

pName Name of region to remove control.

◆ GetControl()

virtual FBVisualComponent* GetControl ( const char * pName )

virtual

Get control of a region in a visual component.

Parameters

pName Name of region to find.

Returns: The component if it is found.

◆ GetHIKtObject()

virtual HIKtObject GetHIKtObject ( const char * pName )

virtual

Set or Get internal toolkit: object.

Parameters

pName Name of region.

Returns: Handle to internal toolkit object.

◆ GetHIKtView()

virtual HIKtView GetHIKtView ( const char * pName )

virtual

Get internal toolkit view.

◆ GetRegion()

virtual bool GetRegion ( const char * pName )

virtual

Verify if a region with pName exists.

Parameters

pName Name of region to check.

Returns: Operation was successful (true or false).

◆ GetRegionPositions()

virtual bool GetRegionPositions	(	const char *	pName,
		bool	pComputed,
		int *	pX,
		int *	pY,
		int *	pW = `NULL`,
		int *	pH = `NULL`
	)

virtual

Get region pName information (position and size)

Parameters

pName	Name of region.
pComputed	Is the information retrieved relative or absolute?

Return values

pX	Position in X of the region.
pY	Position in Y of the region.
pW	Width of the region.
pH	Height of the region.

Returns: Operation was successful (true or false).

◆ GetSplitStyle()

virtual FBSplitStyle GetSplitStyle ( const char * pName )

virtual

Get a region's splitstyle.

Parameters

pName Name of Region to get splitstyle from.

Returns: Split style of specified region.

◆ MoveRegion()

virtual bool MoveRegion	(	const char *	pName,
		int	pX,
		int	pY
	)

virtual

Move a region.

Parameters

pName	Name of region to move.
pX	New X position.
pY	New Y position.

Returns: Operation was successful (true or false).

◆ RemoveRegion()

virtual bool RemoveRegion ( const char * pName )

virtual

Remove a region.

Parameters

pName Name of region to remove.

Returns: Operation was successful (true or false).

◆ RenameRegion()

virtual bool RenameRegion	(	const char *	pOldName,
		const char *	pNewName
	)

virtual

Rename a region.

Parameters

pOldName	Region's old name.
pNewName	Region's new name.

Returns: Operation was successful (true or false).

◆ Restructure()

void Restructure ( bool pNoMove )

Force a recomputation of all region placements in the layout.

◆ SetAutoRestructure()

void SetAutoRestructure ( bool pAutoRestructure )

Suspend all automatic layout recomputation.

Parameters

pAutoRestructure If true, Suspend all automatic layout recomputation, else restore it.

◆ SetBorder()

virtual bool SetBorder	(	const char *	pName,
		FBBorderStyle	pType,
		bool	pShowTitle,
		bool	pInSet,
		int	pWidth,
		int	pSpacing,
		float	pMaxAngle,
		int	pCornerRadius
	)

virtual

Set border properties for a region.

Parameters

pName	Name of Region to change border properties.
pType	Border style to use.
pShowTitle	Show region title?
pInSet	Is region inset?
pWidth	Border width.
pSpacing	Border spacing.
pMaxAngle	Max angle for rounding.
pCornerRadius	Corner radius for rounding.

Returns: Operation was successful (true or false).

◆ SetControl()

virtual bool SetControl	(	const char *	pName,
		FBVisualComponent *	pComponent
	)

virtual

Set control of a region to a visual component.

Parameters

pName	Name of region to affect.
pComponent	Component to control region.

Returns: Operation was successful (true or false).

◆ SetHIKtView()

virtual bool SetHIKtView	(	const char *	pName,
		HIKtView	pView
	)

virtual

Set internal toolkit view.

Parameters

pName	Name of region.
pView	View to set as view for region.

Returns: Operation was successful (true or false).

◆ SetRegionTitle()

virtual bool SetRegionTitle	(	const char *	pName,
		const char *	pTitle
	)

virtual

Set a region's title.

Parameters

pName	Name of region to change title.
pTitle	New title for region.

Returns: Operation was successful (true or false).

◆ SetSplitStyle()

virtual bool SetSplitStyle	(	const char *	pName,
		FBSplitStyle	pRegionType
	)

virtual

Set a region's splitstyle.

Parameters

pName	Name of Region to set splitstyle.
pRegionType	Split style give to region.

Returns: Operation was successful (true or false).

◆ SetView()

virtual bool SetView	(	const char *	pName,
		FBVisualComponent *	pComponent
	)

virtual

Set view.

Parameters

pName	Name of Region.
pComponent	Component to set as view.

Returns: Operation was successful (true or false).

◆ SizeRegion()

virtual bool SizeRegion	(	const char *	pName,
		int	pW,
		int	pH
	)

virtual

Change a region's size.

Parameters

pName	Name of region to resize.
pW	New region width.
pH	New region height.

Returns: Operation was successful (true or false).

Member Data Documentation

◆ OnIdle

FBPropertyEvent OnIdle

Event: Idle.

Definition at line 978 of file fbcontrols.h.

◆ OnInput

FBPropertyEvent OnInput

Event: Input.

Definition at line 976 of file fbcontrols.h.

◆ OnPaint

FBPropertyEvent OnPaint

Event: Paint layout.

Definition at line 977 of file fbcontrols.h.

◆ OnResize

FBPropertyEvent OnResize

Event: Resize layout.

Definition at line 980 of file fbcontrols.h.

◆ OnShow

FBPropertyEvent OnShow

Event: Show layout.

Definition at line 979 of file fbcontrols.h.

The documentation for this class was generated from the following file:

fbcontrols.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FBSplitStyle

Constructor & Destructor Documentation

◆ FBLayout()

Member Function Documentation

◆ AddRegion()

◆ ClearControl()

◆ GetControl()

◆ GetHIKtObject()

◆ GetHIKtView()

◆ GetRegion()

◆ GetRegionPositions()

◆ GetSplitStyle()

◆ MoveRegion()

◆ RemoveRegion()

◆ RenameRegion()

◆ Restructure()

◆ SetAutoRestructure()

◆ SetBorder()

◆ SetControl()

◆ SetHIKtView()

◆ SetRegionTitle()

◆ SetSplitStyle()

◆ SetView()

◆ SizeRegion()

Member Data Documentation

◆ OnIdle

◆ OnInput

◆ OnPaint

◆ OnResize

◆ OnShow