Mercurial > trustbridge
comparison ui/administratorwindow.h @ 1255:2a1aa9df8f11
(issue133) Improve API documentation
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Thu, 25 Sep 2014 17:58:12 +0200 |
| parents | 78798d3af8f0 |
| children | ff9cd05e861e |
comparison
equal
deleted
inserted
replaced
| 1254:6d840341bc25 | 1255:2a1aa9df8f11 |
|---|---|
| 23 #include "certificatetablemodel.h" | 23 #include "certificatetablemodel.h" |
| 24 | 24 |
| 25 class QMenu; | 25 class QMenu; |
| 26 class QAction; | 26 class QAction; |
| 27 | 27 |
| 28 /** @brief Main Window of the Administrator application | |
| 29 * | |
| 30 * The controlling class of the Admin application. Holds | |
| 31 * the certificate data and the settings of the application. | |
| 32 */ | |
| 28 class AdministratorWindow : public QMainWindow | 33 class AdministratorWindow : public QMainWindow |
| 29 { | 34 { |
| 30 Q_OBJECT | 35 Q_OBJECT |
| 31 | 36 |
| 32 public: | 37 public: |
| 56 * @return a list of certificates. | 61 * @return a list of certificates. |
| 57 */ | 62 */ |
| 58 QList<Certificate> currentChanges(); | 63 QList<Certificate> currentChanges(); |
| 59 | 64 |
| 60 private slots: | 65 private slots: |
| 66 /** @brief Create the SW Packages for the target platforms. */ | |
| 61 void createInstaller(); | 67 void createInstaller(); |
| 68 /** @brief Shows the About dialog. */ | |
| 62 void showAbout(); | 69 void showAbout(); |
| 70 /** @brief Opens the Help in a browser window. */ | |
| 63 void showHelp(); | 71 void showHelp(); |
| 72 /** @brief Presents a Dialog to load a certificate list and handles the loading. */ | |
| 64 void loadCertificateFile(); | 73 void loadCertificateFile(); |
| 74 /** @brief Save the current selection of certificates as a certificate list. */ | |
| 65 void saveCertificateFile(); | 75 void saveCertificateFile(); |
| 76 /** @brief Add certificates to the certificate table. */ | |
| 66 void addCertificates(); | 77 void addCertificates(); |
| 78 /** @brief Remove certificates from the current certificate table. */ | |
| 67 void removeCertificates(); | 79 void removeCertificates(); |
| 80 /** @brief Changes the state of a certificate when it was clicked. */ | |
| 68 void clickedCertificate(const QModelIndex&); | 81 void clickedCertificate(const QModelIndex&); |
| 69 | 82 |
| 70 private: | 83 private: |
| 84 /** @brief Setup UI Actions */ | |
| 71 void createActions(); | 85 void createActions(); |
| 86 /** @brief Setup UI Menu Bar */ | |
| 72 void createMenuBar(); | 87 void createMenuBar(); |
| 88 /** @brief Create the UI elements of the Window */ | |
| 73 void createContent(); | 89 void createContent(); |
| 90 /** @brief Load a certificate list into the table view */ | |
| 74 void loadCertificateTable(); | 91 void loadCertificateTable(); |
| 92 /** @brief Add a list of certificates to the table view | |
| 93 * | |
| 94 * @param[in] certs The certificates to add. | |
| 95 */ | |
| 75 void addToCertificateTable(const QList<Certificate> &certs); | 96 void addToCertificateTable(const QList<Certificate> &certs); |
| 97 /** @brief write a log file for the list creation. | |
| 98 * | |
| 99 * This creates a log entry containing all pertinent information of a | |
| 100 * certificate list creation. It records changes | |
| 101 * made to the certificate list and notes down the current time and | |
| 102 * the key used to sign the certificate list. | |
| 103 * | |
| 104 * @param [in] list the certificate list that is about to be created and should | |
| 105 * be logged. | |
| 106 * @param [in] keyFingerprint the encoded fingerprint of the signing key used. | |
| 107 * | |
| 108 * @returns A byte array containing the log information in latin1 encoding. | |
| 109 */ | |
| 76 QByteArray createLogEntries(const CertificateList &list, const QString &keyFingerprint); | 110 QByteArray createLogEntries(const CertificateList &list, const QString &keyFingerprint); |
| 77 | 111 |
| 78 QSettings mSettings; | 112 QSettings mSettings; |
| 79 | 113 |
| 80 QMenuBar *menuBar; | 114 QMenuBar *menuBar; |