sw/source/uibase/inc/formatclipboard.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SW_SOURCE_UIBASE_INC_FORMATCLIPBOARD_HXX
  21 #define INCLUDED_SW_SOURCE_UIBASE_INC_FORMATCLIPBOARD_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26
  27 #include "wrtsh.hxx"
  28 #include <svl/itemset.hxx>
  29 #include <svl/style.hxx>
  30
  31 /** This class acts as data container and execution class for the format paintbrush feature in writer.
  32 */
  33
  34 class SwFormatClipboard
  35 {
  36 public:
  37     SwFormatClipboard();
  38
  39     /**
  40      * Test if the object contains text or paragraph attribute
  41      */
  42     bool HasContent() const;
  43     bool HasContentForThisType(SelectionType nSelectionType) const;
  44     static bool CanCopyThisType(SelectionType nSelectionType);
  45
  46     /**
  47      * Store/Backup the text and paragraph attribute of the current selection.
  48      *
  49      * @param bPersistentCopy
  50      * input parameter - specify if the Paste function will erase the current object.
  51      */
  52     void Copy(SwWrtShell& rWrtShell, SfxItemPool& rPool, bool bPersistentCopy);
  53
  54     /**
  55      * Paste the stored text and paragraph attributes on the current selection and current paragraph.
  56      *
  57      * @param bNoCharacterFormats
  58      * Do not paste the character formats.
  59      *
  60      * @param bNoParagraphFormats
  61      * Do not paste the paragraph formats.
  62      */
  63     void Paste(SwWrtShell& rWrtShell, SfxStyleSheetBasePool* pPool, bool bNoCharacterFormats,
  64                bool bNoParagraphFormats);
  65
  66     /**
  67      * Clear the currently stored text and paragraph attributes.
  68      */
  69     void Erase();
  70
  71 private:
  72     SelectionType m_nSelectionType;
  73
  74     /** automatic/named character attribute set */
  75     std::unique_ptr<SfxItemSet> m_pItemSet_TextAttr;
  76     /** automatic/named paragraph attribute set
  77      * (it can be character attribute applied to the paragraph) */
  78     std::unique_ptr<SfxItemSet> m_pItemSet_ParAttr;
  79
  80     /** table attribute set */
  81     std::unique_ptr<SfxItemSet> m_pTableItemSet;
  82
  83     /** name of the character format (if it exist) */
  84     OUString m_aCharStyle;
  85     /** name of the paragraph format (if it exist) */
  86     OUString m_aParaStyle;
  87     //no frame style because it contains position information
  88
  89     /** specify if the Paste function have to clear the current object */
  90     bool m_bPersistentCopy;
  91 };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */