LibreOffice Module oox (master) 1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
oox::core::ContextHandler2Helper Class Referenceabstract

Helper class that provides a context stack. More...

#include <contexthandler2.hxx>

Inheritance diagram for oox::core::ContextHandler2Helper:
[legend]
Collaboration diagram for oox::core::ContextHandler2Helper:
[legend]

Public Member Functions

 ContextHandler2Helper (bool bEnableTrimSpace, XmlFilterBase &rFilter)
 
 ContextHandler2Helper (const ContextHandler2Helper &rParent)
 
virtual ~ContextHandler2Helper ()
 
virtual void SAL_CALL acquire () noexcept=0
 
virtual void SAL_CALL release () noexcept=0
 
virtual ContextHandlerRef onCreateContext (sal_Int32 nElement, const AttributeList &rAttribs)=0
 Will be called to create a context handler for the passed element. More...
 
virtual void onStartElement (const AttributeList &rAttribs)=0
 Will be called when a new element has been started. More...
 
virtual void onCharacters (const OUString &rChars)=0
 Will be called before a new child element starts, or if the current element is about to be left. More...
 
virtual void onEndElement ()=0
 Will be called when the current element is about to be left. More...
 
virtual ContextHandlerRef onCreateRecordContext (sal_Int32 nRecId, SequenceInputStream &rStrm)=0
 Will be called to create a context handler for the passed record. More...
 
virtual void onStartRecord (SequenceInputStream &rStrm)=0
 Will be called when a new record block in a binary stream has been started. More...
 
virtual void onEndRecord ()=0
 Will be called when the current record block is about to be left. More...
 
sal_Int32 getCurrentElement () const
 Returns the identifier of the currently processed element. More...
 
sal_Int32 getCurrentElementWithMce () const
 Returns the identifier of the currently processed element - Including MCE root elements. More...
 
bool isCurrentElement (sal_Int32 nElement) const
 Returns true, if nElement contains the identifier of the currently processed element. More...
 
bool isCurrentElement (sal_Int32 nElement1, sal_Int32 nElement2) const
 Returns true, if either nElement1 or nElement2 contain the identifier of the currently processed element. More...
 
sal_Int32 getParentElement (sal_Int32 nCountBack=1) const
 Returns the identifier of the specified parent element. More...
 
bool isParentElement (sal_Int32 nElement, sal_Int32 nCountBack=1) const
 Returns true, if nElement contains the identifier of the specified parent element. More...
 
bool isRootElement () const
 Returns true, if the element currently processed is the root element of the context or fragment handler. More...
 

Protected Types

enum class  MCE_STATE {
  Started ,
  FoundChoice
}
 

Protected Member Functions

css::uno::Reference< css::xml::sax::XFastContextHandler > implCreateChildContext (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &rxAttribs)
 Must be called from createFastChildContext() in derived classes. More...
 
void implStartElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &rxAttribs)
 Must be called from startFastElement() in derived classes. More...
 
void implCharacters (std::u16string_view rChars)
 Must be called from characters() in derived classes. More...
 
void implEndElement (sal_Int32 nElement)
 Must be called from endFastElement() in derived classes. More...
 
ContextHandlerRef implCreateRecordContext (sal_Int32 nRecId, SequenceInputStream &rStrm)
 Must be called from createRecordContext() in derived classes. More...
 
void implStartRecord (sal_Int32 nRecId, SequenceInputStream &rStrm)
 Must be called from startRecord() in derived classes. More...
 
void implEndRecord (sal_Int32 nRecId)
 Must be called from endRecord() in derived classes. More...
 
bool prepareMceContext (sal_Int32 nElement, const AttributeList &rAttribs)
 
XmlFilterBase & getDocFilter () const
 
MCE_STATE getMCEState () const
 
void setMCEState (MCE_STATE aState)
 
void addMCEState (MCE_STATE aState)
 
void removeMCEState ()
 
bool isMCEStateEmpty () const
 

Protected Attributes

bool mbEnableTrimSpace
 True = trim whitespace in characters(). More...
 
