GblPropertyClass Struct Reference

#include <gimbal_property.h>

Inheritance diagram for GblPropertyClass:

Data Fields
GblBoxClass	base
GBL_RESULT(*	pFnInitOptionalArgs )(GblProperty *pSelf, size_t argCount, va_list *pVaList)
GBL_RESULT(*	pFnDefaultValue )(const GblProperty *pSelf, GblVariant *pValue)
GBL_RESULT(*	pFnCheckValue )(const GblProperty *pSelf, const GblVariant *pValue)
GBL_RESULT(*	pFnValidateValue )(const GblProperty *pSelf, GblVariant *pValue)
GBL_RESULT(*	pFnCompareValues )(const GblProperty *pSelf, const GblVariant *pV1, const GblVariant *pV2, int *pResult)
Data Fields inherited from GblBoxClass
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_

Additional Inherited Members
Related Symbols inherited from GblBoxClass
GblType	GblBox_type (void)
void *	GblBoxClass_userdata (const GblBoxClass *pSelf)
GBL_RESULT	GblBoxClass_setUserdata (GblBoxClass *pSelf, void *pUserdata)
GBL_RESULT	GblBoxClass_setUserDestructor (GblBoxClass *pSelf, GblArrayMapDtorFn pFnUdDtor)
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 structure for GblProperty.

GblPropertyClass provides overridable virtual methods which allow for a derived type to implement type-specific functionality for a property. This functionality includes:

• additional constructor argument handling
• default value handling
• type checking
• value validation
• (fuzzy) comparisons

See also

GblProperty

Definition at line 80 of file gimbal_property.h.

Field Documentation

base

GblBoxClass GblPropertyClass::base

Inherited base class structure.

Definition at line 80 of file gimbal_property.h.

pFnInitOptionalArgs

GBL_RESULT(* GblPropertyClass::pFnInitOptionalArgs) (GblProperty *pSelf, size_t argCount, va_list *pVaList)

Virtual method invoked during constructor to manage additional, non-default arguments.

Definition at line 82 of file gimbal_property.h.

pFnDefaultValue

GBL_RESULT(* GblPropertyClass::pFnDefaultValue) (const GblProperty *pSelf, GblVariant *pValue)

Virtual method returning the default value for the property.

Definition at line 84 of file gimbal_property.h.

pFnCheckValue

GBL_RESULT(* GblPropertyClass::pFnCheckValue) (const GblProperty *pSelf, const GblVariant *pValue)

Checks whether a variant is of the right type or can even be accepted as the new property value.

Definition at line 86 of file gimbal_property.h.

pFnValidateValue

GBL_RESULT(* GblPropertyClass::pFnValidateValue) (const GblProperty *pSelf, GblVariant *pValue)

Updates the variant's value to be within range and a valid value for the given property.

Definition at line 88 of file gimbal_property.h.

pFnCompareValues

GBL_RESULT(* GblPropertyClass::pFnCompareValues) (const GblProperty *pSelf, const GblVariant *pV1, const GblVariant *pV2, int *pResult)

Compares the values of the two given variants to see if they're even different.

Definition at line 90 of file gimbal_property.h.

---

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

• gimbal_property.h