#include <gimbal_object.h>

Inheritance diagram for GblObject:

[legend]

Collaboration diagram for GblObject:

[legend]

Data Fields
union {

GblObjectClass * pClass

GblBox base

};

Data Fields inherited from GblInstance
GblClass *	pClass

Related Symbols
(Note that these are not member symbols.)
Reading Properties
Methods for retrieving property values.
GBL_RESULT	GblObject_property (const GblObject pSelf, const char pName,...)

GBL_RESULT	GblObject_propertyByQuark (const GblObject *pSelf, GblQuark name,...)

GBL_RESULT	GblObject_propertyVaList (const GblObject pSelf, const char pName, va_list *pList)

GBL_RESULT	GblObject_propertyVaByQuark (const GblObject pSelf, GblQuark name, va_list pList)

GBL_RESULT	GblObject_propertyVariant (const GblObject pSelf, const char pName, GblVariant *pValue)

GBL_RESULT	GblObject_propertyVariantByQuark (const GblObject pSelf, GblQuark name, GblVariant pValue)

GBL_RESULT	GblObject_properties (const GblObject *pSelf,...)

GBL_RESULT	GblObject_propertiesVa (const GblObject pSelf, va_list pList)

GBL_RESULT	GblObject_propertiesVariants (const GblObject pSelf, size_t count, const char pNames[], GblVariant *pValue)

Writing Properties
Methods for setting property values.
GBL_RESULT	GblObject_setProperty (GblObject pSelf, const char pName,...)

GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)

GBL_RESULT	GblObject_setPropertyVa (GblObject pSelf, const char pName, va_list *pList)

GBL_RESULT	GblObject_setPropertyVaListByQuark (GblObject pSelf, GblQuark name, va_list pList)

GBL_RESULT	GblObject_setPropertyVariant (GblObject pSelf, const char pName, GblVariant *pValue)

GBL_RESULT	GblObject_setPropertyVariantByQuark (GblObject pSelf, GblQuark name, GblVariant pValue)

GBL_RESULT	GblObject_setProperties (GblObject *pSelf,...)

GBL_RESULT	GblObject_setPropertiesVa (GblObject pSelf, va_list pList)

GBL_RESULT	GblObject_setPropertiesVariants (GblObject pSelf, size_t count, const char pNames[], GblVariant *pValue)

Property Notification
Methods involving property changed notifiers.
GBL_RESULT	GblObject_emitPropertyChange (const GblObject pSelf, const char pName)

GBL_RESULT	GblObject_emitPropertyChangeByQuark (const GblObject *pSelf, GblQuark name)

GblBool	GblObject_blockPropertyChange (GblObject *pSelf, GblBool blocked)

GblBool	GblObject_propertyChangeBlocked (const GblObject *pSelf)

State Management
Methods for querying GblObject state.
GblBool	GblObject_isInstantiating (const GblObject *pSelf)

GblBool	GblObject_isConstructing (const GblObject *pSelf)

Name Accessors
Methods for reading and writing object name
GblStringRef *	GblObject_name (const GblObject *pSelf)

void	GblObject_setName (GblObject pSelf, const char pName)

void	GblObject_setNameRef (GblObject pSelf, GblStringRef pRef)

Hierarchy Management
Methods for parenting, traversing, or querying object trees
GblObject *	GblObject_parent (const GblObject *pSelf)

void	GblObject_setParent (GblObject pSelf, GblObject pParent)

void	GblObject_addChild (GblObject pSelf, GblObject pChild)

GblBool	GblObject_removeChild (GblObject pSelf, GblObject pChild)

void	GblObject_addChildren (GblObject pSelf, const GblRingList pList)

void	GblObject_removeChildren (GblObject pSelf, const GblRingList pList)

void	GblObject_clearChildren (GblObject *pSelf)

void	GblObject_setChildren (GblObject pSelf, const GblRingList pList)

GblBool	GblObject_iterateChildren (const GblObject pSelf, GblObjectIterFn pFnIt, void pUd)

size_t	GblObject_depth (const GblObject *pSelf)

GblObject *	GblObject_childFirst (const GblObject *pSelf)

GblObject *	GblObject_childLast (const GblObject *pSelf)

size_t	GblObject_childCount (const GblObject *pSelf)