XmlFilterBase & mrFilter
 

Private Types

typedef std::vector< ElementInfo > ContextStack
 
typedef std::shared_ptr< ContextStack > ContextStackRef
 

Private Member Functions

ContextHandler2Helper & operator= (const ContextHandler2Helper &)=delete
 
ElementInfo & pushElementInfo (sal_Int32 nElement)
 
void popElementInfo ()
 
void processCollectedChars ()
 

Private Attributes

ContextStackRef mxContextStack
 Stack of all processed elements. More...
 
size_t mnRootStackSize
 Stack size on construction time. More...
 
std::vector< MCE_STATE > aMceState
 

Detailed Description

Helper class that provides a context stack.

Fragment handlers and context handlers derived from this helper class will track the identifiers of the visited elements in a stack. The idea is to use the same instance of a fragment handler or context handler to process several nested elements in an XML stream. For that, the abstract function onCreateContext() has to return 'this' for the passed element.

Derived classes have to implement the createFastChildContext(), startFastElement(), characters(), and endFastElement() functions from the com.sun.star.xml.sax.XFastContextHandler interface by simply forwarding them to the respective implCreateChildContext(), implStartElement(), implCharacters(), and implEndElement() functions of this helper. This is implemented already in the classes ContextHandler2 and FragmentHandler2. The new abstract functions have to be implemented according to the elements to be processed.

Similarly, for binary import, derived classes have to forward the createRecordContext(), startRecord(), and endRecord() functions from the ContextHandler class to the implCreateRecordContext(), implStartRecord(), and implEndRecord() functions of this helper. Again, this is implemented already in the classes ContextHandler2 and FragmentHandler2.

Definition at line 72 of file contexthandler2.hxx.

Member Typedef Documentation

◆ ContextStack

typedef std::vector< ElementInfo > oox::core::ContextHandler2Helper::ContextStack
private

Definition at line 227 of file contexthandler2.hxx.

◆ ContextStackRef

typedef std::shared_ptr< ContextStack > oox::core::ContextHandler2Helper::ContextStackRef
private

Definition at line 228 of file contexthandler2.hxx.

Member Enumeration Documentation

◆ MCE_STATE

enum class oox::core::ContextHandler2Helper::MCE_STATE
strongprotected
Enumerator
Started 
FoundChoice 

Definition at line 207 of file contexthandler2.hxx.

Constructor & Destructor Documentation

◆ ContextHandler2Helper() [1/2]

oox::core::ContextHandler2Helper::ContextHandler2Helper ( bool  bEnableTrimSpace,
XmlFilterBase &  rFilter 
)
explicit

Definition at line 47 of file contexthandler2.cxx.

References make_shared(), pushElementInfo(), and oox::core::XML_ROOT_CONTEXT.

◆ ContextHandler2Helper() [2/2]

oox::core::ContextHandler2Helper::ContextHandler2Helper ( const ContextHandler2Helper &  rParent)
explicit

Definition at line 56 of file contexthandler2.cxx.

References size.

◆ ~ContextHandler2Helper()

oox::core::ContextHandler2Helper::~ContextHandler2Helper ( )
virtual

Definition at line 64 of file contexthandler2.cxx.

Member Function Documentation

◆ acquire()

virtual void SAL_CALL oox::core::ContextHandler2Helper::acquire ( )
pure virtualnoexcept

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

◆ addMCEState()

void oox::core::ContextHandler2Helper::addMCEState ( MCE_STATE  aState)
inlineprotected

Definition at line 215 of file contexthandler2.hxx.

Referenced by prepareMceContext().

◆ getCurrentElement()

sal_Int32 oox::core::ContextHandler2Helper::getCurrentElement ( ) const

Returns the identifier of the currently processed element.

Ignores MCE elements in stack

Definition at line 73 of file contexthandler2.cxx.

References mxContextStack, and oox::core::XML_ROOT_CONTEXT.

