ADate.3 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .TH "ADate" 3 "Fri Mar 4 2022" "openPilotLog" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. ADate \- The \fBADate\fP class is responsible for input/output of Dates and handling the different Date Formats\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <adate\&.h>\fP
  11. .SS "Static Public Member Functions"
  12. .in +1c
  13. .ti -1c
  14. .RI "static QDate \fBparseInput\fP (QString &io_user_input, Opl::Date::ADateFormat format)"
  15. .br
  16. .RI "takes a user-provided input and tries to convert it to a (valid) QDate\&. "
  17. .ti -1c
  18. .RI "static void \fBtryToFix\fP (QString &io_user_input, Opl::Date::ADateFormat format)"
  19. .br
  20. .ti -1c
  21. .RI "static void \fBpadCentury\fP (QString &io_user_input, Opl::Date::ADateFormat format)"
  22. .br
  23. .RI "padCentury adds the century to a date where it was omitted "
  24. .ti -1c
  25. .RI "static void \fBpadZeroes\fP (QString &io_user_input)"
  26. .br
  27. .RI "pads a user-provided date string with 0s to facilitate conversion to QDate "
  28. .ti -1c
  29. .RI "static void \fBaddSeperators\fP (QString &io_user_input, const Opl::Date::ADateFormat &format)"
  30. .br
  31. .ti -1c
  32. .RI "static bool \fBcontainsSeperator\fP (const QString &user_input)"
  33. .br
  34. .ti -1c
  35. .RI "static QString \fBtoString\fP (const QDate &date, Opl::Date::ADateFormat format=Opl::Date::ADateFormat::ISODate)"
  36. .br
  37. .RI "Reimplements QDate::toString to accept Opl::Date::ADateFormat enums\&. "
  38. .ti -1c
  39. .RI "static const QStringList & \fBgetDisplayNames\fP ()"
  40. .br
  41. .ti -1c
  42. .RI "static const QString \fBgetFormatString\fP (Opl::Date::ADateFormat format)"
  43. .br
  44. .in -1c
  45. .SH "Detailed Description"
  46. .PP
  47. The \fBADate\fP class is responsible for input/output of Dates and handling the different Date Formats\&.
  48. .SH "Member Function Documentation"
  49. .PP
  50. .SS "QDate ADate::parseInput (QString & io_user_input, Opl::Date::ADateFormat format)\fC [static]\fP"
  51. .PP
  52. takes a user-provided input and tries to convert it to a (valid) QDate\&.
  53. .PP
  54. \fBReturns\fP
  55. .RS 4
  56. QDate (invalid if input not recognized)
  57. .RE
  58. .PP
  59. .SH "Author"
  60. .PP
  61. Generated automatically by Doxygen for openPilotLog from the source code\&.