/////////////////////////////////////////////////////////////////////////////// 
// 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.
///////////////////////////////////////////////////////////////////////////////


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishStampAnnotation.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_STAMP_ANNOTATION__INCLUDED_
#define _PDF_PUBLISH_STAMP_ANNOTATION__INCLUDED_

#include "PdfPublishMarkupAnnotation.h"

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

  /** \details
    This class implements functionality for work with a stamp annotation in a PDF document created with Publish SDK.
  */
  class PDFPUBLISH_TOOLKIT OdStampAnnotation : public OdMarkupAnnotation
  {
    //DOM-IGNORE-BEGIN
  protected:
    OdStampAnnotation();
    //DOM-IGNORE-END
  public:
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdStampAnnotation);
    ODRX_HEAP_OPERATORS();
    //DOM-IGNORE-END

    /** \details
      Destroys the stamp annotation object.
    */
    virtual ~OdStampAnnotation();

    /** \details
      Sets the type of the stamp annotation object.
      \param type [in] A new type for the stamp annotation object.
    */
    void setStampAnnotationType(const StampAnnotations::StampAnnotationTypes& type);

    /** \details
      Returns the type of the stamp annotation object.
      The method fills a passed instance of the StampAnnotationTypes enumeration with the current type and returns it to a calling subroutine.
      \param type [out] A placeholder for the type of the stamp annotation object.
    */
    void getStampAnnotationType(StampAnnotations::StampAnnotationTypes& type) const;

  };

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

}
#endif // _PDF_PUBLISH_STAMP_ANNOTATION__INCLUDED_