HybridWebImageFactorySpec.hpp

///
/// HybridWebImageFactorySpec.hpp
/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
/// https://github.com/mrousavy/nitro
/// Copyright © Marc Rousavy @ Margelo
///

#pragma once

#if __has_include(<NitroModules/HybridObject.hpp>)
#include <NitroModules/HybridObject.hpp>
#else
#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
#endif

// Forward declaration of `HybridImageLoaderSpec` to properly resolve imports.
namespace margelo::nitro::image { class HybridImageLoaderSpec; }
// Forward declaration of `AsyncImageLoadOptions` to properly resolve imports.
namespace margelo::nitro::web::image { struct AsyncImageLoadOptions; }
// Forward declaration of `HybridImageSpec` to properly resolve imports.
namespace margelo::nitro::image { class HybridImageSpec; }

#include <memory>
#include <NitroImage/HybridImageLoaderSpec.hpp>
#include <string>
#include "AsyncImageLoadOptions.hpp"
#include <optional>
#include <NitroImage/HybridImageSpec.hpp>
#include <NitroModules/Promise.hpp>

namespace margelo::nitro::web::image {

  using namespace margelo::nitro;

  /**
   * An abstract base class for `WebImageFactory`
   * Inherit this class to create instances of `HybridWebImageFactorySpec` in C++.
   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
   * @example
   * ```cpp
   * class HybridWebImageFactory: public HybridWebImageFactorySpec {
   * public:
   *   HybridWebImageFactory(...): HybridObject(TAG) { ... }
   *   // ...
   * };
   * ```
   */
  class HybridWebImageFactorySpec: public virtual HybridObject {
    public:
      // Constructor
      explicit HybridWebImageFactorySpec(): HybridObject(TAG) { }

      // Destructor
      ~HybridWebImageFactorySpec() override = default;

    public:
      // Properties
      virtual double getMaxMemoryBytes() = 0;
      virtual void setMaxMemoryBytes(double maxMemoryBytes) = 0;

    public:
      // Methods
      virtual std::shared_ptr<margelo::nitro::image::HybridImageLoaderSpec> createWebImageLoader(const std::string& url, const std::optional<AsyncImageLoadOptions>& options) = 0;
      virtual std::shared_ptr<Promise<std::shared_ptr<margelo::nitro::image::HybridImageSpec>>> loadFromURLAsync(const std::string& url, const std::optional<AsyncImageLoadOptions>& options) = 0;
      virtual void preload(const std::string& url) = 0;

    protected:
      // Hybrid Setup
      void loadHybridMethods() override;

    protected:
      // Tag for logging
      static constexpr auto TAG = "WebImageFactory";
  };

} // namespace margelo::nitro::web::image