FBVisualComponent Class Reference

Visual Component base class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBVisualComponent:

Public Member Functions
	FBVisualComponent ()
	Constructor.
bool	AddChild (FBVisualComponent pChild, int pId=0)
	Add a child component.
FBVisualComponent	GetChild (int pId=0)
	Get a child component.
QWidget	GetQWidgetAddress ()
	Get internal QWidget.
bool	IsView ()
	Is component a view?
	Refresh (bool pNow=False)
	Refresh component.
	ViewExpose ()
	Exposed view callback function.
	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
str	Caption
	Property: Widget caption.
bool	Enabled
	Read Write Property: Is visual enabled?
int	Height
	Read Write Property: Height.
str	Hint
	Read Write Property: Hint to show.
int	Left
	Read Write Property: Left coordinate.
bool	ReadOnly
	Read Write Property: Is visual component read only?
int	Top
	Read Write Property: Top coordinate.
bool	Visible
	Read Write Property: Is visual component visible?
int	Width
	Read Write Property: Width.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Visual Component base class.

All of the user interface elements available in the SDK derive from this class.

Constructor & Destructor Documentation

FBVisualComponent()

FBVisualComponent

(

)

Constructor.

Member Function Documentation

AddChild()

bool AddChild	(	FBVisualComponent	pChild,
		int	pId = 0
	)

Add a child component.

Parameters

pChild	Visual component to add as a child.
pId	User reference number to associate with pChild(default=0).

Returns

Operation was successful (true or false).

GetChild()

FBVisualComponent GetChild

(

int

pId = 0

)

Get a child component.

Parameters

pId	User reference number to look for child with(default=0).

Returns

Handle to child (NULL if not found).

GetQWidgetAddress()

QWidget GetQWidgetAddress

(

)

Get internal QWidget.

Returns

Handle to internal QWidget object.

IsView()

bool IsView

(

)

Is component a view?

Returns

true if component is a view.

Refresh()

Refresh

(

bool

pNow = False

)

Refresh component.

Parameters

pNow	Refresh immediately if true (default = false).

ViewExpose()

ViewExpose

(

)

Exposed view callback function.

ViewInput()

ViewInput	(	int	pMouseX,
		int	pMouseY,
		FBInputType	pAction,
		int	pButtonKey,
		int	pModifier
	)

Input callback function.

Parameters

pMouseX	Mouse X position.
pMouseY	Mouse Y position.
pAction	Mouse action.
pButtonKey	Keyboard input.
pModifier	Keyboard input modifier.

Member Data Documentation

Caption

str Caption

Property: Widget caption.

Enabled

bool Enabled

Read Write Property: Is visual enabled?

Height

int Height

Read Write Property: Height.

Hint

str Hint

Read Write Property: Hint to show.

Left

int Left

Read Write Property: Left coordinate.

ReadOnly

bool ReadOnly

Read Write Property: Is visual component read only?

Top

int Top

Read Write Property: Top coordinate.

Visible

bool Visible

Read Write Property: Is visual component visible?

Width

int Width

Read Write Property: Width.