/* -*- 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_EDITDATA_HXX

#define INCLUDED_EDITENG_EDITDATA_HXX

#include <rtl/ustring.hxx>

#include <editeng/editengdllapi.h>

#include <i18nlangtag/lang.h>

#include <editeng/ESelection.hxx>

#include <memory>

class SfxPoolItem;

template<typename T> class SvParser;

class SvxFieldItem;

enum class HtmlTokenId : sal_Int16;

enum class EETextFormat { Text = 0x20, Rtf, Html = 0x32, Xml };

enum class EEHorizontalTextDirection { Default, L2R, R2L };

enum class EESelectionMode  { Std, Hidden };

    // EESelectionMode::Hidden can be used to completely hide the selection. This is useful e.g. when you want show the selection

    // only as long as your window (which the edit view works on) has the focus

enum class EESpellState  { Ok, NoSpeller, ErrorFound };

enum class EEAnchorMode {

            TopLeft,     TopHCenter,     TopRight,

            VCenterLeft, VCenterHCenter, VCenterRight,

            BottomLeft,  BottomHCenter,  BottomRight };

enum class EERemoveParaAttribsMode { RemoveAll, RemoveCharItems, RemoveNone };

EDITENG_DLLPUBLIC extern const size_t EE_APPEND;

// Error messages for Read / Write Method

#define EE_READWRITE_WRONGFORMAT     ErrCode(ErrCodeArea::Svx, 1)

#define EDITUNDO_REMOVECHARS        100

#define EDITUNDO_CONNECTPARAS       101

#define EDITUNDO_MOVEPARAGRAPHS     103

#define EDITUNDO_INSERTFEATURE      104

#define EDITUNDO_SPLITPARA          105

#define EDITUNDO_INSERTCHARS        106

#define EDITUNDO_DELCONTENT         107

#define EDITUNDO_DELETE             108

#define EDITUNDO_CUT                109

#define EDITUNDO_PASTE              110

#define EDITUNDO_INSERT             111

#define EDITUNDO_MOVEPARAS          113

#define EDITUNDO_PARAATTRIBS        114

#define EDITUNDO_ATTRIBS            115

#define EDITUNDO_DRAGANDDROP        116

#define EDITUNDO_READ               117

#define EDITUNDO_STYLESHEET         118

#define EDITUNDO_REPLACEALL         119

#define EDITUNDO_RESETATTRIBS       121

#define EDITUNDO_INDENTBLOCK        122

#define EDITUNDO_UNINDENTBLOCK      123

#define EDITUNDO_MARKSELECTION      124

#define EDITUNDO_TRANSLITERATE      125

#define EDITUNDO_USER               200

struct EDITENG_DLLPUBLIC EFieldInfo

{

    std::unique_ptr<SvxFieldItem>   pFieldItem;

    OUString                        aCurrentText;

    EPaM                            aPosition = EPaM::NotFound();

    EFieldInfo();

    EFieldInfo( const SvxFieldItem& rFieldItem, sal_Int32 nPara, sal_Int32 nPos );

    ~EFieldInfo();

    EFieldInfo( const EFieldInfo& );

    EFieldInfo& operator= ( const EFieldInfo& );

};

enum class RtfImportState {

                    Start, End,               // only pParser, nPara, nIndex

                    NextToken, UnknownAttr,   // nToken+nTokenValue

                    SetAttr,                  // pAttrs

                    InsertText,               // aText

                    InsertPara,               // -

                    };

enum class HtmlImportState {

                    Start, End,               // only pParser, nPara, nIndex

                    NextToken,                // nToken

                    SetAttr,                  // pAttrs

                    InsertText,               // aText

                    InsertPara, InsertField   // -

                    };

struct HtmlImportInfo

{

    SvParser<HtmlTokenId>*  pParser;

    ESelection              aSelection;

    HtmlImportState         eState;

    HtmlTokenId             nToken;

    OUString                aText;

    HtmlImportInfo( HtmlImportState eState, SvParser<HtmlTokenId>* pPrsrs, const ESelection& rSel );

    ~HtmlImportInfo();

};

struct RtfImportInfo

{

    SvParser<int>*          pParser;

    ESelection              aSelection;

    RtfImportState          eState;

    int                     nToken;

    short                   nTokenValue;

    RtfImportInfo( RtfImportState eState, SvParser<int>* pPrsrs, const ESelection& rSel );

};

struct ParagraphInfos

{

    ParagraphInfos()

        : nFirstLineHeight( 0 )

        , nFirstLineTextHeight ( 0 )

        , nFirstLineMaxAscent( 0 )

        , bValid( false )

        {}

    sal_uInt16  nFirstLineHeight;

    sal_uInt16  nFirstLineTextHeight;

    sal_uInt16  nFirstLineMaxAscent;

    bool        bValid; // A query during formatting is not valid!

};

struct ScalingParameters

{

    double fFontX = 1.0;

    double fFontY = 1.0;

    double fSpacingX = 1.0;

    double fSpacingY = 1.0;

    bool operator==(const ScalingParameters& rOther) const = default;

    bool areValuesDefault()

    {

        return fFontX == 1.0 && fFontY == 1.0 && fSpacingX == 1.0 && fSpacingY == 1.0;

    }

};

struct EECharAttrib

{

    const SfxPoolItem*  pAttr;

    sal_Int32           nStart;

    sal_Int32           nEnd;

    EECharAttrib(sal_Int32 nSt, sal_Int32 nE, const SfxPoolItem* pA = nullptr)

        : pAttr(pA)

        , nStart(nSt)

        , nEnd(nE)

    {

    }

};

struct MoveParagraphsInfo

{

    sal_Int32  nStartPara;

    sal_Int32  nEndPara;

    sal_Int32  nDestPara;

    MoveParagraphsInfo( sal_Int32 nS, sal_Int32 nE, sal_Int32 nD )

        { nStartPara = nS; nEndPara = nE; nDestPara = nD; }

};

struct PasteOrDropInfos

{

    sal_Int32              nStartPara;

    sal_Int32              nEndPara;

    PasteOrDropInfos() : nStartPara(-1), nEndPara(-1)  {}

};

enum EENotifyType

{

    /// EditEngine text was modified

    EE_NOTIFY_TEXTMODIFIED,

    /// A paragraph was inserted into the EditEngine

    EE_NOTIFY_PARAGRAPHINSERTED,

    /// A paragraph was removed from the EditEngine

    EE_NOTIFY_PARAGRAPHREMOVED,

    /// Multiple paragraphs have been removed from the EditEngine

    EE_NOTIFY_PARAGRAPHSMOVED,

    /// The height of at least one paragraph has changed

    EE_NOTIFY_TextHeightChanged,

    /// The view area of the EditEngine scrolled

    EE_NOTIFY_TEXTVIEWSCROLLED,

    /// The selection and/or the cursor position has changed

    EE_NOTIFY_TEXTVIEWSELECTIONCHANGED,

    /// The EditEngine is in a valid state again. Process pending notifications.

    EE_NOTIFY_PROCESSNOTIFICATIONS,

    EE_NOTIFY_TEXTVIEWSELECTIONCHANGED_ENDD_PARA

};

struct EENotify

{

    EENotifyType    eNotificationType;

    sal_Int32 nParagraph = EE_PARA_MAX; // only valid in PARAGRAPHINSERTED/EE_NOTIFY_PARAGRAPHREMOVED

    sal_Int32 nParam1 = 0;

    sal_Int32 nParam2 = 0;

    EENotify(EENotifyType eType) { eNotificationType = eType; }

};

namespace editeng

{

struct LanguageSpan

{

    LanguageType nLang = LANGUAGE_DONTKNOW;

    sal_Int32 nStart = -1;

    sal_Int32 nEnd = -1;

};

}

#endif // INCLUDED_EDITENG_EDITDATA_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */