LibreOffice Module registry (master) 1
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
RegistryValueList< ValueType > Class Template Referencefinal

RegistryValueList represents a value list of the specified type. More...

#include <registry.hxx>

Collaboration diagram for RegistryValueList< ValueType >:
[legend]

Public Member Functions

 RegistryValueList ()
 Default constructor. More...
 
 ~RegistryValueList ()
 Destructor, the internal value list will be freed. More...
 
ValueType getElement (sal_uInt32 index)
 returns the value of the list specified by index. More...
 
sal_uInt32 getLength ()
 returns the length of the list. More...
 

Private Member Functions

void setValueList (const Registry &registry, RegValueType valueType, ValueType *pValueList, sal_uInt32 length)
 sets the data of the value list. More...
 

Private Attributes

sal_uInt32 m_length
 stores the length of the list, the number of elements. More...
 
ValueTypem_pValueList
 stores the value list. More...
 
RegValueType m_valueType
 stores the type of the list elements More...
 
Registry m_registry
 stores the handle to the registry file where the appropriate key to this value is located. More...
 

Friends

class RegistryKey
 

Detailed Description

template<class ValueType>
class RegistryValueList< ValueType >

RegistryValueList represents a value list of the specified type.

RegistryValueList is a helper class to work with a list value.

Definition at line 254 of file registry.hxx.

Constructor & Destructor Documentation

◆ RegistryValueList()

Default constructor.

Definition at line 258 of file registry.hxx.

◆ ~RegistryValueList()

template<class ValueType >
RegistryValueList< ValueType >::~RegistryValueList ( )
inline

Member Function Documentation

◆ getElement()

template<class ValueType >
ValueType RegistryValueList< ValueType >::getElement ( sal_uInt32  index)
inline

◆ getLength()

template<class ValueType >
sal_uInt32 RegistryValueList< ValueType >::getLength ( )
inline

returns the length of the list.

Definition at line 286 of file registry.hxx.

References RegistryValueList< ValueType >::m_length.

◆ setValueList()

template<class ValueType >
void RegistryValueList< ValueType >::setValueList ( const Registry registry,
RegValueType  valueType,
ValueType pValueList,
sal_uInt32  length 
)
inlineprivate

sets the data of the value list.

Parameters
registryspecifies the registry files where the appropriate key is located.
valueTypespecifies the type of the list values.
pValueListpoints to a value list.
lengthspecifies the length of the list.

Definition at line 301 of file registry.hxx.

References length, RegistryValueList< ValueType >::m_length, RegistryValueList< ValueType >::m_pValueList, RegistryValueList< ValueType >::m_registry, and RegistryValueList< ValueType >::m_valueType.

Referenced by RegistryKey::getLongListValue(), RegistryKey::getStringListValue(), and RegistryKey::getUnicodeListValue().

Friends And Related Function Documentation

◆ RegistryKey

template<class ValueType >
friend class RegistryKey
friend

Definition at line 291 of file registry.hxx.

Member Data Documentation

◆ m_length

template<class ValueType >
sal_uInt32 RegistryValueList< ValueType >::m_length
private

◆ m_pValueList

template<class ValueType >
ValueType* RegistryValueList< ValueType >::m_pValueList
private

◆ m_registry

template<class ValueType >
Registry RegistryValueList< ValueType >::m_registry
private

stores the handle to the registry file where the appropriate key to this value is located.

Definition at line 319 of file registry.hxx.

Referenced by RegistryValueList< ValueType >::getElement(), RegistryValueList< ValueType >::setValueList(), and RegistryValueList< ValueType >::~RegistryValueList().

◆ m_valueType

template<class ValueType >
RegValueType RegistryValueList< ValueType >::m_valueType
private

stores the type of the list elements

Definition at line 315 of file registry.hxx.

Referenced by RegistryValueList< ValueType >::setValueList(), and RegistryValueList< ValueType >::~RegistryValueList().


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