MenuCommand Class Reference

#include <MenuCommand.h>

Classes
class	DataClass

Public Types
enum	OperatorType { OperatorTypeDriver = 0, OperatorTypeDispatcher = 1 }
using	MenuCommandAction = std::function< void(StateMenu *)>

Public Member Functions
	MenuCommand (const MenuCommandDefines::MenuCommandID commandID, const QString &commandText, const QString &commandDescription, const QString &commandButtonText, MenuCommandAction action)
	MenuCommand (const MenuCommandDefines::MenuCommandID commandID, MenuCommandAction action)
	MenuCommand (const MenuCommand &otherMenuCommand)
	MenuCommand (const MenuCommand *otherMenuCommand)
	~MenuCommand ()
void	SetCommandText (const QString &text)
QString	GetCommandText () const
void	SetCommandDescription (const QString &description)
QString	GetCommandDescription () const
void	SetCommandActionText (const QString &commandButtonText)
QString	GetCommandActionText () const
void	SetAllCommandTexts (const QString &text, const QString &description, const QString &commandButtonText)
void	SetTabIndex (int tabIndex)
int	GetTabIndex () const
MenuCommandDefines::MenuCommandID	GetCommandID () const
void	ExecuteCommand (StateMenu *state)
void	SetVisibleOnlyForDispatcher (const bool dispatcherOnly)
	SetVisibleOnlyForDispatcher - method can limit menu command usage to only dispatcher. More...
bool	IsVisibleOnlyForDispatcher () const
bool	IsAllowedForCurrentOperator (const OperatorType currentOperator) const

Member Typedef Documentation

using MenuCommand::MenuCommandAction = std::function<void(StateMenu*)>

Member Enumeration Documentation

enum MenuCommand::OperatorType

Enumerator
OperatorTypeDriver
OperatorTypeDispatcher

Constructor & Destructor Documentation

MenuCommand::MenuCommand	(	const MenuCommandDefines::MenuCommandID	commandID,
		const QString &	commandText,
		const QString &	commandDescription,
		const QString &	commandButtonText,
		MenuCommandAction	action
	)

MenuCommand::MenuCommand	(	const MenuCommandDefines::MenuCommandID	commandID,
		MenuCommandAction	action
	)

MenuCommand::MenuCommand

(

const MenuCommand &

otherMenuCommand

)

MenuCommand::MenuCommand

(

const MenuCommand *

otherMenuCommand

)

MenuCommand::~MenuCommand

(

)

Member Function Documentation

void MenuCommand::ExecuteCommand

(

StateMenu *

state

)

Here is the call graph for this function:

Here is the caller graph for this function:

QString MenuCommand::GetCommandActionText

(

)

const

Here is the caller graph for this function:

QString MenuCommand::GetCommandDescription

(

)

const

Here is the caller graph for this function:

MenuCommandDefines::MenuCommandID MenuCommand::GetCommandID

(

)

const

Here is the caller graph for this function:

QString MenuCommand::GetCommandText

(

)

const

Here is the caller graph for this function:

int MenuCommand::GetTabIndex

(

)

const

Here is the caller graph for this function:

bool MenuCommand::IsAllowedForCurrentOperator

(

const OperatorType

currentOperator

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool MenuCommand::IsVisibleOnlyForDispatcher

(

)

const

Here is the caller graph for this function:

void MenuCommand::SetAllCommandTexts	(	const QString &	text,
		const QString &	description,
		const QString &	commandButtonText
	)

Here is the caller graph for this function:

void MenuCommand::SetCommandActionText

(

const QString &

commandButtonText

)

void MenuCommand::SetCommandDescription

(

const QString &

description

)

void MenuCommand::SetCommandText

(

const QString &

text

)

void MenuCommand::SetTabIndex

(

int

tabIndex

)

Here is the caller graph for this function:

void MenuCommand::SetVisibleOnlyForDispatcher

(

const bool

dispatcherOnly

)

SetVisibleOnlyForDispatcher - method can limit menu command usage to only dispatcher.

Parameters

dispatcherOnly

- if true, menu command is displayed for dispatcher only, driver can't execute it if false, menu command is intended to use both for dispatcher and driver

Here is the caller graph for this function:

---

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

• src/businesslogic/menu/MenuCommand.h
• src/businesslogic/menu/MenuCommand.cpp