Referenced by oox::vml::TextPortionContext::onCharacters(), oox::drawingml::chart::ChartDrawingFragment::onCharacters(), oox::drawingml::chart::DoubleSequenceContext::onCharacters(), oox::drawingml::chart::StringSequenceContext::onCharacters(), oox::drawingml::ThemeFragmentHandler::onCreateContext(), oox::ole::AxControlPropertyContext::onCreateContext(), oox::vml::ShapeContext::onCreateContext(), oox::vml::TextPortionContext::onCreateContext(), oox::vml::TextBoxContext::onCreateContext(), oox::drawingml::chart::AxisDispUnitsContext::onCreateContext(), oox::drawingml::chart::AxisContextBase::onCreateContext(), oox::drawingml::chart::LayoutContext::onCreateContext(), oox::drawingml::chart::ChartDrawingFragment::onCreateContext(), oox::drawingml::chart::ChartSpaceFragment::onCreateContext(), oox::drawingml::chart::DoubleSequenceContext::onCreateContext(), oox::drawingml::chart::StringSequenceContext::onCreateContext(), oox::drawingml::chart::DataSourceContext::onCreateContext(), oox::drawingml::chart::DataTableContext::onCreateContext(), oox::drawingml::chart::View3DContext::onCreateContext(), oox::drawingml::chart::WallFloorContext::onCreateContext(), oox::drawingml::chart::PlotAreaContext::onCreateContext(), oox::drawingml::chart::DataLabelContext::onCreateContext(), oox::drawingml::chart::DataPointContext::onCreateContext(), oox::drawingml::chart::SeriesContextBase::onCreateContext(), oox::drawingml::chart::AreaSeriesContext::onCreateContext(), oox::drawingml::chart::BarSeriesContext::onCreateContext(), oox::drawingml::chart::BubbleSeriesContext::onCreateContext(), oox::drawingml::chart::LineSeriesContext::onCreateContext(), oox::drawingml::chart::PieSeriesContext::onCreateContext(), oox::drawingml::chart::RadarSeriesContext::onCreateContext(), oox::drawingml::chart::ScatterSeriesContext::onCreateContext(), oox::drawingml::chart::SurfaceSeriesContext::onCreateContext(), oox::drawingml::chart::UpDownBarsContext::onCreateContext(), oox::drawingml::ThemeOverrideFragmentHandler::onCreateContext(), oox::drawingml::DiagramQStylesFragmentHandler::onCreateContext(), oox::drawingml::ColorFragmentHandler::onCreateContext(), oox::drawingml::GraphicalObjectFrameContext::onEndElement(), oox::drawingml::OleObjectGraphicDataContext::onEndElement(), oox::vml::ClientDataContext::onEndElement(), oox::vml::TextPortionContext::onEndElement(), oox::vml::TextBoxContext::onEndElement(), oox::drawingml::RegularTextRunContext::onEndElement(), oox::drawingml::TextFieldContext::onEndElement(), oox::drawingml::DiagramQStylesFragmentHandler::onEndElement(), oox::drawingml::ColorFragmentHandler::onEndElement(), oox::ppt::BuildListContext::onEndElement(), oox::ppt::CommonBehaviorContext::onEndElement(), oox::drawingml::ColorValueContext::onStartElement(), oox::vml::TextPortionContext::onStartElement(), oox::vml::TextBoxContext::onStartElement(), oox::drawingml::DiagramQStylesFragmentHandler::onStartElement(), and oox::drawingml::ColorFragmentHandler::onStartElement().

◆ getCurrentElementWithMce()

sal_Int32 oox::core::ContextHandler2Helper::getCurrentElementWithMce ( ) const

Returns the identifier of the currently processed element - Including MCE root elements.

Definition at line 68 of file contexthandler2.cxx.

References mxContextStack, and oox::core::XML_ROOT_CONTEXT.

Referenced by implEndElement(), and implEndRecord().

◆ getDocFilter()

XmlFilterBase & oox::core::ContextHandler2Helper::getDocFilter ( ) const
inlineprotected

Definition at line 205 of file contexthandler2.hxx.

References mrFilter.

