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


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishStickyNote.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_STICKIY_NOTE_INCLUDED_
#define _PDF_PUBLISH_STICKIY_NOTE_INCLUDED_

#include "PdfPublishMarkupAnnotation.h"

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

/** \details
  This class implements functionality for work with a sticky note in a PDF document created with Publish SDK.
  A sticky note allows specification of an icon on the page that, when is clicked, displays a popup window with text information.
*/
class PDFPUBLISH_TOOLKIT OdStickyNote : public OdMarkupAnnotation
{
  //DOM-IGNORE-BEGIN
protected:
  OdStickyNote();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdStickyNote);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END
 
  /** \details
    Destroys the sticky note object.
  */
  ~OdStickyNote() override;

  /** \details
    Sets the <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> of the sticky note object.
    \param type [in] A new <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> for the sticky note object.
    \remarks
    The <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> determines predefined icon to be displayed when the sticky note is rendered.
  */
  void setStickyNoteType(const StickyNotes::StickyNoteTypes& type);

  /** \details
    Returns the <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> of the sticky note object.
    The method fills a passed instance of the <link OdPdfPublish::StickyNotes::StickyNoteTypes, StickyNoteTypes enumeration> value with the current type of the sticky note object and returns it to a calling subroutine.
    \param type [out] A placeholder for the <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> of the sticky note object.
  */
  void getStickyNoteType(StickyNotes::StickyNoteTypes& type) const;
 
};

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

}
#endif // _PDF_PUBLISH_STICKIY_NOTE_INCLUDED_