lxgui::gui::virtual_registry Class Reference

Keeps track of virtual UI objects and records their names for lookup. More...

#include <gui_virtual_registry.hpp>

Inheritance diagram for lxgui::gui::virtual_registry:

Public Member Functions
	virtual_registry (const registry &object_registry)
	virtual_registry (const virtual_registry &mgr)=default
	virtual_registry (virtual_registry &&mgr)=default
virtual_registry &	operator= (const virtual_registry &mgr)=default
virtual_registry &	operator= (virtual_registry &&mgr)=default
std::vector< utils::observer_ptr< const region > >	get_virtual_region_list (std::string_view names) const
	Return a list of virtual regions matching the provided comma-separated list.
bool	check_region_name (std::string_view name) const
	Checks the provided string is suitable for naming a region.
bool	add_region (utils::observer_ptr< region > obj)
	Adds a region to be handled by this registry.
void	remove_region (const region &obj)
	Removes a region from this registry.
utils::observer_ptr< const region >	get_region_by_name (std::string_view name) const
	Returns the region associated with the given name.
utils::observer_ptr< region >	get_region_by_name (std::string_view name)
	Returns the region associated with the given name.

Detailed Description

Keeps track of virtual UI objects and records their names for lookup.

Definition at line 16 of file gui_virtual_registry.hpp.

Constructor & Destructor Documentation

virtual_registry() [1/3]

lxgui::gui::virtual_registry::virtual_registry ( const registry &  object_registry )

explicit

Definition at line 9 of file gui_virtual_registry.cpp.

virtual_registry() [2/3]

lxgui::gui::virtual_registry::virtual_registry ( const virtual_registry &  mgr )

default

virtual_registry() [3/3]

lxgui::gui::virtual_registry::virtual_registry ( virtual_registry &&  mgr )

default

Member Function Documentation

add_region()

bool lxgui::gui::registry::add_region ( utils::observer_ptr< region >  obj )

inherited

Adds a region to be handled by this registry.

Parameters

obj	The object to add

Returns

'false' if the name of the region was already taken

Definition at line 43 of file gui_registry.cpp.

check_region_name()

bool lxgui::gui::registry::check_region_name ( std::string_view  name ) const

inherited

Checks the provided string is suitable for naming a region.

Parameters

name	The string to test

Returns

'true' if the provided string can be the name of a region

Definition at line 9 of file gui_registry.cpp.

get_region_by_name() [1/2]

utils::observer_ptr< region > lxgui::gui::registry::get_region_by_name ( std::string_view  name )

inlineinherited

Returns the region associated with the given name.

Parameters

name	The name of the region you're after

Returns

The region associated with the given name, or nullptr if not found

Definition at line 58 of file gui_registry.hpp.

get_region_by_name() [2/2]

utils::observer_ptr< const region > lxgui::gui::registry::get_region_by_name ( std::string_view  name ) const

inherited

Returns the region associated with the given name.

Parameters

name	The name of the region you're after

Returns

The region associated with the given name, or nullptr if not found

Definition at line 66 of file gui_registry.cpp.

get_virtual_region_list()

std::vector< utils::observer_ptr< const region > > lxgui::gui::virtual_registry::get_virtual_region_list

(

std::string_view

names

)

const

Return a list of virtual regions matching the provided comma-separated list.

Parameters

names

Comma-separated list of object names

Returns

A vector of objects matching the list. Objects not found will be excluded.

Definition at line 13 of file gui_virtual_registry.cpp.

operator=() [1/2]

virtual_registry & lxgui::gui::virtual_registry::operator= ( const virtual_registry &  mgr )

default

operator=() [2/2]

virtual_registry & lxgui::gui::virtual_registry::operator= ( virtual_registry &&  mgr )

default

remove_region()

void lxgui::gui::registry::remove_region ( const region &  obj )

inherited

Removes a region from this registry.

Parameters

obj	The object to remove

Definition at line 62 of file gui_registry.cpp.

---

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

• /home/runner/work/lxgui/lxgui/include/lxgui/gui_virtual_registry.hpp
• /home/runner/work/lxgui/lxgui/src/gui_virtual_registry.cpp