1
0
Fork 0
libreoffice/sw/source/uibase/uiview/formatclipboard.cxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

624 lines
22 KiB
C++

/* -*- 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 .
*/
#include <memory>
#include <utility>
#include <formatclipboard.hxx>
#include <cmdid.h>
#include <cellatr.hxx>
#include <charfmt.hxx>
#include <frmfmt.hxx>
#include <docstyle.hxx>
#include <fchrfmt.hxx>
#include <svx/svdview.hxx>
#include <editeng/brushitem.hxx>
#include <editeng/shaditem.hxx>
#include <editeng/boxitem.hxx>
#include <editeng/formatbreakitem.hxx>
#include <fmtlsplt.hxx>
#include <editeng/keepitem.hxx>
#include <editeng/frmdiritem.hxx>
#include <fmtpdsc.hxx>
#include <fmtrowsplt.hxx>
#include <frmatr.hxx>
namespace
{
std::unique_ptr<SfxItemSet> lcl_CreateEmptyItemSet( SelectionType nSelectionType, SfxItemPool& rPool, bool bNoParagraphFormats = false )
{
std::unique_ptr<SfxItemSet> pItemSet;
if( nSelectionType & (SelectionType::Frame | SelectionType::Ole | SelectionType::Graphic) )
{
pItemSet = std::make_unique<SfxItemSetFixed<
RES_FRMATR_BEGIN, RES_FILL_ORDER,
// no RES_FRM_SIZE
RES_PAPER_BIN, RES_SURROUND,
// no RES_VERT_ORIENT
// no RES_HORI_ORIENT
// no RES_ANCHOR
RES_BACKGROUND, RES_SHADOW,
// no RES_FRMMACRO
RES_COL, RES_KEEP,
// no RES_URL
RES_EDIT_IN_READONLY, RES_LAYOUT_SPLIT,
// no RES_CHAIN
RES_TEXTGRID, RES_FRMATR_END - 1>>(rPool);
}
else if( nSelectionType & SelectionType::DrawObject )
{
//is handled different
}
else if( nSelectionType & SelectionType::Text )
{
if( bNoParagraphFormats )
pItemSet = std::make_unique<SfxItemSetFixed
<RES_CHRATR_BEGIN, RES_CHRATR_END - 1>>(rPool);
else
pItemSet = std::make_unique<SfxItemSetFixed<
RES_CHRATR_BEGIN, RES_CHRATR_END - 1,
RES_PARATR_BEGIN, RES_FILL_ORDER,
// no RES_FRM_SIZE
RES_PAPER_BIN, RES_SURROUND,
// no RES_VERT_ORIENT
// no RES_HORI_ORIENT
// no RES_ANCHOR
RES_BACKGROUND, RES_SHADOW,
// no RES_FRMMACRO
RES_COL, RES_KEEP,
// no RES_URL
RES_EDIT_IN_READONLY, RES_LAYOUT_SPLIT,
// no RES_CHAIN
RES_TEXTGRID, RES_FRMATR_END - 1>>(rPool);
}
return pItemSet;
}
void lcl_getTableAttributes( SfxItemSet& rSet, SwWrtShell &rSh, bool bAllCellAttrs )
{
if (bAllCellAttrs)
{
std::unique_ptr<SvxBrushItem> aBrush(std::make_unique<SvxBrushItem>(RES_BACKGROUND));
rSh.GetBoxBackground(aBrush);
rSet.Put( *aBrush );
if(rSh.GetRowBackground(aBrush))
{
aBrush->SetWhich(SID_ATTR_BRUSH_ROW);
rSet.Put( *aBrush );
}
else
rSet.InvalidateItem(SID_ATTR_BRUSH_ROW);
rSh.GetTabBackground(aBrush);
aBrush->SetWhich(SID_ATTR_BRUSH_TABLE);
rSet.Put( *aBrush );
SvxBoxInfoItem aBoxInfo( SID_ATTR_BORDER_INNER );
rSet.Put(aBoxInfo);
rSh.GetTabBorders( rSet );
std::unique_ptr<SvxFrameDirectionItem> aBoxDirection(std::make_unique<SvxFrameDirectionItem>(SvxFrameDirection::Environment, RES_FRAMEDIR));
if(rSh.GetBoxDirection( aBoxDirection ))
{
aBoxDirection->SetWhich(FN_TABLE_BOX_TEXTORIENTATION);
rSet.Put(std::move(aBoxDirection));
}
rSet.Put(SfxUInt16Item(FN_TABLE_SET_VERT_ALIGN, rSh.GetBoxAlign()));
rSet.Put( SfxUInt16Item( FN_PARAM_TABLE_HEADLINE, rSh.GetRowsToRepeat() ) );
SwFrameFormat *pFrameFormat = rSh.GetTableFormat();
if(pFrameFormat)
{
rSet.Put( pFrameFormat->GetShadow() );
rSet.Put( pFrameFormat->GetBreak() );
rSet.Put( pFrameFormat->GetPageDesc() );
rSet.Put( pFrameFormat->GetLayoutSplit() );
rSet.Put( pFrameFormat->GetKeep() );
rSet.Put( pFrameFormat->GetFrameDir() );
}
std::unique_ptr<SwFormatRowSplit> pSplit = rSh.GetRowSplit();
if(pSplit)
rSet.Put(std::move(pSplit));
}
SfxItemSetFixed<RES_BOXATR_FORMAT, RES_BOXATR_FORMAT, RES_BOXATR_VALUE, RES_BOXATR_VALUE>
aBoxSet(*rSet.GetPool());
rSh.GetTableBoxFormulaAttrs(aBoxSet);
rSet.Put(aBoxSet);
}
void lcl_setTableAttributes( const SfxItemSet& rSet, SwWrtShell &rSh )
{
bool bBorder = ( SfxItemState::SET == rSet.GetItemState( RES_BOX ) ||
SfxItemState::SET == rSet.GetItemState( SID_ATTR_BORDER_INNER ) );
const SvxBrushItem* pBackgroundItem = rSet.GetItemIfSet( RES_BACKGROUND, false );
const SvxBrushItem* pRowItem = rSet.GetItemIfSet( SID_ATTR_BRUSH_ROW, false );
const SvxBrushItem* pTableItem = rSet.GetItemIfSet( SID_ATTR_BRUSH_TABLE, false );
bool bBackground = pBackgroundItem || pRowItem || pTableItem;
if(bBackground)
{
if(pBackgroundItem)
rSh.SetBoxBackground( *pBackgroundItem );
if(pRowItem)
{
std::unique_ptr<SvxBrushItem> aBrush(pRowItem->Clone());
aBrush->SetWhich(RES_BACKGROUND);
rSh.SetRowBackground(*aBrush);
}
if(pTableItem)
{
std::unique_ptr<SvxBrushItem> aBrush(pTableItem->Clone());
aBrush->SetWhich(RES_BACKGROUND);
rSh.SetTabBackground(*aBrush);
}
}
if(bBorder)
rSh.SetTabBorders( rSet );
if( const SfxUInt16Item* pHeadlineItem = rSet.GetItemIfSet( FN_PARAM_TABLE_HEADLINE, false) )
rSh.SetRowsToRepeat( pHeadlineItem->GetValue() );
SwFrameFormat* pFrameFormat = rSh.GetTableFormat();
if(pFrameFormat)
{
//RES_SHADOW
const SfxPoolItem* pItem = rSet.GetItemIfSet(rSet.GetPool()->GetWhichIDFromSlotID(RES_SHADOW), false);
if(pItem)
pFrameFormat->SetFormatAttr( *pItem );
//RES_BREAK
pItem = rSet.GetItemIfSet(rSet.GetPool()->GetWhichIDFromSlotID(RES_BREAK), false);
if(pItem)
pFrameFormat->SetFormatAttr( *pItem );
//RES_PAGEDESC
pItem = rSet.GetItemIfSet(rSet.GetPool()->GetWhichIDFromSlotID(RES_PAGEDESC), false);
if(pItem)
pFrameFormat->SetFormatAttr( *pItem );
//RES_LAYOUT_SPLIT
pItem = rSet.GetItemIfSet(rSet.GetPool()->GetWhichIDFromSlotID(RES_LAYOUT_SPLIT), false);
if(pItem)
pFrameFormat->SetFormatAttr( *pItem );
//RES_KEEP
pItem = rSet.GetItemIfSet(rSet.GetPool()->GetWhichIDFromSlotID(RES_KEEP), false);
if(pItem)
pFrameFormat->SetFormatAttr( *pItem );
//RES_FRAMEDIR
pItem = rSet.GetItemIfSet(rSet.GetPool()->GetWhichIDFromSlotID(RES_FRAMEDIR), false);
if(pItem)
pFrameFormat->SetFormatAttr( *pItem );
}
if( const SvxFrameDirectionItem* pTextOriItem = rSet.GetItemIfSet( FN_TABLE_BOX_TEXTORIENTATION, false ) )
{
SvxFrameDirectionItem aDirection( SvxFrameDirection::Environment, RES_FRAMEDIR );
aDirection.SetValue(pTextOriItem->GetValue());
rSh.SetBoxDirection(aDirection);
}
if( const SfxUInt16Item* pVertAlignItem = rSet.GetItemIfSet( FN_TABLE_SET_VERT_ALIGN, false ))
rSh.SetBoxAlign(pVertAlignItem->GetValue());
if( const SwFormatRowSplit* pSplitItem = rSet.GetItemIfSet( RES_ROW_SPLIT, false ) )
rSh.SetRowSplit(*pSplitItem);
if (rSet.GetItemIfSet( RES_BOXATR_FORMAT, false ))
rSh.SetTableBoxFormulaAttrs(rSet);
}
}//end anonymous namespace
SwFormatClipboard::SwFormatClipboard()
: m_nSelectionType(SelectionType::NONE)
, m_bPersistentCopy(false)
{
}
bool SwFormatClipboard::HasContent() const
{
return m_pItemSet_TextAttr!=nullptr
|| m_pItemSet_ParAttr!=nullptr
|| m_pTableItemSet != nullptr
|| !m_aCharStyle.isEmpty()
|| !m_aParaStyle.isEmpty()
;
}
bool SwFormatClipboard::HasContentForThisType( SelectionType nSelectionType ) const
{
if( !HasContent() )
return false;
if( m_nSelectionType == nSelectionType )
return true;
if( ( nSelectionType & (SelectionType::Frame | SelectionType::Ole | SelectionType::Graphic) )
&&
( m_nSelectionType & (SelectionType::Frame | SelectionType::Ole | SelectionType::Graphic) )
)
return true;
if( nSelectionType & SelectionType::Text && m_nSelectionType & SelectionType::Text )
return true;
return false;
}
bool SwFormatClipboard::CanCopyThisType( SelectionType nSelectionType )
{
return bool(nSelectionType
& (SelectionType::Frame | SelectionType::Ole | SelectionType::Graphic
| SelectionType::Text | SelectionType::DrawObject | SelectionType::Table | SelectionType::TableCell ));
}
void SwFormatClipboard::Copy( SwWrtShell& rWrtShell, SfxItemPool& rPool, bool bPersistentCopy )
{
// first clear the previously stored attributes
Erase();
m_bPersistentCopy = bPersistentCopy;
SelectionType nSelectionType = rWrtShell.GetSelectionType();
auto pItemSet_TextAttr = lcl_CreateEmptyItemSet( nSelectionType, rPool, true );
auto pItemSet_ParAttr = lcl_CreateEmptyItemSet( nSelectionType, rPool );
rWrtShell.StartAction();
rWrtShell.Push();
// modify the "Point and Mark" of the cursor
// in order to select only the last character of the
// selection(s) and then to get the attributes of this single character
if( nSelectionType == SelectionType::Text )
{
// get the current PaM, the cursor
// if there several selection it currently point
// on the last (sort by there creation time) selection
SwPaM* pCursor = rWrtShell.GetCursor();
bool bHasSelection = pCursor->HasMark();
bool bForwardSelection = false;
if(!bHasSelection && pCursor->IsMultiSelection())
{
// if cursor has multiple selections
// clear all the selections except the last
rWrtShell.KillPams();
// reset the cursor to the remaining selection
pCursor = rWrtShell.GetCursor();
bHasSelection = true;
}
bool dontMove = false;
if (bHasSelection)
{
bForwardSelection = (*pCursor->GetPoint()) > (*pCursor->GetMark());
// clear the selection leaving just the cursor
pCursor->DeleteMark();
pCursor->SetMark();
}
else
{
bool rightToLeft = rWrtShell.IsInRightToLeftText();
// if there were no selection (only a cursor) and the cursor was at
// the end of the paragraph then don't move
if ( rWrtShell.IsEndPara() && !rightToLeft )
dontMove = true;
// revert left and right
if ( rightToLeft )
{
if (pCursor->GetPoint()->GetContentIndex() == 0)
dontMove = true;
else
bForwardSelection = !bForwardSelection;
}
}
// move the cursor in order to select one character
if (!dontMove)
pCursor->Move( bForwardSelection ? fnMoveBackward : fnMoveForward );
}
if(pItemSet_TextAttr)
{
if( nSelectionType & (SelectionType::Frame | SelectionType::Ole | SelectionType::Graphic) )
rWrtShell.GetFlyFrameAttr(*pItemSet_TextAttr);
else
{
// get the text attributes from named and automatic formatting
rWrtShell.GetCurAttr(*pItemSet_TextAttr);
if( nSelectionType & SelectionType::Text )
{
// get the paragraph attributes (could be character properties)
// from named and automatic formatting
rWrtShell.GetCurParAttr(*pItemSet_ParAttr);
}
}
}
else if ( nSelectionType & SelectionType::DrawObject )
{
SdrView* pDrawView = rWrtShell.GetDrawView();
if(pDrawView)
{
if( pDrawView->GetMarkedObjectList().GetMarkCount() != 0 )
{
pItemSet_TextAttr = std::make_unique<SfxItemSet>( pDrawView->GetAttrFromMarked(true/*bOnlyHardAttr*/) );
//remove attributes defining the type/data of custom shapes
pItemSet_TextAttr->ClearItem(SDRATTR_CUSTOMSHAPE_ENGINE);
pItemSet_TextAttr->ClearItem(SDRATTR_CUSTOMSHAPE_DATA);
pItemSet_TextAttr->ClearItem(SDRATTR_CUSTOMSHAPE_GEOMETRY);
}
}
}
if(nSelectionType & (SelectionType::Table | SelectionType::TableCell))
{
if (nSelectionType & SelectionType::TableCell)
{
//only copy all table attributes if really cells are selected (not only text in tables)
m_pTableItemSet = std::make_unique<SfxItemSetFixed<
RES_PAGEDESC, RES_BREAK,
RES_BACKGROUND, RES_SHADOW, // RES_BOX is inbetween
RES_KEEP, RES_KEEP,
RES_LAYOUT_SPLIT, RES_LAYOUT_SPLIT,
RES_FRAMEDIR, RES_FRAMEDIR,
RES_ROW_SPLIT, RES_ROW_SPLIT,
RES_BOXATR_FORMAT, RES_BOXATR_FORMAT,
SID_ATTR_BORDER_INNER, SID_ATTR_BORDER_SHADOW,
// SID_ATTR_BORDER_OUTER is inbetween
SID_ATTR_BRUSH_ROW, SID_ATTR_BRUSH_TABLE,
FN_TABLE_SET_VERT_ALIGN, FN_TABLE_SET_VERT_ALIGN,
FN_TABLE_BOX_TEXTORIENTATION, FN_TABLE_BOX_TEXTORIENTATION,
FN_PARAM_TABLE_HEADLINE, FN_PARAM_TABLE_HEADLINE>>(rPool);
}
else
{
//selection in table should copy number format
m_pTableItemSet = std::make_unique<SfxItemSetFixed<
RES_BOXATR_FORMAT, RES_BOXATR_FORMAT>>(rPool);
}
lcl_getTableAttributes( *m_pTableItemSet, rWrtShell, nSelectionType & SelectionType::TableCell ? true : false);
}
m_nSelectionType = nSelectionType;
m_pItemSet_TextAttr = std::move(pItemSet_TextAttr);
m_pItemSet_ParAttr = std::move(pItemSet_ParAttr);
if( nSelectionType & SelectionType::Text )
{
// if text is selected save the named character format
SwFormat* pFormat = rWrtShell.GetCurCharFormat();
if( pFormat )
m_aCharStyle = pFormat->GetName();
// and the named paragraph format
pFormat = rWrtShell.GetCurTextFormatColl();
if( pFormat )
m_aParaStyle = pFormat->GetName();
}
rWrtShell.Pop(SwCursorShell::PopMode::DeleteCurrent);
rWrtShell.EndAction();
}
typedef std::vector< std::unique_ptr< SfxPoolItem > > ItemVector;
// collect all PoolItems from the applied styles
static void lcl_AppendSetItems( ItemVector& rItemVector, const SfxItemSet& rStyleAttrSet )
{
const WhichRangesContainer& pRanges = rStyleAttrSet.GetRanges();
for(const auto & rPair : pRanges)
{
for ( sal_uInt16 nWhich = rPair.first; nWhich <= rPair.second; ++nWhich )
{
const SfxPoolItem* pItem;
if( SfxItemState::SET == rStyleAttrSet.GetItemState( nWhich, false, &pItem ) )
{
rItemVector.emplace_back( pItem->Clone() );
}
}
}
}
// remove all items that are inherited from the styles
static void lcl_RemoveEqualItems( SfxItemSet& rTemplateItemSet, const ItemVector& rItemVector )
{
for( const auto& rItem : rItemVector )
{
const SfxPoolItem* pItem;
if( SfxItemState::SET == rTemplateItemSet.GetItemState( rItem->Which(), true, &pItem ) &&
*pItem == *rItem )
{
rTemplateItemSet.ClearItem( rItem->Which() );
}
}
}
void SwFormatClipboard::Paste( SwWrtShell& rWrtShell, SfxStyleSheetBasePool* pPool
, bool bNoCharacterFormats, bool bNoParagraphFormats )
{
SelectionType nSelectionType = rWrtShell.GetSelectionType();
if( !HasContentForThisType(nSelectionType) )
{
if(!m_bPersistentCopy)
Erase();
return;
}
rWrtShell.StartAction();
rWrtShell.StartUndo(SwUndoId::INSATTR);
ItemVector aItemVector;
if (m_pItemSet_TextAttr && !( nSelectionType & SelectionType::DrawObject))
{
// reset all direct formatting before applying anything
o3tl::sorted_vector<sal_uInt16> aAttrs;
for (sal_uInt16 nWhich = RES_CHRATR_BEGIN; nWhich < RES_CHRATR_END; nWhich++)
aAttrs.insert(nWhich);
rWrtShell.ResetAttr({ aAttrs });
}
if( nSelectionType & SelectionType::Text )
{
// apply the named text and paragraph formatting
if( pPool )
{
// if there is a named text format recorded and the user wants to apply it
if(!m_aCharStyle.isEmpty() && !bNoCharacterFormats )
{
// look for the named text format in the pool
SwDocStyleSheet* pStyle = static_cast<SwDocStyleSheet*>(pPool->Find(m_aCharStyle, SfxStyleFamily::Char));
// if the style is found
if( pStyle )
{
SwFormatCharFormat aFormat(pStyle->GetCharFormat());
// store the attributes from this style in aItemVector in order
// not to apply them as automatic formatting attributes later in the code
lcl_AppendSetItems( aItemVector, aFormat.GetCharFormat()->GetAttrSet());
// apply the named format
rWrtShell.SetAttrItem( aFormat );
}
}
if (!bNoParagraphFormats)
{
const SwNumRule* pNumRule
= rWrtShell.GetNumRuleAtCurrCursorPos();
if (pNumRule && !pNumRule->IsOutlineRule())
{
rWrtShell.NumOrBulletOff();
}
// if there is a named paragraph format recorded and the user wants to apply it
if(!m_aParaStyle.isEmpty())
{
// look for the named paragraph format in the pool
SwDocStyleSheet* pStyle = static_cast<SwDocStyleSheet*>(pPool->Find(m_aParaStyle, SfxStyleFamily::Para));
if( pStyle )
{
// store the attributes from this style in aItemVector in order
// not to apply them as automatic formatting attributes later in the code
lcl_AppendSetItems( aItemVector, pStyle->GetCollection()->GetAttrSet());
// apply the named format
rWrtShell.SetTextFormatColl( pStyle->GetCollection() );
}
}
}
}
// apply the paragraph automatic attributes
if ( m_pItemSet_ParAttr && m_pItemSet_ParAttr->Count() != 0 && !bNoParagraphFormats )
{
// temporary SfxItemSet
std::unique_ptr<SfxItemSet> pTemplateItemSet(lcl_CreateEmptyItemSet(
nSelectionType, *m_pItemSet_ParAttr->GetPool()));
// no need to verify the existence of pTemplateItemSet as we
// know that here the selection type is SEL_TXT
pTemplateItemSet->Put( *m_pItemSet_ParAttr );
// remove attribute that were applied by named text and paragraph formatting
lcl_RemoveEqualItems( *pTemplateItemSet, aItemVector );
// apply the paragraph automatic attributes to all the nodes in the selection
rWrtShell.SetAttrSet(*pTemplateItemSet);
// store the attributes in aItemVector in order not to apply them as
// text automatic formatting attributes later in the code
lcl_AppendSetItems( aItemVector, *pTemplateItemSet);
}
}
if(m_pItemSet_TextAttr)
{
if( nSelectionType & SelectionType::DrawObject )
{
SdrView* pDrawView = rWrtShell.GetDrawView();
if(pDrawView)
{
pDrawView->SetAttrToMarked(*m_pItemSet_TextAttr, true/*bReplaceAll*/);
}
}
else
{
// temporary SfxItemSet
std::unique_ptr<SfxItemSet> pTemplateItemSet(lcl_CreateEmptyItemSet(
nSelectionType, *m_pItemSet_TextAttr->GetPool(), true ));
if(pTemplateItemSet)
{
// copy the stored automatic text attributes in a temporary SfxItemSet
pTemplateItemSet->Put( *m_pItemSet_TextAttr );
// only attributes that were not apply by named style attributes and automatic
// paragraph attributes should be applied
lcl_RemoveEqualItems( *pTemplateItemSet, aItemVector );
// apply the character automatic attributes
if( nSelectionType & (SelectionType::Frame | SelectionType::Ole | SelectionType::Graphic) )
rWrtShell.SetFlyFrameAttr(*pTemplateItemSet);
else if ( !bNoCharacterFormats )
{
rWrtShell.SetAttrSet(*pTemplateItemSet);
}
}
}
}
if( m_pTableItemSet && nSelectionType & (SelectionType::Table | SelectionType::TableCell) )
lcl_setTableAttributes( *m_pTableItemSet, rWrtShell );
rWrtShell.EndUndo(SwUndoId::INSATTR);
rWrtShell.EndAction();
if(!m_bPersistentCopy)
Erase();
}
void SwFormatClipboard::Erase()
{
m_nSelectionType = SelectionType::NONE;
m_pItemSet_TextAttr.reset();
m_pItemSet_ParAttr.reset();
m_pTableItemSet.reset();
if( !m_aCharStyle.isEmpty() )
m_aCharStyle.clear();
if( !m_aParaStyle.isEmpty() )
m_aParaStyle.clear();
m_bPersistentCopy = false;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */