FBVisualComponent Class Reference

#include <fbcontrols.h>

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

Inheritance diagram for FBVisualComponent:

[legend]

List of all members.

---

Detailed Description

Visual Component base class.

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

Definition at line 304 of file fbcontrols.h.

Public Member Functions
	FBVisualComponent (HIObject pObject)
	Constructor.
virtual HIKtView	GetKtView ()
	Get internal toolkit object.
virtual bool	AddChild (HFBVisualComponent pChild, int pId=0)
	Add a child component.
virtual HFBVisualComponent	GetChild (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
	Region information structure.
struct K_DLLEXPORT FBVisualComponent::__Border	Border
	Border information structure.
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.
Classes
struct	__Border
	Border information structure. More...
struct	__Region
	Region information structure. More...

---

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.

virtual HIKtView GetKtView

(

)

[virtual]

Get internal toolkit object.

Returns:

Handle to internal toolkit object.

virtual bool AddChild	(	HFBVisualComponent	pChild,
		int	pId = 0
	)			[virtual]

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

virtual HFBVisualComponent GetChild

(

int

pId = 0

)

[virtual]

Get a child component.

Parameters:

pId

User 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:

pNow

Refresh 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:

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

virtual bool IsView

(

)

[virtual]

Is component a view?

Returns:

true if component is a view.

Reimplemented in FBView.

---

Member Data Documentation

struct FBVisualComponent::__Region Region

Region information structure.

Contains region attachment and relative value information.

struct K_DLLEXPORT FBVisualComponent::__Border Border

Border information structure.

FBPropertyString Caption

Property: Widget caption.

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

Definition at line 421 of file fbcontrols.h.

FBPropertyBool Visible

Read Write Property: Is visual component visible?

Definition at line 422 of file fbcontrols.h.

FBPropertyBool ReadOnly

Read Write Property: Is visual component read only?

Definition at line 423 of file fbcontrols.h.

FBPropertyBool Enabled

Read Write Property: Is visual enabled?

Definition at line 424 of file fbcontrols.h.

FBPropertyString Hint

Read Write Property: Hint to show.

Definition at line 425 of file fbcontrols.h.

FBPropertyInt Left

Read Write Property: Left coordinate.

Definition at line 427 of file fbcontrols.h.

FBPropertyInt Top

Read Write Property: Top coordinate.

Definition at line 428 of file fbcontrols.h.

FBPropertyInt Width

Read Write Property: Width.

Reimplemented in FBImageContainer.

Definition at line 429 of file fbcontrols.h.

FBPropertyInt Height

Read Write Property: Height.

Reimplemented in FBImageContainer.

Definition at line 430 of file fbcontrols.h.

FBPropertyEvent OnEnter

Event: On mouse enter.

Definition at line 432 of file fbcontrols.h.

FBPropertyEvent OnExit

Event: On mouse exit.

Definition at line 433 of file fbcontrols.h.

---

Please send us your comments about this page.