NDEVR
API Documentation
TooltipTextManager.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Widgets
28File: TooltipTextManager
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/String.h>
35#include <NDEVR/StringEnum.h>
36#include <NDEVR/Dictionary.h>
37#include <NDEVR/TranslatedString.h>
38#include <QString>
39namespace NDEVR
40{
44 enum class TooltipType
45 {
46 e_browse_file
47 , e_quick_start
48 , e_new_project
49 , e_exit_program
50 , e_about_program
51 , e_log_info
52 , e_program_settings
55 , e_tablet_theme
56 , e_desktop_theme
57 , e_mobile_theme
59 , e_add_pattern
60 , e_preserve_precision
61 , e_read_lines
62 , e_read_points
63 , e_read_meshes
64 , e_write_lines
65 , e_write_points
66 , e_write_meshes
67 , e_always_show_import_dialog
68 , e_always_show_export_dialog
69 , e_start_3D_scan
70 , e_stop_3D_scan
71 , e_pause_3D_scan
72 , e_add_deployment_segment
73 , e_remove_deployment_segment
74 , e_run_circle_scan
75 , e_camera_action_combo
76 , e_smooth_button
77 , e_no_smooth
78 , e_light_smooth
79 , e_normal_smooth
80 , e_heavy_smooth
81 , e_max_smooth
82 , e_flip_uv_toggle
83 , e_generate_uv_toggle
84 , e_optimize_mesh_toggle
85 , e_optimize_model_heirarchy_toggle
86 , e_remove_identical_vertices_toggle
87 , e_convert_degenerates_toggle
88 , e_flatten_model_toggle
89 , e_optimize_mesh_instance_toggle
90 , e_flat_normals
95 , e_counter_clockwise_winding
96 , e_print_viewports
97 , e_close_project
98 , e_save_project
99 , e_share_project
100 , e_save_as_project
101 , e_export
102 };
103
106 class NDEVR_WIDGETS_API TooltipTextManager
107 {
108 public:
112 static TranslatedString tooltip(const String& id);
117 private:
118 static Dictionary<String, TranslatedString> s_dictionary;
119 };
120}
A hash-based key-value store, useful for quick associative lookups.
Definition Dictionary.h:64
The core String class for the NDEVR API.
Definition String.h:95
Provides common tooltips for usage with the software.
static TranslatedString tooltip(TooltipType id)
Retrieves a tooltip string by its TooltipType enum value.
static TranslatedString tooltip(const String &id)
Retrieves a tooltip string by its string identifier.
Any text displayed to the user should be defined as a TranslatedString which allows the program to lo...
The primary namespace for the NDEVR SDK.
@ e_smooth_normals
Normals are interpolated smoothly across faces.
@ e_no_normals
No normals are provided.
TooltipType
Enums for program-generated tooltips.
@ e_add_station
Add a new station to the scene.
@ e_light_theme
A light color theme with dark text on light backgrounds.
Definition NDEVRTheme.h:48
@ e_dark_theme
A dark color theme with light text on dark backgrounds.
Definition NDEVRTheme.h:47
@ e_clockwise_winding
Vertices wind clockwise when viewed from the front.
@ e_no_winding
No winding order is defined.