Nui
Public Member Functions | Friends | List of all members
Nui::StableElement Class Reference

#include <stabilize.hpp>

Public Member Functions

 StableElement ()
 
void reset ()
 Resets the stable element, so that it is re-rendered on the next render. More...
 
void destroy ()
 Destroys the stable element directly, which will make it also disappear from the page. More...
 
Dom::ElementstableElement ()
 
Dom::Element const & stableElement () const
 

Friends

ElementRenderer stabilize (StableElement &stableElement, ElementRenderer const &encapsulatedRenderer)
 Stabilizes an element, so that it is not re-rendered on every render. More...
 

Constructor & Destructor Documentation

◆ StableElement()

Nui::StableElement::StableElement ( )
inline

Member Function Documentation

◆ destroy()

void Nui::StableElement::destroy ( )

Destroys the stable element directly, which will make it also disappear from the page.

◆ reset()

void Nui::StableElement::reset ( )

Resets the stable element, so that it is re-rendered on the next render.

◆ stableElement() [1/2]

Dom::Element & Nui::StableElement::stableElement ( )

◆ stableElement() [2/2]

Dom::Element const & Nui::StableElement::stableElement ( ) const

Friends And Related Function Documentation

◆ stabilize

ElementRenderer stabilize ( StableElement stableElement,
ElementRenderer const &  encapsulatedRenderer 
)
friend

Stabilizes an element, so that it is not re-rendered on every render.

Parameters
stableElementA stable element handle held by the caller. Must not be destroyed before the associated ui.
encapsulatedRendererThe renderer that should be rendered once and then stabilized.
Returns
ElementRenderer A renderer that renders the encapsulated renderer once and then stabilizes it.

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