EntityListMdiWindow.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_QT_ENTITY_LIST_MDI_WINDOW_HPP
#define ORES_QT_ENTITY_LIST_MDI_WINDOW_HPP
 
#include <string_view>
#include <QWidget>
#include <QAction>
#include <QTimer>
#include <QIcon>
#include <QCloseEvent>
#include <QProgressBar>
#include <QSplitter>
#include <QTableView>
#include "ores.logging/make_logger.hpp"
#include "ores.qt/AbstractClientModel.hpp"
#include "ores.qt/export.hpp"
 
namespace ores::qt {
 
class ORES_QT_API EntityListMdiWindow : public QWidget {
    Q_OBJECT
 
private:
    inline static std::string_view logger_name = "ores.qt.entity_list_mdi_window";
 
    [[nodiscard]] static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
public:
    explicit EntityListMdiWindow(QWidget* parent = nullptr);
    ~EntityListMdiWindow() override;
 
    QSize sizeHint() const override;
 
public slots:
    void markAsStale();
 
    void clearStaleIndicator();
 
    void reload();
 
protected:
    virtual void doReload() = 0;
 
    virtual void saveSettings();
 
protected:
    void closeEvent(QCloseEvent* event) override;
 
    void initializeTableSettings(QTableView* tableView,
                                  QAbstractItemModel* sourceModel,
                                  std::string_view settingsGroup,
                                  const QVector<int>& defaultHiddenColumns = {},
                                  const QSize& defaultSize = {900, 400},
                                  int settingsVersion = 1,
                                  QSplitter* splitter = nullptr);
 
    void initializeStaleIndicator(QAction* refreshAction, const QString& iconPath);
 
    QProgressBar* loadingBar();
 
    void beginLoading();
 
    void endLoading();
 
    void connectModel(AbstractClientModel* model);
 
    virtual QString normalRefreshTooltip() const { return tr("Refresh"); }
 
    virtual QString staleRefreshTooltip() const {
        return tr("Data changed on server - click to reload");
    }
 
private slots:
    void onPulseTimeout();
 
private:
    void startPulseAnimation();
    void setupColumnVisibility();
    void showHeaderContextMenu(const QPoint& pos);
    void restoreTableSettings();
 
    // Stale indicator members
    QAction* refreshAction_{nullptr};
    QTimer* pulseTimer_{nullptr};
    QIcon normalReloadIcon_;
    QIcon pulseReloadIcon_;
    bool pulseState_{false};
    int pulseCount_{0};
 
    // Loading indicator
    QProgressBar* loadingBar_{nullptr};
 
    // Table settings members
    QTableView* settingsTableView_{nullptr};
    QAbstractItemModel* settingsModel_{nullptr};
    QString settingsGroup_;
    QVector<int> defaultHiddenColumns_;
    QSize defaultSize_{900, 400};
    int settingsVersion_{1};
    QSplitter* settingsSplitter_{nullptr};
 
protected:
    QSize savedWindowSize_;
};
 
}
 
#endif