Add docs for Login Form

This commit is contained in:
E. Kozlovskaya 2021-01-05 22:19:09 +07:00
parent ce4c561382
commit fe7f07fccf

View file

@ -11,24 +11,52 @@
#include "administrationpanel.h" #include "administrationpanel.h"
#include "workerpanel.h" #include "workerpanel.h"
QT_BEGIN_NAMESPACE /**
* @brief В данной неймспейсе QTFramework хранит MOC-объект, позволяющий работать с интерфейсом
*
*/
namespace Ui { class LoginWindow; } namespace Ui { class LoginWindow; }
QT_END_NAMESPACE
/**
* @brief Класс интерфейса панели авторизации
*
*/
class LoginWindow : public QMainWindow { class LoginWindow : public QMainWindow {
private: private:
Q_OBJECT Q_OBJECT
//! Статический объект разметки интерфейса
Ui::LoginWindow *ui; Ui::LoginWindow *ui;
/**
* @brief Функция проверки и запуска соответствующих процедур при первом запуске ИС
*
*/
void checkForFirstRun(); void checkForFirstRun();
/**
* @brief Функция авторизации пользователя
*
*/
void doLogin(); void doLogin();
public: public:
/**
* @brief Стандартный конструктор объекта интерфейса
*
* @param parent [ignored]
*/
LoginWindow(QWidget *parent = nullptr); LoginWindow(QWidget *parent = nullptr);
/**
* @brief Стандартный деструктор объекта интерфейса
*
*/
~LoginWindow(); ~LoginWindow();
public slots: public slots:
/**
* @brief Слот события валидации формы авторизации
*
*/
void validateForm(); void validateForm();
}; };
#endif // LOGINWINDOW_H #endif // LOGINWINDOW_H