#include "stage/model/element-access.hpp"

Description

Interface: access UI elements by navigating the UI topology.

See also: stage::interact::Navigator; ElementAccess_test

Definition at line 77 of file element-access.hpp.

Classes
struct	TypeConverter

Public Member Functions
virtual	~ElementAccess ()
	this is an interface

template<class TAR >
lib::Result< TAR & >	access (UICoord const &destination)
	Navigate the UI topology to access the designated component.

UICoord	locate_or_create (UICoord const &destination, size_t limitCreation=LUMIERA_MAX_ORDINAL_NUMBER)
	Navigate to the designated component, possibly create the element and parents.

Protected Types
using	RawResult = lib::Variant< Types< model::Tangible , Gtk::Widget > >

Protected Member Functions
virtual RawResult	performAccessTo (UICoord::Builder &, size_t limitCreation)=0

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default

	NonCopyable ()=default

	NonCopyable (NonCopyable const &)=delete

NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

◆ ~ElementAccess()

virtual ~ElementAccess ( )

inlinevirtual

this is an interface

Definition at line 82 of file element-access.hpp.

Member Typedef Documentation

◆ RawResult

using RawResult = lib::Variant<Types<model::Tangible*, Gtk::Widget*> >

protected

Definition at line 94 of file element-access.hpp.

Member Function Documentation

◆ access()

template<class TAR >

lib::Result< TAR & > access ( UICoord const & destination )

inline

Navigate the UI topology to access the designated component.

Template Parameters

TAR	type of result element expected at the designated location

Returns: suitably converted direct (language) reference to the desired element wrapped as result proxy

Note: when access was not possible because either the element does not exist, or is not convertible to the desired target type, the result proxy is empty and convertible to bool(false)

Definition at line 163 of file element-access.hpp.

References Variant< TYPES >::accept(), ElementAccess::performAccessTo(), UICoord::rebuild(), and ElementAccess::TypeConverter< TAR >::result.

Here is the call graph for this function:

◆ locate_or_create()

UICoord locate_or_create	(	UICoord const &	destination,
		size_t	limitCreation = `LUMIERA_MAX_ORDINAL_NUMBER`
	)

inline

Navigate to the designated component, possibly create the element and parents.

Parameters

limitCreation limit on the number of similar UI elements that can be created within a scope. A value of zero prohibits creating of new elements.

Returns: location of the actual element to use, as UI-coordinates.

Note: when access was not possible because the element could not been created, the indicated location returned is an empty coordinate spec.

Definition at line 181 of file element-access.hpp.

References ElementAccess::performAccessTo(), and UICoord::rebuild().

Here is the call graph for this function:

◆ performAccessTo()

virtual RawResult performAccessTo	(	UICoord::Builder &	,
		size_t	limitCreation
	)

protectedpure virtual

drill down according to coordinates, maybe create element

Implemented in ElemAccessDir, and TestElementAccess.

Referenced by ElementAccess::access(), and ElementAccess::locate_or_create().

Here is the caller graph for this function:

Inheritance diagram for ElementAccess:

Collaboration diagram for ElementAccess:

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

element-access.hpp

Description

Classes

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members