///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a license
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishSquareAnnotation.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_SQUARE_ANNOTATION_INCLUDED_
#define _PDF_PUBLISH_SQUARE_ANNOTATION_INCLUDED_

#include "PdfPublishMarkupAnnotation.h"
#include "Ge/GePoint2dArray.h"
#include "OdArray.h"
#include "PdfPublishAnnotationBorderStyle.h"
#include "PdfPublishAnnotationBorderEffect.h"

/** \details
  Contains declarations for Publish SDK.
  <group OdPdfPublish_Classes>
*/
namespace OdPdfPublish {

/** \details
  This class implements a square annotation in a .pdf document created with Publish SDK.
  Square annotations represent rectangle or square shapes bounded by a rectangle.
*/
class PDFPUBLISH_TOOLKIT OdSquareAnnotation : public OdMarkupAnnotation
{
  //DOM-IGNORE-BEGIN
protected:
  OdSquareAnnotation();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdSquareAnnotation);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  /** \details
    Destroys the square annotation.
  */
  virtual ~OdSquareAnnotation();

  /** \details
    Sets the border style for the square annotation.
    \param style [in] A smart pointer to a border style object.
  */
  void setLineStyle(const OdAnnotationBorderStylePtr& style);

  /** \details
    Sets the border effect for the square annotation.
    \param effect [in] A smart pointer to a border effect object.
  */
  void setLineEffect(const OdAnnotationBorderEffectPtr& effect);

  /** \details
    Retrieves the current border style of the square annotation.
    \param style [out] A placeholder for the border style.
  */
  void getLineStyle(OdAnnotationBorderStylePtr& style) const;

  /** \details
    Retrieves the current border effect of the square annotation.
    \param effect [out] A placeholder for the border effect.
  */
  void getLineEffect(OdAnnotationBorderEffectPtr& effect) const;
};

/** \details
  A data type that represents a smart pointer to an <link OdPdfPublish::OdSquareAnnotation, OdSquareAnnotation> object.
*/
SMARTPTR(OdSquareAnnotation);

} // namespace OdPdfPublish

#endif // _PDF_PUBLISH_SQUARE_ANNOTATION_INCLUDED_