2
0

class_translator.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  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: Translator 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_translator.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-static-methods">Static Public Member Functions</a> &#124;
  86. <a href="class_translator-members.html">List of all members</a> </div>
  87. <div class="headertitle">
  88. <div class="title">Translator Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <p>The ATranslator class is responsible for managing the QTranslator used for providing localisations. Translations are planned, but are not currently being worked on. The way QT language tools are working with CMAKE, there are some considerations for when works on translation actually start. See <a href="https://bugreports.qt.io/browse/QTBUG-41736">here</a> and <a href="https://bugreports.qt.io/browse/QTBUG-76410">here</a>. Long story short, make sure to use a version of CMake that is 3.16 or earlier, or 3.19.2 or later.
  92. <a href="class_translator.html#details">More...</a></p>
  93. <p><code>#include &lt;<a class="el" href="translator_8h_source.html">translator.h</a>&gt;</code></p>
  94. <div class="dynheader">
  95. Inheritance diagram for Translator:</div>
  96. <div class="dyncontent">
  97. <div class="center">
  98. <img src="class_translator.png" alt=""/>
  99. </div></div>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  102. Static Public Member Functions</h2></td></tr>
  103. <tr class="memitem:a62151ba607a3e1539e177ffbed234717"><td class="memItemLeft" align="right" valign="top"><a id="a62151ba607a3e1539e177ffbed234717"></a>
  104. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_translator.html#a62151ba607a3e1539e177ffbed234717">installTranslator</a> (<a class="el" href="namespace_o_p_l.html#a5bd3211ed824e4526fd117ffb667aacc">OPL::Translation</a> language=OPL::Translation::English)</td></tr>
  105. <tr class="memdesc:a62151ba607a3e1539e177ffbed234717"><td class="mdescLeft">&#160;</td><td class="mdescRight">Installs a QTranslator with the selected language. Defaults to English. Call this function before constructing the Main Window. <br /></td></tr>
  106. <tr class="separator:a62151ba607a3e1539e177ffbed234717"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <div class="textblock"><p>The ATranslator class is responsible for managing the QTranslator used for providing localisations. Translations are planned, but are not currently being worked on. The way QT language tools are working with CMAKE, there are some considerations for when works on translation actually start. See <a href="https://bugreports.qt.io/browse/QTBUG-41736">here</a> and <a href="https://bugreports.qt.io/browse/QTBUG-76410">here</a>. Long story short, make sure to use a version of CMake that is 3.16 or earlier, or 3.19.2 or later. </p>
  110. <p>The translation source files (.ts) are located at /l10n and once compiled, the translation binaries are at <code>$BINDIR/l10n/</code> and can be accessed via <code>OPL::L10N_FILES</code>.</p>
  111. <p>When a QTranslator is installed, the UI is updated through <a href="https://doc.qt.io/qt-5/qwidget.html#changeEvent">QWidget::changeEvent()</a>. </p>
  112. </div><hr/>The documentation for this class was generated from the following files:<ul>
  113. <li>src/classes/<a class="el" href="translator_8h_source.html">translator.h</a></li>
  114. <li>src/classes/translator.cpp</li>
  115. </ul>
  116. </div><!-- contents -->
  117. </div><!-- doc-content -->
  118. <!-- start footer part -->
  119. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  120. <ul>
  121. <li class="navelem"><a class="el" href="class_translator.html">Translator</a></li>
  122. <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>
  123. </ul>
  124. </div>
  125. </body>
  126. </html>