Referenced by prepareMceContext().

◆ getMCEState()

MCE_STATE oox::core::ContextHandler2Helper::getMCEState ( ) const
inlineprotected

Definition at line 213 of file contexthandler2.hxx.

Referenced by oox::drawingml::OleObjectGraphicDataContext::onEndElement(), and prepareMceContext().

◆ getParentElement()

sal_Int32 oox::core::ContextHandler2Helper::getParentElement ( sal_Int32  nCountBack = 1) const

Returns the identifier of the specified parent element.

Definition at line 82 of file contexthandler2.cxx.

References o3tl::make_unsigned(), mxContextStack, oox::core::XML_ROOT_CONTEXT, and XML_TOKEN_INVALID.

Referenced by oox::drawingml::chart::ChartDrawingFragment::onCharacters(), and oox::vml::ShapeContext::onCreateContext().

◆ implCharacters()

void oox::core::ContextHandler2Helper::implCharacters ( std::u16string_view  rChars)
protected

Must be called from characters() in derived classes.

Definition at line 111 of file contexthandler2.cxx.

References mxContextStack.

Referenced by oox::core::ContextHandler2::characters(), and oox::core::FragmentHandler2::characters().

◆ implCreateChildContext()

Reference< XFastContextHandler > oox::core::ContextHandler2Helper::implCreateChildContext ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  rxAttribs 
)
protected

Must be called from createFastChildContext() in derived classes.

Definition at line 95 of file contexthandler2.cxx.

References onCreateContext(), and processCollectedChars().

Referenced by oox::core::ContextHandler2::createFastChildContext(), and oox::core::FragmentHandler2::createFastChildContext().

◆ implCreateRecordContext()

ContextHandlerRef oox::core::ContextHandler2Helper::implCreateRecordContext ( sal_Int32  nRecId,
SequenceInputStream &  rStrm 
)
protected

Must be called from createRecordContext() in derived classes.

Definition at line 130 of file contexthandler2.cxx.

References onCreateRecordContext(), and rStrm.

Referenced by oox::core::ContextHandler2::createRecordContext(), and oox::core::FragmentHandler2::createRecordContext().

◆ implEndElement()

void oox::core::ContextHandler2Helper::implEndElement ( sal_Int32  nElement)
protected

Must be called from endFastElement() in derived classes.

Definition at line 118 of file contexthandler2.cxx.

References getCurrentElementWithMce(), mxContextStack, onEndElement(), popElementInfo(), and processCollectedChars().

Referenced by oox::core::ContextHandler2::endFastElement(), and oox::core::FragmentHandler2::endFastElement().

◆ implEndRecord()

void oox::core::ContextHandler2Helper::implEndRecord ( sal_Int32  nRecId)
protected

Must be called from endRecord() in derived classes.

Definition at line 141 of file contexthandler2.cxx.

References getCurrentElementWithMce(), mxContextStack, onEndRecord(), and popElementInfo().

Referenced by oox::core::ContextHandler2::endRecord(), and oox::core::FragmentHandler2::endRecord().

◆ implStartElement()

void oox::core::ContextHandler2Helper::implStartElement ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  rxAttribs 
)
protected

Must be called from startFastElement() in derived classes.

Definition at line 104 of file contexthandler2.cxx.

References oox::AttributeList::getToken(), oox::core::ElementInfo::mbTrimSpaces, onStartElement(), pushElementInfo(), and XML_TOKEN_INVALID.

Referenced by oox::core::ContextHandler2::startFastElement(), and oox::core::FragmentHandler2::startFastElement().

◆ implStartRecord()

void oox::core::ContextHandler2Helper::implStartRecord ( sal_Int32  nRecId,
SequenceInputStream &  rStrm 
)
protected

Must be called from startRecord() in derived classes.

Definition at line 135 of file contexthandler2.cxx.

References onStartRecord(), pushElementInfo(), and rStrm.

Referenced by oox::core::ContextHandler2::startRecord(), and oox::core::FragmentHandler2::startRecord().

◆ isCurrentElement() [1/2]

