attributeoutputbase.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_SW_SOURCE_FILTER_WW8_ATTRIBUTEOUTPUTBASE_HXX
#define INCLUDED_SW_SOURCE_FILTER_WW8_ATTRIBUTEOUTPUTBASE_HXX
 
#include "WW8TableInfo.hxx"
#include "wrtww8.hxx"
 
#include <rtl/textenc.h>
#include <editeng/svxenum.hxx>
#include <tools/solar.h>
#include <optional>
 
#include <com/sun/star/drawing/TextVerticalAdjust.hpp>
#include <swtypes.hxx>
#include <fldbas.hxx>
#include <utility>
 
class Point;
class SvxCaseMapItem;
class SvxColorItem;
class SvxContourItem;
class SvxCrossedOutItem;
class SvxEscapementItem;
class SvxFontItem;
class SvxFontHeightItem;
class SvxKerningItem;
class SvxLanguageItem;
class SvxPostureItem;
class SvxShadowedItem;
class SvxUnderlineItem;
class SvxWeightItem;
class SvxAutoKernItem;
class SvxBlinkItem;
class SvxBrushItem;
class XFillStyleItem;
class XFillGradientItem;
class SvxFontItem;
class SvxFontHeightItem;
class SvxLanguageItem;
class SvxPostureItem;
class SvxWeightItem;
class SvxFontItem;
class SvxFontHeightItem;
class SvxLanguageItem;
class SvxPostureItem;
class SvxWeightItem;
class SvxCharRotateItem;
class SvxEmphasisMarkItem;
class SvxTwoLinesItem;
class SvxCharScaleWidthItem;
class SvxCharReliefItem;
class SvxCharHiddenItem;
class SvxBoxItem;
class SwFormatINetFormat;
class SwFormatCharFormat;
class SwFormatField;
class SwFormatFlyCnt;
class SwFormatFootnote;
class SvxLineSpacingItem;
class SvxAdjustItem;
class SvxFormatSplitItem;
class SvxWidowsItem;
class SvxTabStopItem;
class SvxHyphenZoneItem;
class SwNumRuleItem;
class SfxBoolItem;
class SfxPoolItem;
class SfxItemSet;
class SvxParaVertAlignItem;
class SvxParaGridItem;
class SwFormatFrameSize;
class SvxPaperBinItem;
class SvxLRSpaceItem;
class SvxULSpaceItem;
class SwFormatPageDesc;
class SvxFormatBreakItem;
class SwFormatSurround;
class SwFormatVertOrient;
class SwFormatHoriOrient;
class SwFormatAnchor;
class SvxBrushItem;
class SvxBoxItem;
class SwFormatCol;
class SvxFormatKeepItem;
class SwTextGridItem;
class SwFormatLineNumber;
class SvxFrameDirectionItem;
class SfxGrabBagItem;
class SfxUInt16Item;
class SwFormatRuby;
class SwTextNode;
class SwTOXMark;
class SwRedlineData;
class SwSection;
class SwFormatDrop;
class SwFrameFormat;
class SwNumFormat;
class SwFormat;
struct WW8_SepInfo;
class SwLineNumberInfo;
class SwNumRule;
class wwFont;
 
namespace editeng { class SvxBorderLine; }
 
namespace rtl { class OUString; }
 
class MSWordExportBase;
 
namespace ww8 { class Frame; }
 
namespace msword {
    const sal_uInt8 ColumnBreak = 0xE;
    const sal_uInt8 PageBreak   = 0xC;
}
 
enum StyleType
{
    STYLE_TYPE_PARA,
    STYLE_TYPE_CHAR,
    STYLE_TYPE_LIST
};
 
class AttributeOutputBase
{
private:
    OUString m_sBaseURL; // To be used in ConvertURL
 
    OUString ConvertURL( const OUString& rUrl, bool bAbsoluteOut );
 
public:
    virtual void RTLAndCJKState( bool bIsRTL, sal_uInt16 nScript ) = 0;
 
    virtual sal_Int32 StartParagraph( ww8::WW8TableNodeInfo::Pointer_t pTextNodeInfo, bool bGenerateParaId ) = 0;
 
    virtual void EndParagraph( ww8::WW8TableNodeInfoInner::Pointer_t pTextNodeInfoInner ) = 0;
 
    virtual void SectionBreaks(const SwNode& rNode) = 0;
 
    virtual void StartParagraphProperties() = 0;
 
    virtual void EndParagraphProperties(const SfxItemSet& rParagraphMarkerProperties, const SwRedlineData* pRedlineData, const SwRedlineData* pRedlineParagraphMarkerDeleted, const SwRedlineData* pRedlineParagraphMarkerInserted) = 0;
 
    virtual void EmptyParagraph() = 0;
 
    virtual void StartRun( const SwRedlineData* pRedlineData, sal_Int32 nPos, bool bSingleEmptyRun = false ) = 0;
 
    virtual void EndRun( const SwTextNode* pNode, sal_Int32 nPos, sal_Int32 nLen, bool bLastRun = false ) = 0;
 
    virtual void StartRunProperties() = 0;
 
    virtual void EndRunProperties( const SwRedlineData* pRedlineData ) = 0;
 
    virtual bool FootnoteEndnoteRefTag() { return false; };
 
    virtual void SectFootnoteEndnotePr() {};
 
    virtual void WritePostitFieldReference() {};
 
    virtual void RunText( const OUString& rText, rtl_TextEncoding eCharSet = RTL_TEXTENCODING_UTF8, const OUString& rSymbolFont = OUString() ) = 0;
 
    virtual void RawText(const OUString& rText, rtl_TextEncoding eCharSet) = 0;
 
    virtual void StartRuby( const SwTextNode& rNode, sal_Int32 nPos, const SwFormatRuby& rRuby ) = 0;
 
    virtual void EndRuby( const SwTextNode& rNode, sal_Int32 nPos ) = 0;
 
    virtual bool StartURL( const OUString& rUrl, const OUString& rTarget ) = 0;
 
    virtual bool EndURL(bool isAtEndOfParagraph) = 0;
 
    virtual void FieldVanish(const OUString& rText, ww::eField eType, OUString const* pBookmarkName) = 0;
 
    void GenerateBookmarksForSequenceField(const SwTextNode& rNode, SwWW8AttrIter& rAttrIter);
 
    void StartTOX( const SwSection& rSect );
 
    void EndTOX( const SwSection& rSect,bool bCareEnd=true );
 
    virtual void OnTOXEnding() {}
 
    void TOXMark( const SwTextNode& rNode, const SwTOXMark& rAttr );
 
    virtual void Redline( const SwRedlineData* pRedline ) = 0;
 
    virtual void FormatDrop( const SwTextNode& rNode, const SwFormatDrop& rSwFormatDrop, sal_uInt16 nStyle, ww8::WW8TableNodeInfo::Pointer_t pTextNodeInfo, ww8::WW8TableNodeInfoInner::Pointer_t pTextNodeInfoInner ) = 0;
 
    virtual void OutputFKP(bool /*bForce*/) {}
 
    virtual void ParagraphStyle( sal_uInt16 nStyle ) = 0;
 
    virtual void TableInfoCell( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableInfoRow( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableDefinition( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableDefaultBorders( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableBackgrounds( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableRowRedline( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableCellRedline( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableHeight( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableCanSplit( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableBidi( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableVerticalCell( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfo ) = 0;
 
    virtual void TableNodeInfoInner( ww8::WW8TableNodeInfoInner::Pointer_t pNodeInfoInner ) = 0;
 
    virtual void TableOrientation( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfoInner ) = 0;
 
    virtual void TableSpacing( ww8::WW8TableNodeInfoInner::Pointer_t pTableTextNodeInfoInner ) = 0;
 
    virtual void TableRowEnd( sal_uInt32 nDepth ) = 0;
 
    virtual void StartStyles() = 0;
 
    virtual void EndStyles( sal_uInt16 nNumberOfStyles ) = 0;
 
    virtual void DefaultStyle() = 0;
 
    virtual void StartStyle( const OUString& rName, StyleType eType,
            sal_uInt16 nBase, sal_uInt16 nNext, sal_uInt16 nLink, sal_uInt16 nWwId, sal_uInt16 nSlot,
            bool bAutoUpdate ) = 0;
 
    virtual void EndStyle() = 0;
 
    virtual void StartStyleProperties( bool bParProp, sal_uInt16 nStyle ) = 0;
 
    virtual void EndStyleProperties( bool bParProp ) = 0;
 
    virtual void OutlineNumbering(sal_uInt8 nLvl) = 0;
 
    virtual void PageBreakBefore( bool bBreak ) = 0;
 
    virtual void SectionBreak( sal_uInt8 nC, bool bBreakAfter, const WW8_SepInfo* pSectionInfo = nullptr, bool bExtraPageBreak = false ) = 0;
 
    // preserve page vertical alignment
    virtual void TextVerticalAdjustment( const css::drawing::TextVerticalAdjust) {};
 
    virtual void StartSection() = 0;
 
    virtual void EndSection() = 0;
 
    virtual void SectionFormProtection( bool bProtected ) = 0;
 
    virtual void SectionLineNumbering( sal_uLong nRestartNo, const SwLineNumberInfo& rLnNumInfo ) = 0;
 
    virtual void SectionTitlePage() = 0;
 
    virtual void SetStateOfFlyFrame( FlyProcessingState /*nStateOfFlyFrame*/ ){};
    virtual void SetAnchorIsLinkedToNode( bool /*bAnchorLinkedToNode*/){};
 
    virtual bool IsFlyProcessingPostponed(){ return false; };
 
    virtual void ResetFlyProcessingFlag(){};
 
    virtual void SectionPageBorders( const SwFrameFormat* pFormat, const SwFrameFormat* pFirstPageFormat ) = 0;
 
    virtual void SectionBiDi( bool bBiDi ) = 0;
 
    virtual void SectionPageNumbering( sal_uInt16 nNumType, const ::std::optional<sal_uInt16>& oPageRestartNumber ) = 0;
 
    virtual void SectionType( sal_uInt8 nBreakCode ) = 0;
 
    virtual void NumberingDefinition( sal_uInt16 nId, const SwNumRule &rRule ) = 0;
 
    virtual void OverrideNumberingDefinition(SwNumRule const&, sal_uInt16 /*nNum*/, sal_uInt16 /*nAbstractNum*/,
        const std::map< size_t, size_t > & /*rLevelOverrides*/)
    { assert(false); } // TODO implement for WW8/RTF
 
    virtual void StartAbstractNumbering( sal_uInt16 /*nId*/ ) {}
 
    virtual void EndAbstractNumbering() {}
 
    virtual void NumberingLevel( sal_uInt8 nLevel,
        sal_uInt16 nStart,
        sal_uInt16 nNumberingType,
        SvxAdjust eAdjust,
        const sal_uInt8 *pNumLvlPos,
        sal_uInt8 nFollow,
        const wwFont *pFont,
        const SfxItemSet *pOutSet,
        sal_Int16 nIndentAt,
        sal_Int16 nFirstLineIndex,
        sal_Int16 nListTabPos,
        const OUString &rNumberingString,
        const SvxBrushItem* pBrush, // #i120928 export graphic of bullet
        bool isLegal) = 0;
 
protected:
 
    static void GetNumberPara( OUString& rStr, const SwField& rField );
 
    virtual void OutputFlyFrame_Impl( const ww8::Frame& rFormat, const Point& rNdTopLeft ) = 0;
 
    virtual void CharCaseMap( const SvxCaseMapItem& ) = 0;
 
    virtual void CharColor( const SvxColorItem& ) = 0;
 
    virtual void CharContour( const SvxContourItem& ) = 0;
 
    virtual void CharCrossedOut( const SvxCrossedOutItem& ) = 0;
 
    virtual void CharEscapement( const SvxEscapementItem& ) = 0;
 
    virtual void CharFont( const SvxFontItem& ) = 0;
 
    virtual void CharFontSize( const SvxFontHeightItem& ) = 0;
 
    virtual void CharKerning( const SvxKerningItem& ) = 0;
 
    virtual void CharLanguage( const SvxLanguageItem& ) = 0;
 
    virtual void CharPosture( const SvxPostureItem& ) = 0;
 
    virtual void CharShadow( const SvxShadowedItem& ) = 0;
 
    virtual void CharUnderline( const SvxUnderlineItem& ) = 0;
 
    virtual void CharWeight( const SvxWeightItem& ) = 0;
 
    virtual void CharAutoKern( const SvxAutoKernItem& ) = 0;
 
    virtual void CharAnimatedText( const SvxBlinkItem& ) = 0;
 
    void CharBackgroundBase( const SvxBrushItem& );
    virtual void CharBackground( const SvxBrushItem& ) = 0;
 
    virtual void CharFontCJK( const SvxFontItem& ) = 0;
 
    virtual void CharFontSizeCJK( const SvxFontHeightItem& ) = 0;
 
    virtual void CharLanguageCJK( const SvxLanguageItem& ) = 0;
 
    virtual void CharPostureCJK( const SvxPostureItem& ) = 0;
 
    virtual void CharWeightCJK( const SvxWeightItem& ) = 0;
 
    virtual void CharFontCTL( const SvxFontItem& ) = 0;
 
    virtual void CharFontSizeCTL( const SvxFontHeightItem& ) = 0;
 
    virtual void CharLanguageCTL( const SvxLanguageItem& ) = 0;
 
    virtual void CharPostureCTL( const SvxPostureItem& ) = 0;
 
    virtual void CharWeightCTL( const SvxWeightItem& ) = 0;
 
    virtual void CharBidiRTL( const SfxPoolItem& ) = 0;
 
    virtual void CharIdctHint( const SfxPoolItem& ) = 0;
 
    virtual void CharRotate( const SvxCharRotateItem& ) = 0;
 
    virtual void CharEmphasisMark( const SvxEmphasisMarkItem& ) = 0;
 
    virtual void CharTwoLines( const SvxTwoLinesItem& ) = 0;
 
    virtual void CharScaleWidth( const SvxCharScaleWidthItem& ) = 0;
 
    virtual void CharRelief( const SvxCharReliefItem& ) = 0;
 
    virtual void CharHidden( const SvxCharHiddenItem& ) = 0;
 
    void FormatCharBorder( const SvxBoxItem& rBox );
    virtual void CharBorder( const ::editeng::SvxBorderLine* pAllBorder, const sal_uInt16 nDist, const bool bShadow ) = 0;
 
    virtual void CharHighlight( const SvxBrushItem& ) = 0;
 
    virtual void TextINetFormat( const SwFormatINetFormat& ) = 0;
 
    virtual void TextCharFormat( const SwFormatCharFormat& ) = 0;
 
    void TextField( const SwFormatField& );
 
    void TextFlyContent( const SwFormatFlyCnt& );
 
    void TextFootnote( const SwFormatFootnote& );
 
    virtual void TextFootnote_Impl( const SwFormatFootnote& ) = 0;
 
    virtual void TextLineBreak(const SwFormatLineBreak&) = 0;
 
    void ParaLineSpacing( const SvxLineSpacingItem& );
 
    virtual void ParaLineSpacing_Impl( short nSpace, short nMulti ) = 0;
 
    virtual void ParaAdjust( const SvxAdjustItem& ) = 0;
 
    virtual void ParaSplit( const SvxFormatSplitItem& ) = 0;
 
    virtual void ParaWidows( const SvxWidowsItem& ) = 0;
 
    virtual void ParaTabStop( const SvxTabStopItem& ) = 0;
 
    virtual void ParaHyphenZone( const SvxHyphenZoneItem& ) = 0;
 
    void ParaNumRule( const SwNumRuleItem& );
 
    virtual void ParaNumRule_Impl( const SwTextNode *pTextNd, sal_Int32 nLvl, sal_Int32 nNumId ) = 0;
 
    virtual void ParaScriptSpace( const SfxBoolItem& ) = 0;
 
    virtual void ParaHangingPunctuation( const SfxBoolItem& ) = 0;
 
    virtual void ParaForbiddenRules( const SfxBoolItem& ) = 0;
 
    virtual void ParaVerticalAlign( const SvxParaVertAlignItem& ) = 0;
 
    virtual void ParaSnapToGrid( const SvxParaGridItem& ) = 0;
 
    virtual void FormatFrameSize( const SwFormatFrameSize& ) = 0;
 
    virtual void FormatPaperBin( const SvxPaperBinItem& ) = 0;
 
    virtual void FormatFirstLineIndent(const SvxFirstLineIndentItem & rFirstLine) = 0;
    virtual void FormatTextLeftMargin(const SvxTextLeftMarginItem & rTextLeftMargin) = 0;
    virtual void FormatRightMargin(const SvxRightMarginItem & rRightMargin) = 0;
 
    virtual void FormatLRSpace( const SvxLRSpaceItem& ) = 0;
 
    virtual void FormatULSpace( const SvxULSpaceItem& ) = 0;
 
    void FormatPageDescription( const SwFormatPageDesc& );
 
    void FormatBreak( const SvxFormatBreakItem& );
 
    virtual void FormatSurround( const SwFormatSurround& ) = 0;
 
    virtual void FormatVertOrientation( const SwFormatVertOrient& ) = 0;
 
    virtual void FormatHorizOrientation( const SwFormatHoriOrient& ) = 0;
 
    virtual void FormatAnchor( const SwFormatAnchor& ) = 0;
 
    virtual void FormatBackground( const SvxBrushItem& ) = 0;
 
    virtual void FormatFillStyle( const XFillStyleItem& ) = 0;
 
    virtual void FormatFillGradient( const XFillGradientItem& ) = 0;
 
    virtual void FormatBox( const SvxBoxItem& ) = 0;
 
    void FormatColumns( const SwFormatCol& );
 
    virtual void FormatColumns_Impl( sal_uInt16 nCols, const SwFormatCol & rCol, bool bEven, SwTwips nPageSize ) = 0;
 
    virtual void FormatKeep( const SvxFormatKeepItem& ) = 0;
 
    sal_uInt32 GridCharacterPitch( const SwTextGridItem& rGrid ) const;
 
    virtual void FormatTextGrid( const SwTextGridItem& ) = 0;
 
    virtual void FormatLineNumbering( const SwFormatLineNumber& ) = 0;
 
    virtual void FormatFrameDirection( const SvxFrameDirectionItem& ) = 0;
 
    virtual void ParaGrabBag( const SfxGrabBagItem& ) = 0;
 
    virtual void CharGrabBag( const SfxGrabBagItem& ) = 0;
 
    void ParaOutlineLevelBase( const SfxUInt16Item& rItem );
    virtual void ParaOutlineLevel( const SfxUInt16Item& ) = 0;
 
    virtual void WriteExpand( const SwField* pField ) = 0;
 
    virtual void RefField( const SwField& rField, const OUString& rRef ) = 0;
    virtual void HiddenField( const SwField& rField ) = 0;
    virtual void SetField( const SwField& rField, ww::eField eType, const OUString& rCmd ) = 0;
    virtual void PostitField( const SwField* pField ) = 0;
    virtual bool DropdownField( const SwField* pField ) = 0;
    virtual bool PlaceholderField( const SwField* pField ) = 0;
 
    virtual bool AnalyzeURL( const OUString& rUrl, const OUString& rTarget, OUString* pLinkURL, OUString* pMark );
 
    virtual void WriteBookmarkInActParagraph( const OUString& rName, sal_Int32 nFirstRunPos, sal_Int32 nLastRunPos ) = 0;
 
    ww8::GridColsPtr GetGridCols( ww8::WW8TableNodeInfoInner::Pointer_t const & pTableTextNodeInfoInner );
    ww8::WidthsPtr   GetColumnWidths( ww8::WW8TableNodeInfoInner::Pointer_t const & pTableTextNodeInfoInner );
 
    virtual void SectionRtlGutter(const SfxBoolItem& rRtlGutter) = 0;
 
public:
    AttributeOutputBase(OUString sBaseURL)
        : m_sBaseURL(std::move(sBaseURL))
    {
    }
    virtual ~AttributeOutputBase() {}
 
    virtual MSWordExportBase& GetExport() = 0;
 
    const MSWordExportBase& GetExport() const { return const_cast< AttributeOutputBase* >( this )->GetExport(); }
 
    void OutputItem( const SfxPoolItem& rHt );
 
    void OutputStyleItemSet( const SfxItemSet& rSet, bool bTestForDefault );
 
    void OutputFlyFrame( const ww8::Frame& rFormat );
 
    void GetTablePageSize
    ( ww8::WW8TableNodeInfoInner const * pTableTextNodeInfoInner,
      tools::Long& rPageSize, bool& rRelBoxSize );
 
    virtual bool MaybeOutputBrushItem(SfxItemSet const&) { return false; }
 
    virtual void BulletDefinition(int /*nId*/, const Graphic& /*rGraphic*/, Size /*aSize*/) {}
 
    // Returns whether or not the 'SwTextNode' has a paragraph marker inserted \ deleted (using 'track changes')
    const SwRedlineData* GetParagraphMarkerRedline( const SwTextNode& rNode, RedlineType aRedlineType );
};
 
class WW8Ruby
{
    sal_Int32 m_nJC;
    char m_cDirective;
    sal_uInt32 m_nRubyHeight;
    sal_uInt32 m_nBaseHeight;
    OUString m_sFontFamily;
 
public:
    WW8Ruby(const SwTextNode& rNode, const SwFormatRuby& rRuby, const MSWordExportBase& rExport );
    sal_Int32   GetJC() const { return m_nJC; }
    char    GetDirective() const { return m_cDirective; }
    sal_uInt32   GetRubyHeight() const { return m_nRubyHeight; }
    sal_uInt32   GetBaseHeight() const { return m_nBaseHeight; }
    OUString const & GetFontFamily() const { return m_sFontFamily; }
};
#endif // INCLUDED_SW_SOURCE_FILTER_WW8_ATTRIBUTEOUTPUTBASE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */