GblBoxClass Struct Reference

#include <gimbal_box.h>

Inheritance diagram for GblBoxClass:

Data Fields
GblClass	base
GblIVariantClass	GblIVariantImpl
struct {
GblArrayMap *   pFields
}	private_
GBL_RESULT(*	pFnDestructor )(GblBox *pSelf)
Data Fields inherited from GblClass
struct {
uintptr_t   metaClassInfo
}	private_
Data Fields inherited from GblIVariantClass
GblInterface	base
const GblIVariantVTable *	pVTable
Data Fields inherited from GblInterface
GblClass	base
size_t	outerClassOffset_

Related Symbols
(Note that these are not member symbols.)
GblType	GblBox_type (void)
Userdata
Methods for managing and destroying userdata
void *	GblBoxClass_userdata (const GblBoxClass *pSelf)
GBL_RESULT	GblBoxClass_setUserdata (GblBoxClass *pSelf, void *pUserdata)
GBL_RESULT	GblBoxClass_setUserDestructor (GblBoxClass *pSelf, GblArrayMapDtorFn pFnUdDtor)
Fields
Methods for managing extended userdata fields
uintptr_t	GblBoxClass_field (const GblBoxClass *pSelf, GblQuark key)
uintptr_t	GblBoxClass_takeField (GblBoxClass *pSelf, GblQuark key)
GblBool	GblBoxClass_clearField (GblBoxClass *pSelf, GblQuark key)
GblBool	GblBoxClass_hasField (const GblBoxClass *pSelf, GblQuark key)
GBL_RESULT	GblBoxClass_setField (GblBoxClass *pSelf, GblQuark key, uintptr_t ud, GblArrayMapDtorFn pFnDtor)
Related Symbols inherited from GblClass
	GBL_CLASS_SUPER (klass)
	GBL_CLASS_DEFAULT (klass)
#define	GBL_CLASS_PRIVATE(cType, klass)
#define	GBL_CLASS_PUBLIC(cType, priv)
#define	GBL_CLASS_TYPECHECK(cType, klass)
	GBL_CLASS_TYPECHECK_PREFIX (klass, typePrefix)
#define	GBL_CLASS_CAST(cType, klass)
	GBL_CLASS_CAST_PREFIX (klass, typePrefix)
	GBL_CLASS_TRY (klass, toType, cType)
	GBL_CLASS_TRY_PREFIX (klass, typePrefix)
GblClass *	GblClass_refDefault (GblType type)
GblRefCount	GblClass_unrefDefault (GblClass *pSelf)
GblClass *	GblClass_weakRefDefault (GblType type)
GblClass *	GblClass_createFloating (GblType type)
GBL_RESULT	GblClass_destroyFloating (GblClass *pSelf)
GBL_RESULT	GblClass_constructFloating (GblClass *pSelf, GblType type)
GBL_RESULT	GblClass_destructFloating (GblClass *pSelf)
#define	GBL_CLASS(klass)
#define	GBL_CLASS_TYPEOF(klass)
#define	GBL_CLASS_PRIVATE(cType, klass)
#define	GBL_CLASS_PUBLIC(cType, priv)
#define	GBL_CLASS_TYPECHECK(cType, klass)
#define	GBL_CLASS_CAST(cType, klass)
#define	GBL_CLASS_AS(cType, klass)
#define	GBL_STATIC_CLASS_TYPE
#define	GBL_STATIC_CLASS(klass)
GblBool	GblClass_check (const GblClass *pSelf, GblType toType)
GblClass *	GblClass_cast (GblClass *pSelf, GblType toType)
GblClass *	GblClass_as (GblClass *pSelf, GblType toType)
void *	GblClass_private (const GblClass *pSelf, GblType base)
GblClass *	GblClass_public (const void *pPrivate, GblType base)
GblType	GblClass_typeOf (const GblClass *pSelf)
size_t	GblClass_size (const GblClass *pSelf)
size_t	GblClass_privateSize (const GblClass *pSelf)
size_t	GblClass_totalSize (const GblClass *pSelf)
GblBool	GblClass_isDefault (const GblClass *pSelf)
GblBool	GblClass_isOverridden (const GblClass *pSelf)
GblBool	GblClass_isInterface (const GblClass *pSelf)
GblBool	GblClass_isInterfaceImpl (const GblClass *pSelf)
GblBool	GblClass_isFloating (const GblClass *pSelf)
GblBool	GblClass_isOwned (const GblClass *pSelf)
GblBool	GblClass_isInPlace (const GblClass *pSelf)
GblClass *	GblClass_super (const GblClass *pSelf)
GblClass *	GblClass_default (const GblClass *pSelf)
Related Symbols inherited from GblInterface
#define	GBL_INTERFACE(klass)
#define	GBL_INTERFACE_TRY(klass)
#define	GBL_INTERFACE_OUTER_CLASS(iface)
#define	GBL_INTERFACE_OUTER_MOST_CLASS(iface)
	GblInterface_outerClass (GblInterface *pSelf)
