unoedsrc.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_EDITENG_UNOEDSRC_HXX
#define INCLUDED_EDITENG_UNOEDSRC_HXX
 
#include <i18nlangtag/lang.h>
#include <rtl/ustring.hxx>
#include <tools/gen.hxx>
#include <tools/fontenum.hxx>
#include <vcl/mapmod.hxx>
#include <svl/poolitem.hxx>
#include <editeng/editengdllapi.h>
#include <editeng/editeng.hxx>
 
#include <vector>
 
struct ESelection;
struct EFieldInfo;
struct EBulletInfo;
class Color;
class OutputDevice;
class SfxItemSet;
class SvxTextForwarder;
class SvxViewForwarder;
class SvxEditViewForwarder;
class SvxFieldItem;
class SfxBroadcaster;
class SvxUnoTextRangeBase;
 
typedef std::vector< SvxUnoTextRangeBase* > SvxUnoTextRangeBaseVec;
 
class EDITENG_DLLPUBLIC SvxEditSource
{
public:
    SvxEditSource() = default;
    SvxEditSource(SvxEditSource const &) = default;
    SvxEditSource(SvxEditSource &&) = default;
    SvxEditSource & operator =(SvxEditSource const &) = default;
    SvxEditSource & operator =(SvxEditSource &&) = default;
 
    virtual                 ~SvxEditSource();
 
    virtual std::unique_ptr<SvxEditSource> Clone() const = 0;
 
    virtual SvxTextForwarder*   GetTextForwarder() = 0;
 
     virtual SvxViewForwarder*  GetViewForwarder();
 
    virtual SvxEditViewForwarder*  GetEditViewForwarder( bool bCreate = false );
 
    virtual void                UpdateData() = 0;
 
    virtual SfxBroadcaster&     GetBroadcaster() const;
 
    virtual void addRange( SvxUnoTextRangeBase* pNewRange );
 
    virtual void removeRange( SvxUnoTextRangeBase* pOldRange );
 
    virtual const SvxUnoTextRangeBaseVec& getRanges() const;
};
 
 
class EDITENG_DLLPUBLIC SvxTextForwarder
{
public:
    virtual             ~SvxTextForwarder() COVERITY_NOEXCEPT_FALSE;
 
    virtual sal_Int32   GetParagraphCount() const = 0;
    virtual sal_Int32   GetTextLen( sal_Int32 nParagraph ) const = 0;
    virtual OUString    GetText( const ESelection& rSel ) const = 0;
    virtual SfxItemSet  GetAttribs( const ESelection& rSel, EditEngineAttribs nOnlyHardAttrib = EditEngineAttribs::All ) const = 0;
    virtual SfxItemSet  GetParaAttribs( sal_Int32 nPara ) const = 0;
    virtual void        SetParaAttribs( sal_Int32 nPara, const SfxItemSet& rSet ) = 0;
    virtual void        RemoveAttribs( const ESelection& rSelection ) = 0;
    virtual void        GetPortions( sal_Int32 nPara, std::vector<sal_Int32>& rList ) const = 0;
 
    virtual OUString    GetStyleSheet(sal_Int32 nPara) const = 0;
    virtual void        SetStyleSheet(sal_Int32 nPara, const OUString& rStyleName) = 0;
 
    virtual SfxItemState    GetItemState( const ESelection& rSel, sal_uInt16 nWhich ) const = 0;
    virtual SfxItemState    GetItemState( sal_Int32 nPara, sal_uInt16 nWhich ) const = 0;
 
    virtual void        QuickInsertText( const OUString& rText, const ESelection& rSel ) = 0;
    virtual void        QuickInsertField( const SvxFieldItem& rFld, const ESelection& rSel ) = 0;
    virtual void        QuickSetAttribs( const SfxItemSet& rSet, const ESelection& rSel ) = 0;
    virtual void        QuickInsertLineBreak( const ESelection& rSel ) = 0;
 
    virtual OUString    CalcFieldValue( const SvxFieldItem& rField, sal_Int32 nPara, sal_Int32 nPos, std::optional<Color>& rpTxtColor, std::optional<Color>& rpFldColor, std::optional<FontLineStyle>& rpFldLineStyle ) = 0;
    virtual void        FieldClicked( const SvxFieldItem& rField ) = 0;
 
    virtual SfxItemPool* GetPool() const = 0;
 
    virtual const SfxItemSet*   GetEmptyItemSetPtr() = 0;
 
    // implementation functions for XParagraphAppend and XTextPortionAppend
    virtual void        AppendParagraph() = 0;
    virtual sal_Int32   AppendTextPortion( sal_Int32 nPara, const OUString &rText, const SfxItemSet &rSet ) = 0;
 
    // XTextCopy
    virtual void        CopyText(const SvxTextForwarder& rSource) = 0;
 
    virtual bool       IsValid() const = 0;
 
    virtual LanguageType    GetLanguage( sal_Int32 nPara, sal_Int32 nIndex ) const = 0;
 
    virtual sal_Int32          GetFieldCount( sal_Int32 nPara ) const = 0;
 
    virtual EFieldInfo      GetFieldInfo( sal_Int32 nPara, sal_uInt16 nField ) const = 0;
 
    virtual EBulletInfo     GetBulletInfo( sal_Int32 nPara ) const = 0;
 
    virtual tools::Rectangle       GetCharBounds( sal_Int32 nPara, sal_Int32 nIndex ) const = 0;
 
    virtual tools::Rectangle       GetParaBounds( sal_Int32 nPara ) const = 0;
 
    virtual MapMode         GetMapMode() const = 0;
 
    virtual OutputDevice*   GetRefDevice() const = 0;
 
    virtual bool            GetIndexAtPoint( const Point& rPoint, sal_Int32& rPara, sal_Int32& rIndex ) const = 0;
 
    virtual bool             GetWordIndices( sal_Int32 nPara, sal_Int32 nIndex, sal_Int32& rStart, sal_Int32& rEnd ) const = 0;
 
    virtual bool               GetAttributeRun( sal_Int32& nStartIndex, sal_Int32& nEndIndex, sal_Int32 nPara, sal_Int32 nIndex, bool bInCell = false ) const = 0;
 
    virtual sal_Int32          GetLineCount( sal_Int32 nPara ) const = 0;
 
    virtual sal_Int32         GetLineLen( sal_Int32 nPara, sal_Int32 nLine ) const = 0;
 
    virtual void            GetLineBoundaries( /*out*/sal_Int32 &rStart, /*out*/sal_Int32 &rEnd, sal_Int32 nParagraph, sal_Int32 nLine ) const = 0;
 
    virtual sal_Int32          GetLineNumberAtIndex( sal_Int32 nPara, sal_Int32 nIndex ) const = 0;
 
    virtual bool            Delete( const ESelection& rSelection ) = 0;
 
    virtual bool            InsertText( const OUString& rText, const ESelection& rSel ) = 0;
 
    virtual bool            QuickFormatDoc( bool bFull = false ) = 0;
 
    virtual sal_Int16       GetDepth( sal_Int32 nPara ) const = 0;
 
    virtual bool            SetDepth( sal_Int32 nPara, sal_Int16 nNewDepth ) = 0;
 
    virtual sal_Int32 GetNumberingStartValue( sal_Int32 nPara );
    virtual void SetNumberingStartValue( sal_Int32 nPara, sal_Int32 nNumberingStartValue );
 
    virtual bool IsParaIsNumberingRestart( sal_Int32 nPara );
    virtual void SetParaIsNumberingRestart( sal_Int32 nPara, bool bParaIsNumberingRestart );
};
 
class EDITENG_DLLPUBLIC SvxViewForwarder
{
public:
    virtual             ~SvxViewForwarder();
 
    virtual bool        IsValid() const = 0;
 
    virtual Point       LogicToPixel( const Point& rPoint, const MapMode& rMapMode ) const = 0;
 
    virtual Point       PixelToLogic( const Point& rPoint, const MapMode& rMapMode ) const = 0;
 
};
 
 
class SvxEditViewForwarder : public SvxViewForwarder
{
public:
 
    virtual bool GetSelection( ESelection& rSelection ) const = 0;
 
    virtual bool SetSelection( const ESelection& rSelection ) = 0;
 
    virtual bool Copy() = 0;
 
    virtual bool Cut() = 0;
 
    virtual bool Paste() = 0;
 
};
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */