GUISkin Class Reference

Description

Holds a set of styles that control how are GUI element types positioned and displayed in the GUI.

Each element type can be assigned a specific style.

Inherits Resource.

Methods

bool hasStyle (const String &name) const
 Checks if the style with the specified name exists. More...
 
const GUIElementStylegetStyle (const String &guiElemType) const
 Returns a style for the specified GUI element type. More...
 
void setStyle (const String &guiElemType, const GUIElementStyle &style)
 Sets a style for the specified GUI element type. More...
 
void removeStyle (const String &guiElemType)
 Removes a style for the specified GUI element type. More...
 
Vector< StringgetStyleNames () const
 Returns names of all styles registered on this skin. More...
 
virtual RTTITypeBasegetRTTI () const override
 Returns an interface you can use to access class' Run Time Type Information. More...
 
- Methods inherited from Resource
 Resource (bool requiresGpuInitialization=true)
 
const WStringgetName () const
 Returns the name of the resource. More...
 
void setName (const WString &name)
 Sets the name of the resource. More...
 
SPtr< ResourceMetaDatagetMetaData () const
 Retrieves meta-data containing various information describing a resource. More...
 
virtual bool allowAsyncLoading () const
 Returns whether or not this resource is allowed to be asynchronously loaded. More...
 
- Methods inherited from IReflectable
bool isDerivedFrom (RTTITypeBase *base)
 Returns true if current RTTI class is derived from base (Or if it is the same type as base). More...
 
UINT32 getTypeId () const
 Returns an unique type identifier of the class. More...
 
const StringgetTypeName () const
 Returns the type name of the class. More...
 
- Methods inherited from CoreObject
virtual void destroy ()
 Frees all the data held by this object. More...
 
virtual void initialize ()
 Initializes all the internal resources of this object. More...
 
bool isDestroyed () const
 Returns true if the object has been destroyed. More...
 
void blockUntilCoreInitialized () const
 Blocks the current thread until the resource is fully initialized. More...
 
UINT64 getInternalID () const
 Returns an unique identifier for this object. More...
 
SPtr< CoreObjectgetThisPtr () const
 Returns a shared_ptr version of "this" pointer. More...
 
SPtr< ct::CoreObjectgetCore () const
 Returns an object that contains a core thread specific implementation of this CoreObject. More...
 
void syncToCore ()
 Ensures all dirty syncable data is send to the core thread counterpart of this object (if any). More...
 
void _setThisPtr (SPtr< CoreObject > ptrThis)
 Sets a shared this pointer to this object. More...
 

Static methods

static HGUISkin create ()
 Creates an empty GUI skin and returns a handle to it. More...
 
static RTTITypeBasegetRTTIStatic ()
 
Internal
static SPtr< GUISkin_createPtr ()
 Creates an empty GUI skin and returns a pointer to it. More...
 
- Static methods inherited from Resource
static RTTITypeBasegetRTTIStatic ()
 
- Static methods inherited from IReflectable
static Vector< RTTITypeBase * > & getDerivedClasses ()
 Returns all classes deriving directly from IReflectable. More...
 
static SPtr< IReflectablecreateInstanceFromTypeId (UINT32 rttiTypeId)
 Creates an empty instance of a class from a type identifier. More...
 
static void _registerDerivedClass (RTTITypeBase *derivedClass)
 Called by each type deriving from IReflectable, on program load. More...
 
static RTTITypeBase_getRTTIfromTypeId (UINT32 rttiTypeId)
 Returns class' RTTI type from type id. More...
 
static bool _isTypeIdDuplicate (UINT32 typeId)
 Checks if the provided type id is unique. More...
 
static void _checkForCircularReferences ()
 Iterates over all RTTI types and reports any circular references (for example one type having a field referencing another type, and that type having a field referencing the first type). More...
 
static RTTITypeBasegetRTTIStatic ()
 Returns an interface you can use to access class' Run Time Type Information. More...
 
- Static methods inherited from CoreObject
template<class T , class MemAlloc >
static void _delete (CoreObject *obj)
 Schedules the object to be destroyed, and then deleted. More...
 

Static fields

static GUIElementStyle DefaultStyle
 Default style that may be used when no other is available. More...
 

Additional Inherited Members

- Protected Types inherited from CoreObject
enum  Flags { CGO_DESTROYED = 0x01, CGO_INIT_ON_CORE_THREAD = 0x02 }
 Values that represent current state of the core object. More...
 

Method documentation

static SPtr<GUISkin> _createPtr ( )
static

Creates an empty GUI skin and returns a pointer to it.

Note
Internal method. Use "create" returning handle for normal use.
static HGUISkin create ( )
static

Creates an empty GUI skin and returns a handle to it.

virtual RTTITypeBase* getRTTI ( ) const
overridevirtual

Returns an interface you can use to access class' Run Time Type Information.

Note
You must derive your own version of RTTITypeBase, in which you may encapsulate all reflection specific operations.

Reimplemented from Resource.

const GUIElementStyle* getStyle ( const String guiElemType) const

Returns a style for the specified GUI element type.

See also
GUIElement::getGUITypeName
Vector<String> getStyleNames ( ) const

Returns names of all styles registered on this skin.

bool hasStyle ( const String name) const

Checks if the style with the specified name exists.

void removeStyle ( const String guiElemType)

Removes a style for the specified GUI element type.

See also
GUIElement::getGUITypeName
void setStyle ( const String guiElemType,
const GUIElementStyle style 
)

Sets a style for the specified GUI element type.

See also
GUIElement::getGUITypeName

Member Data Documentation

GUIElementStyle DefaultStyle
static

Default style that may be used when no other is available.