Public Member Functions | List of all members
sdf::v12::Gui Class Reference

#include <Gui.hh>

Public Member Functions

 Gui ()
 Default constructor. More...
 
sdf::ElementPtr Element () const
 Get a pointer to the SDF element that was used during load. More...
 
bool Fullscreen () const
 Get whether the Gui should be fullscreen. More...
 
Errors Load (ElementPtr _sdf)
 Load the gui based on a element pointer. More...
 
bool operator== (const Gui &_gui) const
 Equality operator that returns true if this Gui instance equals the given Gui instance. More...
 
void SetFullscreen (const bool _fullscreen)
 Set whether the Gui should be full screen. More...
 

Constructor & Destructor Documentation

◆ Gui()

sdf::v12::Gui::Gui ( )

Default constructor.

Member Function Documentation

◆ Element()

sdf::ElementPtr sdf::v12::Gui::Element ( ) const

Get a pointer to the SDF element that was used during load.

Returns
SDF element pointer. The value will be nullptr if Load has not been called.

◆ Fullscreen()

bool sdf::v12::Gui::Fullscreen ( ) const

Get whether the Gui should be fullscreen.

Returns
True if the Gui should be fullscreen.

◆ Load()

Errors sdf::v12::Gui::Load ( ElementPtr  _sdf)

Load the gui based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters
[in]_sdfThe SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

◆ operator==()

bool sdf::v12::Gui::operator== ( const Gui _gui) const

Equality operator that returns true if this Gui instance equals the given Gui instance.

Parameters
[in]_guiGui instance to compare.
Returns
True if this instance equals the given Gui.

◆ SetFullscreen()

void sdf::v12::Gui::SetFullscreen ( const bool  _fullscreen)

Set whether the Gui should be full screen.

Parameters
[in]_fullscreenTrue indicates that the Gui should be fullscreen.

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