bool oox::core::ContextHandler2Helper::isCurrentElement ( sal_Int32  nElement) const
inline

Returns true, if nElement contains the identifier of the currently processed element.

Definition at line 155 of file contexthandler2.hxx.

Referenced by oox::drawingml::chart::ChartDrawingFragment::onCharacters(), oox::drawingml::chart::TrendlineContext::onCharacters(), oox::drawingml::chart::TextContext::onCharacters(), oox::drawingml::chart::TextContext::onCreateContext(), oox::ppt::SlideTransitionContext::onEndElement(), oox::ppt::SoundActionContext::onEndElement(), oox::drawingml::chart::ChartDrawingFragment::onEndElement(), oox::ppt::AnimVariantContext::onEndElement(), oox::ppt::CommonTimeNodeContext::onEndElement(), and oox::ppt::TimeAnimValueListContext::onEndElement().

◆ isCurrentElement() [2/2]

bool oox::core::ContextHandler2Helper::isCurrentElement ( sal_Int32  nElement1,
sal_Int32  nElement2 
) const
inline

Returns true, if either nElement1 or nElement2 contain the identifier of the currently processed element.

Definition at line 160 of file contexthandler2.hxx.

◆ isMCEStateEmpty()

bool oox::core::ContextHandler2Helper::isMCEStateEmpty ( ) const
inlineprotected

Definition at line 217 of file contexthandler2.hxx.

Referenced by oox::drawingml::OleObjectGraphicDataContext::onEndElement(), and prepareMceContext().

◆ isParentElement()

bool oox::core::ContextHandler2Helper::isParentElement ( sal_Int32  nElement,
sal_Int32  nCountBack = 1 
) const
inline

Returns true, if nElement contains the identifier of the specified parent element.

Definition at line 168 of file contexthandler2.hxx.

Referenced by oox::drawingml::chart::DoubleSequenceContext::onCharacters().

◆ isRootElement()

bool oox::core::ContextHandler2Helper::isRootElement ( ) const

Returns true, if the element currently processed is the root element of the context or fragment handler.

Definition at line 90 of file contexthandler2.cxx.

References mnRootStackSize, and mxContextStack.

Referenced by oox::ole::AxControlFragment::onCreateContext(), oox::vml::ClientDataContext::onCreateContext(), oox::vml::ShapeTypeContext::onCreateContext(), oox::vml::ShapeContext::onCreateContext(), oox::drawingml::chart::CatAxisContext::onCreateContext(), oox::drawingml::chart::DateAxisContext::onCreateContext(), oox::drawingml::chart::SerAxisContext::onCreateContext(), oox::drawingml::chart::ValAxisContext::onCreateContext(), oox::drawingml::chart::ShapePrWrapperContext::onCreateContext(), oox::drawingml::chart::DataLabelContext::onCreateContext(), oox::drawingml::chart::DataLabelsContext::onCreateContext(), oox::drawingml::chart::PictureOptionsContext::onCreateContext(), oox::drawingml::chart::ErrorBarContext::onCreateContext(), oox::drawingml::chart::TrendlineLabelContext::onCreateContext(), oox::drawingml::chart::TrendlineContext::onCreateContext(), oox::drawingml::chart::AreaTypeGroupContext::onCreateContext(), oox::drawingml::chart::BarTypeGroupContext::onCreateContext(), oox::drawingml::chart::BubbleTypeGroupContext::onCreateContext(), oox::drawingml::chart::LineTypeGroupContext::onCreateContext(), oox::drawingml::chart::PieTypeGroupContext::onCreateContext(), oox::drawingml::chart::RadarTypeGroupContext::onCreateContext(), oox::drawingml::chart::ScatterTypeGroupContext::onCreateContext(), and oox::drawingml::chart::SurfaceTypeGroupContext::onCreateContext().

◆ onCharacters()

virtual void oox::core::ContextHandler2Helper::onCharacters ( const OUString &  rChars)
pure virtual

Will be called before a new child element starts, or if the current element is about to be left.

