office-gobmx/oox/source/xls/commentsbuffer.cxx
2010-11-28 18:35:13 +01:00

276 lines
9.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#include "oox/xls/commentsbuffer.hxx"
#include <com/sun/star/sheet/XSheetAnnotationAnchor.hpp>
#include <com/sun/star/sheet/XSheetAnnotationShapeSupplier.hpp>
#include <com/sun/star/sheet/XSheetAnnotations.hpp>
#include <com/sun/star/sheet/XSheetAnnotationsSupplier.hpp>
#include "oox/helper/attributelist.hxx"
#include "oox/helper/recordinputstream.hxx"
#include "oox/vml/vmlshape.hxx"
#include "oox/xls/addressconverter.hxx"
#include "oox/xls/drawingfragment.hxx"
#include "properties.hxx"
#include "svx/sdtaitm.hxx"
#include "oox/xls/unitconverter.hxx"
#include <com/sun/star/text/XText.hpp>
#include <com/sun/star/text/XTextRange.hpp>
using ::rtl::OUString;
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::uno::UNO_SET_THROW;
using ::com::sun::star::drawing::XShape;
using ::com::sun::star::table::CellAddress;
using ::com::sun::star::sheet::XSheetAnnotation;
using ::com::sun::star::sheet::XSheetAnnotationAnchor;
using ::com::sun::star::sheet::XSheetAnnotationShapeSupplier;
using ::com::sun::star::sheet::XSheetAnnotations;
using ::com::sun::star::sheet::XSheetAnnotationsSupplier;
using ::com::sun::star::text::XText;
using ::com::sun::star::text::XTextRange;
using ::com::sun::star::awt::Size;
using ::com::sun::star::awt::Point;
static sal_Int32 lcl_ToHorizAlign( sal_Int32 nAlign )
{
switch( nAlign )
{
case XML_left:
return SDRTEXTHORZADJUST_LEFT;
case XML_right:
return SDRTEXTHORZADJUST_RIGHT;
case XML_center:
return SDRTEXTHORZADJUST_CENTER;
default:
return SDRTEXTHORZADJUST_BLOCK;
}
return SDRTEXTHORZADJUST_LEFT;
}
static sal_Int32 lcl_ToVertAlign( sal_Int32 nAlign )
{
switch( nAlign )
{
case XML_top:
return SDRTEXTVERTADJUST_TOP;
case XML_center:
return SDRTEXTVERTADJUST_CENTER;
case XML_bottom:
return SDRTEXTVERTADJUST_BOTTOM;
default:
return SDRTEXTVERTADJUST_BLOCK;
}
return SDRTEXTVERTADJUST_TOP;
}
namespace oox {
namespace xls {
// ============================================================================
CommentModel::CommentModel() :
mnAuthorId( -1 )
{
}
// ----------------------------------------------------------------------------
Comment::Comment( const WorksheetHelper& rHelper ) :
WorksheetHelper( rHelper )
{
}
void Comment::importComment( const AttributeList& rAttribs )
{
maModel.mnAuthorId = rAttribs.getInteger( XML_authorId, -1 );
// cell range will be checked while inserting the comment into the document
getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, rAttribs.getString( XML_ref, OUString() ), getSheetIndex() );
}
void Comment::importCommentPr( const AttributeList& rAttribs )
{
maModel.mbAutoFill = rAttribs.getBool( XML_autoFill, true );
maModel.mbAutoScale = rAttribs.getBool( XML_autoScale, false );
maModel.mbColHidden = rAttribs.getBool( XML_colHidden, false );
maModel.mbLocked = rAttribs.getBool( XML_locked, false );
maModel.mbRowHidden = rAttribs.getBool( XML_rowHidden, false );
maModel.mnTHA = rAttribs.getToken( XML_textHAlign, XML_left );
maModel.mnTVA = rAttribs.getToken( XML_textVAlign, XML_top );
}
void Comment::importAnchor( bool bFrom, sal_Int32 nWhich, const OUString &rChars )
{
sal_Int32 nRow, nCol;
Point aPoint;
UnitConverter& rUnitConv = getUnitConverter();
if( bFrom )
{
nCol = maModel.maAnchor.X;
nRow = maModel.maAnchor.Y;
}
else
{
nCol = maModel.maAnchor.Width + maModel.maAnchor.X ;
nRow = maModel.maAnchor.Height + maModel.maAnchor.Y;
}
switch( nWhich )
{
case XDR_TOKEN( col ):
aPoint = getCellPosition( rChars.toInt32(), 1 );
nCol = aPoint.X;
break;
case XDR_TOKEN( colOff ):
nCol += rUnitConv.scaleToMm100( static_cast< double >( rChars.toInt32() ), UNIT_SCREENX );
break;
case XDR_TOKEN( row ):
aPoint = getCellPosition( 1, rChars.toInt32() );
nRow = aPoint.Y;
break;
case XDR_TOKEN( rowOff ):
nRow += rUnitConv.scaleToMm100( static_cast< double >( rChars.toInt32() ), UNIT_SCREENY );
break;
}
if( bFrom )
{
maModel.maAnchor.X = nCol;
maModel.maAnchor.Y = nRow;
}
else
{
maModel.maAnchor.Width = nCol - maModel.maAnchor.X;
maModel.maAnchor.Height = nRow - maModel.maAnchor.Y;
}
}
void Comment::importComment( RecordInputStream& rStrm )
{
BinRange aBinRange;
rStrm >> maModel.mnAuthorId >> aBinRange;
// cell range will be checked while inserting the comment into the document
getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, aBinRange, getSheetIndex() );
}
RichStringRef Comment::createText()
{
maModel.mxText.reset( new RichString( *this ) );
return maModel.mxText;
}
void Comment::finalizeImport()
{
// OOBIN format stores cell range instead of cell address, use first cell of this range
OSL_ENSURE( (maModel.maRange.StartColumn == maModel.maRange.EndColumn) &&
(maModel.maRange.StartRow == maModel.maRange.EndRow),
"Comment::finalizeImport - comment anchor should be a single cell" );
CellAddress aNotePos( maModel.maRange.Sheet, maModel.maRange.StartColumn, maModel.maRange.StartRow );
if( getAddressConverter().checkCellAddress( aNotePos, true ) && maModel.mxText.get() ) try
{
maModel.mxText->finalizeImport();
OUString aNoteText = maModel.mxText->getPlainText();
// non-empty string required by note implementation
if( aNoteText.getLength() > 0 )
{
Reference< XSheetAnnotationsSupplier > xAnnosSupp( getSheet(), UNO_QUERY_THROW );
Reference< XSheetAnnotations > xAnnos( xAnnosSupp->getAnnotations(), UNO_SET_THROW );
xAnnos->insertNew( aNotePos, aNoteText );
// receive craeted note from cell (insertNew does not return the note)
Reference< XSheetAnnotationAnchor > xAnnoAnchor( getCell( aNotePos ), UNO_QUERY_THROW );
Reference< XSheetAnnotation > xAnno( xAnnoAnchor->getAnnotation(), UNO_SET_THROW );
Reference< XSheetAnnotationShapeSupplier > xAnnoShapeSupp( xAnno, UNO_QUERY_THROW );
Reference< XShape > xAnnoShape( xAnnoShapeSupp->getAnnotationShape(), UNO_SET_THROW );
Reference <XText> xText( xAnnoShape, UNO_QUERY_THROW );
Reference <XTextRange> xTextRange( xText, UNO_QUERY_THROW );
xTextRange->setString( OUString() ); // Clear contents
maModel.mxText->convert( xText, -1 );
// Add shape formatting properties (autoFill, colHidden and rowHidden are dropped)
PropertySet aCommentPr( xAnnoShape );
aCommentPr.setProperty( PROP_TextFitToSize, maModel.mbAutoScale );
aCommentPr.setProperty( PROP_MoveProtect, maModel.mbLocked );
aCommentPr.setProperty( PROP_TextHorizontalAdjust, lcl_ToHorizAlign( maModel.mnTHA ) );
aCommentPr.setProperty( PROP_TextVerticalAdjust, lcl_ToVertAlign( maModel.mnTVA ) );
if( maModel.maAnchor.Width > 0 && maModel.maAnchor.Height > 0 )
{
xAnnoShape->setPosition( Point( maModel.maAnchor.X, maModel.maAnchor.Y ) );
xAnnoShape->setSize( Size( maModel.maAnchor.Width, maModel.maAnchor.Height ) );
}
// convert shape formatting
if( const ::oox::vml::ShapeBase* pNoteShape = getVmlDrawing().getNoteShape( aNotePos ) )
{
// position and formatting
pNoteShape->convertFormatting( xAnnoShape );
// visibility
const ::oox::vml::ShapeModel::ShapeClientDataPtr& rxClientData = pNoteShape->getShapeModel().mxClientData;
bool bVisible = rxClientData.get() && rxClientData->mbVisible;
xAnno->setIsVisible( bVisible );
}
}
}
catch( Exception& )
{
}
}
// ============================================================================
CommentsBuffer::CommentsBuffer( const WorksheetHelper& rHelper ) :
WorksheetHelper( rHelper )
{
}
void CommentsBuffer::appendAuthor( const OUString& rAuthor )
{
maAuthors.push_back( rAuthor );
}
CommentRef CommentsBuffer::createComment()
{
CommentRef xComment( new Comment( *this ) );
maComments.push_back( xComment );
return xComment;
}
void CommentsBuffer::finalizeImport()
{
maComments.forEachMem( &Comment::finalizeImport );
}
// ============================================================================
} // namespace xls
} // namespace oox
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */