0.4.1
Loading...
Searching...
No Matches
HelpMarker.hpp
Go to the documentation of this file.
1// This file is part of INSTINCT, the INS Toolkit for Integrated
2// Navigation Concepts and Training by the Institute of Navigation of
3// the University of Stuttgart, Germany.
4//
5// This Source Code Form is subject to the terms of the Mozilla Public
6// License, v. 2.0. If a copy of the MPL was not distributed with this
7// file, You can obtain one at https://mozilla.org/MPL/2.0/.
8
9/// @file HelpMarker.hpp
10/// @brief Text Help Marker (?) with Tooltip
11/// @author T. Topp (topp@ins.uni-stuttgart.de)
12/// @date 2020-12-13
13
14#pragma once
15
16namespace NAV::gui::widgets
17{
18/// @brief Text Help Marker, e.g. '(?)', with Tooltip
19/// @param[in] desc Text to display as tooltip
20/// @param[in] symbol Symbol to display
21void HelpMarker(const char* desc, const char* symbol = "(?)");
22
23/// @brief Begins a Text Help Marker, e.g. '(?)', with custom content
24/// @param[in] symbol Symbol to display
25/// @param[in] textWrapLength Length to wrap symbols after (set to 0.0F to disable)
26bool BeginHelpMarker(const char* symbol = "(?)", float textWrapLength = 35.0F);
27
28/// @brief Ends a Text Help Marker with custom content
29/// @param[in] wrapText Wether text was wrapped
30void EndHelpMarker(bool wrapText = true);
31
32} // namespace NAV::gui::widgets
bool BeginHelpMarker(const char *symbol="(?)", float textWrapLength=35.0F)
Begins a Text Help Marker, e.g. '(?)', with custom content.
void EndHelpMarker(bool wrapText=true)
Ends a Text Help Marker with custom content.
void HelpMarker(const char *desc, const char *symbol="(?)")
Text Help Marker, e.g. '(?)', with Tooltip.