This helper function collects all text fragments received by the characters() function (such as encoded characters which are passed in separate calls to the characters() function), and passes the concatenated and trimmed string.

The current element identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by OOXML import only.

Implemented in oox::drawingml::GuidContext, oox::drawingml::RegularTextRunContext, oox::drawingml::TextFieldContext, oox::ppt::CommonBehaviorContext, oox::core::ContextHandler2, oox::core::FragmentHandler2, oox::ppt::SlideFragmentHandler, oox::vml::ClientDataContext, oox::vml::TextPortionContext, oox::drawingml::chart::ChartDrawingFragment, oox::drawingml::chart::DoubleSequenceContext, oox::drawingml::chart::StringSequenceContext, oox::drawingml::chart::DataLabelContext, oox::drawingml::chart::DataLabelsContext, oox::drawingml::chart::TrendlineContext, and oox::drawingml::chart::TextContext.

Referenced by processCollectedChars().

◆ onCreateContext()

virtual ContextHandlerRef oox::core::ContextHandler2Helper::onCreateContext ( sal_Int32  nElement,
const AttributeList &  rAttribs 
)
pure virtual

Will be called to create a context handler for the passed element.

Usually 'this' can be returned to improve performance by reusing the same instance to process several elements. Used by OOXML import only.

Implemented in oox::ppt::BackgroundPropertiesContext, oox::ppt::CustomShowListContext, oox::ppt::LayoutFragmentHandler, oox::ppt::PresentationFragmentHandler, oox::ppt::PresPropsFragmentHandler, oox::ppt::SlideFragmentHandler, oox::ppt::SlideMasterTextStylesContext, oox::ppt::SlideTimingContext, oox::ppt::SlideTransitionContext, oox::ppt::SoundActionContext, oox::ppt::TimeNodeListContext, oox::ppt::AnimVariantContext, oox::ppt::BuildListContext, oox::ppt::CommonBehaviorContext, oox::ppt::CommonTimeNodeContext, oox::ppt::CondContext, oox::ppt::CondListContext, oox::ppt::TimeAnimValueListContext, oox::ppt::TimeTargetElementContext, oox::shape::ShapeDrawingFragmentHandler, oox::drawingml::TextEffectsContext, oox::core::ContextHandler2, oox::core::FragmentHandler2, oox::drawingml::ThemeFragmentHandler, oox::ole::AxControlPropertyContext, oox::ole::AxControlFragment, oox::vml::DrawingFragment, oox::vml::ShapeLayoutContext, oox::vml::ClientDataContext, oox::vml::ShapeTypeContext, oox::vml::ShapeContext, oox::vml::GroupShapeContext, oox::vml::RectangleShapeContext, oox::vml::TextPortionContext, oox::vml::TextBoxContext, oox::drawingml::chart::AxisDispUnitsContext, oox::drawingml::chart::AxisContextBase, oox::drawingml::chart::CatAxisContext, oox::drawingml::chart::DateAxisContext, oox::drawingml::chart::SerAxisContext, oox::drawingml::chart::ValAxisContext, oox::drawingml::chart::ShapePrWrapperContext, oox::drawingml::chart::LayoutContext, oox::drawingml::chart::ChartDrawingFragment, oox::drawingml::chart::ChartSpaceFragment, oox::drawingml::chart::DoubleSequenceContext, oox::drawingml::chart::StringSequenceContext, oox::drawingml::chart::DataSourceContext, oox::drawingml::chart::DataTableContext, oox::drawingml::chart::View3DContext, oox::drawingml::chart::WallFloorContext, oox::drawingml::chart::PlotAreaContext, oox::drawingml::chart::DataLabelContext, oox::drawingml::chart::DataLabelsContext, oox::drawingml::chart::PictureOptionsContext, oox::drawingml::chart::ErrorBarContext, oox::drawingml::chart::TrendlineLabelContext, oox::drawingml::chart::TrendlineContext, oox::drawingml::chart::DataPointContext, oox::drawingml::chart::SeriesContextBase, oox::drawingml::chart::AreaSeriesContext, oox::drawingml::chart::BarSeriesContext, oox::drawingml::chart::BubbleSeriesContext, oox::drawingml::chart::LineSeriesContext, oox::drawingml::chart::PieSeriesContext, oox::drawingml::chart::RadarSeriesContext, oox::drawingml::chart::ScatterSeriesContext, oox::drawingml::chart::SurfaceSeriesContext, oox::drawingml::chart::TextContext, oox::drawingml::chart::TitleContext, oox::drawingml::chart::LegendEntryContext, oox::drawingml::chart::LegendContext, oox::drawingml::chart::UpDownBarsContext, oox::drawingml::chart::AreaTypeGroupContext, oox::drawingml::chart::BarTypeGroupContext, oox::drawingml::chart::BubbleTypeGroupContext, oox::drawingml::chart::LineTypeGroupContext, oox::drawingml::chart::PieTypeGroupContext, oox::drawingml::chart::RadarTypeGroupContext, oox::drawingml::chart::ScatterTypeGroupContext, oox::drawingml::chart::SurfaceTypeGroupContext, oox::drawingml::ThemeOverrideFragmentHandler, oox::drawingml::DiagramQStylesFragmentHandler, oox::drawingml::ColorFragmentHandler, oox::drawingml::RuleListContext, oox::shape::WpgContext, and oox::shape::WpsContext.

