InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
INoteData Class Referenceabstract

#include <INoteData.h>

Inheritance diagram for INoteData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_INOTEDATA }
 

Public Member Functions

virtual const WideStringGetAuthor () const =0
 
virtual void SetAuthor (const WideString &author)=0
 
virtual bool16 GetCollapse () const =0
 
virtual void SetCollapse (bool16 collapsedState)=0
 
virtual GlobalTime GetCreationTime () const =0
 
virtual void SetCreationTime (const GlobalTime newTime)=0
 
virtual GlobalTime GetModifiedTime () const =0
 
virtual void SetModifiedTime (const GlobalTime newTime)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Represents the information of a Note object (kNoteDataBoss)

In practice, every Note has an associated INoteData to tell who is the Author, the creation time, the modification time, and the collapsed state of the Note in galley/story view.

Member Function Documentation

virtual const WideString& INoteData::GetAuthor () const
pure virtual

Get the Author of the Note

Parameters
none
Returns
WideString& of the Author
virtual bool16 INoteData::GetCollapse () const
pure virtual

Get the collapse state of the Note

Parameters
none
Returns
kTrue if the Note is collapsed
virtual GlobalTime INoteData::GetCreationTime () const
pure virtual

Get the creation time of the Note

Parameters
none
Returns
GlobalTime the creation time of the Note
virtual GlobalTime INoteData::GetModifiedTime () const
pure virtual

Get the modified time of the Note

Parameters
none
Returns
GlobalTime the modified time of the Note
virtual void INoteData::SetAuthor (const WideStringauthor)
pure virtual

Set the Author of the Note

Parameters
authorWideString of the Author
virtual void INoteData::SetCollapse (bool16 collapsedState)
pure virtual

Set the collapse state of the Note

Parameters
collapsedStatekTrue if the Note is collapsed
Returns
virtual void INoteData::SetCreationTime (const GlobalTime newTime)
pure virtual

Set the creation time of the Note

Parameters
newTimethe creation time of the Note
virtual void INoteData::SetModifiedTime (const GlobalTime newTime)
pure virtual

Set the modified time of the Note

Parameters
newTimethe modified time of the Note