IDocumentContentOperations.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 .
 */
 
#pragma once
 
#include <sal/types.h>
#include <rtl/ustring.hxx>
#include "swtypes.hxx"
 
class SwPaM;
struct SwPosition;
class SwNode;
class SwNodeRange;
class Graphic;
class SfxItemSet;
class SfxPoolItem;
class GraphicObject;
class SdrObject;
class SwFrameFormat;
class SwDrawFrameFormat;
class SwFlyFrameFormat;
class SwNodeIndex;
class SwRootFrame;
class SwTextAttr;
 
namespace utl { class TransliterationWrapper; }
namespace svt { class EmbeddedObjectRef; }
 
enum class SwMoveFlags
{
    DEFAULT       = 0x00,
    ALLFLYS       = 0x01,
    CREATEUNDOOBJ = 0x02,
    REDLINES      = 0x04,
    NO_DELFRMS    = 0x08
};
namespace o3tl
{
    template<> struct typed_flags<SwMoveFlags> : is_typed_flags<SwMoveFlags, 0x0f> {};
}
 
// constants for inserting text
enum class SwInsertFlags
{
    DEFAULT         = 0x00, // no extras
    EMPTYEXPAND     = 0x01, // expand empty hints at insert position
    NOHINTEXPAND    = 0x02, // do not expand any hints at insert pos
    FORCEHINTEXPAND = 0x04 // expand all hints at insert position
};
namespace o3tl
{
    template<> struct typed_flags<SwInsertFlags> : is_typed_flags<SwInsertFlags, 0x07> {};
}
 
enum class SwCopyFlags
{
    Default         = 0,
    CopyAll         = (1<<0), 
    CheckPosInFly   = (1<<1), 
    IsMoveToFly     = (1<<2), 
    // TODO: mbCopyIsMove? mbIsRedlineMove?
};
namespace o3tl
{
    template<> struct typed_flags<SwCopyFlags> : is_typed_flags<SwCopyFlags, 0x07> {};
}
 
enum class SwDeleteFlags
{
    Default = 0,
    ArtificialSelection = (1<<0), 
};
namespace o3tl
{
    template<> struct typed_flags<SwDeleteFlags> : is_typed_flags<SwDeleteFlags, 0x01> {};
}
 
class IDocumentContentOperations
{
public:
public:
    virtual bool CopyRange(SwPaM& rPam, SwPosition& rPos, SwCopyFlags flags) const = 0;
 
    virtual void DeleteSection(SwNode* pNode) = 0;
 
    virtual void DeleteRange(SwPaM&) = 0;
 
    virtual bool DelFullPara(SwPaM&) = 0;
 
    virtual bool DeleteAndJoin(SwPaM&, SwDeleteFlags flags = SwDeleteFlags::Default) = 0;
 
    virtual bool MoveRange(SwPaM&, SwPosition&, SwMoveFlags) = 0;
 
    virtual bool MoveNodeRange(SwNodeRange&, SwNode&, SwMoveFlags) = 0;
 
    virtual void MoveAndJoin(SwPaM&, SwPosition&) = 0;
 
    virtual bool Overwrite(const SwPaM &rRg, const OUString& rStr) = 0;
 
    virtual bool InsertString(const SwPaM &rRg, const OUString&,
              const SwInsertFlags nInsertMode = SwInsertFlags::EMPTYEXPAND ) = 0;
 
    virtual void SetIME(bool bIME) = 0;
 
    virtual bool GetIME() const = 0;
 
    virtual void TransliterateText(const SwPaM& rPaM, utl::TransliterationWrapper&) = 0;
 
    virtual SwFlyFrameFormat* InsertGraphic(
        const SwPaM &rRg, const OUString& rGrfName,
        const OUString& rFltName, const Graphic* pGraphic,
        const SfxItemSet* pFlyAttrSet, const SfxItemSet* pGrfAttrSet,
        SwFrameFormat*) = 0;
 
    virtual void ReRead(SwPaM&, const OUString& rGrfName, const OUString& rFltName, const Graphic* pGraphic) = 0;
 
    virtual SwDrawFrameFormat* InsertDrawObj(
        const SwPaM &rRg, SdrObject& rDrawObj, const SfxItemSet& rFlyAttrSet) = 0;
 
    virtual SwFlyFrameFormat* InsertEmbObject(
        const SwPaM &rRg, const svt::EmbeddedObjectRef& xObj,
        SfxItemSet* pFlyAttrSet) = 0;
 
    virtual SwFlyFrameFormat* InsertOLE(
        const SwPaM &rRg, const OUString& rObjName, sal_Int64 nAspect,
        const SfxItemSet* pFlyAttrSet, const SfxItemSet* pGrfAttrSet) = 0;
 
    virtual bool SplitNode(const SwPosition &rPos, bool bChkTableStart) = 0;
 
    virtual bool AppendTextNode(SwPosition& rPos) = 0;
 
    virtual bool ReplaceRange(SwPaM& rPam, const OUString& rNewStr,
                              const bool bRegExReplace) = 0;
 
    virtual bool InsertPoolItem(const SwPaM &rRg, const SfxPoolItem&,
                                const SetAttrMode nFlags = SetAttrMode::DEFAULT,
                                SwRootFrame const* pLayout = nullptr,
                                SwTextAttr **ppNewTextAttr = nullptr) = 0;
 
    virtual void InsertItemSet (const SwPaM &rRg, const SfxItemSet&,
        const SetAttrMode nFlags = SetAttrMode::DEFAULT,
        SwRootFrame const* pLayout = nullptr) = 0;
 
    virtual void RemoveLeadingWhiteSpace(const SwPosition & rPos ) = 0;
    virtual void RemoveLeadingWhiteSpace(SwPaM& rPaM) = 0;
 
protected:
    virtual ~IDocumentContentOperations() {};
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */