sdf::v9::Gui Class Reference

#include <Gui.hh>

Public Member Functions
	Gui ()
	Default constructor. More...
	Gui (const Gui &_gui)
	Copy constructor. More...
	Gui (Gui &&_gui) noexcept
	Move constructor. More...
	~Gui ()
	Destructor. 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...
Gui &	operator= (const Gui &_gui)
	Copy assignment operator. More...
Gui &	operator= (Gui &&_gui)
	Move assignment operator. 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) const
	Set whether the Gui should be full screen. More...

Constructor & Destructor Documentation

Gui() [1/3]

sdf::v9::Gui::Gui

(

)

Default constructor.

Gui() [2/3]

sdf::v9::Gui::Gui

(

const Gui &

_gui

)

Copy constructor.

Parameters

[in]

_gui

Gui element to copy.

Gui() [3/3]

sdf::v9::Gui::Gui ( Gui &&  _gui )

noexcept

Move constructor.

Parameters

[in]

_gui

Gui to move.

~Gui()

sdf::v9::Gui::~Gui

(

)

Destructor.

Member Function Documentation

Element()

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

(

)

const

Get whether the Gui should be fullscreen.

Returns

True if the Gui should be fullscreen.

Load()

Errors sdf::v9::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=() [1/2]

Gui& sdf::v9::Gui::operator=

(

const Gui &

_gui

)

Copy assignment operator.

Parameters

[in]

_gui

Gui to copy.

Returns

Reference to this.

operator=() [2/2]

Gui& sdf::v9::Gui::operator=

(

Gui &&

_gui

)

Move assignment operator.

Parameters

[in]

_gui

Gui to move.

Returns

Reference to this.

operator==()

bool sdf::v9::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::v9::Gui::SetFullscreen

(

const bool

_fullscreen

)

const

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