Cogs::Core::GuiExtension Struct Reference

Inheritance diagram for Cogs::Core::GuiExtension:

Public Member Functions
virtual bool	initializeStatic () override
	Initialize extension statically.
virtual bool	initialize (Context *context) override
	Initialize extension for the given context.
virtual const char *	getExtensionKey () const override
	Get the extensions unique key, used to check for extension presence and retrieve extension specific data from the context.
virtual const void *	getPublicAPI () const override
	Retrieve a pointer to a struct containing all publicly available function pointers.
Public Member Functions inherited from Cogs::Core::Extension
virtual bool	initializeStatic ()
	Initialize extension statically.
virtual bool	initialize (Context *)
	Initialize extension for the given context.
virtual void	cleanup (Context *)
	Cleanup context bound extension content.
virtual const char *	getExtensionKey () const =0
	Get the extensions unique key, used to check for extension presence and retrieve extension specific data from the context.
virtual void *	getSymbolPointer (const char *) const
	Get pointer to symbol defined by extension.
virtual const void *	getPublicAPI () const
	Retrieve a pointer to a struct containing all publicly available function pointers.

Static Public Member Functions
static ResourceId	loadHTML (Context *context, const char *path)
static void	setComponentHTML (Context *context, GuiComponent *component, ResourceId id)
static void	setInnerHTML (Context *context, GuiComponent *component, const char *elementId, const char *html)

Public Attributes
GuiModuleAPI	api

Static Public Attributes
static constexpr const char *	cExtensionKey = "Gui"

Detailed Description

Definition at line 178 of file GuiExtension.cpp.

Constructor & Destructor Documentation

GuiExtension()

Cogs::Core::GuiExtension::GuiExtension ( )

inline

Definition at line 188 of file GuiExtension.cpp.

Member Function Documentation

getExtensionKey()

virtual const char * Cogs::Core::GuiExtension::getExtensionKey ( ) const

inlineoverridevirtual

Get the extensions unique key, used to check for extension presence and retrieve extension specific data from the context.

Returns

Pointer to a null-terminated string containing the name of the extension.

Implements Cogs::Core::Extension.

Definition at line 215 of file GuiExtension.cpp.

getPublicAPI()

virtual const void * Cogs::Core::GuiExtension::getPublicAPI ( ) const

inlineoverridevirtual

Retrieve a pointer to a struct containing all publicly available function pointers.

The returned pointer should be cast to the structure type defined by the extension.

Reimplemented from Cogs::Core::Extension.

Definition at line 216 of file GuiExtension.cpp.

initialize()

virtual bool Cogs::Core::GuiExtension::initialize ( Context *  )

inlineoverridevirtual

Initialize extension for the given context.

Override this method to provide context bound initialization. This can for example be registering entity definitions in the entity store, creating component systems in the context, or other per context tasks.

Parameters

context

Context currently being initialized.

Reimplemented from Cogs::Core::Extension.

Definition at line 200 of file GuiExtension.cpp.

References Cogs::Core::Context::engine, Cogs::Core::SystemPriority::PreTransform, Cogs::Core::IRenderer::registerExtension(), and Cogs::Core::Context::renderer.

initializeStatic()

virtual bool Cogs::Core::GuiExtension::initializeStatic ( )

inlineoverridevirtual

Initialize extension statically.

Override this method to provide static initialization code. This can for example be filling data tables for later use, registering types in the static type system or other tasks that are only necessary to perform once per application run.

Reimplemented from Cogs::Core::Extension.

Definition at line 193 of file GuiExtension.cpp.

loadHTML()

static ResourceId Cogs::Core::GuiExtension::loadHTML ( Context *  context, const char *  path  )

inlinestatic

Definition at line 218 of file GuiExtension.cpp.

setComponentHTML()

static void Cogs::Core::GuiExtension::setComponentHTML ( Context *  context, GuiComponent *  component, ResourceId  id  )

inlinestatic

Definition at line 234 of file GuiExtension.cpp.

setInnerHTML()

static void Cogs::Core::GuiExtension::setInnerHTML ( Context *  context, GuiComponent *  component, const char *  elementId, const char *  html  )

inlinestatic

Definition at line 242 of file GuiExtension.cpp.

Member Data Documentation

api

GuiModuleAPI Cogs::Core::GuiExtension::api

Initial value:

= {
      reinterpret_cast<LoadHTMLFn>(&GuiExtension::loadHTML),
      reinterpret_cast<SetComponentHTMLFn>(&GuiExtension::setComponentHTML),
      reinterpret_cast<SetInnerHTMLFn>(&GuiExtension::setInnerHTML),
    }

Definition at line 182 of file GuiExtension.cpp.

cExtensionKey

constexpr const char* Cogs::Core::GuiExtension::cExtensionKey = "Gui"

staticconstexpr

Definition at line 180 of file GuiExtension.cpp.

---

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

• Extensions/Gui/Source/GuiExtension.cpp