#ifndef FS_OFD_BLOCKOBJECT_H_
#define FS_OFD_BLOCKOBJECT_H_

#include "common/fs_common.h"

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

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

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

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

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

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

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

  explicit OFDBlockObject(FS_HANDLE handle);
};

}  // namespace graphics
}  // namespace ofd
}  // namespace foxit

#endif  // FS_OFD_BLOCKOBJECT_H_
