class_first_run_dialog.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  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: FirstRunDialog 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_first_run_dialog.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-methods">Public Member Functions</a> &#124;
  86. <a href="#pro-methods">Protected Member Functions</a> &#124;
  87. <a href="class_first_run_dialog-members.html">List of all members</a> </div>
  88. <div class="headertitle">
  89. <div class="title">FirstRunDialog Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>The <a class="el" href="class_first_run_dialog.html" title="The FirstRunDialog is used as a set-up wizard for the application.">FirstRunDialog</a> is used as a set-up wizard for the application.
  93. <a href="class_first_run_dialog.html#details">More...</a></p>
  94. <p><code>#include &lt;<a class="el" href="firstrundialog_8h_source.html">firstrundialog.h</a>&gt;</code></p>
  95. <div class="dynheader">
  96. Inheritance diagram for FirstRunDialog:</div>
  97. <div class="dyncontent">
  98. <div class="center">
  99. <img src="class_first_run_dialog.png" alt=""/>
  100. </div></div>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  103. Public Member Functions</h2></td></tr>
  104. <tr class="memitem:af20a93d7f364e102f2b8525a85860415"><td class="memItemLeft" align="right" valign="top"><a id="af20a93d7f364e102f2b8525a85860415"></a>
  105. &#160;</td><td class="memItemRight" valign="bottom"><b>FirstRunDialog</b> (QWidget *parent=nullptr)</td></tr>
  106. <tr class="separator:af20a93d7f364e102f2b8525a85860415"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table><table class="memberdecls">
  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  109. Protected Member Functions</h2></td></tr>
  110. <tr class="memitem:a0d7e1fb158f0c2850a1c0238752ff67c"><td class="memItemLeft" align="right" valign="top"><a id="a0d7e1fb158f0c2850a1c0238752ff67c"></a>
  111. void&#160;</td><td class="memItemRight" valign="bottom"><b>reject</b> () override</td></tr>
  112. <tr class="separator:a0d7e1fb158f0c2850a1c0238752ff67c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a314dfc62070d7d88b9a98a5c18c31e74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_first_run_dialog.html#a314dfc62070d7d88b9a98a5c18c31e74">keyPressEvent</a> (QKeyEvent *keyEvent) override</td></tr>
  114. <tr class="memdesc:a314dfc62070d7d88b9a98a5c18c31e74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shows the debug widget by pressing &lt;ctrl + t&gt; <a href="class_first_run_dialog.html#a314dfc62070d7d88b9a98a5c18c31e74">More...</a><br /></td></tr>
  115. <tr class="separator:a314dfc62070d7d88b9a98a5c18c31e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table>
  117. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  118. <div class="textblock"><p>The <a class="el" href="class_first_run_dialog.html" title="The FirstRunDialog is used as a set-up wizard for the application.">FirstRunDialog</a> is used as a set-up wizard for the application. </p>
  119. <p>The Application does not ship with a database, it is created on the fly. This is the main purpose of the <a class="el" href="class_first_run_dialog.html" title="The FirstRunDialog is used as a set-up wizard for the application.">FirstRunDialog</a>. Apart from this main task, user details and preferences are gathered and saved using <a class="el" href="class_settings.html" title="Thin wrapper for the QSettings class, simplifying reading and writing of settings.">Settings</a>.</p>
  120. <p>The Dialog contains a tabbed widget which guides the user through the set up process.</p>
  121. <h3><a class="anchor" id="autotoc_md7"></a>
  122. 1 - Welcome</h3>
  123. <p>In this tab, the user is greeted and has the option to import an existing database instead of creating a new one.</p>
  124. <h3><a class="anchor" id="autotoc_md8"></a>
  125. 2 - Personal Data</h3>
  126. <p>In this tab, the users personal data is collected, which is used to create the first Pilot Entry in the database. ROW ID (1) identifies the logbook owner, which is also referred to as "self" in the application.</p>
  127. <h3><a class="anchor" id="autotoc_md9"></a>
  128. 3 - Currencies</h3>
  129. <p>In this tab, the user can enter the expiration dates of his licenses, medical or other currencies that he wishes to keep track of. These are stored in the database within the currencies table.</p>
  130. <h3><a class="anchor" id="autotoc_md10"></a>
  131. 4 - Flight Logging</h3>
  132. <p>In this tab, the user can determine what the defualt selections for logging a new flight will be. These selections (Pilot Function, Flight Rules,...) are stored in an INI file using the <a class="el" href="class_settings.html" title="Thin wrapper for the QSettings class, simplifying reading and writing of settings.">Settings</a> class.</p>
  133. <h3><a class="anchor" id="autotoc_md11"></a>
  134. 5 - Customization</h3>
  135. <p>In this tab, the user can make selections regarding the application layout and theming, as well as with regards to how data is being displayed. These settings are stored in an INI file using the <a class="el" href="class_settings.html" title="Thin wrapper for the QSettings class, simplifying reading and writing of settings.">Settings</a> class.</p>
  136. <h3><a class="anchor" id="autotoc_md12"></a>
  137. 6 - Finish / Database creation</h3>
  138. <p>In this tab the user can select how the database is created. There are two options, either downloading database templates from the github repository, or to fall back to a set of JSON files inclnuded in the application ressources (see templates.qrc). These built in files are probably not as up-to-date, but enable the application to function if no internet connection is available or the links to the online ressources are broken.</p>
  139. <p>For Debug purcposes, pressing &lt;ctrl+t&gt; will enable a line edit in which a different branch than main can be selected from which the database templates are to be pulled.</p>
  140. <p>Upon successful completion of the <a class="el" href="class_first_run_dialog.html" title="The FirstRunDialog is used as a set-up wizard for the application.">FirstRunDialog</a>, a Setting is written so that the dialog is not shown on subsequent runs. </p>
  141. </div><h2 class="groupheader">Member Function Documentation</h2>
  142. <a id="a314dfc62070d7d88b9a98a5c18c31e74"></a>
  143. <h2 class="memtitle"><span class="permalink"><a href="#a314dfc62070d7d88b9a98a5c18c31e74">&#9670;&nbsp;</a></span>keyPressEvent()</h2>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="mlabels">
  147. <tr>
  148. <td class="mlabels-left">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">void FirstRunDialog::keyPressEvent </td>
  152. <td>(</td>
  153. <td class="paramtype">QKeyEvent *&#160;</td>
  154. <td class="paramname"><em>keyEvent</em></td><td>)</td>
  155. <td></td>
  156. </tr>
  157. </table>
  158. </td>
  159. <td class="mlabels-right">
  160. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Shows the debug widget by pressing &lt;ctrl + t&gt; </p>
  165. <p>keyPressEvent ctrl + t enables debug mode, showing the branch selector which is used to select a git branch other than main for downloading the templates </p><dl class="params"><dt>Parameters</dt><dd>
  166. <table class="params">
  167. <tr><td class="paramname">keyEvent</td><td></td></tr>
  168. </table>
  169. </dd>
  170. </dl>
  171. </div>
  172. </div>
  173. <hr/>The documentation for this class was generated from the following files:<ul>
  174. <li>src/gui/dialogues/<a class="el" href="firstrundialog_8h_source.html">firstrundialog.h</a></li>
  175. <li>src/gui/dialogues/firstrundialog.cpp</li>
  176. </ul>
  177. </div><!-- contents -->
  178. </div><!-- doc-content -->
  179. <!-- start footer part -->
  180. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  181. <ul>
  182. <li class="navelem"><a class="el" href="class_first_run_dialog.html">FirstRunDialog</a></li>
  183. <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>
  184. </ul>
  185. </div>
  186. </body>
  187. </html>