settings_8h_source.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>openPilotLog: src/classes/settings.h Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  17. <script type="text/javascript" src="search/searchdata.js"></script>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. <link href="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
  21. </head>
  22. <body>
  23. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  24. <div id="titlearea">
  25. <table cellspacing="0" cellpadding="0">
  26. <tbody>
  27. <tr style="height: 56px;">
  28. <td id="projectlogo"><img alt="Logo" src="icon_main.png"/></td>
  29. <td id="projectalign" style="padding-left: 0.5em;">
  30. <div id="projectname">openPilotLog
  31. </div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- end header part -->
  38. <!-- Generated by Doxygen 1.9.1 -->
  39. <script type="text/javascript">
  40. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  41. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  42. /* @license-end */
  43. </script>
  44. <script type="text/javascript" src="menudata.js"></script>
  45. <script type="text/javascript" src="menu.js"></script>
  46. <script type="text/javascript">
  47. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  48. $(function() {
  49. initMenu('',true,false,'search.php','Search');
  50. $(document).ready(function() { init_search(); });
  51. });
  52. /* @license-end */</script>
  53. <div id="main-nav"></div>
  54. </div><!-- top -->
  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
  56. <div id="nav-tree">
  57. <div id="nav-tree-contents">
  58. <div id="nav-sync" class="sync"></div>
  59. </div>
  60. </div>
  61. <div id="splitbar" style="-moz-user-select:none;"
  62. class="ui-resizable-handle">
  63. </div>
  64. </div>
  65. <script type="text/javascript">
  66. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  67. $(document).ready(function(){initNavTree('settings_8h_source.html',''); initResizable(); });
  68. /* @license-end */
  69. </script>
  70. <div id="doc-content">
  71. <!-- window showing the filter options -->
  72. <div id="MSearchSelectWindow"
  73. onmouseover="return searchBox.OnSearchSelectShow()"
  74. onmouseout="return searchBox.OnSearchSelectHide()"
  75. onkeydown="return searchBox.OnSearchSelectKey(event)">
  76. </div>
  77. <!-- iframe showing the search results (closed by default) -->
  78. <div id="MSearchResultsWindow">
  79. <iframe src="javascript:void(0)" frameborder="0"
  80. name="MSearchResults" id="MSearchResults">
  81. </iframe>
  82. </div>
  83. <div class="header">
  84. <div class="headertitle">
  85. <div class="title">settings.h</div> </div>
  86. </div><!--header-->
  87. <div class="contents">
  88. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  89. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *openPilotLog - A FOSS Pilot Logbook Application</span></div>
  90. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *Copyright (C) 2020-2022 Felix Turowsky</span></div>
  91. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  92. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *This program is free software: you can redistribute it and/or modify</span></div>
  93. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *it under the terms of the GNU General Public License as published by</span></div>
  94. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *the Free Software Foundation, either version 3 of the License, or</span></div>
  95. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *(at your option) any later version.</span></div>
  96. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
  97. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *This program is distributed in the hope that it will be useful,</span></div>
  98. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
  99. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
  100. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *GNU General Public License for more details.</span></div>
  101. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> *</span></div>
  102. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *You should have received a copy of the GNU General Public License</span></div>
  103. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.</span></div>
  104. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  105. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#ifndef SETTINGS_H</span></div>
  106. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define SETTINGS_H</span></div>
  107. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;QtCore&gt;</span></div>
  108. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;QSettings&gt;</span></div>
  109. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
  110. <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_settings.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_settings.html">Settings</a> {</div>
  111. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">public</span>:</div>
  112. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">enum class</span> Main {</div>
  113. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; SetupComplete,</div>
  114. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; Style,</div>
  115. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; Font,</div>
  116. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; FontSize,</div>
  117. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; UseSystemFont,</div>
  118. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; LogbookView,</div>
  119. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; DateFormat,</div>
  120. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; };</div>
  121. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
  122. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">enum class</span> UserData {</div>
  123. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; DisplaySelfAs,</div>
  124. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; TailSortColumn,</div>
  125. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; PilotSortColumn,</div>
  126. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; FtlWarningThreshold,</div>
  127. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; CurrWarningThreshold,</div>
  128. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; ShowToLgdCurrency,</div>
  129. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; ShowLicCurrency,</div>
  130. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ShowTrCurrency,</div>
  131. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; ShowLckCurrency,</div>
  132. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; ShowMedCurrency,</div>
  133. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; ShowCustom1Currency,</div>
  134. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; ShowCustom2Currency,</div>
  135. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; Custom1CurrencyName,</div>
  136. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; Custom2CurrencyName,</div>
  137. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; };</div>
  138. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
  139. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">enum class</span> FlightLogging {</div>
  140. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; Function,</div>
  141. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; Approach,</div>
  142. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; NightLoggingEnabled,</div>
  143. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; LogIFR,</div>
  144. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; FlightNumberPrefix,</div>
  145. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; PilotFlying,</div>
  146. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; NightAngle,</div>
  147. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="comment">//FlightTimeFormat,</span></div>
  148. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; };</div>
  149. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
  150. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_settings.html#a15c8ec82ace3649517d3f2f1bd943b66">setup</a>();</div>
  151. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_settings.html#aa26da663d96a908585fb90c6444f975b">resetToDefaults</a>();</div>
  152. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
  153. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">static</span> QVariant read(<span class="keyword">const</span> Main key);</div>
  154. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> write(<span class="keyword">const</span> Main key, <span class="keyword">const</span> QVariant &amp;val);</div>
  155. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
  156. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">static</span> QVariant read(<span class="keyword">const</span> FlightLogging key);</div>
  157. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> write(<span class="keyword">const</span> UserData key, <span class="keyword">const</span> QVariant &amp;val);</div>
  158. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
  159. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">static</span> QVariant read(<span class="keyword">const</span> UserData key);</div>
  160. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> write(<span class="keyword">const</span> FlightLogging key, <span class="keyword">const</span> QVariant &amp;val);</div>
  161. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
  162. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">static</span> QString <a class="code" href="class_settings.html#a383fcbcbdc4875a7bfe78adafa1bf434">groupOfKey</a>(<span class="keyword">const</span> Main key);</div>
  163. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">static</span> QString <a class="code" href="class_settings.html#a383fcbcbdc4875a7bfe78adafa1bf434">groupOfKey</a>(<span class="keyword">const</span> FlightLogging key);</div>
  164. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">static</span> QString <a class="code" href="class_settings.html#a383fcbcbdc4875a7bfe78adafa1bf434">groupOfKey</a>(<span class="keyword">const</span> UserData key);</div>
  165. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
  166. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">static</span> QString <a class="code" href="class_settings.html#a5607bfbe89ee46c468cd0912e191ca08">stringOfKey</a>(<span class="keyword">const</span> Main key);</div>
  167. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">static</span> QString <a class="code" href="class_settings.html#a5607bfbe89ee46c468cd0912e191ca08">stringOfKey</a>(<span class="keyword">const</span> FlightLogging key);</div>
  168. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">static</span> QString <a class="code" href="class_settings.html#a5607bfbe89ee46c468cd0912e191ca08">stringOfKey</a>(<span class="keyword">const</span> UserData key);</div>
  169. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
  170. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">static</span> QSettings settings();</div>
  171. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> sync() { QSettings().sync(); }</div>
  172. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
  173. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="keyword">private</span>:</div>
  174. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">static</span> QMap&lt;Main, QString&gt; mainMap;</div>
  175. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">static</span> QMap&lt;UserData, QString&gt; userDataMap;</div>
  176. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">static</span> QMap&lt;FlightLogging, QString&gt; flightLoggingMap;</div>
  177. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;};</div>
  178. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
  179. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// SETTINGS_H</span></div>
  180. <div class="ttc" id="aclass_settings_html"><div class="ttname"><a href="class_settings.html">Settings</a></div><div class="ttdoc">Thin wrapper for the QSettings class, simplifying reading and writing of settings.</div><div class="ttdef"><b>Definition:</b> settings.h:27</div></div>
  181. <div class="ttc" id="aclass_settings_html_a15c8ec82ace3649517d3f2f1bd943b66"><div class="ttname"><a href="class_settings.html#a15c8ec82ace3649517d3f2f1bd943b66">Settings::setup</a></div><div class="ttdeci">static void setup()</div><div class="ttdoc">Should be called after QCoreApplication::set...Name have been called.</div><div class="ttdef"><b>Definition:</b> settings.cpp:60</div></div>
  182. <div class="ttc" id="aclass_settings_html_a383fcbcbdc4875a7bfe78adafa1bf434"><div class="ttname"><a href="class_settings.html#a383fcbcbdc4875a7bfe78adafa1bf434">Settings::groupOfKey</a></div><div class="ttdeci">static QString groupOfKey(const Main key)</div><div class="ttdoc">Return string representation of group of key: &quot;ini_header/key&quot;.</div><div class="ttdef"><b>Definition:</b> settings.cpp:119</div></div>
  183. <div class="ttc" id="aclass_settings_html_a5607bfbe89ee46c468cd0912e191ca08"><div class="ttname"><a href="class_settings.html#a5607bfbe89ee46c468cd0912e191ca08">Settings::stringOfKey</a></div><div class="ttdeci">static QString stringOfKey(const Main key)</div><div class="ttdoc">Return string representation of key.</div><div class="ttdef"><b>Definition:</b> settings.cpp:131</div></div>
  184. <div class="ttc" id="aclass_settings_html_aa26da663d96a908585fb90c6444f975b"><div class="ttname"><a href="class_settings.html#aa26da663d96a908585fb90c6444f975b">Settings::resetToDefaults</a></div><div class="ttdeci">static void resetToDefaults()</div><div class="ttdoc">Settings::resetToDefaults (Re-)sets all settings to the default value.</div><div class="ttdef"><b>Definition:</b> settings.cpp:69</div></div>
  185. </div><!-- fragment --></div><!-- contents -->
  186. </div><!-- doc-content -->
  187. <!-- start footer part -->
  188. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  189. <ul>
  190. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_018e9aafb459e6e1a4953404cb0c0b1d.html">classes</a></li><li class="navelem"><b>settings.h</b></li>
  191. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  192. </ul>
  193. </div>
  194. </body>
  195. </html>