sdf::v11::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::v11::Gui::Gui

(

)

Default constructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v11::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::v11::Gui::Fullscreen

(

)

const

Get whether the Gui should be fullscreen.

Returns

True if the Gui should be fullscreen.

Load()

Errors sdf::v11::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]

_sdf

The 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::v11::Gui::operator==

(

const Gui &

_gui

)

const

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

Parameters

[in]

_gui

Gui instance to compare.

Returns

True if this instance equals the given Gui.

SetFullscreen()

void sdf::v11::Gui::SetFullscreen

(

const bool

_fullscreen

)

Set whether the Gui should be full screen.

Parameters

[in]

_fullscreen

True indicates that the Gui should be fullscreen.

---

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

• Gui.hh