size_t	GblObject_childIndex (const GblObject *pSelf)

GblObject *	GblObject_siblingNext (const GblObject *pSelf)

GblObject *	GblObject_siblingNextByCmpFn (const GblObject pSelf, GblObjectCmpFn pCmpFn, void pClosure)

GblObject *	GblObject_siblingNextByType (const GblObject *pSelf, GblType type)

GblObject *	GblObject_siblingNextByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_siblingPrevious (const GblObject *pSelf)

GblObject *	GblObject_siblingPreviousByCmpFn (const GblObject pSelf, GblObjectCmpFn pCmpFn, void pClosure)

GblObject *	GblObject_siblingPreviousByType (const GblObject *pSelf, GblType type)

GblObject *	GblObject_siblingPreviousByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findAncestorByCmpFn (const GblObject pSelf, GblObjectCmpFn pCmpFn, void pClosure)

GblObject *	GblObject_findAncestorByType (const GblObject *pSelf, GblType ancestorType)

GblObject *	GblObject_findAncestorByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findAncestorByHeight (const GblObject *pSelf, size_t height)

GblObject *	GblObject_findBaseByDepth (const GblObject *pSelf, size_t depth)

GblObject *	GblObject_findChildByCmpFn (const GblObject pSelf, GblObjectCmpFn pCmpFn, void pClosure)

GblObject *	GblObject_findChildByType (const GblObject *pSelf, GblType childType)

GblObject *	GblObject_findChildByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findChildByIndex (const GblObject *pSelf, size_t index)

GblObject *	GblObject_findSiblingByCmpFn (const GblObject pSelf, GblObjectCmpFn pCmpFn, void pClosure)

GblObject *	GblObject_findSiblingByType (const GblObject *pSelf, GblType siblingType)

GblObject *	GblObject_findSiblingByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)

GblObject *	GblObject_findDescendantByCmpFn (const GblObject pSelf, GblObjectCmpFn pCmpFn, void pClosure)

GblObject *	GblObject_findDescendantByType (const GblObject *pSelf, GblType descendantType)

GblObject *	GblObject_findDescendantByName (const GblObject pSelf, const char pName)

Event Management
Methods for sending, notifying, and filtering events
GBL_RESULT	GblObject_sendEvent (GblObject pSelf, GblEvent pEvent)

GBL_RESULT	GblObject_notifyEvent (GblObject pSelf, GblEvent pEvent)

GBL_RESULT	GblObject_installEventFilter (GblObject pSelf, GblIEventReceiver pFilter)

GBL_RESULT	GblObject_uninstallEventFilter (GblObject pSelf, GblIEventReceiver pFilter)

size_t	GblObject_eventFilterCount (const GblObject *pSelf)

GblIEventReceiver *	GblObject_eventFilter (const GblObject *pSelf, size_t index)

Related Symbols inherited from GblInstance
#define	GBL_TYPEOF(self)

#define	GBL_PRIVATE(cType, self)

#define	GBL_PUBLIC(cType, selfPriv)

#define	GBL_TYPECHECK(cType, self)

#define	GBL_CAST(cType, self)

#define	GBL_AS(cType, self)

#define	GBL_CLASSOF(cType, self)

#define	GBL_CLASSOF_AS(cType, self)

#define	GBL_VCALL(cType, method, ...)

#define	GBL_VCALL_DEFAULT(cType, method, ...)

GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)

GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)

GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)

void *	GblInstance_private (const GblInstance *pSelf, GblType base)

GblInstance *	GblInstance_public (const void *pPriv, GblType base)

GblType	GblInstance_typeOf (const GblInstance *pSelf)

size_t	GblInstance_size (const GblInstance *pSelf)

size_t	GblInstance_privateSize (const GblInstance *pSelf)

size_t	GblInstance_totalSize (const GblInstance *pSelf)

GblClass *	GblInstance_class (const GblInstance *pSelf)

GBL_RESULT	GblInstance_swizzleClass (GblInstance pSelf, GblClass pClass)

GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)

GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)

Detailed Description

Main Object-Oriented Instance with Properties, EventReceivers, and Parenting.