GblClass *	GblInterface_outerMostClass (GblInterface *pSelf)

Detailed Description

GblClass VTable/static data structure for GblBox.

GblBoxClass extends GblClass and implements the GblIVariant interface for GblVariant container support. It also provides arbitrary userdata storage at the class-level.

See also

GblBox

Definition at line 54 of file gimbal_box.h.

Friends And Related Symbol Documentation

GblBoxClass_userdata()

void * GblBoxClass_userdata ( const GblBoxClass *  pSelf )

related

Returns the void* userdata pointer that has been associated with the given GblBoxClass.

GblBoxClass_setUserdata()

GBL_RESULT GblBoxClass_setUserdata ( GblBoxClass *  pSelf, void *  pUserdata  )

related

Sets the void* userdata pointer, associating it with the given GblBoxClass.

GblBoxClass_setUserDestructor()

GBL_RESULT GblBoxClass_setUserDestructor ( GblBoxClass *  pSelf, GblArrayMapDtorFn  pFnUdDtor  )

related

Adds an extra destructor callback to the field list, passing the given class back as the destructed value.

GblBoxClass_field()

uintptr_t GblBoxClass_field ( const GblBoxClass *  pSelf, GblQuark  key  )

related

Returns the generic userdata field value associated with the given key on the class, or 0 if there isn't one.

GblBoxClass_takeField()

uintptr_t GblBoxClass_takeField ( GblBoxClass *  pSelf, GblQuark  key  )

related

Extracts the generic userdata field value associated with the given key on the class, without destroying it.

GblBoxClass_clearField()

GblBool GblBoxClass_clearField ( GblBoxClass *  pSelf, GblQuark  key  )

related

Destroys the generic userdata field value associated with the given key on the class, returning GBL_TRUE upon success.

GblBoxClass_hasField()

GblBool GblBoxClass_hasField ( const GblBoxClass *  pSelf, GblQuark  key  )

related

Returns GBL_TRUE if the given class has generic userdata field value associated with the given key.

GblBoxClass_setField()

GBL_RESULT GblBoxClass_setField ( GblBoxClass *  pSelf, GblQuark  key, uintptr_t  ud, GblArrayMapDtorFn  pFnDtor  )

related

Sets the generic userdata value and its optional destructor for the given key on the class, destroying the previous value if there was one.

GblBox_type()

GblType GblBox_type ( void  )

related

Returns the GblType UUID associated with GblBox.

Field Documentation

base

GblClass GblBoxClass::base

Inherited base class structure.

Definition at line 54 of file gimbal_box.h.

GblIVariantImpl

GblIVariantClass GblBoxClass::GblIVariantImpl

Embedded interface class structure.

Definition at line 54 of file gimbal_box.h.

pFields

GblArrayMap* GblBoxClass::pFields

PRIVATE: Internal storage for userdata fields.

Definition at line 56 of file gimbal_box.h.

pFnDestructor

GBL_RESULT(* GblBoxClass::pFnDestructor) (GblBox *pSelf)

Virtual method invoked when a GblBox is being destroyed.

Definition at line 60 of file gimbal_box.h.

---

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

• gimbal_box.h