a70f7bfc5e
# Original author: Daniel Rentz [dr] <daniel.rentz@oracle.com> * found as LGPLv3-only fix at svn rev 1172134 (http://svn.apache.org/viewvc?view=revision&revision=1172134)
369 lines
13 KiB
C++
369 lines
13 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/token/properties.hxx>
|
|
#include <oox/token/tokens.hxx>
|
|
|
|
#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/vml/vmlshape.hxx"
|
|
#include "oox/xls/addressconverter.hxx"
|
|
#include "oox/xls/biffinputstream.hxx"
|
|
#include "oox/xls/drawingfragment.hxx"
|
|
#include "svx/sdtaitm.hxx"
|
|
#include "oox/xls/unitconverter.hxx"
|
|
#include "oox/xls/drawingmanager.hxx"
|
|
|
|
#include <com/sun/star/text/XText.hpp>
|
|
#include <com/sun/star/text/XTextRange.hpp>
|
|
|
|
using ::com::sun::star::text::XText;
|
|
using ::com::sun::star::text::XTextRange;
|
|
using ::com::sun::star::awt::Size;
|
|
using ::com::sun::star::awt::Point;
|
|
|
|
namespace oox {
|
|
namespace xls {
|
|
|
|
// ============================================================================
|
|
|
|
using namespace ::com::sun::star::drawing;
|
|
using namespace ::com::sun::star::sheet;
|
|
using namespace ::com::sun::star::table;
|
|
using namespace ::com::sun::star::text;
|
|
using namespace ::com::sun::star::uno;
|
|
|
|
using ::rtl::OUString;
|
|
|
|
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;
|
|
}
|
|
}
|
|
|
|
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;
|
|
}
|
|
}
|
|
|
|
// ============================================================================
|
|
|
|
namespace {
|
|
|
|
const sal_uInt16 BIFF_NOTE_VISIBLE = 0x0002;
|
|
|
|
} // namespace
|
|
|
|
// ============================================================================
|
|
|
|
CommentModel::CommentModel() :
|
|
mnAuthorId( -1 ),
|
|
mnObjId( BIFF_OBJ_INVALID_ID ),
|
|
mbVisible( false )
|
|
{
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
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( SequenceInputStream& 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() );
|
|
}
|
|
|
|
void Comment::importNote( BiffInputStream& rStrm )
|
|
{
|
|
BinAddress aBinAddr;
|
|
rStrm >> aBinAddr;
|
|
// cell range will be checked while inserting the comment into the document
|
|
getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, BinRange( aBinAddr ), getSheetIndex() );
|
|
|
|
// remaining record data is BIFF dependent
|
|
switch( getBiff() )
|
|
{
|
|
case BIFF2:
|
|
case BIFF3:
|
|
importNoteBiff2( rStrm );
|
|
break;
|
|
case BIFF4:
|
|
case BIFF5:
|
|
importNoteBiff2( rStrm );
|
|
// in BIFF4 and BIFF5, comments can have an associated sound
|
|
if( (rStrm.getNextRecId() == BIFF_ID_NOTESOUND) && rStrm.startNextRecord() )
|
|
importNoteSound( rStrm );
|
|
break;
|
|
case BIFF8:
|
|
importNoteBiff8( rStrm );
|
|
break;
|
|
case BIFF_UNKNOWN:
|
|
break;
|
|
}
|
|
}
|
|
|
|
RichStringRef Comment::createText()
|
|
{
|
|
maModel.mxText.reset( new RichString( *this ) );
|
|
return maModel.mxText;
|
|
}
|
|
|
|
void Comment::finalizeImport()
|
|
{
|
|
// BIFF12 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
|
|
{
|
|
Reference< XSheetAnnotationsSupplier > xAnnosSupp( getSheet(), UNO_QUERY_THROW );
|
|
Reference< XSheetAnnotations > xAnnos( xAnnosSupp->getAnnotations(), UNO_SET_THROW );
|
|
// non-empty string required by note implementation (real text will be added below)
|
|
xAnnos->insertNew( aNotePos, OUString( sal_Unicode( ' ' ) ) );
|
|
|
|
// receive created 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 );
|
|
|
|
// convert shape formatting and visibility
|
|
sal_Bool bVisible = sal_True;
|
|
switch( getFilterType() )
|
|
{
|
|
case FILTER_OOXML:
|
|
{
|
|
// 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::ClientData* pClientData = pNoteShape->getClientData();
|
|
xAnno->setIsVisible( pClientData && pClientData->mbVisible );
|
|
}
|
|
}
|
|
break;
|
|
case FILTER_BIFF:
|
|
bVisible = maModel.mbVisible;
|
|
break;
|
|
case FILTER_UNKNOWN:
|
|
break;
|
|
}
|
|
xAnno->setIsVisible( bVisible );
|
|
|
|
// insert text and convert text formatting
|
|
maModel.mxText->finalizeImport();
|
|
Reference< XText > xAnnoText( xAnnoShape, UNO_QUERY_THROW );
|
|
maModel.mxText->convert( xAnnoText, true );
|
|
}
|
|
catch( Exception& )
|
|
{
|
|
}
|
|
}
|
|
|
|
// private --------------------------------------------------------------------
|
|
|
|
void Comment::importNoteBiff2( BiffInputStream& rStrm )
|
|
{
|
|
sal_uInt16 nTotalLen;
|
|
rStrm >> nTotalLen;
|
|
sal_uInt16 nPartLen = ::std::min( nTotalLen, static_cast< sal_uInt16 >( rStrm.getRemaining() ) );
|
|
RichStringRef xNoteText = createText();
|
|
xNoteText->importCharArray( rStrm, nPartLen, getTextEncoding() );
|
|
|
|
nTotalLen = nTotalLen - nPartLen; // operator-=() gives compiler warning
|
|
while( (nTotalLen > 0) && (rStrm.getNextRecId() == BIFF_ID_NOTE) && rStrm.startNextRecord() )
|
|
{
|
|
sal_uInt16 nMarker;
|
|
rStrm >> nMarker;
|
|
rStrm.skip( 2 );
|
|
rStrm >> nPartLen;
|
|
OSL_ENSURE( nMarker == 0xFFFF, "Comment::importNoteBiff2 - missing continuation NOTE record" );
|
|
if( nMarker == 0xFFFF )
|
|
{
|
|
OSL_ENSURE( nPartLen <= nTotalLen, "Comment::importNoteBiff2 - string too long" );
|
|
// call to RichString::importCharArray() appends new text portion
|
|
xNoteText->importCharArray( rStrm, nPartLen, getTextEncoding() );
|
|
nTotalLen = nTotalLen - ::std::min( nTotalLen, nPartLen );
|
|
}
|
|
else
|
|
{
|
|
// seems to be a new note, rewind record, so worksheet fragment loop will find it
|
|
rStrm.rewindRecord();
|
|
nTotalLen = 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
void Comment::importNoteBiff8( BiffInputStream& rStrm )
|
|
{
|
|
sal_uInt16 nFlags;
|
|
rStrm >> nFlags >> maModel.mnObjId;
|
|
maModel.maAuthor = rStrm.readUniString();
|
|
maModel.mbVisible = getFlag( nFlags, BIFF_NOTE_VISIBLE );
|
|
}
|
|
|
|
void Comment::importNoteSound( BiffInputStream& /*rStrm*/ )
|
|
{
|
|
}
|
|
|
|
// ============================================================================
|
|
|
|
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: */
|