class_settings.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  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: Settings Class Reference</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('class_settings.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="summary">
  85. <a href="#pub-types">Public Types</a> &#124;
  86. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  87. <a href="class_settings-members.html">List of all members</a> </div>
  88. <div class="headertitle">
  89. <div class="title">Settings Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>Thin wrapper for the QSettings class, simplifying reading and writing of settings.
  93. <a href="class_settings.html#details">More...</a></p>
  94. <p><code>#include &lt;<a class="el" href="settings_8h_source.html">settings.h</a>&gt;</code></p>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  97. Public Types</h2></td></tr>
  98. <tr class="memitem:ad773155b416593422351cfd13fa0988a"><td class="memItemLeft" align="right" valign="top"><a id="ad773155b416593422351cfd13fa0988a"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Main</b> { <br />
  99. &#160;&#160;<b>SetupComplete</b>
  100. , <b>Style</b>
  101. , <b>Font</b>
  102. , <b>FontSize</b>
  103. , <br />
  104. &#160;&#160;<b>UseSystemFont</b>
  105. , <b>LogbookView</b>
  106. , <b>DateFormat</b>
  107. <br />
  108. }</td></tr>
  109. <tr class="separator:ad773155b416593422351cfd13fa0988a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:aec0902ffbe61e904967453056bf4522b"><td class="memItemLeft" align="right" valign="top"><a id="aec0902ffbe61e904967453056bf4522b"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>UserData</b> { <br />
  111. &#160;&#160;<b>DisplaySelfAs</b>
  112. , <b>TailSortColumn</b>
  113. , <b>PilotSortColumn</b>
  114. , <b>FtlWarningThreshold</b>
  115. , <br />
  116. &#160;&#160;<b>CurrWarningThreshold</b>
  117. , <b>ShowToLgdCurrency</b>
  118. , <b>ShowLicCurrency</b>
  119. , <b>ShowTrCurrency</b>
  120. , <br />
  121. &#160;&#160;<b>ShowLckCurrency</b>
  122. , <b>ShowMedCurrency</b>
  123. , <b>ShowCustom1Currency</b>
  124. , <b>ShowCustom2Currency</b>
  125. , <br />
  126. &#160;&#160;<b>Custom1CurrencyName</b>
  127. , <b>Custom2CurrencyName</b>
  128. <br />
  129. }</td></tr>
  130. <tr class="separator:aec0902ffbe61e904967453056bf4522b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a43c8bcc5043cdb47eda97d1386d187e7"><td class="memItemLeft" align="right" valign="top"><a id="a43c8bcc5043cdb47eda97d1386d187e7"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>FlightLogging</b> { <br />
  132. &#160;&#160;<b>Function</b>
  133. , <b>Approach</b>
  134. , <b>NightLoggingEnabled</b>
  135. , <b>LogIFR</b>
  136. , <br />
  137. &#160;&#160;<b>FlightNumberPrefix</b>
  138. , <b>PilotFlying</b>
  139. , <b>NightAngle</b>
  140. <br />
  141. }</td></tr>
  142. <tr class="separator:a43c8bcc5043cdb47eda97d1386d187e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table><table class="memberdecls">
  144. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  145. Static Public Member Functions</h2></td></tr>
  146. <tr class="memitem:a15c8ec82ace3649517d3f2f1bd943b66"><td class="memItemLeft" align="right" valign="top"><a id="a15c8ec82ace3649517d3f2f1bd943b66"></a>
  147. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_settings.html#a15c8ec82ace3649517d3f2f1bd943b66">setup</a> ()</td></tr>
  148. <tr class="memdesc:a15c8ec82ace3649517d3f2f1bd943b66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be called after QCoreApplication::set...Name have been called. <br /></td></tr>
  149. <tr class="separator:a15c8ec82ace3649517d3f2f1bd943b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aa26da663d96a908585fb90c6444f975b"><td class="memItemLeft" align="right" valign="top"><a id="aa26da663d96a908585fb90c6444f975b"></a>
  151. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_settings.html#aa26da663d96a908585fb90c6444f975b">resetToDefaults</a> ()</td></tr>
  152. <tr class="memdesc:aa26da663d96a908585fb90c6444f975b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_settings.html#aa26da663d96a908585fb90c6444f975b" title="Settings::resetToDefaults (Re-)sets all settings to the default value.">Settings::resetToDefaults</a> (Re-)sets all settings to the default value. <br /></td></tr>
  153. <tr class="separator:aa26da663d96a908585fb90c6444f975b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:aec518e95a03d5ff6e999756ba015ffa0"><td class="memItemLeft" align="right" valign="top"><a id="aec518e95a03d5ff6e999756ba015ffa0"></a>
  155. static QVariant&#160;</td><td class="memItemRight" valign="bottom"><b>read</b> (const Main key)</td></tr>
  156. <tr class="separator:aec518e95a03d5ff6e999756ba015ffa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a7f24cef54e7e28cc01c312acfeefec4d"><td class="memItemLeft" align="right" valign="top"><a id="a7f24cef54e7e28cc01c312acfeefec4d"></a>
  158. static void&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (const Main key, const QVariant &amp;val)</td></tr>
  159. <tr class="separator:a7f24cef54e7e28cc01c312acfeefec4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a3ca5be51df62f94f4763bd55256627c5"><td class="memItemLeft" align="right" valign="top"><a id="a3ca5be51df62f94f4763bd55256627c5"></a>
  161. static QVariant&#160;</td><td class="memItemRight" valign="bottom"><b>read</b> (const FlightLogging key)</td></tr>
  162. <tr class="separator:a3ca5be51df62f94f4763bd55256627c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a45772487ba213f70fa8fa2c8f57dd46f"><td class="memItemLeft" align="right" valign="top"><a id="a45772487ba213f70fa8fa2c8f57dd46f"></a>
  164. static void&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (const UserData key, const QVariant &amp;val)</td></tr>
  165. <tr class="separator:a45772487ba213f70fa8fa2c8f57dd46f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:aad7abd7032f601b6dc535195d68fe9ec"><td class="memItemLeft" align="right" valign="top"><a id="aad7abd7032f601b6dc535195d68fe9ec"></a>
  167. static QVariant&#160;</td><td class="memItemRight" valign="bottom"><b>read</b> (const UserData key)</td></tr>
  168. <tr class="separator:aad7abd7032f601b6dc535195d68fe9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a7bd82c8398781688095057d227405e81"><td class="memItemLeft" align="right" valign="top"><a id="a7bd82c8398781688095057d227405e81"></a>
  170. static void&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (const FlightLogging key, const QVariant &amp;val)</td></tr>
  171. <tr class="separator:a7bd82c8398781688095057d227405e81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a383fcbcbdc4875a7bfe78adafa1bf434"><td class="memItemLeft" align="right" valign="top"><a id="a383fcbcbdc4875a7bfe78adafa1bf434"></a>
  173. static QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_settings.html#a383fcbcbdc4875a7bfe78adafa1bf434">groupOfKey</a> (const Main key)</td></tr>
  174. <tr class="memdesc:a383fcbcbdc4875a7bfe78adafa1bf434"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return string representation of group of key: "ini_header/key". <br /></td></tr>
  175. <tr class="separator:a383fcbcbdc4875a7bfe78adafa1bf434"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a95ab752b0270a83a6e7137a4b5813c67"><td class="memItemLeft" align="right" valign="top"><a id="a95ab752b0270a83a6e7137a4b5813c67"></a>
  177. static QString&#160;</td><td class="memItemRight" valign="bottom"><b>groupOfKey</b> (const FlightLogging key)</td></tr>
  178. <tr class="separator:a95ab752b0270a83a6e7137a4b5813c67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a026c28b54029b1d2641bc58664a23ccd"><td class="memItemLeft" align="right" valign="top"><a id="a026c28b54029b1d2641bc58664a23ccd"></a>
  180. static QString&#160;</td><td class="memItemRight" valign="bottom"><b>groupOfKey</b> (const UserData key)</td></tr>
  181. <tr class="separator:a026c28b54029b1d2641bc58664a23ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a5607bfbe89ee46c468cd0912e191ca08"><td class="memItemLeft" align="right" valign="top"><a id="a5607bfbe89ee46c468cd0912e191ca08"></a>
  183. static QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_settings.html#a5607bfbe89ee46c468cd0912e191ca08">stringOfKey</a> (const Main key)</td></tr>
  184. <tr class="memdesc:a5607bfbe89ee46c468cd0912e191ca08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return string representation of key. <br /></td></tr>
  185. <tr class="separator:a5607bfbe89ee46c468cd0912e191ca08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a51b9c2b631939cea25a7c9aa7bbef728"><td class="memItemLeft" align="right" valign="top"><a id="a51b9c2b631939cea25a7c9aa7bbef728"></a>
  187. static QString&#160;</td><td class="memItemRight" valign="bottom"><b>stringOfKey</b> (const FlightLogging key)</td></tr>
  188. <tr class="separator:a51b9c2b631939cea25a7c9aa7bbef728"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a638714c15f1853789abc332af86fd364"><td class="memItemLeft" align="right" valign="top"><a id="a638714c15f1853789abc332af86fd364"></a>
  190. static QString&#160;</td><td class="memItemRight" valign="bottom"><b>stringOfKey</b> (const UserData key)</td></tr>
  191. <tr class="separator:a638714c15f1853789abc332af86fd364"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a529d2c05573494740e1f45c946349352"><td class="memItemLeft" align="right" valign="top"><a id="a529d2c05573494740e1f45c946349352"></a>
  193. static QSettings&#160;</td><td class="memItemRight" valign="bottom"><b>settings</b> ()</td></tr>
  194. <tr class="separator:a529d2c05573494740e1f45c946349352"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:a0c1faf096c16f1626ce9f5c67ce666a3"><td class="memItemLeft" align="right" valign="top"><a id="a0c1faf096c16f1626ce9f5c67ce666a3"></a>
  196. static void&#160;</td><td class="memItemRight" valign="bottom"><b>sync</b> ()</td></tr>
  197. <tr class="separator:a0c1faf096c16f1626ce9f5c67ce666a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. </table>
  199. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  200. <div class="textblock"><p>Thin wrapper for the QSettings class, simplifying reading and writing of settings. </p>
  201. </div><hr/>The documentation for this class was generated from the following files:<ul>
  202. <li>src/classes/<a class="el" href="settings_8h_source.html">settings.h</a></li>
  203. <li>src/classes/settings.cpp</li>
  204. </ul>
  205. </div><!-- contents -->
  206. </div><!-- doc-content -->
  207. <!-- start footer part -->
  208. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  209. <ul>
  210. <li class="navelem"><a class="el" href="class_settings.html">Settings</a></li>
  211. <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>
  212. </ul>
  213. </div>
  214. </body>
  215. </html>