LibreOffice Module sfx2 (master) 1
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
SfxOleDictionaryProperty Class Reference

Property containing custom names for other properties in the property set. More...

#include <oleprops.hxx>

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

Public Member Functions

 SfxOleDictionaryProperty (const SfxOleTextEncoding &rTextEnc)
 
bool HasPropertyNames () const
 Returns true, if the property contains at least one custom property name. More...
 
void SetNameCount (sal_Int32 nNameCount)
 Prepares the property for loading. More...
 
OUString GetPropertyName (sal_Int32 nPropId) const
 Returns the custom name for the passed property ID, or an empty string, if name not found. More...
 
void SetPropertyName (sal_Int32 nPropId, const OUString &rPropName)
 Sets a custom name for the passed property ID. More...
 
- Public Member Functions inherited from SfxOlePropertyBase
 SfxOlePropertyBase (sal_Int32 nPropId, sal_Int32 nPropType)
 
sal_Int32 GetPropId () const
 
sal_Int32 GetPropType () const
 
- Public Member Functions inherited from SfxOleObjectBase
 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...
 
- Public Member Functions inherited from SfxOleStringHelper
 SfxOleStringHelper (const SfxOleTextEncoding &rTextEnc)
 Creates a string helper object depending on an external text encoding. More...
 
 SfxOleStringHelper (rtl_TextEncoding eTextEnc)
 Creates a string helper object with own text encoding. More...
 
OUString LoadString8 (SvStream &rStrm) const
 Loads a string from the passed stream with current encoding (maybe Unicode). More...
 
void SaveString8 (SvStream &rStrm, std::u16string_view rValue) const
 Saves a string to the passed stream with current encoding (maybe Unicode). More...
 
- Public Member Functions inherited from SfxOleTextEncoding
 SfxOleTextEncoding ()
 
 SfxOleTextEncoding (rtl_TextEncoding eTextEnc)
 
rtl_TextEncoding GetTextEncoding () const
 Returns the current text encoding identifier. More...
 
void SetTextEncoding (rtl_TextEncoding eTextEnc)
 Sets the passed text encoding. More...
 
bool IsUnicode () const
 Returns true, if this object contains Unicode text encoding. More...
 
void SetUnicode ()
 Sets Unicode text encoding to this object. More...
 
sal_uInt16 GetCodePage () const
 Converts the current settings to a Windows codepage identifier. More...
 
void SetCodePage (sal_uInt16 nCodePage)
 Sets the current text encoding from a Windows codepage identifier. More...
 

Private Types

typedef ::std::map< sal_Int32, OUString > SfxOlePropNameMap
 

Private Member Functions

virtual void ImplLoad (SvStream &rStrm) override
 Derived classes implement loading the object from the passed steam. More...
 
virtual void ImplSave (SvStream &rStrm) override
 Derived classes implement saving the object to the passed steam. More...
 

Private Attributes

SfxOlePropNameMap maPropNameMap
 

Additional Inherited Members

- Static Public Member Functions inherited from SfxOleStringHelper
static OUString LoadString16 (SvStream &rStrm)
 Loads a Unicode string from the passed stream, ignores own encoding. More...
 
static void SaveString16 (SvStream &rStrm, std::u16string_view rValue)
 Saves a Unicode string to the passed stream, ignores own encoding. More...
 
- Protected Member Functions inherited from SfxOlePropertyBase
void SetPropType (sal_Int32 nPropType)
 
- Protected Member Functions inherited from SfxOleObjectBase
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...
 

Detailed Description

Property containing custom names for other properties in the property set.

Definition at line 235 of file oleprops.hxx.

Member Typedef Documentation

◆ SfxOlePropNameMap

typedef ::std::map< sal_Int32, OUString > SfxOleDictionaryProperty::SfxOlePropNameMap
private

Definition at line 255 of file oleprops.hxx.

Constructor & Destructor Documentation

◆ SfxOleDictionaryProperty()

SfxOleDictionaryProperty::SfxOleDictionaryProperty ( const SfxOleTextEncoding rTextEnc)
explicit

Definition at line 663 of file oleprops.cxx.

Member Function Documentation

◆ GetPropertyName()

OUString SfxOleDictionaryProperty::GetPropertyName ( sal_Int32  nPropId) const

Returns the custom name for the passed property ID, or an empty string, if name not found.

Definition at line 669 of file oleprops.cxx.

References maPropNameMap.

Referenced by SfxOleSection::GetPropertyName().

◆ HasPropertyNames()

bool SfxOleDictionaryProperty::HasPropertyNames ( ) const
inline

Returns true, if the property contains at least one custom property name.

Definition at line 241 of file oleprops.hxx.

References maPropNameMap.

Referenced by SfxOleSection::ImplSave().

◆ ImplLoad()

void SfxOleDictionaryProperty::ImplLoad ( SvStream rStrm)
overrideprivatevirtual

Derived classes implement loading the object from the passed steam.

Implements SfxOleObjectBase.

Definition at line 682 of file oleprops.cxx.

References SfxOlePropertyBase::GetPropType(), SvStream::good(), SfxOleStringHelper::LoadString8(), maPropNameMap, SvStream::ReadInt32(), SvStream::remainingSize(), and rStrm.

◆ ImplSave()

void SfxOleDictionaryProperty::ImplSave ( SvStream rStrm)
overrideprivatevirtual

Derived classes implement saving the object to the passed steam.

Implements SfxOleObjectBase.

Definition at line 697 of file oleprops.cxx.

References maPropNameMap, rStrm, SfxOleStringHelper::SaveString8(), and SvStream::WriteInt32().

◆ SetNameCount()

void SfxOleDictionaryProperty::SetNameCount ( sal_Int32  nNameCount)
inline

Prepares the property for loading.

Does not affect contained names for its own.

Definition at line 243 of file oleprops.hxx.

References SfxOlePropertyBase::SetPropType().

Referenced by SfxOleSection::ImplLoad().

◆ SetPropertyName()

void SfxOleDictionaryProperty::SetPropertyName ( sal_Int32  nPropId,
const OUString &  rPropName 
)

Sets a custom name for the passed property ID.

Definition at line 675 of file oleprops.cxx.

References maPropNameMap, and SfxOlePropertyBase::SetPropType().

Referenced by SfxOleSection::SetPropertyName().

Member Data Documentation

◆ maPropNameMap

SfxOlePropNameMap SfxOleDictionaryProperty::maPropNameMap
private

Definition at line 256 of file oleprops.hxx.

Referenced by GetPropertyName(), HasPropertyNames(), ImplLoad(), ImplSave(), and SetPropertyName().


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