LibreOffice Module sw (master) 1
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
SwPostItField Class Referencefinal

#include <docufld.hxx>

Inheritance diagram for SwPostItField:
[legend]
Collaboration diagram for SwPostItField:
[legend]

Public Member Functions

 SwPostItField (SwPostItFieldType *, OUString aAuthor, OUString aText, OUString aInitials, OUString aName, const DateTime &rDate, const bool bResolved=false, const sal_uInt32 nPostItId=0)
 
 SwPostItField (const SwPostItField &)=delete
 
SwPostItFieldoperator= (const SwPostItField &)=delete
 
virtual ~SwPostItField () override
 
virtual OUString ExpandImpl (SwRootFrame const *pLayout) const override
 
virtual std::unique_ptr< SwFieldCopy () const override
 
const DateTimeGetDateTime () const
 
Date GetDate () const
 
tools::Time GetTime () const
 
sal_uInt32 GetPostItId () const
 
void SetPostItId (const sal_uInt32 nPostItId=0)
 
virtual OUString GetPar1 () const override
 Author. More...
 
virtual void SetPar1 (const OUString &rStr) override
 set author More...
 
virtual OUString GetPar2 () const override
 Text. More...
 
virtual void SetPar2 (const OUString &rStr) override
 set the PostIt's text More...
 
const OUString & GetText () const
 
const OUString & GetInitials () const
 
void SetName (const OUString &rStr)
 
const OUString & GetName () const
 
const OutlinerParaObjectGetTextObject () const
 
void SetTextObject (std::optional< OutlinerParaObject > pText)
 
void SetResolved (bool bNewState)
 
void ToggleResolved ()
 
bool GetResolved () const
 
sal_Int32 GetNumberOfParagraphs () const
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich) override
 
virtual OUString GetDescription () const override
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
- Public Member Functions inherited from SwField
virtual ~SwField ()
 
 SwField (SwField const &)=default
 
 SwField (SwField &&)=default
 
SwFieldoperator= (SwField const &)=default
 
SwFieldoperator= (SwField &&)=default
 
SwFieldTypeGetTyp () const
 
virtual SwFieldTypeChgTyp (SwFieldType *)
 Set new type (used for copying among documents). More...
 
OUString ExpandField (bool bCached, SwRootFrame const *pLayout) const
 expand the field. More...
 
virtual OUString GetFieldName () const
 get name or content More...
 
std::unique_ptr< SwFieldCopyField () const
 
SwFieldIds Which () const
 ResId. More...
 
SwFieldTypesEnum GetTypeId () const
 
virtual sal_uInt16 GetSubType () const
 
virtual void SetSubType (sal_uInt16)
 
LanguageType GetLanguage () const
 Language at field position. More...
 
virtual void SetLanguage (LanguageType nLng)
 
sal_uInt32 GetFormat () const
 Query parameters for dialog and for BASIC. More...
 
virtual OUString GetPar1 () const
 
virtual OUString GetPar2 () const
 
virtual OUString GetFormula () const
 
void ChangeFormat (sal_uInt32 n)
 
virtual void SetPar1 (const OUString &rStr)
 
virtual void SetPar2 (const OUString &rStr)
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhichId) const
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhichId)
 
bool HasClickHdl () const
 Does the field possess an action on its ClickHandler? (e.g. INetFields, ...). More...
 
bool IsFixed () const
 
bool IsAutomaticLanguage () const
 
void SetAutomaticLanguage (bool const bSet)
 
virtual OUString GetDescription () const
 
bool IsClickable () const
 Is this field clickable? More...
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
const OUString & GetTitle () const
 
void SetTitle (const OUString &rTitle)
 

Static Public Attributes

static sal_uInt32 s_nLastPostItId = 1
 

Private Attributes

OUString m_sText
 
OUString m_sAuthor
 
OUString m_sInitials
 Initials of the author. More...
 
OUString m_sName
 Name of the comment. More...
 
DateTime m_aDateTime
 
bool m_bResolved
 
std::optional< OutlinerParaObjectmpText
 
rtl::Reference< SwTextAPIObjectm_xTextObject
 
sal_uInt32 m_nPostItId
 

Additional Inherited Members

- Protected Member Functions inherited from SwField
void SetFormat (sal_uInt32 const nSet)
 
 SwField (SwFieldType *pTyp, sal_uInt32 nFormat=0, LanguageType nLang=LANGUAGE_SYSTEM, bool m_bUseFieldValueCache=true)
 

Detailed Description

Definition at line 448 of file docufld.hxx.

Constructor & Destructor Documentation

◆ SwPostItField() [1/2]

SwPostItField::SwPostItField ( SwPostItFieldType pT,
OUString  aAuthor,
OUString  aText,
OUString  aInitials,
OUString  aName,
const DateTime rDate,
const bool  bResolved = false,
const sal_uInt32  nPostItId = 0 
)

Definition at line 1732 of file docufld.cxx.

References aName, m_nPostItId, m_sName, and s_nLastPostItId.

Referenced by Copy().

◆ SwPostItField() [2/2]

SwPostItField::SwPostItField ( const SwPostItField )
delete

◆ ~SwPostItField()

SwPostItField::~SwPostItField ( )
overridevirtual

Definition at line 1752 of file docufld.cxx.

References m_xTextObject, mpText, and std::optional< OutlinerParaObject >::reset().

Member Function Documentation

◆ Copy()

std::unique_ptr< SwField > SwPostItField::Copy ( ) const
overridevirtual

◆ dumpAsXml()

void SwPostItField::dumpAsXml ( xmlTextWriterPtr  pWriter) const
overridevirtual

Reimplemented from SwField.

Definition at line 1945 of file docufld.cxx.

References OutlinerParaObject::dumpAsXml(), SwField::dumpAsXml(), GetName(), and mpText.

◆ ExpandImpl()

OUString SwPostItField::ExpandImpl ( SwRootFrame const *  pLayout) const
overridevirtual

Implements SwField.

Definition at line 1762 of file docufld.cxx.

◆ GetDate()

Date SwPostItField::GetDate ( ) const
inline

◆ GetDateTime()

const DateTime & SwPostItField::GetDateTime ( ) const
inline

Definition at line 480 of file docufld.hxx.

Referenced by SwXTextDocument::getPostIts(), and RtfAttributeOutput::PostitField().

◆ GetDescription()

OUString SwPostItField::GetDescription ( ) const
overridevirtual

Reimplemented from SwField.

Definition at line 1767 of file docufld.cxx.

References SwResId().

◆ GetInitials()

const OUString & SwPostItField::GetInitials ( ) const
inline

Definition at line 494 of file docufld.hxx.

Referenced by RtfAttributeOutput::PostitField(), and WW8_Annotation::WW8_Annotation().

◆ GetName()

const OUString & SwPostItField::GetName ( ) const
inline

◆ GetNumberOfParagraphs()

sal_Int32 SwPostItField::GetNumberOfParagraphs ( ) const

Definition at line 1835 of file docufld.cxx.

References OutlinerParaObject::Count(), and mpText.

◆ GetPar1()

OUString SwPostItField::GetPar1 ( ) const
overridevirtual

◆ GetPar2()

OUString SwPostItField::GetPar2 ( ) const
overridevirtual

Text.

get the PostIt's text

Reimplemented from SwField.

Definition at line 1818 of file docufld.cxx.

References m_sText.

Referenced by SwXTextDocument::getPostIts(), lcl_FormatPostIt(), and sw::annotation::SwAnnotationWin::SetPostItText().

◆ GetPostItId()

sal_uInt32 SwPostItField::GetPostItId ( ) const
inline

◆ GetResolved()

bool SwPostItField::GetResolved ( ) const

◆ GetText()

const OUString & SwPostItField::GetText ( ) const
inline

◆ GetTextObject()

