FBPropertyEvent Class Reference

Search for all occurrences

---

Detailed Description

PropertyEvent: Base event class.

Definition at line 398 of file fbproperties.h.

#include <fbproperties.h>

Inheritance diagram for FBPropertyEvent:

List of all members.

Public Member Functions
	FBPropertyEvent ()
	Constructor.
FBPropertyEvent *	Init (FBComponent *pComponent, HIRegister pParent, char *pName, int pType, int pSubType=K_INT_MAX)
	Property initialization function.
FBPropertyEvent *	InitGlobal (char *pName, char *pGlobalEventName)
	Property initialization function, for global events.
virtual	~FBPropertyEvent ()
	Destructor.
virtual void	InvalidateParent ()
	Invalidate parent, removing internal register parent.
virtual FBPropertyType	GetPropertyType () override
	Get the property's type.
virtual void	Add (HICallback pOwner, kICallbackHandler pHandler)
	Add/Remove a callback.
virtual void	Remove (HICallback pOwner, kICallbackHandler pHandler)
Protected Attributes
HIRegister	mParentRegister
	Internal callback register.
int	mType
	Type of event.
int	mSubType
	SubType of event.

---

Constructor & Destructor Documentation

FBPropertyEvent

(

)

Constructor.

virtual ~FBPropertyEvent

(

)

[virtual]

Destructor.

---

Member Function Documentation

FBPropertyEvent* Init	(	FBComponent *	pComponent,
		HIRegister	pParent,
		char *	pName,
		int	pType,
		int	pSubType = K_INT_MAX
	)

Search for all occurrences

Property initialization function.

Parameters:

pComponent	Owner component.
pParent	Internal register interface of object owner.
pName	Name of FBPropertyEvent
pType	Type of event.
pSubType	SubType of event(default=K_INT_MAX).

Returns:

Pointer to this FBPropertyEvent

FBPropertyEvent* InitGlobal	(	char *	pName,
		char *	pGlobalEventName
	)

Search for all occurrences

Property initialization function, for global events.

Parameters:

pName	Name of FBPropertyEvent
pGlobalEventName	Name of global event.

Returns:

Pointer to this FBPropertyEvent

virtual void Add	(	HICallback	pOwner,
		kICallbackHandler	pHandler
	)		[virtual]

Search for all occurrences

Add/Remove a callback.

Parameters:

pOwner	Callback owner.
pHandler	Callback handler.

Reimplemented in FBPropertyEventAnimationNode, FBPropertyEventUIIdle, FBPropertyEventConnectionNotify, FBPropertyEventConnectionDataNotify, and FBPropertyEventConnectionStateNotify.

virtual void Remove	(	HICallback	pOwner,
		kICallbackHandler	pHandler
	)		[virtual]

Search for all occurrences

Reimplemented in FBPropertyEventAnimationNode, FBPropertyEventUIIdle, FBPropertyEventConnectionNotify, FBPropertyEventConnectionDataNotify, and FBPropertyEventConnectionStateNotify.

virtual void InvalidateParent

(

)

[virtual]

Search for all occurrences

Invalidate parent, removing internal register parent.

virtual FBPropertyType GetPropertyType

(

)

[inline, override, virtual]

Search for all occurrences

Get the property's type.

Returns:

The property's type.

Reimplemented from FBProperty.

Definition at line 448 of file fbproperties.h.

{ return kFBPT_event; }

---

Member Data Documentation

HIRegister mParentRegister [protected]

Search for all occurrences

Internal callback register.

Definition at line 403 of file fbproperties.h.

int mType [protected]

Search for all occurrences

Type of event.

Definition at line 405 of file fbproperties.h.

int mSubType [protected]

Search for all occurrences

SubType of event.

Definition at line 407 of file fbproperties.h.

---

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

• fbsdk/fbproperties.h