Classes | Public Member Functions | Public Attributes | Protected Member Functions | Friends

FBVisualComponent Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, Events & callbacks, User Interface, Widgets.


Search for all occurrences

Detailed Description

Visual Component base class.

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

Definition at line 306 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBVisualComponent:
Inheritance graph
[legend]

List of all members.

Classes

struct  __Border
 Border information structure. More...
struct  __Region
 Region information structure. More...

Public Member Functions

 FBVisualComponent (HIObject pObject)
 Constructor.
 IObject_Declare (K_IMPLEMENTATION)
 ICallback_Declare (K_IMPLEMENTATION)
virtual HIKtView GetKtView ()
 Get internal toolkit object.
QWidget * GetQWidgetAddress ()
 Get internal QWidget.
virtual bool AddChild (FBVisualComponent *pChild, int pId=0)
 Add a child component.
virtual FBVisualComponentGetChild (int pId=0)
 Get a child component.
virtual void Refresh (bool pNow=false)
 Refresh component.
virtual void ViewExpose ()
 Exposed view callback function.
virtual void ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function.
virtual bool IsView ()
 Is component a view?

Public Attributes

struct FBVisualComponent::__Region Region
struct FBSDK_DLL
FBVisualComponent::__Border 
Border
FBPropertyString Caption
 Property: Widget caption.
FBPropertyBool Visible
 Read Write Property: Is visual component visible?
FBPropertyBool ReadOnly
 Read Write Property: Is visual component read only?
FBPropertyBool Enabled
 Read Write Property: Is visual enabled?
FBPropertyString Hint
 Read Write Property: Hint to show.
FBPropertyInt Left
 Read Write Property: Left coordinate.
FBPropertyInt Top
 Read Write Property: Top coordinate.
FBPropertyInt Width
 Read Write Property: Width.
FBPropertyInt Height
 Read Write Property: Height.
FBPropertyEvent OnEnter
 Event: On mouse enter.
FBPropertyEvent OnExit
 Event: On mouse exit.

Protected Member Functions

virtual HIKtObject GetHIKtObject ()
 Get internal toolkit object.

Friends

class FBLayout
class FBRenderer

Constructor & Destructor Documentation

FBVisualComponent ( HIObject  pObject)

Constructor.


Member Function Documentation

virtual HIKtObject GetHIKtObject ( ) [protected, virtual]

Get internal toolkit object.

Returns:
Handle to internal toolkit object.
IObject_Declare ( K_IMPLEMENTATION  )

Reimplemented from FBComponent.

Reimplemented in FBLayout, and FBView.

ICallback_Declare ( K_IMPLEMENTATION  )
virtual HIKtView GetKtView ( ) [virtual]

Get internal toolkit object.

Returns:
Handle to internal toolkit object.
QWidget* GetQWidgetAddress ( )

Get internal QWidget.

Returns:
Handle to internal QWidget object.
virtual bool AddChild ( FBVisualComponent pChild,
int  pId = 0 
) [virtual]

Add a child component.

Parameters:
pChildVisual component to add as a child.
pIdUser reference number to associate with pChild(default=0).
Returns:
Operation was successful (true or false).
virtual FBVisualComponent* GetChild ( int  pId = 0) [virtual]

Get a child component.

Parameters:
pIdUser reference number to look for child with(default=0).
Returns:
Handle to child (NULL if not found).
virtual void Refresh ( bool  pNow = false) [virtual]

Refresh component.

Parameters:
pNowRefresh immediately if true (default = false).

Reimplemented in FBView.

virtual void ViewExpose ( ) [virtual]

Exposed view callback function.

virtual void ViewInput ( int  pMouseX,
int  pMouseY,
FBInputType  pAction,
int  pButtonKey,
int  pModifier 
) [virtual]

Input callback function.

Parameters:
pMouseXMouse X position.
pMouseYMouse Y position.
pActionMouse action.
pButtonKeyKeyboard input.
pModifierKeyboard input modifier.
virtual bool IsView ( ) [virtual]

Is component a view?

Returns:
true if component is a view.

Reimplemented in FBView.


Friends And Related Function Documentation

friend class FBLayout [friend]

Definition at line 309 of file fbcontrols.h.

friend class FBRenderer [friend]

Definition at line 310 of file fbcontrols.h.


Member Data Documentation

Property: Widget caption.

Reimplemented in FBSpread, FBProgress, FBPopup, FBFilePopup, and FBFolderPopup.

Definition at line 429 of file fbcontrols.h.

Read Write Property: Is visual component visible?

Definition at line 430 of file fbcontrols.h.

Read Write Property: Is visual component read only?

Definition at line 431 of file fbcontrols.h.

Read Write Property: Is visual enabled?

Definition at line 432 of file fbcontrols.h.

Read Write Property: Hint to show.

Definition at line 433 of file fbcontrols.h.

Read Write Property: Left coordinate.

Definition at line 435 of file fbcontrols.h.

Read Write Property: Top coordinate.

Definition at line 436 of file fbcontrols.h.

Read Write Property: Width.

Definition at line 437 of file fbcontrols.h.

Read Write Property: Height.

Definition at line 438 of file fbcontrols.h.

Event: On mouse enter.

Definition at line 440 of file fbcontrols.h.

Event: On mouse exit.

Definition at line 441 of file fbcontrols.h.


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

FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent
FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent