#ifndef FS_OFD_IMAGEOBJECT_H_
#define FS_OFD_IMAGEOBJECT_H_

#include "common/fs_common.h"
#include "fs_ofdgraphicsobject.h"

/**
 * @brief Foxit 命名空间。
 *
 * @details Foxit PDF SDK 的所有定义和类都在此命名空间内定义。
 */
namespace foxit {
/**
 * @brief ofd 命名空间。
 */
namespace ofd {
/**
 * @brief ofd graphics 命名空间。
 */
namespace graphics {
/** 此类表示和OFD图像对象相关的方法。*/
class OFDImageObject FS_FINAL : public OFDGraphicsObject {
 public:
  /**
   * @brief  构造函数，从现有@link foxit::ofd::graphics::OFDGraphicsObject @endlink对象。
   * @param[in] object OFDGraphicsObject对象。
                       此对象必须是一个有效的对象，并且其类型必须是@link foxit::ofd::graphics::OFDGraphicsObject::e_ObjectTypeImage @endlink，否则构造函数将抛出异常。
   */
  explicit OFDImageObject(OFDGraphicsObject object);

  /** @brief 析构函数。 */
  ~OFDImageObject();

  /**
   * @brief 构造函数，通过另一个OFD图像对象。
   *
   * @param[in] other  另一个OFD图像对象。
   */
  OFDImageObject(const OFDImageObject& other);

  /**
   * @brief 赋值操作符。
   *
   * @param[in] other  另一个OFD图像对象，其值将被赋给当前对象。
   *
   * @return 当前对象自身的引用。
   */
  OFDImageObject& operator = (const OFDImageObject& other);

  /**
   * @brief 相等操作符。
   *
   * @param[in] other  另一个OFD图像对象。此函数将检查当前对象是否等于这个对象。
   *
   * @return <b>true</b> 表示相等，<b>false</b> 表示不相等。
   */
  bool operator == (const OFDImageObject& other) const;

  /**
   * @brief 不相等操作符。
   *
   * @param[in] other  另一个OFD图像对象。此函数将检查当前对象是否不等于这个对象。
   *
   * @return <b>true</b> 表示不相等，<b>false</b> 表示相等。
   */
  bool operator != (const OFDImageObject& other) const;

  /**
   * @brief 检查当前对象是否为空。
   *
   * @details 当前对象为空时，表示当前对象是无用的。
   *
   * @return <b>true</b> 表示当前对象为空，<b>false</b> 表示不为空。
   */
  bool IsEmpty() const;

  /**
   * @brief 获取图像对象中的图像数据。
   *
   * @return 图像对象中的图像数据。
   */
  String GetImageBuffer() const;

  /**
   * @brief 通过内存缓冲区设置图像对象中的图像数据。
   *
   * @param[in] buffer        指定的内存缓冲区。
   * @param[in] size          指定的内存缓冲区大小。
   * @param[in] format        指定的图像格式。
   *
   * @return 图像资源ID。
   */
  foxit::uint32 SetImage(const void* buffer, size_t size, foxit::common::Image::Type format);

  /**
   * @brief 通过文件设置图像对象中的图像数据。
   *
   * @param[in] file_path     指定的图像文件路径。它不应该是空字符串。
   *
   * @return 图像资源ID。
   */
  foxit::uint32 SetImage(const String& file_path);

  /**
  * @brief 通过文件设置图像对象中的图像数据。
  *
  * @param[in] file_path      指定的图像文件路径。它不应该是空字符串。
  *
  * @return 图像资源ID。
  */
  foxit::uint32 SetImage(const WString& file_path);

  /**
   * @brief 通过资源ID设置图像对象中的图像数据。
   *
   * @param[in] resource_id   指定的图像资源ID。
   *
   * @return 无。
   */
  void SetImage(foxit::uint32 resource_id);

  /**
   * @brief 获取图像对象格式。
   *
   * @return 图像对象格式。请参考从 @link foxit::common::Image::e_Unknown @endlink 开始的值，
   *         应该是这些值中的一个。
   */
  foxit::common::Image::Type GetImageFormat() const;

  explicit OFDImageObject(FS_HANDLE handle);
};

}  // namespace objects
}  // namespace ofd
}  // namespace foxit

#endif  // FS_OFD_IMAGEOBJECT_H_
