Files
libreoffice/sw/source/ui/vba/vbadocument.cxx
Stephan Bergmann 54e87df11f Change INetProtocol enumerators to CamelCase
...to avoid clashes with macros and poor warnings about hiding global FILE

Change-Id: I444e8b958f029201b228937e088efabc4b6d3050
2015-04-02 18:33:37 +02:00

525 lines
20 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 "vbadocument.hxx"
#include "vbarange.hxx"
#include "vbarangehelper.hxx"
#include "vbadocumentproperties.hxx"
#include "vbabookmarks.hxx"
#include "vbavariables.hxx"
#include <com/sun/star/text/XBookmarksSupplier.hpp>
#include <com/sun/star/document/XDocumentPropertiesSupplier.hpp>
#include <com/sun/star/document/XDocumentProperties.hpp>
#include <com/sun/star/drawing/XDrawPageSupplier.hpp>
#include <com/sun/star/drawing/XControlShape.hpp>
#include <com/sun/star/form/XFormsSupplier.hpp>
#include <com/sun/star/document/XRedlinesSupplier.hpp>
#include <ooo/vba/XControlProvider.hpp>
#include <ooo/vba/word/WdProtectionType.hpp>
#include <vbahelper/helperdecl.hxx>
#include <wordvbahelper.hxx>
#include <docsh.hxx>
#include "vbatemplate.hxx"
#include "vbaparagraph.hxx"
#include "vbastyles.hxx"
#include "vbatables.hxx"
#include "vbafield.hxx"
#include "vbapagesetup.hxx"
#include "vbasections.hxx"
#include "vbatablesofcontents.hxx"
#include <vbahelper/vbashapes.hxx>
#include <vbahelper/vbahelper.hxx>
#include "vbarevisions.hxx"
#include "vbaframes.hxx"
#include <osl/file.hxx>
#include <tools/urlobj.hxx>
using namespace ::ooo::vba;
using namespace ::com::sun::star;
SwVbaDocument::SwVbaDocument( const uno::Reference< XHelperInterface >& xParent, const uno::Reference< uno::XComponentContext >& xContext, uno::Reference< frame::XModel > xModel ): SwVbaDocument_BASE( xParent, xContext, xModel )
{
Initialize();
}
SwVbaDocument::SwVbaDocument( uno::Sequence< uno::Any > const& aArgs, uno::Reference< uno::XComponentContext >const& xContext ) : SwVbaDocument_BASE( aArgs, xContext )
{
Initialize();
}
SwVbaDocument::~SwVbaDocument()
{
}
void SwVbaDocument::Initialize()
{
mxTextDocument.set( getModel(), uno::UNO_QUERY_THROW );
}
uno::Reference< word::XRange > SAL_CALL
SwVbaDocument::getContent() throw ( uno::RuntimeException, std::exception )
{
uno::Reference< text::XTextRange > xStart = mxTextDocument->getText()->getStart();
uno::Reference< text::XTextRange > xEnd;
return uno::Reference< word::XRange >( new SwVbaRange( this, mxContext, mxTextDocument, xStart, xEnd, true ) );
}
uno::Reference< word::XRange > SAL_CALL
SwVbaDocument::Range( const uno::Any& rStart, const uno::Any& rEnd )
throw (css::script::BasicErrorException, uno::RuntimeException, std::exception)
{
if( !rStart.hasValue() && !rEnd.hasValue() )
return getContent();
sal_Int32 nStart = 0;
sal_Int32 nEnd = 0;
rStart >>= nStart;
rEnd >>= nEnd;
nStart--;
nEnd--;
uno::Reference< text::XTextRange > xStart;
uno::Reference< text::XTextRange > xEnd;
if( nStart != -1 || nEnd != -1 )
{
if( nStart == -1 )
xStart = mxTextDocument->getText()->getStart();
else
xStart = SwVbaRangeHelper::getRangeByPosition( mxTextDocument->getText(), nStart );
if( nEnd == -1 )
xEnd = mxTextDocument->getText()->getEnd();
else
xEnd = SwVbaRangeHelper::getRangeByPosition( mxTextDocument->getText(), nEnd );
}
if( !xStart.is() && !xEnd.is() )
{
try
{
// FIXME
xStart = mxTextDocument->getText()->getStart();
xEnd = mxTextDocument->getText()->getEnd();
}
catch(const uno::Exception&)
{
DebugHelper::basicexception(SbERR_METHOD_FAILED, OUString());
}
}
return uno::Reference< word::XRange >( new SwVbaRange( this, mxContext, mxTextDocument, xStart, xEnd ) );
}
uno::Any SAL_CALL
SwVbaDocument::BuiltInDocumentProperties( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaBuiltinDocumentProperties( mxParent, mxContext, getModel() ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::CustomDocumentProperties( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaCustomDocumentProperties( mxParent, mxContext, getModel() ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::Bookmarks( const uno::Any& rIndex ) throw ( uno::RuntimeException, std::exception )
{
uno::Reference< text::XBookmarksSupplier > xBookmarksSupplier( getModel(),uno::UNO_QUERY_THROW );
uno::Reference<container::XIndexAccess > xBookmarks( xBookmarksSupplier->getBookmarks(), uno::UNO_QUERY_THROW );
uno::Reference< XCollection > xBookmarksVba( new SwVbaBookmarks( this, mxContext, xBookmarks, getModel() ) );
if ( rIndex.getValueTypeClass() == uno::TypeClass_VOID )
return uno::makeAny( xBookmarksVba );
return uno::Any( xBookmarksVba->Item( rIndex, uno::Any() ) );
}
uno::Any SAL_CALL
SwVbaDocument::Variables( const uno::Any& rIndex ) throw ( uno::RuntimeException, std::exception )
{
uno::Reference< document::XDocumentPropertiesSupplier > xDocumentPropertiesSupplier( getModel(),uno::UNO_QUERY_THROW );
uno::Reference< document::XDocumentProperties > xDocumentProperties = xDocumentPropertiesSupplier->getDocumentProperties();
uno::Reference< beans::XPropertyAccess > xUserDefined( xDocumentProperties->getUserDefinedProperties(), uno::UNO_QUERY_THROW );
uno::Reference< XCollection > xVariables( new SwVbaVariables( this, mxContext, xUserDefined ) );
if ( rIndex.getValueTypeClass() == uno::TypeClass_VOID )
return uno::makeAny( xVariables );
return uno::Any( xVariables->Item( rIndex, uno::Any() ) );
}
uno::Any SAL_CALL
SwVbaDocument::Paragraphs( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaParagraphs( mxParent, mxContext, mxTextDocument ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::Styles( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaStyles( mxParent, mxContext, getModel() ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::Fields( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaFields( mxParent, mxContext, getModel() ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::Shapes( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< drawing::XDrawPageSupplier > xDrawPageSupplier( getModel(), uno::UNO_QUERY_THROW );
uno::Reference< container::XIndexAccess > xIndexAccess( xDrawPageSupplier->getDrawPage(), uno::UNO_QUERY_THROW );
uno::Reference< frame::XModel > xModel( mxTextDocument, uno::UNO_QUERY_THROW );
uno::Reference< XCollection > xCol( new ScVbaShapes( this, mxContext, xIndexAccess, xModel ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::Sections( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaSections( mxParent, mxContext, getModel() ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::TablesOfContents( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol( new SwVbaTablesOfContents( this, mxContext, mxTextDocument ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::FormFields( const uno::Any& /*index*/ ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< XCollection > xCol;
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::PageSetup( ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< beans::XPropertySet > xPageProps( word::getCurrentPageStyle( mxModel ), uno::UNO_QUERY_THROW );
return uno::makeAny( uno::Reference< word::XPageSetup >( new SwVbaPageSetup( this, mxContext, mxModel, xPageProps ) ) );
}
OUString
SwVbaDocument::getServiceImplName()
{
return OUString("SwVbaDocument");
}
uno::Any SAL_CALL
SwVbaDocument::getAttachedTemplate() throw (uno::RuntimeException, std::exception)
{
uno::Reference< word::XTemplate > xTemplate;
uno::Reference<document::XDocumentPropertiesSupplier> const xDocPropSupp(
getModel(), uno::UNO_QUERY_THROW);
uno::Reference< document::XDocumentProperties > xDocProps( xDocPropSupp->getDocumentProperties(), uno::UNO_QUERY_THROW );
OUString sTemplateUrl = xDocProps->getTemplateURL();
xTemplate = new SwVbaTemplate( this, mxContext, getModel(), sTemplateUrl );
return uno::makeAny( xTemplate );
}
void SAL_CALL
SwVbaDocument::setAttachedTemplate( const css::uno::Any& _attachedtemplate ) throw (uno::RuntimeException, std::exception)
{
OUString sTemplate;
if( !( _attachedtemplate >>= sTemplate ) )
{
throw uno::RuntimeException();
}
OUString aURL;
INetURLObject aObj;
aObj.SetURL( sTemplate );
bool bIsURL = aObj.GetProtocol() != INetProtocol::NotValid;
if ( bIsURL )
aURL = sTemplate;
else
osl::FileBase::getFileURLFromSystemPath( sTemplate, aURL );
uno::Reference< word::XTemplate > xTemplate;
uno::Reference<document::XDocumentPropertiesSupplier> const xDocPropSupp(
getModel(), uno::UNO_QUERY_THROW );
uno::Reference< document::XDocumentProperties > xDocProps( xDocPropSupp->getDocumentProperties(), uno::UNO_QUERY_THROW );
xDocProps->setTemplateURL( aURL );
}
uno::Any SAL_CALL
SwVbaDocument::Tables( const css::uno::Any& aIndex ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< frame::XModel > xModel( mxTextDocument, uno::UNO_QUERY_THROW );
uno::Reference< XCollection > xColl( new SwVbaTables( mxParent, mxContext, xModel ) );
if ( aIndex.hasValue() )
return xColl->Item( aIndex, uno::Any() );
return uno::makeAny( xColl );
}
void SAL_CALL SwVbaDocument::Activate() throw (uno::RuntimeException, std::exception)
{
VbaDocumentBase::Activate();
}
::sal_Int32 SAL_CALL SwVbaDocument::getProtectionType() throw (css::uno::RuntimeException, std::exception)
{
//TODO
return word::WdProtectionType::wdNoProtection;
}
void SAL_CALL SwVbaDocument::setProtectionType( ::sal_Int32 /*_protectiontype*/ ) throw (css::uno::RuntimeException, std::exception)
{
//TODO
}
sal_Bool SAL_CALL SwVbaDocument::getUpdateStylesOnOpen() throw (css::uno::RuntimeException, std::exception)
{
//TODO
return sal_False;
}
void SAL_CALL SwVbaDocument::setUpdateStylesOnOpen( sal_Bool /*_updatestylesonopen*/ ) throw (uno::RuntimeException, std::exception)
{
//TODO
}
sal_Bool SAL_CALL SwVbaDocument::getAutoHyphenation() throw (uno::RuntimeException, std::exception)
{
// check this property only in default paragraph style
bool IsAutoHyphenation = false;
uno::Reference< beans::XPropertySet > xParaProps( word::getDefaultParagraphStyle( getModel() ), uno::UNO_QUERY_THROW );
xParaProps->getPropertyValue("ParaIsHyphenation") >>= IsAutoHyphenation;
return IsAutoHyphenation;
}
void SAL_CALL SwVbaDocument::setAutoHyphenation( sal_Bool _autohyphenation ) throw (uno::RuntimeException, std::exception)
{
//TODO
uno::Reference< beans::XPropertySet > xParaProps( word::getDefaultParagraphStyle( getModel() ), uno::UNO_QUERY_THROW );
xParaProps->setPropertyValue("ParaIsHyphenation", uno::makeAny( _autohyphenation ) );
}
::sal_Int32 SAL_CALL SwVbaDocument::getHyphenationZone() throw (uno::RuntimeException, std::exception)
{
//TODO
return 0;
}
void SAL_CALL SwVbaDocument::setHyphenationZone( ::sal_Int32 /*_hyphenationzone*/ ) throw (uno::RuntimeException, std::exception)
{
//TODO
}
::sal_Int32 SAL_CALL SwVbaDocument::getConsecutiveHyphensLimit() throw (uno::RuntimeException, std::exception)
{
//TODO
sal_Int16 nHyphensLimit = 0;
uno::Reference< beans::XPropertySet > xParaProps( word::getDefaultParagraphStyle( getModel() ), uno::UNO_QUERY_THROW );
xParaProps->getPropertyValue("ParaHyphenationMaxHyphens") >>= nHyphensLimit;
return nHyphensLimit;
}
void SAL_CALL SwVbaDocument::setConsecutiveHyphensLimit( ::sal_Int32 _consecutivehyphenslimit ) throw (uno::RuntimeException, std::exception)
{
sal_Int16 nHyphensLimit = static_cast< sal_Int16 >( _consecutivehyphenslimit );
uno::Reference< beans::XPropertySet > xParaProps( word::getDefaultParagraphStyle( getModel() ), uno::UNO_QUERY_THROW );
xParaProps->setPropertyValue("ParaHyphenationMaxHyphens", uno::makeAny( nHyphensLimit ) );
}
void SAL_CALL SwVbaDocument::Protect( ::sal_Int32 /*Type*/, const uno::Any& /*NOReset*/, const uno::Any& /*Password*/, const uno::Any& /*UseIRM*/, const uno::Any& /*EnforceStyleLock*/ ) throw (uno::RuntimeException, std::exception)
{
// Seems not support in Writer
// VbaDocumentBase::Protect( Password );
}
void SAL_CALL SwVbaDocument::PrintOut( const uno::Any& /*Background*/, const uno::Any& /*Append*/, const uno::Any& /*Range*/, const uno::Any& /*OutputFileName*/, const uno::Any& /*From*/, const uno::Any& /*To*/, const uno::Any& /*Item*/, const uno::Any& /*Copies*/, const uno::Any& /*Pages*/, const uno::Any& /*PageType*/, const uno::Any& /*PrintToFile*/, const uno::Any& /*Collate*/, const uno::Any& /*FileName*/, const uno::Any& /*ActivePrinterMacGX*/, const uno::Any& /*ManualDuplexPrint*/, const uno::Any& /*PrintZoomColumn*/, const uno::Any& /*PrintZoomRow*/, const uno::Any& /*PrintZoomPaperWidth*/, const uno::Any& /*PrintZoomPaperHeight*/ ) throw (uno::RuntimeException, std::exception)
{
//TODO
}
void SAL_CALL SwVbaDocument::PrintPreview( ) throw (uno::RuntimeException, std::exception)
{
OUString url = ".uno:PrintPreview";
dispatchRequests( mxModel,url );
}
void SAL_CALL SwVbaDocument::ClosePrintPreview( ) throw (uno::RuntimeException, std::exception)
{
OUString url = ".uno:ClosePreview";
dispatchRequests( mxModel,url );
}
uno::Any SAL_CALL
SwVbaDocument::Revisions( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< document::XRedlinesSupplier > xRedlinesSupp( mxTextDocument, uno::UNO_QUERY_THROW );
uno::Reference< container::XIndexAccess > xRedlines( xRedlinesSupp->getRedlines(), uno::UNO_QUERY_THROW );
uno::Reference< XCollection > xCol( new SwVbaRevisions( this, mxContext, getModel(), xRedlines ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any SAL_CALL
SwVbaDocument::Frames( const uno::Any& index ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< text::XTextFramesSupplier > xTextFramesSupp( mxTextDocument, uno::UNO_QUERY_THROW );
uno::Reference< container::XIndexAccess > xFrames( xTextFramesSupp->getTextFrames(), uno::UNO_QUERY_THROW );
uno::Reference< XCollection > xCol( new SwVbaFrames( this, mxContext, xFrames, getModel() ) );
if ( index.hasValue() )
return xCol->Item( index, uno::Any() );
return uno::makeAny( xCol );
}
uno::Any
SwVbaDocument::getControlShape( const OUString& sName )
{
uno::Reference< drawing::XDrawPageSupplier > xDrawPageSupplier( mxTextDocument, uno::UNO_QUERY_THROW );
uno::Reference< container::XIndexAccess > xIndexAccess( xDrawPageSupplier->getDrawPage(), uno::UNO_QUERY_THROW );
sal_Int32 nCount = xIndexAccess->getCount();
for( int index = 0; index < nCount; index++ )
{
uno::Any aUnoObj = xIndexAccess->getByIndex( index );
// It seems there are some drawing objects that can not query into Control shapes?
uno::Reference< drawing::XControlShape > xControlShape( aUnoObj, uno::UNO_QUERY );
if( xControlShape.is() )
{
uno::Reference< container::XNamed > xNamed( xControlShape->getControl(), uno::UNO_QUERY_THROW );
if( sName.equals( xNamed->getName() ))
{
return aUnoObj;
}
}
}
return uno::Any();
}
uno::Reference< beans::XIntrospectionAccess > SAL_CALL
SwVbaDocument::getIntrospection( ) throw (uno::RuntimeException, std::exception)
{
return uno::Reference< beans::XIntrospectionAccess >();
}
uno::Any SAL_CALL
SwVbaDocument::invoke( const OUString& aFunctionName, const uno::Sequence< uno::Any >& /*aParams*/, uno::Sequence< ::sal_Int16 >& /*aOutParamIndex*/, uno::Sequence< uno::Any >& /*aOutParam*/ ) throw (lang::IllegalArgumentException, script::CannotConvertException, reflection::InvocationTargetException, uno::RuntimeException, std::exception)
{
OSL_TRACE("** SwVbaDocument::invoke( %s ), will barf",
OUStringToOString( aFunctionName, RTL_TEXTENCODING_UTF8 ).getStr() );
throw uno::RuntimeException(); // unsupported operation
}
void SAL_CALL
SwVbaDocument::setValue( const OUString& /*aPropertyName*/, const uno::Any& /*aValue*/ ) throw (beans::UnknownPropertyException, script::CannotConvertException, reflection::InvocationTargetException, uno::RuntimeException, std::exception)
{
throw uno::RuntimeException(); // unsupported operation
}
uno::Any SAL_CALL
SwVbaDocument::getValue( const OUString& aPropertyName ) throw (beans::UnknownPropertyException, uno::RuntimeException, std::exception)
{
uno::Reference< drawing::XControlShape > xControlShape( getControlShape( aPropertyName ), uno::UNO_QUERY_THROW );
uno::Reference<lang::XMultiComponentFactory > xServiceManager( mxContext->getServiceManager(), uno::UNO_QUERY_THROW );
uno::Reference< XControlProvider > xControlProvider( xServiceManager->createInstanceWithContext("ooo.vba.ControlProvider", mxContext ), uno::UNO_QUERY_THROW );
uno::Reference< msforms::XControl > xControl( xControlProvider->createControl( xControlShape, getModel() ) );
return uno::makeAny( xControl );
}
sal_Bool SAL_CALL
SwVbaDocument::hasMethod( const OUString& /*aName*/ ) throw (uno::RuntimeException, std::exception)
{
return sal_False;
}
sal_Bool SAL_CALL
SwVbaDocument::hasProperty( const OUString& aName ) throw (uno::RuntimeException, std::exception)
{
uno::Reference< container::XNameAccess > xFormControls( getFormControls() );
if ( xFormControls.is() )
return xFormControls->hasByName( aName );
return sal_False;
}
uno::Reference< container::XNameAccess >
SwVbaDocument::getFormControls()
{
uno::Reference< container::XNameAccess > xFormControls;
try
{
uno::Reference< drawing::XDrawPageSupplier > xDrawPageSupplier( mxTextDocument, uno::UNO_QUERY_THROW );
uno::Reference< form::XFormsSupplier > xFormSupplier( xDrawPageSupplier->getDrawPage(), uno::UNO_QUERY_THROW );
uno::Reference< container::XIndexAccess > xIndexAccess( xFormSupplier->getForms(), uno::UNO_QUERY_THROW );
// get the www-standard container ( maybe we should access the
// 'www-standard' by name rather than index, this seems an
// implementation detail
xFormControls.set( xIndexAccess->getByIndex(0), uno::UNO_QUERY_THROW );
}
catch(const uno::Exception&)
{
}
return xFormControls;
}
uno::Sequence< OUString >
SwVbaDocument::getServiceNames()
{
static uno::Sequence< OUString > aServiceNames;
if ( aServiceNames.getLength() == 0 )
{
aServiceNames.realloc( 1 );
aServiceNames[ 0 ] = "ooo.vba.word.Document";
}
return aServiceNames;
}
namespace document
{
namespace sdecl = comphelper::service_decl;
sdecl::vba_service_class_<SwVbaDocument, sdecl::with_args<true> > serviceImpl;
extern sdecl::ServiceDecl const serviceDecl(
serviceImpl,
"SwVbaDocument",
"ooo.vba.word.Document" );
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */