sc/source/filter/oox/commentsbuffer.cxx

   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 #include <oox/token/properties.hxx>
  21 #include <oox/token/tokens.hxx>
  22
  23 #include <commentsbuffer.hxx>
  24
  25 #include <com/sun/star/beans/XPropertySet.hpp>
  26 #include <com/sun/star/beans/XMultiPropertySet.hpp>
  27 #include <com/sun/star/sheet/XSheetAnnotationAnchor.hpp>
  28 #include <com/sun/star/sheet/XSheetAnnotationShapeSupplier.hpp>
  29 #include <com/sun/star/sheet/XSheetAnnotations.hpp>
  30 #include <com/sun/star/sheet/XSheetAnnotationsSupplier.hpp>
  31 #include <com/sun/star/text/XText.hpp>
  32 #include <osl/diagnose.h>
  33 #include <oox/helper/attributelist.hxx>
  34 #include <oox/vml/vmlshape.hxx>
  35 #include <addressconverter.hxx>
  36 #include <drawingfragment.hxx>
  37 #include <svx/sdtaitm.hxx>
  38 #include <svx/svdocapt.hxx>
  39 #include <svx/unoshape.hxx>
  40 #include <tools/diagnose_ex.h>
  41 #include <document.hxx>
  42 #include <drwlayer.hxx>
  43 #include <cellsuno.hxx>
  44 #include <docfunc.hxx>
  45 #include <docuno.hxx>
  46 #include <docsh.hxx>
  47 #include <postit.hxx>
  48
  49 namespace oox {
  50 namespace xls {
  51
  52 using namespace ::com::sun::star::drawing;
  53 using namespace ::com::sun::star::sheet;
  54 using namespace ::com::sun::star::table;
  55 using namespace ::com::sun::star::text;
  56 using namespace ::com::sun::star::uno;
  57
  58 static sal_Int32 lcl_ToHorizAlign( sal_Int32 nAlign )
  59 {
  60     switch( nAlign )
  61     {
  62         case XML_left:
  63             return SDRTEXTHORZADJUST_LEFT;
  64         case XML_right:
  65             return SDRTEXTHORZADJUST_RIGHT;
  66         case XML_center:
  67             return SDRTEXTHORZADJUST_CENTER;
  68         default:
  69             return SDRTEXTHORZADJUST_BLOCK;
  70     }
  71 }
  72
  73 static sal_Int32 lcl_ToVertAlign( sal_Int32 nAlign )
  74 {
  75     switch( nAlign )
  76     {
  77         case XML_top:
  78         case XML_Top:
  79             return SDRTEXTVERTADJUST_TOP;
  80         case XML_center:
  81         case XML_Center:
  82             return SDRTEXTVERTADJUST_CENTER;
  83         case XML_bottom:
  84         case XML_Bottom:
  85             return SDRTEXTVERTADJUST_BOTTOM;
  86         default:
  87             return SDRTEXTVERTADJUST_BLOCK;
  88     }
  89 }
  90
  91 static sal_Int16 lcl_ToParaAlign(sal_Int32 nAlign)
  92 {
  93     switch ( nAlign )
  94     {
  95         case XML_Left:
  96             return sal_Int16(css::style::ParagraphAdjust_LEFT);
  97         case XML_Right:
  98             return sal_Int16(css::style::ParagraphAdjust_RIGHT);
  99         case XML_Center:
 100             return sal_Int16(css::style::ParagraphAdjust_CENTER);
 101         default:
 102             return sal_Int16(css::style::ParagraphAdjust_BLOCK);
 103     }
 104 }
 105
 106 CommentModel::CommentModel()
 107     : mnAuthorId(-1)
 108     , mbAutoFill(false)
 109     , mbAutoScale(false)
 110     , mbColHidden(false)
 111     , mbLocked(false)
 112     , mbRowHidden(false)
 113     , mnTHA(0)
 114     , mnTVA(0)
 115 {
 116 }
 117
 118 Comment::Comment( const WorksheetHelper& rHelper ) :
 119     WorksheetHelper( rHelper )
 120 {
 121 }
 122
 123 void Comment::importComment( const AttributeList& rAttribs )
 124 {
 125     maModel.mnAuthorId = rAttribs.getInteger( XML_authorId, -1 );
 126     // cell range will be checked while inserting the comment into the document
 127     AddressConverter::convertToCellRangeUnchecked( maModel.maRange, rAttribs.getString( XML_ref, OUString() ), getSheetIndex() );
 128 }
 129
 130 void Comment::importCommentPr( const AttributeList& rAttribs )
 131 {
 132     maModel.mbAutoFill  = rAttribs.getBool( XML_autoFill, true );
 133     maModel.mbAutoScale = rAttribs.getBool( XML_autoScale, false );
 134     maModel.mbColHidden = rAttribs.getBool( XML_colHidden, false );
 135     maModel.mbLocked    = rAttribs.getBool( XML_locked, false );
 136     maModel.mbRowHidden = rAttribs.getBool( XML_rowHidden, false );
 137     maModel.mnTHA       = rAttribs.getToken( XML_textHAlign, XML_left );
 138     maModel.mnTVA       = rAttribs.getToken( XML_textVAlign, XML_top );
 139 }
 140
 141 void Comment::importComment( SequenceInputStream& rStrm )
 142 {
 143     BinRange aBinRange;
 144     maModel.mnAuthorId = rStrm.readInt32();
 145     rStrm >> aBinRange;
 146     // cell range will be checked while inserting the comment into the document
 147     AddressConverter::convertToCellRangeUnchecked( maModel.maRange, aBinRange, getSheetIndex() );
 148 }
 149
 150 RichStringRef const & Comment::createText()
 151 {
 152     maModel.mxText.reset( new RichString( *this ) );
 153     return maModel.mxText;
 154 }
 155
 156 void Comment::finalizeImport()
 157 {
 158     // BIFF12 stores cell range instead of cell address, use first cell of this range
 159     OSL_ENSURE( maModel.maRange.aStart == maModel.maRange.aEnd,
 160         "Comment::finalizeImport - comment anchor should be a single cell" );
 161     if( !getAddressConverter().checkCellAddress( maModel.maRange.aStart, true ) || !maModel.mxText.get() )
 162         return;
 163
 164     try
 165     {
 166         ScTableSheetObj* pAnnosSupp = static_cast<ScTableSheetObj*>(getSheet().get());
 167         rtl::Reference<ScAnnotationsObj> xAnnos = static_cast<ScAnnotationsObj*>(pAnnosSupp->getAnnotations().get());
 168         ScDocShell* pDocShell = xAnnos->GetDocShell();
 169         // non-empty string required by note implementation (real text will be added below)
 170         ScPostIt* pPostIt = pDocShell->GetDocFunc().ImportNote( maModel.maRange.aStart, OUString( ' ' ), nullptr, nullptr );
 171         SdrCaptionObj* pCaption = pPostIt->GetOrCreateCaption( maModel.maRange.aStart );
 172
 173         Reference< XShape > xAnnoShape( pCaption->getUnoShape(), UNO_QUERY_THROW ); // SvxShapeText
 174         // setting a property triggers expensive process, so set them all at once
 175         Reference< css::beans::XMultiPropertySet > xAnnoShapeMultiPropSet(xAnnoShape, UNO_QUERY_THROW);
 176
 177         // Add shape formatting properties (autoFill, colHidden and rowHidden are dropped)
 178         xAnnoShapeMultiPropSet->setPropertyValues(
 179             Sequence<OUString> { "TextFitToSize", "MoveProtect", "TextHorizontalAdjust", "TextVerticalAdjust" },
 180             Sequence<Any> { Any(maModel.mbAutoScale), Any(maModel.mbLocked),
 181                 Any(lcl_ToHorizAlign( maModel.mnTHA )), Any(lcl_ToVertAlign( maModel.mnTVA )) });
 182         if( maModel.maAnchor.Width > 0 && maModel.maAnchor.Height > 0 )
 183         {
 184             xAnnoShape->setPosition( css::awt::Point( maModel.maAnchor.X, maModel.maAnchor.Y ) );
 185             xAnnoShape->setSize( css::awt::Size( maModel.maAnchor.Width, maModel.maAnchor.Height ) );
 186         }
 187
 188         // convert shape formatting and visibility
 189         bool bVisible = true;
 190         if( const ::oox::vml::ShapeBase* pVmlNoteShape = getVmlDrawing().getNoteShape( maModel.maRange.aStart ) )
 191         {
 192             // position and formatting
 193             pVmlNoteShape->convertFormatting( xAnnoShape );
 194             // visibility
 195             bVisible = pVmlNoteShape->getTypeModel().mbVisible;
 196
 197             // Setting comment text alignment
 198             const ::oox::vml::ClientData* xClientData = pVmlNoteShape->getClientData();
 199             xAnnoShapeMultiPropSet->setPropertyValues(
 200                 Sequence<OUString> { "TextVerticalAdjust", "ParaAdjust" },
 201                 Sequence<Any> { Any(lcl_ToVertAlign( xClientData->mnTextVAlign )), Any(lcl_ToParaAlign( xClientData->mnTextHAlign )) });
 202         }
 203         if (bVisible)
 204             pDocShell->GetDocFunc().ShowNote( maModel.maRange.aStart, bVisible );
 205
 206         // insert text and convert text formatting
 207         maModel.mxText->finalizeImport();
 208         Reference< XText > xAnnoText( xAnnoShape, UNO_QUERY_THROW );
 209         maModel.mxText->convert( xAnnoText );
 210     }
 211     catch( Exception& )
 212     {
 213         DBG_UNHANDLED_EXCEPTION("sc");
 214     }
 215 }
 216
 217 // private --------------------------------------------------------------------
 218
 219 CommentsBuffer::CommentsBuffer( const WorksheetHelper& rHelper ) :
 220     WorksheetHelper( rHelper )
 221 {
 222 }
 223
 224 void CommentsBuffer::appendAuthor( const OUString& rAuthor )
 225 {
 226     maAuthors.push_back( rAuthor );
 227 }
 228
 229 CommentRef CommentsBuffer::createComment()
 230 {
 231     CommentRef xComment( new Comment( *this ) );
 232     maComments.push_back( xComment );
 233     return xComment;
 234 }
 235
 236 void CommentsBuffer::finalizeImport()
 237 {
 238     // keep the model locked to avoid repeated reformatting in the model
 239     auto pModel = getScDocument().GetDrawLayer();
 240     bool bWasLocked = pModel->isLocked();
 241     pModel->setLock(true);
 242     maComments.forEachMem( &Comment::finalizeImport );
 243     pModel->setLock(bWasLocked);
 244 }
 245
 246 } // namespace xls
 247 } // namespace oox
 248
 249 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */