Dragengine.Scenery.ECPGuiTheme Class Reference

GuiTheme class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPGuiTheme:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
	Copy value from another element class property of the same type. More...
GuiTheme	getGuiTheme ()
	GuiTheme or null if not present. More...
GuiTheme	getGuiTheme (StubWithProperties stub, ElementClass eclass)
	GuiTheme modified by stub property if present. More...
bool	getHasPreloaded ()
	Property has been preloaded. More...
LoadGuiTheme	getLoader ()
	GuiTheme loader. More...
String	getPath ()
	Path to animator. More...
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems. More...
ECPGuiTheme	new (String name, LoadGuiTheme loader)
	Create property. More...
ECPGuiTheme	new (String name, LoadGuiTheme loader, String path)
	Create property with initial path. More...
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported. More...
void	setGuiTheme (GuiTheme animator)
	Set animator or null if not present. More...
void	setPath (String path)
	Set path to animator. More...
void	setValue (Object value)
	Set value of property from XML decoded value. More...
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void	dispose ()
	Dispose of element class property to break reference loops. More...
String	getName ()
	Name. More...
ElementClassProperty	new (String name)
	Create property. More...

Detailed Description

GuiTheme class property for use with XML loading.

GuiTheme is set from XML using a path. Loads the gui theme during preloading. The value of the property is then the loaded resource. If loading fails null gui theme is stored.

Member Function Documentation

copyValue()

void Dragengine.Scenery.ECPGuiTheme.copyValue	(	ElementClass	elementClass,
		ElementClassProperty	property
	)

Copy value from another element class property of the same type.

Version

1.17

getGuiTheme() [1/2]

GuiTheme Dragengine.Scenery.ECPGuiTheme.getGuiTheme

(

)

GuiTheme or null if not present.

getGuiTheme() [2/2]

GuiTheme Dragengine.Scenery.ECPGuiTheme.getGuiTheme	(	StubWithProperties	stub,
		ElementClass	eclass
	)

GuiTheme modified by stub property if present.

If named stub property is not present or empty string the stored animator is returned. If the named stub property is present it is loaded as animator resource.

getHasPreloaded()

bool Dragengine.Scenery.ECPGuiTheme.getHasPreloaded

(

)

Property has been preloaded.

getLoader()

LoadGuiTheme Dragengine.Scenery.ECPGuiTheme.getLoader

(

)

GuiTheme loader.

getPath()

String Dragengine.Scenery.ECPGuiTheme.getPath

(

)

Path to animator.

logPreloadProblems()

bool Dragengine.Scenery.ECPGuiTheme.logPreloadProblems	(	ElementClass	elementClass,
		Console	console
	)

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

new() [1/2]

ECPGuiTheme Dragengine.Scenery.ECPGuiTheme.new	(	String	name,
		LoadGuiTheme	loader
	)

Create property.

new() [2/2]

ECPGuiTheme Dragengine.Scenery.ECPGuiTheme.new	(	String	name,
		LoadGuiTheme	loader,
		String	path
	)

Create property with initial path.

preloadResources()

void Dragengine.Scenery.ECPGuiTheme.preloadResources	(	ElementClass	elementClass,
		PreloadCounter	counter
	)

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setGuiTheme()

void Dragengine.Scenery.ECPGuiTheme.setGuiTheme

(

GuiTheme

animator

)

Set animator or null if not present.

setPath()

void Dragengine.Scenery.ECPGuiTheme.setPath

(

String

path

)

Set path to animator.

setValue()

void Dragengine.Scenery.ECPGuiTheme.setValue

(

Object

value

)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

---

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

• ECPGuiTheme.ds