PdfPublishStickyNote.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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 "PdfPublishBaseObject.h"

namespace OdPdfPublish{

class PDFPUBLISH_TOOLKIT OdStickyNote : public OdObject
{
  //DOM-IGNORE-BEGIN
protected:
  OdStickyNote();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdStickyNote);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END
 
  virtual ~OdStickyNote();

  void setStickyNoteType(const StickyNotes::StickyNoteTypes& type);

  void setPopupLocation(const OdRect& popup_location);

  void setOpen(const bool state);

  void setContents(const OdString& value);

  void setTitle(const OdString& value);

  void setDescription(const OdString& value);

  void setCreationDate(const OdTimeStamp& value);

  void setOpacity(const OdUInt8& value);

  void setColor(const ODCOLORREF color);
  
  void setLock(const bool state);
  
  void setMarkedState(const StickyNotes::StickyNoteMarkedStates& marked_state);

  void setReviewState(const StickyNotes::StickyNoteReviewStates& review_state);

  void getStickyNoteType(StickyNotes::StickyNoteTypes& type) const;

  void getPopupLocation(OdRect& popup_location) const;

  void getOpen(bool& state) const;

  void getContents(OdString& value) const;

  void getTitle(OdString& value) const;

  void getDescription(OdString& value) const;

  bool getCreationDate(OdTimeStamp& value) const;

  void getOpacity(OdUInt8& value) const;

  void getColor(ODCOLORREF& color) const;
  
  void getLock(bool& state) const;

  void getMarkedState(StickyNotes::StickyNoteMarkedStates& marked_state) const;

  void getReviewState(StickyNotes::StickyNoteReviewStates& review_state) const;
  
};

SMARTPTR(OdStickyNote);
 
}
#endif // _PDF_PUBLISH_STICKIY_NOTE_INCLUDED_