INSTINCT Code Coverage Report


Directory: src/
File: internal/gui/widgets/EnumComboWithAbbreviation.hpp
Date: 2025-11-25 23:34:18
Exec Total Coverage
Lines: 0 12 0.0%
Functions: 0 1 0.0%
Branches: 0 10 0.0%

Line Branch Exec Source
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 EnumComboWithAbbreviation.hpp
10 /// @brief Combo representing an enumeration
11 /// @author T. Topp (topp@ins.uni-stuttgart.de)
12 /// @date 2023-09-29
13
14 #pragma once
15
16 #include <imgui.h>
17 #include <fmt/core.h>
18
19 namespace NAV::gui::widgets
20 {
21
22 /// @brief Combo representing an enumeration and use abbreviations to display in the preview
23 /// @tparam T Enumeration Type
24 /// @param[in] label Label to show beside the combo box. This has to be a unique id for ImGui.
25 /// @param[in] enumeration Reference to the enumeration variable to select
26 /// @param[in] startIdx Start Index in the enum (so skip first items)
27 /// @return True if the value changed
28 /// @attention The Enum type needs a last element called 'COUNT'
29 template<typename T>
30 bool EnumComboAbbreviation(const char* label, T& enumeration, size_t startIdx = 0)
31 {
32 bool clicked = false;
33 if (ImGui::BeginCombo(label, NAV::to_string_short(enumeration)))
34 {
35 for (size_t i = startIdx; i < static_cast<size_t>(T::COUNT); i++)
36 {
37 const bool is_selected = (static_cast<size_t>(enumeration) == i);
38 if (ImGui::Selectable(NAV::to_string(static_cast<T>(i)), is_selected))
39 {
40 enumeration = static_cast<T>(i);
41 clicked = true;
42 }
43
44 // Set the initial focus when opening the combo (scrolling + keyboard navigation focus)
45 if (is_selected)
46 {
47 ImGui::SetItemDefaultFocus();
48 }
49 }
50
51 ImGui::EndCombo();
52 }
53 return clicked;
54 }
55
56 } // namespace NAV::gui::widgets
57