Rebel Fork Framework
Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
Urho3D::RmlNavigable Class Reference

UI element that can be navigated with arrows. More...

#include <Urho3D/RmlUI/RmlNavigable.h>

Inheritance diagram for Urho3D::RmlNavigable:

Classes

struct  Cache
 

Public Member Functions

 RmlNavigable (const Rml::String &tag, const Rml::String &group)
 
void Refresh ()
 Update caches if dirty.
 
void SetNavigated (bool navigated, NavigableEventMode eventMode)
 
void SetPressed (bool pressed, NavigableInputSource inputSource, NavigableEventMode eventMode)
 
Rml::Element * AsElement ()
 
const Rml::Element * AsElement () const
 
RmlUIComponent * GetOwner () const
 
const ea::string & GetGroup () const
 
NavigablePressMode GetMousePressMode () const
 
NavigablePressMode GetKeyboardPressMode () const
 
NavigablePressMode GetJoystickPressMode () const
 
const Vector2 & GetPosition () const
 
bool IsDisabled () const
 
bool IsHovered () const
 
bool IsVisible () const
 
bool IsNavigable () const
 
bool IsNavigableInGroup (const ea::string &group) const
 

Static Public Member Functions

static void Register ()
 

Private Member Functions

bool EnsureInitialized ()
 
void MarkCachesDirty ()
 
void UpdatePosition ()
 
void UpdateCaches ()
 
void UpdateDisabled ()
 
void UpdateHovered ()
 
void UpdateStyle ()
 
void UpdateVisible ()
 
template<class T >
void ForEach (Rml::Element *element, const T &func)
 
template<class T >
void ForEachChild (Rml::Element *element, const T &func)
 
void OnUpdate () override
 
void Release () override
 
void OnResize () override
 
void OnLayout () override
 
void OnDpRatioChange () override
 
void OnStyleSheetChange () override
 
void OnAttributeChange (const Rml::ElementAttributes &changedAttributes) override
 
void OnPropertyChange (const Rml::PropertyIdSet &changedProperties) override
 
void OnPseudoClassChange (const Rml::String &pseudoClass, bool activate) override
 

Private Attributes

const Rml::String group_
 
WeakPtr< RmlUIComponent > owner_
 
bool cachesDirty_ {true}
 
bool firstUpdate_ {true}
 
Vector2 position_
 
bool disabled_ {}
 
struct Urho3D::RmlNavigable::Cache cache_
 

Detailed Description

UI element that can be navigated with arrows.

Member Function Documentation

◆ AsElement()

Rml::Element * Urho3D::RmlNavigable::AsElement ( )
inline

Return internal pointers.

◆ GetGroup()

const ea::string & Urho3D::RmlNavigable::GetGroup ( ) const
inline

Return properties of the navigable.

◆ GetPosition()

const Vector2 & Urho3D::RmlNavigable::GetPosition ( ) const
inline

Return state of the navigable. May be slightly outdated.

◆ OnUpdate()

void Urho3D::RmlNavigable::OnUpdate ( )
overrideprivate

Implement Rml::Element

◆ SetNavigated()

void Urho3D::RmlNavigable::SetNavigated ( bool  navigated,
NavigableEventMode  eventMode 
)

Modify element style.

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