XMLPropertySetMapper Class Reference
#include <xmlprmap.hxx>
Public Member Functions | |
| XMLPropertySetMapper (const XMLPropertyMapEntry *pEntries, const UniReference< XMLPropertyHandlerFactory > &rFactory) | |
| The last element of the XMLPropertyMapEntry-array must contain NULL-values. | |
| virtual | ~XMLPropertySetMapper () |
| void | AddMapperEntry (const UniReference< XMLPropertySetMapper > &rMapper) |
| sal_Int32 | GetEntryCount () const |
| Return number of entries in input-array. | |
| sal_uInt32 | GetEntryFlags (sal_Int32 nIndex) const |
| Returns the flags of an entry. | |
| sal_uInt32 | GetEntryType (sal_Int32 nIndex, sal_Bool bWithFlags=sal_True) const |
| Returns the type of an entry. | |
| sal_uInt16 | GetEntryNameSpace (sal_Int32 nIndex) const |
| Returns the namespace-key of an entry. | |
| const ::rtl::OUString & | GetEntryXMLName (sal_Int32 nIndex) const |
| Returns the 'local' XML-name of the entry. | |
| const ::rtl::OUString & | GetEntryAPIName (sal_Int32 nIndex) const |
| Returns the entry API name. | |
| sal_Int16 | GetEntryContextId (sal_Int32 nIndex) const |
| returns the entry context id. | |
| SvtSaveOptions::ODFDefaultVersion | GetEarliestODFVersionForExport (sal_Int32 nIndex) const |
| returns the earliest odf version for which this property should be exported. | |
| sal_Int32 | GetEntryIndex (sal_uInt16 nNamespace, const ::rtl::OUString &rStrName, sal_uInt32 nPropType, sal_Int32 nStartAt=-1) const |
| Returns the index of an entry with the given XML-name and namespace If there is no matching entry the method returns -1. | |
| const XMLPropertyHandler * | GetPropertyHandler (sal_Int32 nIndex) const |
| Retrieves a PropertyHandler for that property wich placed at nIndex in the XMLPropertyMapEntry-array. | |
| virtual sal_Bool | exportXML (::rtl::OUString &rStrExpValue, const XMLPropertyState &rProperty, const SvXMLUnitConverter &rUnitConverter) const |
| import/export This methods calls the respective im/export-method of the respective PropertyHandler. | |
| virtual sal_Bool | importXML (const ::rtl::OUString &rStrImpValue, XMLPropertyState &rProperty, const SvXMLUnitConverter &rUnitConverter) const |
| sal_Int32 | FindEntryIndex (const sal_Char *sApiName, sal_uInt16 nNameSpace, const ::rtl::OUString &sXMLName) const |
| searches for an entry that matches the given api name, namespace and local name or -1 if nothing found | |
| sal_Int32 | FindEntryIndex (const sal_Int16 nContextId) const |
| searches for an entry that matches the given ContextId or gives -1 if nothing found | |
| void | RemoveEntry (sal_Int32 nIndex) |
| Remove an entry. | |
Private Attributes | |
| ::std::vector < XMLPropertySetMapperEntry_Impl > | aMapEntries |
| ::std::vector< UniReference < XMLPropertyHandlerFactory > > | aHdlFactories |
Detailed Description
Definition at line 84 of file xmlprmap.hxx.
Constructor & Destructor Documentation
| XMLPropertySetMapper::XMLPropertySetMapper | ( | const XMLPropertyMapEntry * | pEntries, | |
| const UniReference< XMLPropertyHandlerFactory > & | rFactory | |||
| ) |
The last element of the XMLPropertyMapEntry-array must contain NULL-values.
Definition at line 80 of file xmlprmap.cxx.
References aHdlFactories, aMapEntries, and XMLPropertyMapEntry::msApiName.
| XMLPropertySetMapper::~XMLPropertySetMapper | ( | ) | [virtual] |
Definition at line 99 of file xmlprmap.cxx.
Member Function Documentation
| void XMLPropertySetMapper::AddMapperEntry | ( | const UniReference< XMLPropertySetMapper > & | rMapper | ) |
| sal_Int32 XMLPropertySetMapper::GetEntryCount | ( | ) | const [inline] |
Return number of entries in input-array.
Definition at line 99 of file xmlprmap.hxx.
Referenced by FindEntryIndex(), and RemoveEntry().
| sal_uInt32 XMLPropertySetMapper::GetEntryFlags | ( | sal_Int32 | nIndex | ) | const [inline] |
Returns the flags of an entry.
Definition at line 102 of file xmlprmap.hxx.
References MID_FLAG_MASK.
| sal_uInt32 XMLPropertySetMapper::GetEntryType | ( | sal_Int32 | nIndex, | |
| sal_Bool | bWithFlags = sal_True | |||
| ) | const [inline] |
Returns the type of an entry.
Definition at line 109 of file xmlprmap.hxx.
References MID_FLAG_MASK.
| sal_uInt16 XMLPropertySetMapper::GetEntryNameSpace | ( | sal_Int32 | nIndex | ) | const [inline] |
| const ::rtl::OUString& XMLPropertySetMapper::GetEntryXMLName | ( | sal_Int32 | nIndex | ) | const [inline] |
| const ::rtl::OUString& XMLPropertySetMapper::GetEntryAPIName | ( | sal_Int32 | nIndex | ) | const [inline] |
| sal_Int16 XMLPropertySetMapper::GetEntryContextId | ( | sal_Int32 | nIndex | ) | const [inline] |
returns the entry context id.
-1 is a valid index here.
Definition at line 141 of file xmlprmap.hxx.
| SvtSaveOptions::ODFDefaultVersion XMLPropertySetMapper::GetEarliestODFVersionForExport | ( | sal_Int32 | nIndex | ) | const [inline] |
returns the earliest odf version for which this property should be exported.
Definition at line 148 of file xmlprmap.hxx.
References SvtSaveOptions::ODFVER_UNKNOWN.
| sal_Int32 XMLPropertySetMapper::GetEntryIndex | ( | sal_uInt16 | nNamespace, | |
| const ::rtl::OUString & | rStrName, | |||
| sal_uInt32 | nPropType, | |||
| sal_Int32 | nStartAt = -1 | |||
| ) | const |
Returns the index of an entry with the given XML-name and namespace If there is no matching entry the method returns -1.
| const XMLPropertyHandler* XMLPropertySetMapper::GetPropertyHandler | ( | sal_Int32 | nIndex | ) | const [inline] |
Retrieves a PropertyHandler for that property wich placed at nIndex in the XMLPropertyMapEntry-array.
Definition at line 162 of file xmlprmap.hxx.
| virtual sal_Bool XMLPropertySetMapper::exportXML | ( | ::rtl::OUString & | rStrExpValue, | |
| const XMLPropertyState & | rProperty, | |||
| const SvXMLUnitConverter & | rUnitConverter | |||
| ) | const [virtual] |
import/export This methods calls the respective im/export-method of the respective PropertyHandler.
| virtual sal_Bool XMLPropertySetMapper::importXML | ( | const ::rtl::OUString & | rStrImpValue, | |
| XMLPropertyState & | rProperty, | |||
| const SvXMLUnitConverter & | rUnitConverter | |||
| ) | const [virtual] |
| sal_Int32 XMLPropertySetMapper::FindEntryIndex | ( | const sal_Char * | sApiName, | |
| sal_uInt16 | nNameSpace, | |||
| const ::rtl::OUString & | sXMLName | |||
| ) | const |
searches for an entry that matches the given api name, namespace and local name or -1 if nothing found
| sal_Int32 XMLPropertySetMapper::FindEntryIndex | ( | const sal_Int16 | nContextId | ) | const |
searches for an entry that matches the given ContextId or gives -1 if nothing found
Definition at line 222 of file xmlprmap.cxx.
References aMapEntries, GetEntryCount(), and XMLPropertySetMapperEntry_Impl::nContextId.
| void XMLPropertySetMapper::RemoveEntry | ( | sal_Int32 | nIndex | ) |
Remove an entry.
Definition at line 243 of file xmlprmap.cxx.
References aMapEntries, and GetEntryCount().
Member Data Documentation
Definition at line 86 of file xmlprmap.hxx.
Referenced by AddMapperEntry(), FindEntryIndex(), RemoveEntry(), and XMLPropertySetMapper().
::std::vector< UniReference < XMLPropertyHandlerFactory > > XMLPropertySetMapper::aHdlFactories [private] |
Definition at line 87 of file xmlprmap.hxx.
Referenced by AddMapperEntry(), and XMLPropertySetMapper().
The documentation for this class was generated from the following files:
