LibreOffice Module xmloff (master)  1
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
XMLIndexMarkExport Class Reference

This class handles the export of index marks for table of content, alphabetical and user index. More...

#include <XMLIndexMarkExport.hxx>

Collaboration diagram for XMLIndexMarkExport:
[legend]

Public Member Functions

 XMLIndexMarkExport (SvXMLExport &rExp)
 
 ~XMLIndexMarkExport ()
 
void ExportIndexMark (const css::uno::Reference< css::beans::XPropertySet > &rPropSet, bool bAutoStyles)
 export by the property set of its text portion. More...
 

Private Member Functions

void ExportTOCMarkAttributes (const css::uno::Reference< css::beans::XPropertySet > &rPropSet)
 export attributes of table-of-content index marks More...
 
void ExportUserIndexMarkAttributes (const css::uno::Reference< css::beans::XPropertySet > &rPropSet)
 export attributes of user index marks More...
 
void ExportAlphabeticalIndexMarkAttributes (const css::uno::Reference< css::beans::XPropertySet > &rPropSet)
 export attributes of alphabetical index marks More...
 

Static Private Member Functions

static void GetID (OUStringBuffer &sBuffer, const css::uno::Reference< css::beans::XPropertySet > &rPropSet)
 create a numerical ID for this index mark (represented by its properties) More...
 

Private Attributes

SvXMLExportrExport
 

Static Private Attributes

static constexpr OUStringLiteral gsLevel = u"Level"
 
static constexpr OUStringLiteral gsUserIndexName = u"UserIndexName"
 
static constexpr OUStringLiteral gsPrimaryKey = u"PrimaryKey"
 
static constexpr OUStringLiteral gsSecondaryKey = u"SecondaryKey"
 
static constexpr OUStringLiteral gsDocumentIndexMark = u"DocumentIndexMark"
 
static constexpr OUStringLiteral gsIsStart = u"IsStart"
 
static constexpr OUStringLiteral gsIsCollapsed = u"IsCollapsed"
 
static constexpr OUStringLiteral gsAlternativeText = u"AlternativeText"
 
static constexpr OUStringLiteral gsTextReading = u"TextReading"
 
static constexpr OUStringLiteral gsPrimaryKeyReading = u"PrimaryKeyReading"
 
static constexpr OUStringLiteral gsSecondaryKeyReading = u"SecondaryKeyReading"
 
static constexpr OUStringLiteral gsMainEntry = u"IsMainEntry"
 

Detailed Description

This class handles the export of index marks for table of content, alphabetical and user index.

Marks for bibliography indices are internally modelled as text fields and thus handled in txtparae.cxx

Definition at line 39 of file XMLIndexMarkExport.hxx.

Constructor & Destructor Documentation

XMLIndexMarkExport::XMLIndexMarkExport ( SvXMLExport rExp)
explicit

Definition at line 40 of file XMLIndexMarkExport.cxx.

XMLIndexMarkExport::~XMLIndexMarkExport ( )

Definition at line 57 of file XMLIndexMarkExport.cxx.

Member Function Documentation

void XMLIndexMarkExport::ExportAlphabeticalIndexMarkAttributes ( const css::uno::Reference< css::beans::XPropertySet > &  rPropSet)
private
void XMLIndexMarkExport::ExportIndexMark ( const css::uno::Reference< css::beans::XPropertySet > &  rPropSet,
bool  bAutoStyles 
)

export by the property set of its text portion.

The text portion supplies us with the properties of the index mark itself, as well as the information whether we are at the start or end of an index mark, or whether the index mark is collapsed.

index marks have no styles!

Definition at line 61 of file XMLIndexMarkExport.cxx.

References SvXMLExport::AddAttribute(), Any, DBG_ASSERT, ExportAlphabeticalIndexMarkAttributes(), ExportTOCMarkAttributes(), ExportUserIndexMarkAttributes(), GetID(), gsAlternativeText, gsDocumentIndexMark, gsIsCollapsed, gsIsStart, gsPrimaryKey, gsUserIndexName, lcl_pAlphaIndexMarkName, lcl_pTocMarkNames, lcl_pUserIndexMarkName, rExport, xmloff::token::XML_ID, XML_NAMESPACE_TEXT, and xmloff::token::XML_STRING_VALUE.

void XMLIndexMarkExport::ExportTOCMarkAttributes ( const css::uno::Reference< css::beans::XPropertySet > &  rPropSet)
private

export attributes of table-of-content index marks

Definition at line 156 of file XMLIndexMarkExport.cxx.

References SvXMLExport::AddAttribute(), Any, gsLevel, rExport, XML_NAMESPACE_TEXT, and xmloff::token::XML_OUTLINE_LEVEL.

Referenced by ExportIndexMark(), and ExportUserIndexMarkAttributes().

void XMLIndexMarkExport::ExportUserIndexMarkAttributes ( const css::uno::Reference< css::beans::XPropertySet > &  rPropSet)
private

export attributes of user index marks

Definition at line 197 of file XMLIndexMarkExport.cxx.

References Any, ExportTOCMarkAttributes(), gsUserIndexName, lcl_ExportPropertyString(), rExport, and xmloff::token::XML_INDEX_NAME.

Referenced by ExportIndexMark().

void XMLIndexMarkExport::GetID ( OUStringBuffer &  sBuffer,
const css::uno::Reference< css::beans::XPropertySet > &  rPropSet 
)
staticprivate

create a numerical ID for this index mark (represented by its properties)

Definition at line 222 of file XMLIndexMarkExport.cxx.

References nId.

Referenced by ExportIndexMark().

Member Data Documentation

constexpr OUStringLiteral XMLIndexMarkExport::gsAlternativeText = u"AlternativeText"
staticprivate

Definition at line 48 of file XMLIndexMarkExport.hxx.

Referenced by ExportIndexMark().

constexpr OUStringLiteral XMLIndexMarkExport::gsDocumentIndexMark = u"DocumentIndexMark"
staticprivate

Definition at line 45 of file XMLIndexMarkExport.hxx.

Referenced by ExportIndexMark().

constexpr OUStringLiteral XMLIndexMarkExport::gsIsCollapsed = u"IsCollapsed"
staticprivate

Definition at line 47 of file XMLIndexMarkExport.hxx.

Referenced by ExportIndexMark().

constexpr OUStringLiteral XMLIndexMarkExport::gsIsStart = u"IsStart"
staticprivate

Definition at line 46 of file XMLIndexMarkExport.hxx.

Referenced by ExportIndexMark().

constexpr OUStringLiteral XMLIndexMarkExport::gsLevel = u"Level"
staticprivate

Definition at line 41 of file XMLIndexMarkExport.hxx.

Referenced by ExportTOCMarkAttributes().

constexpr OUStringLiteral XMLIndexMarkExport::gsMainEntry = u"IsMainEntry"
staticprivate

Definition at line 52 of file XMLIndexMarkExport.hxx.

Referenced by ExportAlphabeticalIndexMarkAttributes().

constexpr OUStringLiteral XMLIndexMarkExport::gsPrimaryKey = u"PrimaryKey"
staticprivate
constexpr OUStringLiteral XMLIndexMarkExport::gsPrimaryKeyReading = u"PrimaryKeyReading"
staticprivate

Definition at line 50 of file XMLIndexMarkExport.hxx.

Referenced by ExportAlphabeticalIndexMarkAttributes().

constexpr OUStringLiteral XMLIndexMarkExport::gsSecondaryKey = u"SecondaryKey"
staticprivate

Definition at line 44 of file XMLIndexMarkExport.hxx.

Referenced by ExportAlphabeticalIndexMarkAttributes().

constexpr OUStringLiteral XMLIndexMarkExport::gsSecondaryKeyReading = u"SecondaryKeyReading"
staticprivate

Definition at line 51 of file XMLIndexMarkExport.hxx.

Referenced by ExportAlphabeticalIndexMarkAttributes().

constexpr OUStringLiteral XMLIndexMarkExport::gsTextReading = u"TextReading"
staticprivate

Definition at line 49 of file XMLIndexMarkExport.hxx.

Referenced by ExportAlphabeticalIndexMarkAttributes().

constexpr OUStringLiteral XMLIndexMarkExport::gsUserIndexName = u"UserIndexName"
staticprivate

Definition at line 42 of file XMLIndexMarkExport.hxx.

Referenced by ExportIndexMark(), and ExportUserIndexMarkAttributes().

SvXMLExport& XMLIndexMarkExport::rExport
private

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