Referenced by implCreateChildContext().

◆ onCreateRecordContext()

virtual ContextHandlerRef oox::core::ContextHandler2Helper::onCreateRecordContext ( sal_Int32  nRecId,
SequenceInputStream &  rStrm 
)
pure virtual

Will be called to create a context handler for the passed record.

Usually 'this' can be returned to improve performance by reusing the same instance to process several records. Used by BIFF import only.

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

Referenced by implCreateRecordContext().

◆ onEndElement()

virtual void oox::core::ContextHandler2Helper::onEndElement ( )
pure virtual

Will be called when the current element is about to be left.

The current element identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by OOXML import only.

Implemented in oox::core::ContextHandler2, oox::core::FragmentHandler2, oox::drawingml::GraphicalObjectFrameContext, oox::drawingml::OleObjectGraphicDataContext, oox::ppt::SlideTransitionContext, oox::ppt::SoundActionContext, oox::vml::ClientDataContext, oox::vml::TextPortionContext, oox::vml::TextBoxContext, oox::drawingml::chart::ChartDrawingFragment, oox::drawingml::RegularTextRunContext, oox::drawingml::TextEffectsContext, oox::drawingml::TextFieldContext, oox::drawingml::DiagramQStylesFragmentHandler, oox::drawingml::ColorFragmentHandler, oox::ppt::AnimVariantContext, oox::ppt::BuildListContext, oox::ppt::CommonBehaviorContext, oox::ppt::CommonTimeNodeContext, and oox::ppt::TimeAnimValueListContext.

Referenced by implEndElement().

◆ onEndRecord()

virtual void oox::core::ContextHandler2Helper::onEndRecord ( )
pure virtual

Will be called when the current record block is about to be left.

The current record identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by BIFF import only.

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

Referenced by implEndRecord().

◆ onStartElement()

virtual void oox::core::ContextHandler2Helper::onStartElement ( const AttributeList &  rAttribs)
pure virtual

Will be called when a new element has been started.

This function is called at the context handler returned from onCreateContext(), or, for root elements of an XML stream, at the fragment handler itself.

The current element identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by OOXML import only.

Implemented in oox::core::ContextHandler2, oox::core::FragmentHandler2, oox::vml::TextPortionContext, oox::vml::TextBoxContext, oox::drawingml::DiagramQStylesFragmentHandler, oox::drawingml::ColorFragmentHandler, and oox::drawingml::TextEffectsContext.

Referenced by implStartElement().

◆ onStartRecord()

virtual void oox::core::ContextHandler2Helper::onStartRecord ( SequenceInputStream &  rStrm)
pure virtual

