SvxEditSource Class Reference

Wrapper class for unified EditEngine/Outliner access. More...

#include <unoedsrc.hxx>

Inheritance diagram for SvxEditSource:

Public Member Functions
	SvxEditSource ()=default
	SvxEditSource (SvxEditSource const &)=default
	SvxEditSource (SvxEditSource &&)=default
SvxEditSource &	operator= (SvxEditSource const &)=default
SvxEditSource &	operator= (SvxEditSource &&)=default
virtual	~SvxEditSource ()
virtual std::unique_ptr< SvxEditSource >	Clone () const =0
	Returns a new reference to the same object. This is a shallow copy. More...
virtual SvxTextForwarder *	GetTextForwarder ()=0
	Query the text forwarder. More...
virtual SvxViewForwarder *	GetViewForwarder ()
	Query the view forwarder. More...
virtual SvxEditViewForwarder *	GetEditViewForwarder (bool bCreate=false)
	Query the edit view forwarder. More...
virtual void	UpdateData ()=0
	Write back data to model. More...
virtual SfxBroadcaster &	GetBroadcaster () const
	Returns broadcaster the underlying edit engine's events are sent from. More...
virtual void	addRange (SvxUnoTextRangeBase *pNewRange)
	adds the given SvxUnoTextRangeBase to the text object capsulated by this SvxEditSource. More...
virtual void	removeRange (SvxUnoTextRangeBase *pOldRange)
	removes the given SvxUnoTextRangeBase from the text object capsulated by this SvxEditSource. More...
virtual const SvxUnoTextRangeBaseVec &	getRanges () const
	returns a const list of all text ranges that are registered for the underlying text object. More...

Detailed Description

Wrapper class for unified EditEngine/Outliner access.

This class wraps a textual object, which might or might not contain an EditEngine/Outliner. Is used e.g. for filling an EditEngine with the content of a cell, note page or page template.

Definition at line 55 of file unoedsrc.hxx.

Constructor & Destructor Documentation

SvxEditSource() [1/3]

SvxEditSource::SvxEditSource ( )

default

SvxEditSource() [2/3]

SvxEditSource::SvxEditSource ( SvxEditSource const &  )

default

SvxEditSource() [3/3]

SvxEditSource::SvxEditSource ( SvxEditSource &&  )

default

~SvxEditSource()

SvxEditSource::~SvxEditSource ( )

virtual

Definition at line 54 of file unoedsrc.cxx.

Member Function Documentation

addRange()

void SvxEditSource::addRange ( SvxUnoTextRangeBase *  pNewRange )

virtual

adds the given SvxUnoTextRangeBase to the text object capsulated by this SvxEditSource.

This allows the text object to inform all created text ranges about changes and also allows to re use already created instances. All SvxUnoTextRangeBase must remove itself with removeRange() before they are deleted.

Definition at line 27 of file unoedsrc.cxx.

Clone()

virtual std::unique_ptr< SvxEditSource > SvxEditSource::Clone ( ) const

pure virtual

Returns a new reference to the same object. This is a shallow copy.

Implemented in SvxEditEngineSource, and SvxDummyTextSource.

GetBroadcaster()

SfxBroadcaster & SvxEditSource::GetBroadcaster ( ) const

virtual

Returns broadcaster the underlying edit engine's events are sent from.

Derive: \n default implementation provided, overriding is optional

Definition at line 68 of file unoedsrc.cxx.

GetEditViewForwarder()

SvxEditViewForwarder * SvxEditSource::GetEditViewForwarder ( bool  bCreate = false )

virtual

Query the edit view forwarder.

Parameters

bCreate

Determines whether an EditView should be created, if there is none active. If set to sal_True, and the underlying object is not in EditMode, the text forwarder changes and the object is set to EditMode.

Returns

the edit view forwarder, or NULL if the underlying object is dead, or if no view is available (if bCreate is sal_False, NULL is also returned if the object is not in EditMode)

Derive: \n default implementation provided, overriding is optional

Attention: \n If this method is called with bCreate equal to

sal_True, all previously returned text forwarder can become invalid

Definition at line 63 of file unoedsrc.cxx.

getRanges()

const SvxUnoTextRangeBaseVec & SvxEditSource::getRanges ( ) const

virtual

returns a const list of all text ranges that are registered for the underlying text object.

Definition at line 37 of file unoedsrc.cxx.

GetTextForwarder()

virtual SvxTextForwarder * SvxEditSource::GetTextForwarder ( )

pure virtual

Query the text forwarder.

Returns

the text forwarder, or NULL if the underlying object is dead

Implemented in SvxEditEngineSource, and SvxDummyTextSource.

Referenced by SvxUnoTextBase::appendTextPortion(), SvxUnoTextBase::copyText(), SvxUnoTextBase::finishParagraph(), accessibility::AccessibleImageBullet::GetTextForwarder(), and SvxUnoTextBase::insertTextPortion().

GetViewForwarder()

SvxViewForwarder * SvxEditSource::GetViewForwarder ( )

virtual

Query the view forwarder.

Returns

the view forwarder, or NULL if the underlying object is dead, or if no view is available

Derive: \n default implementation provided, overriding is optional

Definition at line 58 of file unoedsrc.cxx.

Referenced by accessibility::AccessibleImageBullet::GetViewForwarder().

operator=() [1/2]

SvxEditSource & SvxEditSource::operator= ( SvxEditSource &&  )

default

operator=() [2/2]

SvxEditSource & SvxEditSource::operator= ( SvxEditSource const &  )

default

removeRange()

void SvxEditSource::removeRange ( SvxUnoTextRangeBase *  pOldRange )

virtual

removes the given SvxUnoTextRangeBase from the text object capsulated by this SvxEditSource.

This text range will not be informed any longer of changes on the underlying text and will also not re used anymore.

Definition at line 32 of file unoedsrc.cxx.

UpdateData()

virtual void SvxEditSource::UpdateData ( )

pure virtual

Write back data to model.

Implemented in SvxEditEngineSource, and SvxDummyTextSource.

Referenced by SvxUnoTextBase::appendTextPortion(), SvxUnoTextBase::copyText(), SvxUnoTextBase::finishParagraph(), and SvxUnoTextBase::insertTextPortion().

---

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

• unoedsrc.hxx
• unoedsrc.cxx