LibreOffice Module sfx2 (master): SfxOleObjectBase Class Reference

LibreOffice Module sfx2 (master) 1

Base class for all classes related to OLE property sets. More...

#include <oleprops.hxx>

Inheritance diagram for SfxOleObjectBase:

Collaboration diagram for SfxOleObjectBase:

Public Member Functions
	SfxOleObjectBase ()

virtual	~SfxOleObjectBase ()

ErrCode const &	GetError () const
	Returns the current error code. More...

ErrCode const &	Load (SvStream &rStrm)
	Loads this object from the passed stream. More...

ErrCode const &	Save (SvStream &rStrm)
	Saves this object to the passed stream. More...

Protected Member Functions
void	SetError (ErrCode nErrCode)
	Sets the passed error code. More...

void	LoadObject (SvStream &rStrm, SfxOleObjectBase &rObj)
	Loads the passed object from the stream. More...

void	SaveObject (SvStream &rStrm, SfxOleObjectBase &rObj)
	Saves the passed object to the stream. More...

Private Member Functions
virtual void	ImplLoad (SvStream &rStrm)=0
	Derived classes implement loading the object from the passed steam. More...

virtual void	ImplSave (SvStream &rStrm)=0
	Derived classes implement saving the object to the passed steam. More...

Private Attributes
ErrCode	mnErrCode

Detailed Description

Base class for all classes related to OLE property sets.

Derived classes have to implement the pure virtual functions ImplLoad() and ImplSave().

Definition at line 167 of file oleprops.hxx.

Constructor & Destructor Documentation

◆ SfxOleObjectBase()

SfxOleObjectBase::SfxOleObjectBase ( )

inlineexplicit

Definition at line 170 of file oleprops.hxx.

References ERRCODE_NONE.

◆ ~SfxOleObjectBase()

SfxOleObjectBase::~SfxOleObjectBase ( )

virtual

Definition at line 334 of file oleprops.cxx.

Member Function Documentation

◆ GetError()

ErrCode const & SfxOleObjectBase::GetError ( ) const

inline

Returns the current error code.

Definition at line 174 of file oleprops.hxx.

References mnErrCode.

Referenced by Load(), SfxOlePropertySet::LoadPropertySet(), Save(), and SfxOlePropertySet::SavePropertySet().

◆ ImplLoad()

virtual void SfxOleObjectBase::ImplLoad ( SvStream & rStrm )

privatepure virtual

Derived classes implement loading the object from the passed steam.

Implemented in SfxOleCodePageProperty, SfxOleDictionaryProperty, SfxOleSection, and SfxOlePropertySet.

Referenced by Load().

◆ ImplSave()

virtual void SfxOleObjectBase::ImplSave ( SvStream & rStrm )

privatepure virtual

Derived classes implement saving the object to the passed steam.

Implemented in SfxOleCodePageProperty, SfxOleDictionaryProperty, SfxOleSection, and SfxOlePropertySet.

Referenced by Save().

◆ Load()

ErrCode const & SfxOleObjectBase::Load ( SvStream & rStrm )

Loads this object from the passed stream.

Calls virtual ImplLoad().

Definition at line 338 of file oleprops.cxx.

References ERRCODE_NONE, GetError(), SvStream::GetErrorCode(), ImplLoad(), mnErrCode, rStrm, and SetError().

Referenced by LoadObject(), and SfxOlePropertySet::LoadPropertySet().

◆ LoadObject()

void SfxOleObjectBase::LoadObject	(	SvStream &	rStrm,
		SfxOleObjectBase &	rObj
	)

protected

Loads the passed object from the stream.

Sets returned error code as own error.

Definition at line 354 of file oleprops.cxx.

References Load(), rStrm, and SetError().

Referenced by SfxOleSection::ImplLoad(), and SfxOlePropertySet::ImplLoad().

◆ Save()

ErrCode const & SfxOleObjectBase::Save ( SvStream & rStrm )

Saves this object to the passed stream.

Calls virtual ImplSave().

Definition at line 346 of file oleprops.cxx.

References ERRCODE_NONE, GetError(), SvStream::GetErrorCode(), ImplSave(), mnErrCode, rStrm, and SetError().

Referenced by SaveObject(), and SfxOlePropertySet::SavePropertySet().

◆ SaveObject()

void SfxOleObjectBase::SaveObject	(	SvStream &	rStrm,
		SfxOleObjectBase &	rObj
	)

protected

Saves the passed object to the stream.

Sets returned error code as own error.

Definition at line 359 of file oleprops.cxx.

References rStrm, Save(), and SetError().

Referenced by SfxOlePropertySet::ImplSave(), and SfxOleSection::SaveProperty().

◆ SetError()

void SfxOleObjectBase::SetError ( ErrCode nErrCode )

inlineprotected

Sets the passed error code.

Will be returned by Load() and Save() functions. Always the first error code is stored. Multiple calls have no effect.

Definition at line 184 of file oleprops.hxx.

References ERRCODE_NONE, and mnErrCode.

Referenced by Load(), LoadObject(), SfxOleSection::LoadProperty(), SfxOlePropertySet::LoadPropertySet(), Save(), SaveObject(), and SfxOlePropertySet::SavePropertySet().

Member Data Documentation

◆ mnErrCode

ErrCode SfxOleObjectBase::mnErrCode

private

Definition at line 197 of file oleprops.hxx.

Referenced by GetError(), Load(), Save(), and SetError().

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