office-gobmx/oox/source/xls/commentsbuffer.cxx
2011-01-06 12:32:39 +01:00

202 lines
7.8 KiB
C++

/*************************************************************************
*
* 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/biffinputstream.hxx"
#include "oox/xls/drawingfragment.hxx"
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;
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::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() );
}
void Comment::importNote( BiffInputStream& rStrm )
{
BinAddress aBinAddr;
sal_uInt16 nTotalLen;
rStrm >> aBinAddr >> nTotalLen;
// cell range will be checked while inserting the comment into the document
getAddressConverter().convertToCellRangeUnchecked( maModel.maRange, BinRange( aBinAddr ), getSheetIndex() );
RichStringRef xNoteText = createText();
sal_uInt16 nPartLen = ::std::min( nTotalLen, static_cast< sal_uInt16 >( rStrm.getRemaining() ) );
xNoteText->importCharArray( rStrm, nPartLen, getTextEncoding() );
nTotalLen = nTotalLen - nPartLen; // operator-=() gives compiler warning
while( (nTotalLen > 0) && (rStrm.getNextRecId() == BIFF_ID_NOTE) && rStrm.startNextRecord() )
{
rStrm >> aBinAddr >> nPartLen;
OSL_ENSURE( aBinAddr.mnRow == 0xFFFF, "Comment::importNote - missing continuation NOTE record" );
if( aBinAddr.mnRow == 0xFFFF )
{
OSL_ENSURE( nPartLen <= nTotalLen, "Comment::importNote - 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;
}
}
}
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
{
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 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 );
// convert shape formatting
switch( getFilterType() )
{
case FILTER_OOX:
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 );
}
break;
case FILTER_BIFF:
// notes are always hidden and unformatted in BIFF3-BIFF5
xAnno->setIsVisible( sal_False );
break;
case FILTER_UNKNOWN:
break;
}
// insert text and convert text formatting
maModel.mxText->finalizeImport();
Reference< XText > xAnnoText( xAnnoShape, UNO_QUERY_THROW );
maModel.mxText->convert( xAnnoText, -1, true );
}
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