A GblObject is the default, full-blown object-oriented instantiable type. It is analogous to Qt's "QObject" or GNOME's "GObject" root type. It extends GblBox to add the following additional functionality:

properties
GblVariant table operations
constructor / post-constructor
event handling and filtering
object parenting and hierarchy
object name

Note: A GblObject by default has the same size of a GblBox. Additional data for fields such as name, parent, children, event filters, etc are created lazily and are stored within GblBox::pFields.

See also: GblBox, GblObjectClass, GblProperty

Definition at line 138 of file gimbal_object.h.

Friends And Related Symbol Documentation

◆ GblObject_property()

GBL_RESULT GblObject_property	(	const GblObject *	pSelf,
		const char *	pName,
			... )

Looks up the property on the object by name, storing its value in the pointer passed as a variadic argument.

◆ GblObject_propertyByQuark()

GBL_RESULT GblObject_propertyByQuark	(	const GblObject *	pSelf,
		GblQuark	name,
			... )

Looks up the property on the object by quark (faster), storing its value in the pointer passed as a variadic argument.

◆ GblObject_propertyVaList()

GBL_RESULT GblObject_propertyVaList	(	const GblObject *	pSelf,
		const char *	pName,
		va_list *	pList )

Variant of GblObject_property() with the pointer for storing the value specified by a pointer to a va_list.

◆ GblObject_propertyVaByQuark()

GBL_RESULT GblObject_propertyVaByQuark	(	const GblObject *	pSelf,
		GblQuark	name,
		va_list *	pList )

Variant of GblObject_propertyVaList() with the name being specified by a quark (faster lookups)

◆ GblObject_propertyVariant()

GBL_RESULT GblObject_propertyVariant	(	const GblObject *	pSelf,
		const char *	pName,
		GblVariant *	pValue )

Fetches the value of the specified property, storing it within a variant.

◆ GblObject_propertyVariantByQuark()

GBL_RESULT GblObject_propertyVariantByQuark	(	const GblObject *	pSelf,
		GblQuark	name,
		GblVariant *	pValue )

Variant of GblObject_propertyVariant(), with the property name specified as a quark (faster lookups)

◆ GblObject_properties()

GBL_RESULT GblObject_properties	(	const GblObject *	pSelf,
			... )

Takes a NULL-terminated K,V pair list of string property names and pointers to store their values within.

◆ GblObject_propertiesVa()

GBL_RESULT GblObject_propertiesVa	(	const GblObject *	pSelf,
		va_list *	pList )

Variant of GblObject_properties() with the NULL-terminated K,V pair list being specified as a pointer to a va_list.

◆ GblObject_propertiesVariants()

GBL_RESULT GblObject_propertiesVariants	(	const GblObject *	pSelf,
		size_t	count,
		const char *	pNames[],
		GblVariant *	pValue )

Looks up multiple properties by the names provided by the pNames list and stores them within the array of GblVariants.

◆ GblObject_setProperty()

GBL_RESULT GblObject_setProperty	(	GblObject *	pSelf,
		const char *	pName,
			... )

Sets the property with the given string name to the value given by the pointer passed through the variadic argument list.

◆ GblObject_setPropertyByQuark()

GBL_RESULT GblObject_setPropertyByQuark	(	GblObject *	pSelf,
		GblQuark	quark,
			... )

Variant of GblObject_setProperty() with the name being specified as a quark (for faster lookups)

◆ GblObject_setPropertyVa()

GBL_RESULT GblObject_setPropertyVa	(	GblObject *	pSelf,
		const char *	pName,
		va_list *	pList )

Variant of GblObject_setProperty() with the pointer for storing the value being specified as a pointer to a va_list.

◆ GblObject_setPropertyVaListByQuark()

GBL_RESULT GblObject_setPropertyVaListByQuark	(	GblObject *	pSelf,
		GblQuark	name,
		va_list *	pList )

Variant of GblObject_setPropertyVaList() with the name being specified as a quark (for faster lookups)

◆ GblObject_setPropertyVariant()

GBL_RESULT GblObject_setPropertyVariant	(	GblObject *	pSelf,
		const char *	pName,
		GblVariant *	pValue )

Variant of GblObject_setProperty() where the property value is provided as a GblVariant.

◆ GblObject_setPropertyVariantByQuark()

