sani7/remote-ui
1
0
Fork 0
mirror of https://github.com/Sani7/remote-ui.git synced 2026-10-27 06:01:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Client doxygen

Browse Source 
Add documentation to the client
This commit is contained in:
sani7
2026-02-14 14:32:36 +01:00
parent 758958fd3a
commit 7a74847f45
5 changed files with 448 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/ui_base.hpp
+259 -22
View File
@@ -22,10 +22,34 @@ class UI_base : public QMainWindow
{
Q_OBJECT
public:
/**
* @brief Construct a new ui base object
*
* @param name The name of the simulator
* @param api The weboscket connection to the server API
* @param parent The parent widget
*/
explicit UI_base(QString name, Web_socket_wrapper *api, QWidget *parent = nullptr);
void sim_update(void);
/**
* @brief Get the name of the simulator
*
* @return QString The name of the simulator
*/
QString name() const;
/**
* @brief Get the UI element by its ID
*
* @param id The ID of the UI element
* @return QWidget* The UI element
*/
QWidget *id_to_ui(size_t id);
/**
* @brief Get the label associated with a widget
* This function has to be overridden in derived classes if labels are used
*
* @param widget The widget
* @return QLabel* The associated label, or nullptr if none
*/
virtual QLabel *id_to_label(QWidget *widget)
{
Q_UNUSED(widget);
@@ -33,46 +57,259 @@ class UI_base : public QMainWindow
}
protected:
/**
* @brief Handle an event callback from the server
*
* @param j The JSON event
*/
void on_event_cb(json &j);
/**
* @brief Handle a command callback from the server
*
* @param j The JSON command
*/
void on_cmd_cb(json &j);
/**
* @brief Push a UI item to the internal list and setup its connections
* The item have to be in the same order as from the server
*
* @param item The UI item to push
*/
void push_ui_item(QWidget *item);
/**
* @brief Parse UI items from JSON and update the UI accordingly
*
* @param input The JSON input containing UI items
*/
void UI_item_parser(json &input);
virtual void process_ui_label(json &ui_item, QWidget *widget);
virtual void process_ui_slider(json &ui_item, QWidget *widget);
virtual void process_ui_dial(json &ui_item, QWidget *widget);
virtual void process_ui_thermo(json &ui_item, QWidget *widget);
virtual void process_ui_textbox(json &ui_item, QWidget *widget);
virtual void process_ui_combobox(json &ui_item, QWidget *widget);
virtual void process_ui_radiobutton(json &ui_item, QWidget *widget);
virtual void process_ui_checkbox(json &ui_item, QWidget *widget);
virtual void process_ui_button(json &ui_item, QWidget *widget);
virtual void process_ui_led(json &ui_item, QWidget *widget);
virtual void process_ui_spinbox(json &ui_item, QWidget *widget);
virtual void process_ui_double_spinbox(json &ui_item, QWidget *widget);
virtual void process_ui_hex_spinbox(json &ui_item, QWidget *widget);
virtual void process_ui_tab_widget(json &ui_item, QWidget *widget);
virtual void process_ui_stacked_widget(json &ui_item, QWidget *widget);
virtual void process_ui_status_bar(json &ui_item, QWidget *widget);
virtual void process_ui_plot(json &ui_item, QWidget *widget);
virtual void process_ui_table(json &ui_item, QWidget *widget);
virtual void process_ui_can(json &ui_item, QWidget *widget);
/**
* @brief Process a label UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_label(json &ui_item, QWidget *widget);
/**
* @brief Process a slider UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_slider(json &ui_item, QWidget *widget);
/**
* @brief Process a dial UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_dial(json &ui_item, QWidget *widget);
/**
* @brief Process a thermo UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_thermo(json &ui_item, QWidget *widget);
/**
* @brief Process a textbox UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_textbox(json &ui_item, QWidget *widget);
/**
* @brief Process a combobox UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_combobox(json &ui_item, QWidget *widget);
/**
* @brief Process a radiobutton UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_radiobutton(json &ui_item, QWidget *widget);
/**
* @brief Process a checkbox UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_checkbox(json &ui_item, QWidget *widget);
/**
* @brief Process a button UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_button(json &ui_item, QWidget *widget);
/**
* @brief Process a LED UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_led(json &ui_item, QWidget *widget);
/**
* @brief Process a spinbox UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_spinbox(json &ui_item, QWidget *widget);
/**
* @brief Process a double spinbox UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_double_spinbox(json &ui_item, QWidget *widget);
/**
* @brief Process a hex spinbox UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_hex_spinbox(json &ui_item, QWidget *widget);
/**
* @brief Process a tab widget UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_tab_widget(json &ui_item, QWidget *widget);
/**
* @brief Process a stacked widget UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_stacked_widget(json &ui_item, QWidget *widget);
/**
* @brief Process a status bar UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_status_bar(json &ui_item, QWidget *widget);
/**
* @brief Process a plot UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_plot(json &ui_item, QWidget *widget);
/**
* @brief Process a table UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_table(json &ui_item, QWidget *widget);
/**
* @brief Process a CAN UI item
*
* @param ui_item The JSON UI item
* @param widget The associated widget
*/
void process_ui_can(json &ui_item, QWidget *widget);
/**
* @brief Setup a generic UI item
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_ui_item(QWidget *item, size_t index);
/**
* @brief Setup a button UI item
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_button(QWidget *item, size_t index);
/**
* @brief Set the up combobox object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_combobox(QWidget *item, size_t index);
/**
* @brief Set the up checkbox object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_checkbox(QWidget *item, size_t index);
/**
* @brief Set the up dial object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_dial(QWidget *item, size_t index);
/**
* @brief Set the up slider object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_slider(QWidget *item, size_t index);
/**
* @brief Set the up spinbox object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_spinbox(QWidget *item, size_t index);
/**
* @brief Set the up double spinbox object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_double_spinbox(QWidget *item, size_t index);
/**
* @brief Set the up hex spinbox object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_hex_spinbox(QWidget *item, size_t index);
/**
* @brief Set the up tab widget object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_tab_widget(QWidget *item, size_t index);
/**
* @brief Set the up CAN UI object
*
* @param item The UI item
* @param index The index of the UI item
*/
void setup_can_ui(QWidget *item, size_t index);
void showEvent(QShowEvent *event);
void closeEvent(QCloseEvent *event);
/**
* @brief Handle the show event
* And will connect the WebSocket signals
*
* @param event
*/
void showEvent(QShowEvent *event) override;
/**
* @brief Handle the close event
* And will disconnect the WebSocket signals
*
* @param event
*/
void closeEvent(QCloseEvent *event) override;
private:
Web_socket_wrapper *m_web_socket;