IInstrumentForm.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2026 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_I_INSTRUMENT_FORM_HPP
#define ORES_QT_I_INSTRUMENT_FORM_HPP
 
#include <chrono>
#include <functional>
#include <string>
#include <QString>
#include <QWidget>
#include "ores.trading.api/domain/trade_instrument.hpp"
 
namespace ores::qt {
 
class ClientManager;
class ImageCache;
 
struct InstrumentProvenance {
    int version = 0;
    std::string modified_by;
    std::string performed_by;
    std::chrono::system_clock::time_point recorded_at;
    std::string change_reason_code;
    std::string change_commentary;
};
 
class IInstrumentForm : public QWidget {
    Q_OBJECT
public:
    using QWidget::QWidget;
    ~IInstrumentForm() override = default;
 
    virtual void setClientManager(ClientManager* cm) = 0;
 
    virtual void setUsername(const std::string& username) = 0;
 
    virtual void setImageCache(ImageCache* /*cache*/) {}
 
    virtual void setInstrument(
        const trading::domain::trade_instrument& instrument) = 0;
 
    virtual void clear() = 0;
 
    virtual void setTradeType(const QString& code,
        bool has_options, bool has_extension) = 0;
 
    virtual void setReadOnly(bool readOnly) = 0;
 
    virtual bool isDirty() const = 0;
 
    virtual bool isLoaded() const = 0;
 
    virtual void setChangeReason(
        const std::string& code, const std::string& commentary) = 0;
 
    virtual void writeUiToInstrument() = 0;
 
    virtual void saveInstrument(
        std::function<void(const std::string& id)> on_success,
        std::function<void(const QString& error)> on_failure) = 0;
 
signals:
    void changed();
 
    void instrumentLoaded();
 
    void loadFailed(const QString& error);
 
    void provenanceChanged(const InstrumentProvenance& provenance);
};
 
}
 
#endif