HelpMarker.hpp File Reference

Text Help Marker (?) with Tooltip. More...

Go to the source code of this file.

Functions
bool	NAV::gui::widgets::BeginHelpMarker (const char *symbol="(?)", float textWrapLength=35.0F)
	Begins a Text Help Marker, e.g. '(?)', with custom content.
void	NAV::gui::widgets::EndHelpMarker (bool wrapText=true)
	Ends a Text Help Marker with custom content.
void	NAV::gui::widgets::HelpMarker (const char *desc, const char *symbol="(?)")
	Text Help Marker, e.g. '(?)', with Tooltip.

Detailed Description

Text Help Marker (?) with Tooltip.

Icon Widget.

Author

T. Topp (topp@.nosp@m.ins..nosp@m.uni-s.nosp@m.tutt.nosp@m.gart..nosp@m.de)

Date

2020-12-13

Author

T. Topp (topp@.nosp@m.ins..nosp@m.uni-s.nosp@m.tutt.nosp@m.gart..nosp@m.de)

Date

2020-12-14

Function Documentation

BeginHelpMarker()

bool NAV::gui::widgets::BeginHelpMarker	(	const char *	symbol = "(?)",
		float	textWrapLength = 35.0F )

Begins a Text Help Marker, e.g. '(?)', with custom content.

Parameters

[in]	symbol	Symbol to display
[in]	textWrapLength	Length to wrap symbols after (set to 0.0F to disable)

EndHelpMarker()

void NAV::gui::widgets::EndHelpMarker

(

bool

wrapText = true

)

Ends a Text Help Marker with custom content.

Parameters

[in]

wrapText

Wether text was wrapped

HelpMarker()

void NAV::gui::widgets::HelpMarker	(	const char *	desc,
		const char *	symbol = "(?)" )

Text Help Marker, e.g. '(?)', with Tooltip.

Parameters

[in]	desc	Text to display as tooltip
[in]	symbol	Symbol to display