SDOM - Simple SDL Document Object Model
A lightweight, extensible Document Object Model for SDL-based applications.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SDOM::DisplayHandle Class Reference

#include <SDOM_DisplayHandle.hpp>

Inheritance diagram for SDOM::DisplayHandle:
SDOM::IDataObject SDOM::IUnitTest

Public Member Functions

 DisplayHandle ()
 
 DisplayHandle (const std::string &name, const std::string &type)
 
 DisplayHandle (const DisplayHandle &other)
 
DisplayHandle & operator= (const DisplayHandle &other)
 
DisplayHandle & operator= (DisplayHandle &&other) noexcept
 
 DisplayHandle (std::nullptr_t)
 
virtual ~DisplayHandle ()
 
virtual bool onInit () override
 
virtual void onQuit () override
 
virtual bool onUnitTest () override
 Runs unit tests for this object.
 
IDisplayObject * get () const
 
template<typename T >
T * as () const
 
IDisplayObject & operator* () const
 
IDisplayObject * operator-> () const
 
 operator bool () const
 
bool operator== (std::nullptr_t) const
 
bool operator!= (std::nullptr_t) const
 
bool operator== (const DisplayHandle &other) const
 
bool operator!= (const DisplayHandle &other) const
 
void reset ()
 
std::string getName () const
 
std::string getType () const
 
void setName (const std::string &newName)
 
void setType (const std::string &newType)
 
std::string str () const
 
const char * c_str () const
 
bool isValid () const
 
IDisplayObject * get_lua (DisplayHandle *self) const
 
bool isValid_lua (DisplayHandle *self) const
 
std::string getName_lua (DisplayHandle *self) const
 
std::string getType_lua (DisplayHandle *self) const
 
void registerLuaBindings (const std::string &typeName, sol::state_view lua)
 

Static Public Member Functions

static sol::table ensure_handle_table (sol::state_view lua)
 
static void bind_minimal (sol::state_view lua)
 
template<typename T >
static T lua_value_case_insensitive (const sol::table &tbl, const std::string &key, const T &default_value)
 

Static Public Attributes

static constexpr const char * LuaHandleName = "DisplayHandle"
 
static Factory * factory_ = nullptr
 

Protected Member Functions

virtual void _registerLuaBindings (const std::string &typeName, sol::state_view lua) override
 

Static Protected Member Functions

static DisplayHandle resolveChildSpec (const sol::object &spec)
 

Protected Attributes

sol::usertype< DisplayHandle > objHandleType_
 

Constructor & Destructor Documentation

◆ DisplayHandle() [1/4]

SDOM::DisplayHandle::DisplayHandle ( )

◆ DisplayHandle() [2/4]

SDOM::DisplayHandle::DisplayHandle ( const std::string &  name,
const std::string &  type 
)
inline

◆ DisplayHandle() [3/4]

SDOM::DisplayHandle::DisplayHandle ( const DisplayHandle &  other)
inline

◆ DisplayHandle() [4/4]

SDOM::DisplayHandle::DisplayHandle ( std::nullptr_t  )
inline

◆ ~DisplayHandle()

SDOM::DisplayHandle::~DisplayHandle ( )
virtual

Member Function Documentation

◆ _registerLuaBindings()

void SDOM::DisplayHandle::_registerLuaBindings ( const std::string &  typeName,
sol::state_view  lua 
)
overrideprotectedvirtual

Reimplemented from SDOM::IDataObject.

◆ as()

template<typename T >
T * SDOM::DisplayHandle::as ( ) const
inline

◆ bind_minimal()

void SDOM::DisplayHandle::bind_minimal ( sol::state_view  lua)
static

◆ c_str()

const char * SDOM::DisplayHandle::c_str ( ) const
inline

◆ ensure_handle_table()

sol::table SDOM::DisplayHandle::ensure_handle_table ( sol::state_view  lua)
static

◆ get()

IDisplayObject * SDOM::DisplayHandle::get ( ) const

◆ get_lua()

IDisplayObject * SDOM::DisplayHandle::get_lua ( DisplayHandle *  self) const
inline

◆ getName()

std::string SDOM::DisplayHandle::getName ( ) const
inline

◆ getName_lua()

std::string SDOM::DisplayHandle::getName_lua ( DisplayHandle *  self) const
inline

◆ getType()

std::string SDOM::DisplayHandle::getType ( ) const
inline

◆ getType_lua()

std::string SDOM::DisplayHandle::getType_lua ( DisplayHandle *  self) const
inline

◆ isValid()

bool SDOM::DisplayHandle::isValid ( ) const
inline

◆ isValid_lua()

bool SDOM::DisplayHandle::isValid_lua ( DisplayHandle *  self) const
inline

◆ lua_value_case_insensitive()

template<typename T >
static T SDOM::IDataObject::lua_value_case_insensitive ( const sol::table &  tbl,
const std::string &  key,
const T &  default_value 
)
inlinestaticinherited

◆ onInit()

virtual bool SDOM::DisplayHandle::onInit ( )
inlineoverridevirtual

Implements SDOM::IDataObject.

◆ onQuit()

virtual void SDOM::DisplayHandle::onQuit ( )
inlineoverridevirtual

Implements SDOM::IDataObject.

◆ onUnitTest()

virtual bool SDOM::DisplayHandle::onUnitTest ( )
inlineoverridevirtual

Runs unit tests for this object.

Returns
true if all tests pass, false otherwise.

Reimplemented from SDOM::IDataObject.

◆ operator bool()

SDOM::DisplayHandle::operator bool ( ) const
inline

◆ operator!=() [1/2]

bool SDOM::DisplayHandle::operator!= ( const DisplayHandle &  other) const
inline

◆ operator!=() [2/2]

bool SDOM::DisplayHandle::operator!= ( std::nullptr_t  ) const
inline

◆ operator*()

IDisplayObject & SDOM::DisplayHandle::operator* ( ) const
inline

◆ operator->()

IDisplayObject * SDOM::DisplayHandle::operator-> ( ) const
inline

◆ operator=() [1/2]

DisplayHandle & SDOM::DisplayHandle::operator= ( const DisplayHandle &  other)
inline

◆ operator=() [2/2]

DisplayHandle & SDOM::DisplayHandle::operator= ( DisplayHandle &&  other)
inlinenoexcept

◆ operator==() [1/2]

bool SDOM::DisplayHandle::operator== ( const DisplayHandle &  other) const
inline

◆ operator==() [2/2]

bool SDOM::DisplayHandle::operator== ( std::nullptr_t  ) const
inline

◆ registerLuaBindings()

void SDOM::IDataObject::registerLuaBindings ( const std::string &  typeName,
sol::state_view  lua 
)
inlineinherited

◆ reset()

void SDOM::DisplayHandle::reset ( )
inline

◆ resolveChildSpec()

DisplayHandle SDOM::DisplayHandle::resolveChildSpec ( const sol::object &  spec)
staticprotected

◆ setName()

void SDOM::DisplayHandle::setName ( const std::string &  newName)
inline

◆ setType()

void SDOM::DisplayHandle::setType ( const std::string &  newType)
inline

◆ str()

std::string SDOM::DisplayHandle::str ( ) const
inline

Member Data Documentation

◆ factory_

Factory* SDOM::DisplayHandle::factory_ = nullptr
inlinestatic

◆ LuaHandleName

constexpr const char* SDOM::DisplayHandle::LuaHandleName = "DisplayHandle"
inlinestaticconstexpr

◆ objHandleType_

sol::usertype<DisplayHandle> SDOM::DisplayHandle::objHandleType_
protected
The documentation for this class was generated from the following files: