#include <mobu-python-api.h>

Class Description

Tool class.

Inheritance diagram for FBTool:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1, str arg2, object arg3)

	SetPossibleDockPosition (FBTool arg1, FBToolPossibleDockPosition arg2)
	Set the possible docking position for the tool. More...

FBToolPossibleDockPosition	GetPossibleDockPosition (FBTool arg1)
	Get the possible docking position for the tool (concatenated). More...

Public Member Functions inherited from FBLayout
	__reduce__ ()

bool	AddRegion (FBLayout arg1, str arg2, str arg3, FBAddRegionParam arg4, FBAddRegionParam arg5, FBAddRegionParam arg6, FBAddRegionParam arg7)
	Add a region to the layout. More...

	__init__ (object arg1)
	Constructor. More...

bool	GetRegion (FBLayout arg1, str arg2)
	Verify if a region with pName exists. More...

bool	GetRegionPositions (FBLayout arg1, str arg2, object arg3, object arg4, object arg5, object arg6, object arg7)
	Get region pName information (position and size) More...

FBSplitStyle	GetSplitStyle (FBLayout arg1, str arg2)
	Get a region's splitstyle. More...

bool	MoveRegion (FBLayout arg1, str arg2, object arg3, object arg4)
	Move a region. More...

bool	RemoveRegion (FBLayout arg1, str arg2)
	Remove a region. More...

bool	RenameRegion (FBLayout arg1, str arg2, str arg3)
	Rename a region. More...

bool	SetBorder (FBLayout arg1, str arg2, FBBorderStyle arg3, object arg4, object arg5, object arg6, object arg7, float arg8, object arg9)
	Set border properties for a region. More...

bool	SetControl (FBLayout arg1, str arg2, FBVisualComponent arg3)

bool	SetRegionTitle (FBLayout arg1, str arg2, str arg3)
	Set a region's title. More...

bool	SetSplitStyle (FBLayout arg1, str arg2, FBSplitStyle arg3)
	Set a region's splitstyle. More...

bool	SetView (FBLayout arg1, str arg2, FBVisualComponent arg3)

bool	SizeRegion (FBLayout arg1, str arg2, object arg3, object arg4)
	Change a region's size. More...

	ClearControl (FBLayout arg1, str arg2)
	Remove a control from a region in a visual component. More...

object	GetControl (FBLayout arg1, str arg2)
	Get control of a region in a visual component. More...

	SetAutoRestructure (FBLayout arg1, object arg2)
	Suspend all automatic layout recomputation. More...

	Restructure (FBLayout arg1, object arg2)
	Force a recomputation of all region placements in the layout. More...

Public Member Functions inherited from FBVisualComponent
	__reduce__ ()

bool	AddChild (FBVisualComponent arg1, FBVisualComponent arg2, object arg3)
	Add a child component. More...

object	GetChild (FBVisualComponent arg1, object arg2)
	Get a child component. More...

bool	IsView (FBVisualComponent arg1)
	Is component a view? More...

	Refresh (FBVisualComponent arg1, object arg2)
	Refresh component. More...

	ViewExpose (FBVisualComponent arg1)
	Exposed view callback function. More...

	ViewInput (FBVisualComponent arg1, object arg2, object arg3, FBInputType arg4, object arg5, object arg6)
	Input callback function. More...

int	GetQWidgetAddress (FBVisualComponent arg1)
	Get internal QWidget. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

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

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

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

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

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

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

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

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

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

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

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
object	StartSizeX

object	StartSizeY

object	MinSizeX

object	MinSizeY

object	MaxSizeX

object	MaxSizeY

object	StartPosX

object	StartPosY

object	ToolName

Public Attributes inherited from FBLayout
ORSDK2018::FBPropertyEvent	OnIdle
	Event: Idle. More...

ORSDK2018::FBPropertyEvent	OnPaint
	Event: Paint layout. More...

ORSDK2018::FBPropertyEvent	OnResize
	Event: Resize layout. More...

ORSDK2018::FBPropertyEvent	OnShow
	Event: Show layout. More...

ORSDK2018::FBPropertyEvent	OnInput
	Event: Input. More...

Public Attributes inherited from FBVisualComponent
ORSDK2018::FBPropertyString	Caption
	Property: Widget caption. More...

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

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

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

FBPropertyBool	Visible
	Read Write Property: Is visual component visible? 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...

object	RegionName

object	RegionOffsetX

object	RegionOffsetY

object	RegionOffsetWidth

object	RegionOffsetHeight

object	RegionRatioX

object	RegionRatioY

object	RegionRatioWidth

object	RegionRatioHeight

object	RegionAttachTypeX

object	RegionAttachTypeY

object	RegionAttachTypeWidth

object	RegionAttachTypeHeight

object	RegionAttachToX

object	RegionAttachToY

object	RegionAttachToWidth

object	RegionAttachToHeight

object	RegionPosMinX

object	RegionPosMaxX

object	RegionPosMinY

object	RegionPosMaxY

object	BorderCaption

object	BorderShowCaption

object	BorderStyle

object	BorderWidth

object	BorderSpacing

object	BorderInSet

object	BorderMaxAngle

object	BorderCornerRadius

Public Attributes inherited from FBComponent
object	OwnerNamespace

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

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

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

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

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2,
		object	arg3
	)

Python Docstring:

__init__( (object)arg1, (str)arg2 [, (object)arg3]) -> None

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBTool(const char * pName = ((void *) 0))
 FBTool(const char * pName, bool pRegisterTool)

__reduce__ ( )

FBToolPossibleDockPosition GetPossibleDockPosition ( FBTool arg1 )

Get the possible docking position for the tool (concatenated).

Python Docstring:

GetPossibleDockPosition( (FBTool)arg1) -> FBToolPossibleDockPosition

C++ Signature:

FBToolPossibleDockPosition GetPossibleDockPosition()

Returns: Get all the docking flags in one call. Flags can be concatenated.

See the C++ reference

SetPossibleDockPosition	(	FBTool	arg1,
		FBToolPossibleDockPosition	arg2
	)

Set the possible docking position for the tool.

Python Docstring:

SetPossibleDockPosition( (FBTool)arg1, (FBToolPossibleDockPosition)arg2) -> None

C++ Signature:

void SetPossibleDockPosition(FBToolPossibleDockPosition pFlags)

Be sure to call this function once the tool is visible, a good place to call it is when the OnShow event of the layout is called.

Parameters

pFlags Set the docking position flag values. Note: this function overwrites all flags with those passed in parameter.

See the C++ reference

Member Data Documentation

MaxSizeX

Read Property: (int) Maximum Size in X (Disabled in this version). A value of -1 means no maximum size.

MaxSizeY

(int) Maximum Size in Y (Disabled in this version). A value of -1 means no maximum size.

MinSizeX

Read Property: (int) Minimum Size in X. A value of -1 means no minimum value.

MinSizeY

Read Property: (int) Minimum Size in Y. A value of -1 means no minimum value.

StartPosX

Read Property: (int) Starting Position in X. This is the initial position when the tool is opened. Default = 450

StartPosY

Read Property: (int) Starting Position in Y. This is the initial position when the tool is opened. Default = 450

StartSizeX

Read Property: (int) Starting Size. This is the initial size in X when the tool is opened. Default = 800

StartSizeY

Read Property: (int) Starting Size. This is the initial size in Y when the tool is opened. Default = 400

ToolName

Read Property: (str) Tool Name

FBTool Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation