#include <PdfPublishStickyNote.h>

Inheritance diagram for OdPdfPublish::OdStickyNote:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdStickyNote)

	ODRX_HEAP_OPERATORS ()

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

Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)

	ODRX_HEAP_OPERATORS ()

virtual	~OdObject ()

virtual bool	isEmpty () const

virtual bool	isValid () const

virtual void	clear ()

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdStickyNote ()

Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

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.

Definition at line 46 of file PdfPublishStickyNote.h.

Constructor & Destructor Documentation

◆ OdStickyNote()

OdPdfPublish::OdStickyNote::OdStickyNote ( )

protected

◆ ~OdStickyNote()

virtual OdPdfPublish::OdStickyNote::~OdStickyNote ( )

virtual

Destroys the sticky note object.

Member Function Documentation

◆ getColor()

void OdPdfPublish::OdStickyNote::getColor ( ODCOLORREF & color ) const

Returns the current color of the sticky note object. The method fills a passed ODCOLORREF value with the sticky note object's color and returns it to a calling subroutine.

Parameters

color [in] A placeholder for the color value.

Remarks: The color value affects the icon and the frame of the popup window that displays the sticky note content.

◆ getContents()

void OdPdfPublish::OdStickyNote::getContents ( OdString & value ) const

Returns the content displayed in the popup window for the sticky note object. The method fills a passed <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> object with the popup window content and returns it to a calling subroutine.

Parameters

value [out] A placeholder for the <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the popup window content for the sticky note object.

◆ getCreationDate()

bool OdPdfPublish::OdStickyNote::getCreationDate ( OdTimeStamp & value ) const

Returns the creation date and time of the sticky note object. The method fills a passed <exref target="https://docs.opendesign.com/tkernel/OdTimeStamp.html">OdTimeStamp</exref> object with the sticky note object's creation date and time and returns it to a calling subroutine.

Parameters

value [in] A placeholder for the <exref target="https://docs.opendesign.com/tkernel/OdTimeStamp.html">OdTimeStamp</exref> object that contains the date and time of the sticky note object creation.

Returns: true if creation date and time are set; otherwise, creation date and time are not set and method returns false.

◆ getDescription()

void OdPdfPublish::OdStickyNote::getDescription ( OdString & value ) const

Returns the description of the sticky note object. The method fills a passed <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> object with the sticky note description and returns it to a calling subroutine.

Parameters

value [in] A placeholder for the <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the description of the sticky note object.

Remarks: A reader application display the description only when a user views the sticky note properties.

◆ getLock()

void OdPdfPublish::OdStickyNote::getLock ( bool & state ) const

Returns the current value of the lock flag for the sticky note. The lock flag determines whether a user can not edit the content of the sticky note object (equals true); otherwise, a user can edit the sticky note object content (equals false).

Parameters

state [in] A placeholder for the current flag value.

Remarks: The method fills a passed boolean value with the current value of the lock flag and returns it to a calling subroutine.

◆ getMarkedState()

void OdPdfPublish::OdStickyNote::getMarkedState ( StickyNotes::StickyNoteMarkedStates & marked_state ) const

Returns the current value of the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates, marked state> for the sticky object. The method fills the passed value of the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates, StickyNoteMarkedStates enumeration> with the current value of the marked state and returns it to a calling subroutine.

Parameters

marked_state [in] A placeholder for the current value of the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates, marked state>.

Remarks: Default marked state value equals to the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates::kUnmarkedState, kUnmarkedState>.

◆ getOpacity()

void OdPdfPublish::OdStickyNote::getOpacity ( OdUInt8 & value ) const

Returns the icon opacity for the sticky note object. The method fills a passed unsigned 8-bit integer value with the opacity value and returns it to a calling subroutine.

Parameters

value [in] A placeholder for the opacity value.

Remarks: The opacity value should be in the range between 0 and 100. Default value is 100.

◆ getOpen()

void OdPdfPublish::OdStickyNote::getOpen ( bool & state ) const

Returns the current value of the popup window flag for the sticky note object. The popup window flag determines whether a reader application displays the sticky note object when opens the PDF document (equals true). Otherwise, the reader application doesn't display the sticky note (equals false).

Parameters

state [out] A placeholder for the popup window flag's value.

Remarks: The method fills a passed boolean value with the current value of the popup window flag and returns it to a calling subroutine.

◆ getPopupLocation()

void OdPdfPublish::OdStickyNote::getPopupLocation ( OdRect & popup_location ) const

Returns the location of the popup window that displays the sticky note object's content. The method fills the content of the passed <exref target="https://docs.opendesign.com/tkernel/ODRECT.html">OdRect</exref> instance with location data and returns it to a calling subroutine.

Parameters

popup_location [out] A placeholder for the <exref target="https://docs.opendesign.com/tkernel/ODRECT.html">rectangle</exref> that represents the location of the popup window.

◆ getReviewState()

void OdPdfPublish::OdStickyNote::getReviewState ( StickyNotes::StickyNoteReviewStates & review_state ) const

Retrieves the <link OdPdfPublish::StickyNotes::StickyNoteReviewStates, review status> for the sticky note object. The method fills a passed value of the <link OdPdfPublish::StickyNotes::StickyNoteReviewStates, StickyNoteReviewStates enumeration> with the current value of the review status and returns it to a calling subroutine.

Parameters

review_state [in] A placeholder for the <link OdPdfPublish::StickyNotes::StickyNoteReviewStates, review status> value.

Remarks: Default review status equals to the <link OdPdfPublish::StickyNotes::StickyNoteReviewStates::kNone, kNone> value.

◆ getStickyNoteType()

void OdPdfPublish::OdStickyNote::getStickyNoteType ( StickyNotes::StickyNoteTypes & type ) const

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.

Parameters

type	[out] A placeholder for the <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> of the sticky note object.

◆ getTitle()

void OdPdfPublish::OdStickyNote::getTitle ( OdString & value ) const

Returns the title of the popup window for the sticky note object. The method fills a passed <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> object with the popup window's title and returns it to a calling subroutine.

Parameters

value [in] A placeholder for the <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the title of the popup window.

Remarks: Usually, the popup window title contains the name of the user who has added the note.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdStickyNote::ODRX_DECLARE_MEMBERS ( OdStickyNote )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdStickyNote::ODRX_HEAP_OPERATORS ( )

◆ setColor()

void OdPdfPublish::OdStickyNote::setColor ( const ODCOLORREF color )

Sets the color of the sticky note object.

Parameters

color [in] A new color value.

Remarks: The color value affects the icon and the frame of the popup window that displays the sticky note content.

◆ setContents()

void OdPdfPublish::OdStickyNote::setContents ( const OdString & value )

Sets the content displayed in the popup window for the sticky note object.

Parameters

value [in] A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the displayed contents.

◆ setCreationDate()

void OdPdfPublish::OdStickyNote::setCreationDate ( const OdTimeStamp & value )

Sets the creation date and time of the sticky note object.

Parameters

value [in] An <exref target="https://docs.opendesign.com/tkernel/OdTimeStamp.html">OdTimeStamp</exref> object that contains the date and time of the sticky note object creation.

◆ setDescription()

void OdPdfPublish::OdStickyNote::setDescription ( const OdString & value )

Sets the description of the sticky note object.

Parameters

value [in] A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the description of the sticky note object.

Remarks: A reader application display the description only when a user views the sticky note properties.

◆ setLock()

void OdPdfPublish::OdStickyNote::setLock ( const bool state )

Sets a new value of the lock flag for the sticky note. The lock flag determines whether a user can not edit the content of the sticky note object (equals true); otherwise, a user can edit the sticky note object content (equals false).

Parameters

state [in] A new flag value.

◆ setMarkedState()

void OdPdfPublish::OdStickyNote::setMarkedState ( const StickyNotes::StickyNoteMarkedStates & marked_state )

Sets a new value of the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates, marked state> for the sticky object.

Parameters

marked_state [in] A new value of the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates, marked state>.

Remarks: Default marked state value equals to the <link OdPdfPublish::StickyNotes::StickyNoteMarkedStates::kUnmarkedState, kUnmarkedState>.

◆ setOpacity()

void OdPdfPublish::OdStickyNote::setOpacity ( const OdUInt8 & value )

Sets the icon opacity for the sticky note object.

Parameters

value [in] A new opacity value.

Remarks: The opacity value should be in the range between 0 and 100. Default value is 100.

◆ setOpen()

void OdPdfPublish::OdStickyNote::setOpen ( const bool state )

Sets a new value of the popup window flag for the sticky note object. The popup window flag determines whether a reader application displays the sticky note object when opens the PDF document (equals true). Otherwise, the reader application doesn't display the sticky note (equals false). Default value of the flag equals false.

Parameters

state [in] A new flag value.

◆ setPopupLocation()

void OdPdfPublish::OdStickyNote::setPopupLocation ( const OdRect & popup_location )

Sets the location of the popup window where the sticky note object appears.

Parameters

popup_location [in] A <exref target="https://docs.opendesign.com/tkernel/ODRECT.html">rectangle</exref> that specifies the page area where the popup window appears.

◆ setReviewState()

void OdPdfPublish::OdStickyNote::setReviewState ( const StickyNotes::StickyNoteReviewStates & review_state )

Sets the <link OdPdfPublish::StickyNotes::StickyNoteReviewStates, review status> for the sticky note object.

Parameters

review_state [in] A new <link OdPdfPublish::StickyNotes::StickyNoteReviewStates, review status> for the sticky note object.

Remarks: Default review status equals to the <link OdPdfPublish::StickyNotes::StickyNoteReviewStates::kNone, kNone> value.

◆ setStickyNoteType()

void OdPdfPublish::OdStickyNote::setStickyNoteType ( const StickyNotes::StickyNoteTypes & type )

Sets the <link OdPdfPublish::StickyNotes::StickyNoteTypes, type> of the sticky note object.

Parameters

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.

◆ setTitle()

void OdPdfPublish::OdStickyNote::setTitle ( const OdString & value )

Sets the title of the popup window for the sticky note object.

Parameters

value [in] A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the title of the popup window.

Remarks: Usually, the popup window title contains the name of the user who has added the note.

The documentation for this class was generated from the following file:

PdfPublishStickyNote.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdStickyNote()

◆ ~OdStickyNote()

Member Function Documentation

◆ getColor()

◆ getContents()

◆ getCreationDate()

◆ getDescription()

◆ getLock()

◆ getMarkedState()

◆ getOpacity()

◆ getOpen()

◆ getPopupLocation()

◆ getReviewState()

◆ getStickyNoteType()

◆ getTitle()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setColor()

◆ setContents()

◆ setCreationDate()

◆ setDescription()

◆ setLock()

◆ setMarkedState()

◆ setOpacity()

◆ setOpen()

◆ setPopupLocation()

◆ setReviewState()

◆ setStickyNoteType()

◆ setTitle()