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


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishTextMarkupAnnotation.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_TEXT_MARKUP_ANNOTATION__INCLUDED_
#define _PDF_PUBLISH_TEXT_MARKUP_ANNOTATION__INCLUDED_

#include "PdfPublishMarkupAnnotation.h"

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

/** \details
  This class implements functionality for working with a text markup annotation in a PDF document created with Publish SDK.
  A text markup annotation allows marking up portions of text with highlighting, underlining, strikeout, or squiggly styles,
  optionally displaying a popup window with additional information.
*/
class PDFPUBLISH_TOOLKIT OdTextMarkupAnnotation : public OdMarkupAnnotation
{
  //DOM-IGNORE-BEGIN
protected:
  OdTextMarkupAnnotation();
  //DOM-IGNORE-END

public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdTextMarkupAnnotation);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  /** \details
    Destroys the text markup annotation object.
  */
  virtual ~OdTextMarkupAnnotation();

  /** \details
    Sets the <link OdPdfPublish::TextMarkupAnnotations::TextMarkupAnnotationTypes, type> of the text markup annotation.
    \param type [in] A new <link OdPdfPublish::TextMarkupAnnotations::TextMarkupAnnotationTypes, type> value for the annotation.
    \remarks
    The type determines the visual representation of the markup on the page (e.g., highlight, underline).
  */
  void setTextMarkupAnnotationType(const TextMarkupAnnotations::TextMarkupAnnotationTypes& type);

  /** \details
    Returns the <link OdPdfPublish::TextMarkupAnnotations::TextMarkupAnnotationTypes, type> of the text markup annotation.
    \param type [out] A placeholder for the <link OdPdfPublish::TextMarkupAnnotations::TextMarkupAnnotationTypes, type> value.
    \remarks
    This value determines how the annotation is visually rendered on the page.
  */
  void getTextMarkupAnnotationType(TextMarkupAnnotations::TextMarkupAnnotationTypes& type) const;

};

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

}
#endif // _PDF_PUBLISH_TEXT_MARKUP_ANNOTATION__INCLUDED_