sw/source/ui/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 _SWFORMATCLIPBOARD_HXX
  21 #define _SWFORMATCLIPBOARD_HXX
  22
  23 // header for class SwWrtShell
  24 #include <wrtsh.hxx>
  25 // header for class SfxItemSet
  26 #include <svl/itemset.hxx>
  27 // header for class SfxStyleSheetBasePool
  28 #include <svl/style.hxx>
  29
  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     ~SwFormatClipboard();
  39
  40     /**
  41      * Test if the object contains text or paragraph attribute
  42      */
  43     bool HasContent() const;
  44     bool HasContentForThisType( int nSelectionType ) const;
  45     bool CanCopyThisType( int nSelectionType ) const;
  46
  47     /**
  48      * Store/Backup the text and paragraph attribute of the current selection.
  49      *
  50      * @param bPersistentCopy
  51      * input parameter - specify if the Paste function will erase the current object.
  52      */
  53     void Copy( SwWrtShell& rWrtShell, SfxItemPool& rPool, bool bPersistentCopy=false );
  54
  55     /**
  56      * Paste the stored text and paragraph attributes on the current selection and current paragraph.
  57      *
  58      * @param bNoCharacterFormats
  59      * Do not paste the character formats.
  60      *
  61      * @param bNoParagraphFormats
  62      * Do not paste the paragraph formats.
  63      */
  64     void Paste( SwWrtShell& rWrtShell, SfxStyleSheetBasePool* pPool
  65         , bool bNoCharacterFormats=false, bool bNoParagraphFormats=false );
  66
  67     /**
  68      * Clear the currently stored text and paragraph attributes.
  69      */
  70     void Erase();
  71
  72 private:
  73     int         m_nSelectionType;
  74
  75     /** automatic/named character attribute set */
  76     SfxItemSet* m_pItemSet_TxtAttr;
  77     /** automatic/named paragraph attribute set
  78      * (it can be caractere attribute applyied to the paragraph) */
  79     SfxItemSet* m_pItemSet_ParAttr;
  80
  81     /** table attribute set */
  82     SfxItemSet* m_pTableItemSet;
  83
  84     /** name of the character format (if it exist) */
  85     String m_aCharStyle;
  86     /** name of the paragraph format (if it exist) */
  87     String m_aParaStyle;
  88     //no frame style because it contains position information
  89
  90     /** specify if the Paste function have to clear the current object */
  91     bool   m_bPersistentCopy;
  92 };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */