LibreOffice Module framework (master) 1
Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
framework::AcceleratorConfigurationReader Class Referencefinal

#include <acceleratorconfigurationreader.hxx>

Inheritance diagram for framework::AcceleratorConfigurationReader:
[legend]
Collaboration diagram for framework::AcceleratorConfigurationReader:
[legend]

Public Member Functions

 AcceleratorConfigurationReader (AcceleratorCache &rContainer)
 connect this new reader/writer instance to an outside container, which should be used flushed to the underlying XML configuration or filled from there. More...
 
virtual ~AcceleratorConfigurationReader () override
 does nothing real ... More...
 
virtual void SAL_CALL startDocument () override
 
virtual void SAL_CALL endDocument () override
 
virtual void SAL_CALL startElement (const OUString &sElement, const css::uno::Reference< css::xml::sax::XAttributeList > &xAttributeList) override
 
virtual void SAL_CALL endElement (const OUString &sElement) override
 
virtual void SAL_CALL characters (const OUString &sChars) override
 
virtual void SAL_CALL ignorableWhitespace (const OUString &sWhitespaces) override
 
virtual void SAL_CALL processingInstruction (const OUString &sTarget, const OUString &sData) override
 
virtual void SAL_CALL setDocumentLocator (const css::uno::Reference< css::xml::sax::XLocator > &xLocator) override
 

Private Types

enum  EXMLElement {
  E_ELEMENT_ACCELERATORLIST ,
  E_ELEMENT_ITEM
}
 classification of XML elements. More...
 
enum  EXMLAttribute {
  E_ATTRIBUTE_KEYCODE ,
  E_ATTRIBUTE_MOD_SHIFT ,
  E_ATTRIBUTE_MOD_MOD1 ,
  E_ATTRIBUTE_MOD_MOD2 ,
  E_ATTRIBUTE_MOD_MOD3 ,
  E_ATTRIBUTE_URL
}
 classification of XML attributes. More...
 

Private Member Functions

OUString implts_getErrorLineString ()
 TODO document me. More...
 

Static Private Member Functions

static EXMLElement implst_classifyElement (std::u16string_view sElement)
 TODO document me. More...
 
static EXMLAttribute implst_classifyAttribute (std::u16string_view sAttribute)
 TODO document me. More...
 

Private Attributes

AcceleratorCache & m_rContainer
 reference to the outside container, where this reader/writer must work on. More...
 
bool m_bInsideAcceleratorList
 used to detect if an accelerator list occurs recursive inside xml. More...
 
bool m_bInsideAcceleratorItem
 used to detect if an accelerator item occurs recursive inside xml. More...
 
css::uno::Reference< css::xml::sax::XLocator > m_xLocator
 provide information about the parsing state. More...
 

Detailed Description

Definition at line 33 of file acceleratorconfigurationreader.hxx.

Member Enumeration Documentation

◆ EXMLAttribute

enum framework::AcceleratorConfigurationReader::EXMLAttribute
private

classification of XML attributes.

Enumerator
E_ATTRIBUTE_KEYCODE 
E_ATTRIBUTE_MOD_SHIFT 
E_ATTRIBUTE_MOD_MOD1 
E_ATTRIBUTE_MOD_MOD2 
E_ATTRIBUTE_MOD_MOD3 
E_ATTRIBUTE_URL 

Definition at line 48 of file acceleratorconfigurationreader.hxx.

◆ EXMLElement

enum framework::AcceleratorConfigurationReader::EXMLElement
private

classification of XML elements.

Enumerator
E_ELEMENT_ACCELERATORLIST 
E_ELEMENT_ITEM 

Definition at line 41 of file acceleratorconfigurationreader.hxx.

Constructor & Destructor Documentation

◆ AcceleratorConfigurationReader()

framework::AcceleratorConfigurationReader::AcceleratorConfigurationReader ( AcceleratorCache &  rContainer)

connect this new reader/writer instance to an outside container, which should be used flushed to the underlying XML configuration or filled from there.

Parameters
rContainera reference to the outside container.

Definition at line 50 of file acceleratorconfigurationreader.cxx.

◆ ~AcceleratorConfigurationReader()

framework::AcceleratorConfigurationReader::~AcceleratorConfigurationReader ( )
overridevirtual

does nothing real ...

Definition at line 57 of file acceleratorconfigurationreader.cxx.

Member Function Documentation

◆ characters()

void SAL_CALL framework::AcceleratorConfigurationReader::characters ( const OUString &  sChars)
overridevirtual

Definition at line 186 of file acceleratorconfigurationreader.cxx.

◆ endDocument()

void SAL_CALL framework::AcceleratorConfigurationReader::endDocument ( )
overridevirtual

Definition at line 65 of file acceleratorconfigurationreader.cxx.

References m_bInsideAcceleratorItem, m_bInsideAcceleratorList, and THROW_PARSEEXCEPTION.

◆ endElement()

void SAL_CALL framework::AcceleratorConfigurationReader::endElement ( const OUString &  sElement)
overridevirtual

Definition at line 165 of file acceleratorconfigurationreader.cxx.

References E_ELEMENT_ACCELERATORLIST, E_ELEMENT_ITEM, implst_classifyElement(), m_bInsideAcceleratorItem, m_bInsideAcceleratorList, and THROW_PARSEEXCEPTION.

◆ ignorableWhitespace()

void SAL_CALL framework::AcceleratorConfigurationReader::ignorableWhitespace ( const OUString &  sWhitespaces)
overridevirtual

Definition at line 190 of file acceleratorconfigurationreader.cxx.

◆ implst_classifyAttribute()

AcceleratorConfigurationReader::EXMLAttribute framework::AcceleratorConfigurationReader::implst_classifyAttribute ( std::u16string_view  sAttribute)
staticprivate

TODO document me.

Definition at line 220 of file acceleratorconfigurationreader.cxx.

References E_ATTRIBUTE_KEYCODE, E_ATTRIBUTE_MOD_MOD1, E_ATTRIBUTE_MOD_MOD2, E_ATTRIBUTE_MOD_MOD3, E_ATTRIBUTE_MOD_SHIFT, E_ATTRIBUTE_URL, and u.

Referenced by startElement().

◆ implst_classifyElement()

AcceleratorConfigurationReader::EXMLElement framework::AcceleratorConfigurationReader::implst_classifyElement ( std::u16string_view  sElement)
staticprivate

TODO document me.

Definition at line 204 of file acceleratorconfigurationreader.cxx.

References E_ELEMENT_ACCELERATORLIST, E_ELEMENT_ITEM, and u.

Referenced by endElement(), and startElement().

◆ implts_getErrorLineString()

OUString framework::AcceleratorConfigurationReader::implts_getErrorLineString ( )
private

TODO document me.

Definition at line 244 of file acceleratorconfigurationreader.cxx.

References m_xLocator.

◆ processingInstruction()

void SAL_CALL framework::AcceleratorConfigurationReader::processingInstruction ( const OUString &  sTarget,
const OUString &  sData 
)
overridevirtual

Definition at line 194 of file acceleratorconfigurationreader.cxx.

◆ setDocumentLocator()

void SAL_CALL framework::AcceleratorConfigurationReader::setDocumentLocator ( const css::uno::Reference< css::xml::sax::XLocator > &  xLocator)
overridevirtual

Definition at line 199 of file acceleratorconfigurationreader.cxx.

References m_xLocator.

◆ startDocument()

void SAL_CALL framework::AcceleratorConfigurationReader::startDocument ( )
overridevirtual

Definition at line 61 of file acceleratorconfigurationreader.cxx.

◆ startElement()

void SAL_CALL framework::AcceleratorConfigurationReader::startElement ( const OUString &  sElement,
const css::uno::Reference< css::xml::sax::XAttributeList > &  xAttributeList 
)
overridevirtual

Definition at line 76 of file acceleratorconfigurationreader.cxx.

References aEvent, E_ATTRIBUTE_KEYCODE, E_ATTRIBUTE_MOD_MOD1, E_ATTRIBUTE_MOD_MOD2, E_ATTRIBUTE_MOD_MOD3, E_ATTRIBUTE_MOD_SHIFT, E_ATTRIBUTE_URL, E_ELEMENT_ACCELERATORLIST, E_ELEMENT_ITEM, framework::KeyMapping::get(), framework::AcceleratorCache::hasKey(), i, implst_classifyAttribute(), implst_classifyElement(), m_bInsideAcceleratorItem, m_bInsideAcceleratorList, m_rContainer, framework::KeyMapping::mapIdentifierToCode(), SAL_INFO, framework::AcceleratorCache::setKeyCommandPair(), and THROW_PARSEEXCEPTION.

Member Data Documentation

◆ m_bInsideAcceleratorItem

bool framework::AcceleratorConfigurationReader::m_bInsideAcceleratorItem
private

used to detect if an accelerator item occurs recursive inside xml.

Definition at line 72 of file acceleratorconfigurationreader.hxx.

Referenced by endDocument(), endElement(), and startElement().

◆ m_bInsideAcceleratorList

bool framework::AcceleratorConfigurationReader::m_bInsideAcceleratorList
private

used to detect if an accelerator list occurs recursive inside xml.

Definition at line 68 of file acceleratorconfigurationreader.hxx.

Referenced by endDocument(), endElement(), and startElement().

◆ m_rContainer

AcceleratorCache& framework::AcceleratorConfigurationReader::m_rContainer
private

reference to the outside container, where this reader/writer must work on.

Definition at line 64 of file acceleratorconfigurationreader.hxx.

Referenced by startElement().

◆ m_xLocator

css::uno::Reference< css::xml::sax::XLocator > framework::AcceleratorConfigurationReader::m_xLocator
private

provide information about the parsing state.

@descr We use it to find out the line and column, where an error occurred.

Definition at line 79 of file acceleratorconfigurationreader.hxx.

Referenced by implts_getErrorLineString(), and setDocumentLocator().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:33:38 for LibreOffice Module framework (master) by doxygen 1.9.3