ot::Frontend Class Reference

Frontend request layer. The Frontend prvoides a set methods that may be used to send requests to the frontend. More...

#include "Frontend.h"

Public Member Functions
bool	setControlEnabled (const std::string &_controlName, bool _isEnabled=true, bool _sendRequest=true)
	Sets the control enabled state.
bool	setControlEnabled (const std::string &_toolBarPageName, const std::string &_toolBarGroupName, const std::string &_controlName, bool _isEnabled=true, bool _sendRequest=true)
	Sets the control enabled state.
bool	setControlEnabled (const std::string &_toolBarPageName, const std::string &_toolBarGroupName, const std::string &_toolBarSubGroupName, const std::string &_controlName, bool _isEnabled=true, bool _sendRequest=true)
	Sets the control enabled state.
bool	sendCurrentControlEnabledStates (void)
	Will send the currently buffered control enabled states to the frontend.

Detailed Description

Frontend request layer. The Frontend prvoides a set methods that may be used to send requests to the frontend.

Member Function Documentation

sendCurrentControlEnabledStates()

bool ot::Frontend::sendCurrentControlEnabledStates

(

void

)

Will send the currently buffered control enabled states to the frontend.

setControlEnabled() [1/3]

bool ot::Frontend::setControlEnabled	(	const std::string &	_controlName,
		bool	_isEnabled = true,
		bool	_sendRequest = true )

Sets the control enabled state.

Parameters

_controlName	Name of the control.
_isEnabled	If true the control should be enabled.
_sendRequest	If true the enabled state request will be send to the frontend, otherwise the state will be buffered to be send later.

setControlEnabled() [2/3]

bool ot::Frontend::setControlEnabled	(	const std::string &	_toolBarPageName,
		const std::string &	_toolBarGroupName,
		const std::string &	_controlName,
		bool	_isEnabled = true,
		bool	_sendRequest = true )

Sets the control enabled state.

Parameters

_toolBarPageName	Name of the ToolBar page where the controls group is located at.
_toolBarGroupName	Name of the ToolBar group where the control is located at.
_controlName	Name of the control.
_isEnabled	If true the control should be enabled.
_sendRequest	If true the enabled state request will be send to the frontend, otherwise the state will be buffered to be send later.

setControlEnabled() [3/3]

bool ot::Frontend::setControlEnabled	(	const std::string &	_toolBarPageName,
		const std::string &	_toolBarGroupName,
		const std::string &	_toolBarSubGroupName,
		const std::string &	_controlName,
		bool	_isEnabled = true,
		bool	_sendRequest = true )

Sets the control enabled state.

Parameters

_toolBarPageName	Name of the ToolBar page where the controls group is located at.
_toolBarGroupName	Name of the ToolBar group where the control is located at.
_controlName	Name of the control.
_isEnabled	If true the control should be enabled.
_sendRequest	If true the enabled state request will be send to the frontend, otherwise the state will be buffered to be send later.

---

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

• Libraries/OTGuiAPI/include/OTGuiAPI/Frontend.h
• Libraries/OTGuiAPI/src/Frontend.cpp