Translator.3 1.7 KB

1234567891011121314151617181920212223242526272829303132
  1. .TH "Translator" 3 "Tue Aug 9 2022" "openPilotLog" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. Translator \- 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 \fChere\fP and \fChere\fP\&. Long story short, make sure to use a version of CMake that is 3\&.16 or earlier, or 3\&.19\&.2 or later\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <translator\&.h>\fP
  11. .PP
  12. Inherits QObject\&.
  13. .SS "Static Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "static void \fBinstallTranslator\fP (\fBOPL::Translation\fP language=OPL::Translation::English)"
  17. .br
  18. .RI "Installs a QTranslator with the selected language\&. Defaults to English\&. Call this function before constructing the Main Window\&. "
  19. .in -1c
  20. .SH "Detailed Description"
  21. .PP
  22. 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 \fChere\fP and \fChere\fP\&. Long story short, make sure to use a version of CMake that is 3\&.16 or earlier, or 3\&.19\&.2 or later\&.
  23. The translation source files (\&.ts) are located at /l10n and once compiled, the translation binaries are at \fC$BINDIR/l10n/\fP and can be accessed via \fCOPL::L10N_FILES\fP\&.
  24. .PP
  25. When a QTranslator is installed, the UI is updated through \fCQWidget::changeEvent()\fP\&.
  26. .SH "Author"
  27. .PP
  28. Generated automatically by Doxygen for openPilotLog from the source code\&.