const OutlinerParaObject * SwPostItField::GetTextObject ( ) const
inline

◆ GetTime()

tools::Time SwPostItField::GetTime ( ) const
inline

◆ operator=()

SwPostItField * SwPostItField::operator= ( const SwPostItField )
delete

◆ PutValue()

bool SwPostItField::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhich 
)
overridevirtual

◆ QueryValue()

bool SwPostItField::QueryValue ( css::uno::Any &  rVal,
sal_uInt16  nWhich 
) const
overridevirtual

◆ SetName()

void SwPostItField::SetName ( const OUString &  rStr)

Definition at line 1824 of file docufld.cxx.

References m_sName.

Referenced by MakeTextAttr().

◆ SetPar1()

void SwPostItField::SetPar1 ( const OUString &  rStr)
overridevirtual

set author

Reimplemented from SwField.

Definition at line 1800 of file docufld.cxx.

References m_sAuthor.

◆ SetPar2()

void SwPostItField::SetPar2 ( const OUString &  rStr)
overridevirtual

set the PostIt's text

Reimplemented from SwField.

Definition at line 1812 of file docufld.cxx.

References m_sText.

Referenced by SwXTextField::attach(), sw::annotation::SwAnnotationWin::InitAnswer(), and sw::annotation::SwAnnotationWin::UpdateData().

◆ SetPostItId()

void SwPostItField::SetPostItId ( const sal_uInt32  nPostItId = 0)

Definition at line 1840 of file docufld.cxx.

References m_nPostItId, and s_nLastPostItId.

◆ SetResolved()

void SwPostItField::SetResolved ( bool  bNewState)

Definition at line 1772 of file docufld.cxx.

References m_bResolved.

◆ SetTextObject()

void SwPostItField::SetTextObject ( std::optional< OutlinerParaObject pText)

◆ ToggleResolved()

void SwPostItField::ToggleResolved ( )

Definition at line 1777 of file docufld.cxx.

References m_bResolved.

Member Data Documentation

◆ m_aDateTime

DateTime SwPostItField::m_aDateTime
private

Definition at line 454 of file docufld.hxx.

Referenced by Copy(), PutValue(), and QueryValue().

◆ m_bResolved

bool SwPostItField::m_bResolved
private

Definition at line 455 of file docufld.hxx.

Referenced by Copy(), GetResolved(), PutValue(), QueryValue(), SetResolved(), and ToggleResolved().

◆ m_nPostItId

sal_uInt32 SwPostItField::m_nPostItId
private

Definition at line 458 of file docufld.hxx.

Referenced by Copy(), SetPostItId(), and SwPostItField().

◆ m_sAuthor

OUString SwPostItField::m_sAuthor
private

Definition at line 451 of file docufld.hxx.

Referenced by Copy(), GetPar1(), PutValue(), QueryValue(), and SetPar1().

◆ m_sInitials

OUString SwPostItField::m_sInitials
private

Initials of the author.

Definition at line 452 of file docufld.hxx.

Referenced by Copy(), PutValue(), and QueryValue().

◆ m_sName

OUString SwPostItField::m_sName
private

Name of the comment.

Definition at line 453 of file docufld.hxx.

Referenced by Copy(), PutValue(), QueryValue(), and SetName().

◆ m_sText

OUString SwPostItField::m_sText
private

Definition at line 450 of file docufld.hxx.

Referenced by Copy(), GetPar2(), PutValue(), QueryValue(), and SetPar2().

◆ m_xTextObject

rtl::Reference<SwTextAPIObject> SwPostItField::m_xTextObject
private

Definition at line 457 of file docufld.hxx.

Referenced by QueryValue(), and ~SwPostItField().

◆ mpText

std::optional<OutlinerParaObject> SwPostItField::mpText
private

◆ s_nLastPostItId

sal_uInt32 SwPostItField::s_nLastPostItId = 1
static

Definition at line 461 of file docufld.hxx.

Referenced by SetPostItId(), and SwPostItField().


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