Mercurial > trustbridge
comparison ui/mainwindow.h @ 1255:2a1aa9df8f11
(issue133) Improve API documentation
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Thu, 25 Sep 2014 17:58:12 +0200 |
parents | 9a482182f80f |
children | 64f812a63de6 |
comparison
equal
deleted
inserted
replaced
1254:6d840341bc25 | 1255:2a1aa9df8f11 |
---|---|
33 class QAction; | 33 class QAction; |
34 class QTimer; | 34 class QTimer; |
35 class QPushButton; | 35 class QPushButton; |
36 | 36 |
37 | 37 |
38 /** @brief Main UI controller | |
39 * | |
40 * The MainWindow controls the logic of the Application | |
41 * it is the central piece that controls the state and starts | |
42 * updates / certificate installation. | |
43 * It also controls the UI widgets for the various certificate lists. | |
44 */ | |
38 class MainWindow : public QMainWindow | 45 class MainWindow : public QMainWindow |
39 { | 46 { |
40 Q_OBJECT | 47 Q_OBJECT |
41 | 48 |
42 public: | 49 public: |
67 /** | 74 /** |
68 * @enum CurrentState | 75 * @enum CurrentState |
69 * @brief The internal state of the application | 76 * @brief The internal state of the application |
70 */ | 77 */ |
71 enum CurrentState { | 78 enum CurrentState { |
72 NewListAvailable, /*! A new certificate list is available. */ | 79 /*! A new certificate list is available. */ |
73 NewSoftwareAvailable, /*! A new Software is avaialable. */ | 80 NewListAvailable, |
74 DownloadingSW, /*! Download in progress. */ | 81 /*! A new Software is avaialable. */ |
75 TransferError, /*! An error happened on the last connection. */ | 82 NewSoftwareAvailable, |
76 NothingChanged /*! Update was susccessfull but nothing new is available. */ | 83 /*! Download in progress. */ |
84 DownloadingSW, | |
85 /*! An error happened on the last connection. */ | |
86 TransferError, | |
87 /*! Update was susccessfull but nothing new is available. */ | |
88 NothingChanged | |
77 }; | 89 }; |
78 | 90 |
79 /** | 91 /** |
80 * @enum LongTimeErrors | 92 * @enum LongTimeErrors |
81 * @brief Errors that should be stored and only shown after some time has elapsed. | 93 * @brief Errors that should be stored and only shown after some time has elapsed. |
82 */ | 94 */ |
83 enum LongTimeErrors { | 95 enum LongTimeErrors { |
84 lteInvalidSoftware, /*! The downloaded Software was invalid. */ | 96 /*! The downloaded Software was invalid. */ |
85 lteInvalidCertificate, /*! The SSL certificate of the download server was wrong. */ | 97 lteInvalidSoftware, |
86 lteInvalidList, /*! The downloaded Certificate List was invalid. */ | 98 /*! The SSL certificate of the download server was wrong. */ |
99 lteInvalidCertificate, | |
100 /*! The downloaded Certificate List was invalid. */ | |
101 lteInvalidList, | |
102 /*! No connection to the server could be established. */ | |
87 lteNoConnection | 103 lteNoConnection |
88 }; | 104 }; |
89 | 105 |
90 /** @brief accessor for the current state. */ | 106 /** @brief accessor for the current state. */ |
91 CurrentState getState() {return mCurState;} | 107 CurrentState getState() {return mCurState;} |