Will be called when a new record block in a binary stream has been started.

The current record identifier can be accessed with getCurrentElement() or isCurrentElement(). Used by BIFF import only.

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

Referenced by implStartRecord().

◆ operator=()

ContextHandler2Helper & oox::core::ContextHandler2Helper::operator= ( const ContextHandler2Helper &  )
privatedelete

◆ popElementInfo()

void oox::core::ContextHandler2Helper::popElementInfo ( )
private

Definition at line 159 of file contexthandler2.cxx.

References mxContextStack.

Referenced by implEndElement(), and implEndRecord().

◆ prepareMceContext()

bool oox::core::ContextHandler2Helper::prepareMceContext ( sal_Int32  nElement,
const AttributeList &  rAttribs 
)
protected

Definition at line 223 of file contexthandler2.cxx.

References addMCEState(), FoundChoice, getDocFilter(), getMCEState(), oox::AttributeList::getString(), oox::AttributeList::getStringDefaulted(), isMCEStateEmpty(), setMCEState(), Started, and xModel.

Referenced by oox::core::ContextHandler2::createFastChildContext(), and oox::core::FragmentHandler2::createFastChildContext().

◆ processCollectedChars()

void oox::core::ContextHandler2Helper::processCollectedChars ( )
private

Definition at line 166 of file contexthandler2.cxx.

References oox::core::ElementInfo::maChars, mbEnableTrimSpace, oox::core::ElementInfo::mbTrimSpaces, mxContextStack, and onCharacters().

Referenced by implCreateChildContext(), and implEndElement().

◆ pushElementInfo()

ElementInfo & oox::core::ContextHandler2Helper::pushElementInfo ( sal_Int32  nElement)
private

Definition at line 151 of file contexthandler2.cxx.

References oox::core::ElementInfo::mnElement, and mxContextStack.

Referenced by ContextHandler2Helper(), implStartElement(), and implStartRecord().

◆ release()

virtual void SAL_CALL oox::core::ContextHandler2Helper::release ( )
pure virtualnoexcept

Implemented in oox::core::ContextHandler2, and oox::core::FragmentHandler2.

◆ removeMCEState()

void oox::core::ContextHandler2Helper::removeMCEState ( )
inlineprotected

Definition at line 216 of file contexthandler2.hxx.

Referenced by oox::core::FragmentHandler2::endFastElement().

◆ setMCEState()

void oox::core::ContextHandler2Helper::setMCEState ( MCE_STATE  aState)
inlineprotected

Definition at line 214 of file contexthandler2.hxx.

Referenced by oox::drawingml::OleObjectGraphicDataContext::onEndElement(), and prepareMceContext().

Member Data Documentation

◆ aMceState

std::vector<MCE_STATE> oox::core::ContextHandler2Helper::aMceState
private

Definition at line 232 of file contexthandler2.hxx.

◆ mbEnableTrimSpace

bool oox::core::ContextHandler2Helper::mbEnableTrimSpace
protected

True = trim whitespace in characters().

Definition at line 235 of file contexthandler2.hxx.

Referenced by processCollectedChars().

◆ mnRootStackSize

size_t oox::core::ContextHandler2Helper::mnRootStackSize
private

Stack size on construction time.

Definition at line 231 of file contexthandler2.hxx.

Referenced by isRootElement().

◆ mrFilter

XmlFilterBase& oox::core::ContextHandler2Helper::mrFilter
protected

Definition at line 236 of file contexthandler2.hxx.

◆ mxContextStack

ContextStackRef oox::core::ContextHandler2Helper::mxContextStack
private

Stack of all processed elements.

Definition at line 230 of file contexthandler2.hxx.

Referenced by getCurrentElement(), getCurrentElementWithMce(), getParentElement(), implCharacters(), implEndElement(), implEndRecord(), isRootElement(), popElementInfo(), processCollectedChars(), and pushElementInfo().

The documentation for this class was generated from the following files:
Generated on Wed Sep 21 2022 21:41:19 for LibreOffice Module oox (master) by doxygen 1.9.3