GBL_RESULT GblObject_setPropertyVariantByQuark	(	GblObject *	pSelf,
		GblQuark	name,
		GblVariant *	pValue )

Variant of GblObject_setPropertyVariant() where the property name is provided as a quark (for faster lookups)

◆ GblObject_setProperties()

GBL_RESULT GblObject_setProperties	(	GblObject *	pSelf,
			... )

Sets multiple properties by taking a NULL-terminated K,V pairs list of string names and values.

Each value which is rejected is skipped, while the remaining properties are still set, and the last error is returned. An unknown property name stops processing of the list, as none of the remaining arguments can then be read.

◆ GblObject_setPropertiesVa()

GBL_RESULT GblObject_setPropertiesVa	(	GblObject *	pSelf,
		va_list *	pList )

Variant of GblObject_setProperties() where the NULL-terminated K,V pairs list is specified as a pointer to a va_list.

◆ GblObject_setPropertiesVariants()

GBL_RESULT GblObject_setPropertiesVariants	(	GblObject *	pSelf,
		size_t	count,
		const char *	pNames[],
		GblVariant *	pValue )

Sets the properties specified by the list of names to the corresponding values specified as the list of GblVariants.

◆ GblObject_emitPropertyChange()

GBL_RESULT GblObject_emitPropertyChange	(	const GblObject *	pSelf,
		const char *	pName )

Notifies any listeners that the value of a property has changed internally, by emitting the "propertyChanged" signal.

◆ GblObject_emitPropertyChangeByQuark()

GBL_RESULT GblObject_emitPropertyChangeByQuark	(	const GblObject *	pSelf,
		GblQuark	name )

Equivalent to GblObject_emitPropertyChange(), except that the property lookup is done more efficiently by using a quark for its name.

◆ GblObject_blockPropertyChange()

GblBool GblObject_blockPropertyChange	(	GblObject *	pSelf,
		GblBool	blocked )

Disables or enables emission of the "propertyChange" signal, returning its previous enablement. Typically you want to only do this temporarily and restore its previous state when done.

◆ GblObject_propertyChangeBlocked()

GblBool GblObject_propertyChangeBlocked ( const GblObject * pSelf )

Returns true if emission of the "propertyChange" signal has been blocked on the current object or false if it is enabled.

◆ GblObject_isInstantiating()

GblBool GblObject_isInstantiating ( const GblObject * pSelf )

Returns true from the time the object has been allocated to the time its final (possibly optional) initial properties have been set.

◆ GblObject_isConstructing()

GblBool GblObject_isConstructing ( const GblObject * pSelf )

Returns true immediately after type initializers are called, but before GblObject::pFnConstructed() is called with the initial constructor properties.

◆ GblObject_name()

GblStringRef * GblObject_name ( const GblObject * pSelf )

Retrieves the name of the given object or returns an empty string if it doesn't have one.

◆ GblObject_setName()

void GblObject_setName	(	GblObject *	pSelf,
		const char *	pName )

Sets the name of the given object to pName, making a copy of its contents to store internally.

◆ GblObject_setNameRef()

void GblObject_setNameRef	(	GblObject *	pSelf,
		GblStringRef *	pRef )

Sets the name of the given object to pRef, taking ownership of the given reference.

◆ GblObject_parent()

GblObject * GblObject_parent ( const GblObject * pSelf )

Returns a pointer to the parent of the given object, or NULL if it doesn't have one.

◆ GblObject_setParent()

void GblObject_setParent	(	GblObject *	pSelf,
		GblObject *	pParent )

Sets the parent of the given object to pParent, handing ownership to it.

◆ GblObject_addChild()

void GblObject_addChild	(	GblObject *	pSelf,
		GblObject *	pChild )

Adds pChild as a child of the given object, setting itself as the parent and taking ownership of it.

◆ GblObject_removeChild()

GblBool GblObject_removeChild	(	GblObject *	pSelf,
		GblObject *	pChild )

Removes pChild from being a child of the given object, setting its parent to NULL.

◆ GblObject_addChildren()

void GblObject_addChildren	(	GblObject *	pSelf,
		const GblRingList *	pList )

Adds all the objects in pList as children of the given object, taking ownership of them.

◆ GblObject_removeChildren()

void GblObject_removeChildren	(	GblObject *	pSelf,
		const GblRingList *	pList )

Removes all the objects in pList as children of the given object, giving up ownership of them.

◆ GblObject_clearChildren()

void GblObject_clearChildren ( GblObject * pSelf )

Clears the children list of the given object, giving up ownership of them.

◆ GblObject_setChildren()

void GblObject_setChildren	(	GblObject *	pSelf,
		const GblRingList *	pList )

Sets the children of the given object to pList, replacing the current children list and taking ownership of the new one.

◆ GblObject_iterateChildren()

GblBool GblObject_iterateChildren	(	const GblObject *	pSelf,
		GblObjectIterFn	pFnIt,
		void *	pUd )

Iterates over every child of the given object, passing them to the given iterator function, which may optionally take a user data pointer.

Iteration ends early when the iterator returns GBL_TRUE.

◆ GblObject_depth()

size_t GblObject_depth ( const GblObject * pSelf )

Returns the number of levels deep the given object is in the object tree formed by its ancestors.

◆ GblObject_childFirst()

GblObject * GblObject_childFirst ( const GblObject * pSelf )

Returns a pointer to the first child of the given object, or NULL if it has none.

◆ GblObject_childLast()

GblObject * GblObject_childLast ( const GblObject * pSelf )

Returns a pointer to the last child of the given object, or NULL if it has none.

◆ GblObject_childCount()

size_t GblObject_childCount ( const GblObject * pSelf )

Returns the number of children with the given object as their parent.

◆ GblObject_childIndex()

size_t GblObject_childIndex ( const GblObject * pSelf )

Returns the index of the given object in its parent's list of children.

◆ GblObject_siblingNext()

GblObject * GblObject_siblingNext ( const GblObject * pSelf )

Returns the next sibling after the given object, forming a linked list of their parents' children.

◆ GblObject_siblingNextByCmpFn()

GblObject * GblObject_siblingNextByCmpFn	(	const GblObject *	pSelf,
		GblObjectCmpFn	pCmpFn,
		void *	pClosure )

Returns the next sibling after the given object that satisfies the provided comparator callback, or NULL if there isn't one.

◆ GblObject_siblingNextByType()

GblObject * GblObject_siblingNextByType	(	const GblObject *	pSelf,
		GblType	type )

Returns the next sibling after the given object that is of type, or NULL if there isn't one.

◆ GblObject_siblingNextByName()

GblObject * GblObject_siblingNextByName	(	const GblObject *	pSelf,
		const char *	pName )

Returns the next sibling after the given object with the given name, or NULL if there isn't one.

◆ GblObject_siblingPrevious()

GblObject * GblObject_siblingPrevious ( const GblObject * pSelf )

Returns the previous sibling before the given object, forming a linked list of their parents' children.

◆ GblObject_siblingPreviousByCmpFn()

GblObject * GblObject_siblingPreviousByCmpFn	(	const GblObject *	pSelf,
		GblObjectCmpFn	pCmpFn,
		void *	pClosure )

Returns the previous sibling before the given object that satisfies the provided comparator callback, or NULL if there isn't one.

◆ GblObject_siblingPreviousByType()

GblObject * GblObject_siblingPreviousByType	(	const GblObject *	pSelf,
		GblType	type )

Returns the previous sibling before the given object that is of type, or NULL if there isn't one.

◆ GblObject_siblingPreviousByName()

GblObject * GblObject_siblingPreviousByName	(	const GblObject *	pSelf,
		const char *	pName )

Returns the previous sibling before the given object with the given name, or NULL if there isn't one.

◆ GblObject_findAncestorByCmpFn()

GblObject * GblObject_findAncestorByCmpFn	(	const GblObject *	pSelf,
		GblObjectCmpFn	pCmpFn,
		void *	pClosure )

Returns a pointer to the closest ancestor found that satisfies the provided comparator callback, or NULL if there isn't one.

◆ GblObject_findAncestorByType()

GblObject * GblObject_findAncestorByType	(	const GblObject *	pSelf,
		GblType	ancestorType )

Returns a pointer to the closest ancestor object of the given object that is of ancestorType, or NULL if there isn't one.

◆ GblObject_findAncestorByName()

GblObject * GblObject_findAncestorByName	(	const GblObject *	pSelf,
		const char *	pName )

Returns a pointer to the first ancestor found with the given name or NULL if none were found.

◆ GblObject_findAncestorByHeight()

GblObject * GblObject_findAncestorByHeight	(	const GblObject *	pSelf,
		size_t	height )

Returns a pointer to the ancestor object of the given object at the specified height, with 1 being the direct parent.

◆ GblObject_findBaseByDepth()

GblObject * GblObject_findBaseByDepth	(	const GblObject *	pSelf,
		size_t	depth )

Starting at the root object, returns a pointer to the ancestor of the given object at the specified depth, or NULL if there isn't one.

◆ GblObject_findChildByCmpFn()

GblObject * GblObject_findChildByCmpFn	(	const GblObject *	pSelf,
		GblObjectCmpFn	pCmpFn,
		void *	pClosure )

Searches through the list of children on the given object, returning a pointer to the first one that satisfies the provided comparator callback, or NULL if there isn't one.

◆ GblObject_findChildByType()

GblObject * GblObject_findChildByType	(	const GblObject *	pSelf,
		GblType	childType )

Searches through the list of children on the given object, returning a pointer to the first one with the given type, or NULL if there isn't one.

◆ GblObject_findChildByName()

GblObject * GblObject_findChildByName	(	const GblObject *	pSelf,
		const char *	pName )

Searches through the list of children on the given object, returning a pointer to the first one with the given name, or NULL if there isn't one.

◆ GblObject_findChildByIndex()

GblObject * GblObject_findChildByIndex	(	const GblObject *	pSelf,
		size_t	index )

Iterates sequentially over the list of children on the given object, returning a pointer to the one at the given type, or NULL if there isn't one.

◆ GblObject_findSiblingByCmpFn()

GblObject * GblObject_findSiblingByCmpFn	(	const GblObject *	pSelf,
		GblObjectCmpFn	pCmpFn,
		void *	pClosure )

Iterates sequentially over the list of siblings to the given object, returning a pointer to the first one that satisfies the provided comparator callback, or NULL if there isn't one.

◆ GblObject_findSiblingByType()

GblObject * GblObject_findSiblingByType	(	const GblObject *	pSelf,
		GblType	siblingType )

Iterates sequentially over the list of siblings to the given object, returning a pointer to the first one of the given type, or NULL if there isn't one.

◆ GblObject_findSiblingByName()

GblObject * GblObject_findSiblingByName	(	const GblObject *	pSelf,
		const char *	pName )

Iterates sequentially over the list of siblings to the given object, returning a pointer to the first one with the given name, or NULL if there isn't one.

◆ GblObject_findSiblingByIndex()

GblObject * GblObject_findSiblingByIndex	(	const GblObject *	pSelf,
		size_t	index )

Iterates sequentially over the list of siblings to the given object, returning a pointer to the one at the given index, or NULL if there isn't one.

◆ GblObject_findDescendantByCmpFn()

GblObject * GblObject_findDescendantByCmpFn	(	const GblObject *	pSelf,
		GblObjectCmpFn	pCmpFn,
		void *	pClosure )

Returns a pointer to the closest descendant found that satisfies the provided comparator callback, or NULL if there isn't one.

◆ GblObject_findDescendantByType()

GblObject * GblObject_findDescendantByType	(	const GblObject *	pSelf,
		GblType	descendantType )

Returns a pointer to the closest descendant found that is of descendantType, or NULL if there isn't one.

◆ GblObject_findDescendantByName()

GblObject * GblObject_findDescendantByName	(	const GblObject *	pSelf,
		const char *	pName )

Returns a pointer to the closest descendant found with the given name or NULL if none were found.

◆ GblObject_sendEvent()

GBL_RESULT GblObject_sendEvent	(	GblObject *	pSelf,
		GblEvent *	pEvent )

Emits an event upwards through the object hierarchy, notifying the parent of the given object of the event.

◆ GblObject_notifyEvent()

GBL_RESULT GblObject_notifyEvent	(	GblObject *	pSelf,
		GblEvent *	pEvent )

Notifies the given object of an event, which first propagates through its event filters before going through its event handler and propagating up if still unhandled.

◆ GblObject_installEventFilter()

