GblModule Struct Reference

#include <gimbal_module.h>

Inheritance diagram for GblModule:

Data Fields
union {
GblModuleClass *   pClass
GblContext   base
};
GblVersion	version
GblStringRef *	pPrefix
GblStringRef *	pAuthor
GblStringRef *	pDescription
GblOptionGroup *	pOptionGroup
Data Fields inherited from GblContext
union {
GblContextClass *   pClass
GblObject   base
};
GblCallRecord	lastIssue
uint32_t	logStackDepth
GblFlags	logFilter
Data Fields inherited from GblObject
union {
GblObjectClass *   pClass
GblBox   base
};
Data Fields inherited from GblBox
union {
GblBoxClass *   pClass
GblInstance   base
};
struct {
GblArrayMap *   pFields
volatile uint16_t   refCounter
uint16_t   contextType: 1
uint16_t   constructedInPlace: 1
uint16_t   derivedFlags: 14
}	private_
Data Fields inherited from GblInstance
GblClass *	pClass

Additional Inherited Members
Related Symbols inherited from GblObject
GblContext *	GblObject_findContext (GblObject *pSelf)
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_propertyVaListByQuark (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_propertiesVaList (const GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_propertiesVariants (const GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
GBL_RESULT	GblObject_setProperty (GblObject *pSelf, const char *pName,...)
GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)
GBL_RESULT	GblObject_setPropertyVaList (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_setPropertiesVaList (GblObject *pSelf, va_list *pList)
GBL_RESULT	GblObject_setPropertiesVariants (GblObject *pSelf, size_t count, const char *pNames[], GblVariant *pValue)
const GblStringRef *	GblObject_name (const GblObject *pSelf)
void	GblObject_setName (GblObject *pSelf, const char *pName)
void	GblObject_setNameRef (GblObject *pSelf, const GblStringRef *pRef)
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)
size_t	GblObject_depth (const GblObject *pSelf)
GblObject *	GblObject_childFirst (const GblObject *pSelf)
size_t	GblObject_childCount (const GblObject *pSelf)
GblObject *	GblObject_siblingNext (const GblObject *pSelf)
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_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_findSiblingByType (const GblObject *pSelf, GblType siblingType)
GblObject *	GblObject_findSiblingByName (const GblObject *pSelf, const char *pName)
GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)
GBL_RESULT	GblObject_sendEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_notifyEvent (GblObject *pSelf, GblEvent *pEvent)
GBL_RESULT	GblObject_installEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
GBL_RESULT	GblObject_uninstallEventFilter (GblObject *pSelf, GblIEventFilter *pFilter)
size_t	GblObject_eventFilterCount (const GblObject *pSelf)
GblIEventFilter *	GblObject_eventFilter (const GblObject *pSelf, size_t index)
Related Symbols inherited from GblBox
GblBox *	GblBox_ref (GblBox *pSelf)
GblRefCount	GblBox_unref (GblBox *pSelf)
GblRefCount	GblBox_refCount (const GblBox *pSelf)
void *	GblBox_userdata (const GblBox *pSelf)
GBL_RESULT	GblBox_setUserdata (GblBox *pSelf, void *pUserdata)
GBL_RESULT	GblBox_setUserDestructor (GblBox *pSelf, GblArrayMapDtorFn pFnUdDtor)
uintptr_t	GblBox_field (const GblBox *pSelf, GblQuark key)
uintptr_t	GblBox_takeField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_clearField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_hasField (const GblBox *pSelf, GblQuark key)
GBL_RESULT	GblBox_setField (GblBox *pSelf, GblQuark key, uintptr_t ud, GblArrayMapDtorFn pFnDtor)
Related Symbols inherited from GblInstance
GblRefCount	GblInstance_destroy (GblInstance *pSelf)
#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

Dynamically loadable service and associated meta types.

A Module is a lazily-loaded object which is registered then later can be queried for by anywhere else in the application. This behavior lets you implement "services" as global singletons which can be accessed from anywhere. Modules also maintain their own inner registry of associated meta types, which is managed through the implemented GblIPlugin interface.

See also

GbModuleClass

Definition at line 75 of file gimbal_module.h.

Field Documentation

pClass

GblModuleClass* GblModule::pClass

Pointer to class/vtable structure.

Definition at line 75 of file gimbal_module.h.

base

GblContext GblModule::base

Inherited base instance structure.

Definition at line 75 of file gimbal_module.h.

version

GblVersion GblModule::version

Version of a module.

Definition at line 76 of file gimbal_module.h.

pPrefix

GblStringRef* GblModule::pPrefix

Namespace prefix of a module.

Definition at line 77 of file gimbal_module.h.

pAuthor

GblStringRef* GblModule::pAuthor

Author(s) of a module.

Definition at line 78 of file gimbal_module.h.

pDescription

GblStringRef* GblModule::pDescription

Description of a module.

Definition at line 79 of file gimbal_module.h.

pOptionGroup

GblOptionGroup* GblModule::pOptionGroup

Command-line option handler of a module.

Definition at line 80 of file gimbal_module.h.

---

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

• gimbal_module.h