GBL_RESULT GblObject_installEventFilter	(	GblObject *	pSelf,
		GblIEventReceiver *	pFilter )

Installs the event filter on the given object, allowing it to intercept event notifications.

◆ GblObject_uninstallEventFilter()

GBL_RESULT GblObject_uninstallEventFilter	(	GblObject *	pSelf,
		GblIEventReceiver *	pFilter )

Removes the event filter from the given object, so that it no longer intercepts event notifications.

◆ GblObject_eventFilterCount()

size_t GblObject_eventFilterCount ( const GblObject * pSelf )

Returns the number of event filters currently installed on the given object.

◆ GblObject_eventFilter()

GblIEventReceiver * GblObject_eventFilter	(	const GblObject *	pSelf,
		size_t	index )

Returns a pointer to the event filter installed on the given object at the index position.

Field Documentation

◆ pClass

GblObjectClass* GblObject::pClass

Pointer to class/vtable structure.

Definition at line 138 of file gimbal_object.h.

◆ base

GblBox GblObject::base

Inherited base instance structure.

Definition at line 138 of file gimbal_object.h.

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

gimbal_object.h

Data Fields

Related Symbols

Detailed Description

Friends And Related Symbol Documentation

◆ GblObject_property()

◆ GblObject_propertyByQuark()

◆ GblObject_propertyVaList()

◆ GblObject_propertyVaByQuark()

◆ GblObject_propertyVariant()

◆ GblObject_propertyVariantByQuark()

◆ GblObject_properties()

◆ GblObject_propertiesVa()

◆ GblObject_propertiesVariants()

◆ GblObject_setProperty()

◆ GblObject_setPropertyByQuark()

◆ GblObject_setPropertyVa()

◆ GblObject_setPropertyVaListByQuark()

◆ GblObject_setPropertyVariant()

◆ GblObject_setPropertyVariantByQuark()

◆ GblObject_setProperties()

◆ GblObject_setPropertiesVa()

◆ GblObject_setPropertiesVariants()

◆ GblObject_emitPropertyChange()

◆ GblObject_emitPropertyChangeByQuark()

◆ GblObject_blockPropertyChange()

◆ GblObject_propertyChangeBlocked()

◆ GblObject_isInstantiating()

◆ GblObject_isConstructing()

◆ GblObject_name()

◆ GblObject_setName()

◆ GblObject_setNameRef()

◆ GblObject_parent()

◆ GblObject_setParent()

◆ GblObject_addChild()

◆ GblObject_removeChild()

◆ GblObject_addChildren()

◆ GblObject_removeChildren()

◆ GblObject_clearChildren()

◆ GblObject_setChildren()

◆ GblObject_iterateChildren()

◆ GblObject_depth()

◆ GblObject_childFirst()

◆ GblObject_childLast()

◆ GblObject_childCount()

◆ GblObject_childIndex()

◆ GblObject_siblingNext()

◆ GblObject_siblingNextByCmpFn()

◆ GblObject_siblingNextByType()

◆ GblObject_siblingNextByName()

◆ GblObject_siblingPrevious()

◆ GblObject_siblingPreviousByCmpFn()

◆ GblObject_siblingPreviousByType()

◆ GblObject_siblingPreviousByName()

◆ GblObject_findAncestorByCmpFn()

◆ GblObject_findAncestorByType()

◆ GblObject_findAncestorByName()

◆ GblObject_findAncestorByHeight()

◆ GblObject_findBaseByDepth()

◆ GblObject_findChildByCmpFn()

◆ GblObject_findChildByType()

◆ GblObject_findChildByName()

◆ GblObject_findChildByIndex()

◆ GblObject_findSiblingByCmpFn()

◆ GblObject_findSiblingByType()

◆ GblObject_findSiblingByName()

◆ GblObject_findSiblingByIndex()

◆ GblObject_findDescendantByCmpFn()

◆ GblObject_findDescendantByType()

◆ GblObject_findDescendantByName()

◆ GblObject_sendEvent()

◆ GblObject_notifyEvent()

◆ GblObject_installEventFilter()

◆ GblObject_uninstallEventFilter()

◆ GblObject_eventFilterCount()

◆ GblObject_eventFilter()

Field Documentation

◆ pClass

◆ base