office-gobmx/sc/source/ui/vba/vbahyperlink.cxx
Noel Grandin 5a602ed852 loplugin:ostr in sc/.../vba
Change-Id: Ifdf0ebba617432f49e2c14c8a52c495dc1c6a36a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/167853
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Jenkins
2024-05-20 14:40:36 +02:00

236 lines
8.4 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 <sal/config.h>
#include "vbahyperlink.hxx"
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/table/XCellRange.hpp>
#include <com/sun/star/text/XText.hpp>
#include <com/sun/star/text/XTextFieldsSupplier.hpp>
#include <ooo/vba/office/MsoHyperlinkType.hpp>
#include <ooo/vba/msforms/XShape.hpp>
#include "vbarange.hxx"
using namespace ::ooo::vba;
using namespace ::com::sun::star;
ScVbaHyperlink::ScVbaHyperlink( const uno::Sequence< uno::Any >& rArgs,
const uno::Reference< uno::XComponentContext >& rxContext ) :
HyperlinkImpl_BASE( getXSomethingFromArgs< XHelperInterface >( rArgs, 0 ), rxContext ),
mxCell( getXSomethingFromArgs< table::XCell >( rArgs, 1, false ) ),
mnType( office::MsoHyperlinkType::msoHyperlinkRange )
{
uno::Reference< text::XTextFieldsSupplier > xTextFields( mxCell, uno::UNO_QUERY_THROW );
uno::Reference< container::XIndexAccess > xIndex( xTextFields->getTextFields(), uno::UNO_QUERY_THROW );
mxTextField.set( xIndex->getByIndex(0), uno::UNO_QUERY_THROW );
}
ScVbaHyperlink::ScVbaHyperlink( const uno::Reference< XHelperInterface >& rxAnchor,
const uno::Reference< uno::XComponentContext >& rxContext,
const uno::Any& rAddress, const uno::Any& rSubAddress,
const uno::Any& rScreenTip, const uno::Any& rTextToDisplay ) :
HyperlinkImpl_BASE( rxAnchor, rxContext ) // parent of Hyperlink is the anchor object
{
// extract parameters, Address must not be empty
UrlComponents aUrlComp;
OUString aTextToDisplay;
if( !(rAddress >>= aUrlComp.first) || aUrlComp.first.isEmpty() )
throw uno::RuntimeException(u"Cannot get address"_ustr );
rSubAddress >>= aUrlComp.second;
rScreenTip >>= maScreenTip;
rTextToDisplay >>= aTextToDisplay;
// get anchor range or anchor shape
uno::Reference< excel::XRange > xAnchorRange( rxAnchor, uno::UNO_QUERY );
if( xAnchorRange.is() )
{
mnType = office::MsoHyperlinkType::msoHyperlinkRange;
// only single ranges are allowed
uno::Reference< table::XCellRange > xUnoRange( ScVbaRange::getCellRange( xAnchorRange ), uno::UNO_QUERY_THROW );
// insert the hyperlink into the top-left cell only
mxCell.set( xUnoRange->getCellByPosition( 0, 0 ), uno::UNO_SET_THROW );
uno::Reference< text::XText > xText( mxCell, uno::UNO_QUERY_THROW );
// use cell text or URL if no TextToDisplay has been passed
if( aTextToDisplay.isEmpty() )
{
aTextToDisplay = xText->getString();
if( aTextToDisplay.isEmpty() )
{
OUStringBuffer aBuffer( aUrlComp.first );
if( !aUrlComp.second.isEmpty() )
aBuffer.append( " - " + aUrlComp.second );
aTextToDisplay = aBuffer.makeStringAndClear();
}
}
// create and initialize a new URL text field
uno::Reference< lang::XMultiServiceFactory > xFactory( ScVbaRange::getUnoModel( xAnchorRange ), uno::UNO_QUERY_THROW );
uno::Reference< text::XTextContent > xUrlField( xFactory->createInstance(u"com.sun.star.text.TextField.URL"_ustr), uno::UNO_QUERY_THROW );
mxTextField.set( xUrlField, uno::UNO_QUERY_THROW );
setUrlComponents( aUrlComp );
setTextToDisplay( aTextToDisplay );
// insert the text field into the document
xText->setString( OUString() );
uno::Reference< text::XTextRange > xRange( xText->createTextCursor(), uno::UNO_QUERY_THROW );
xText->insertTextContent( xRange, xUrlField, false );
}
else
{
uno::Reference< msforms::XShape > xAnchorShape( rxAnchor, uno::UNO_QUERY_THROW );
mnType = office::MsoHyperlinkType::msoHyperlinkShape;
// FIXME: insert hyperlink into shape
throw uno::RuntimeException();
}
}
ScVbaHyperlink::~ScVbaHyperlink()
{
}
OUString ScVbaHyperlink::getName()
{
// it seems this attribute is same as TextToDisplay
return getTextToDisplay();
}
void ScVbaHyperlink::setName( const OUString& rName )
{
setTextToDisplay( rName );
}
OUString ScVbaHyperlink::getAddress()
{
return getUrlComponents().first;
}
void ScVbaHyperlink::setAddress( const OUString& rAddress )
{
UrlComponents aUrlComp = getUrlComponents();
aUrlComp.first = rAddress;
setUrlComponents( aUrlComp );
}
OUString ScVbaHyperlink::getSubAddress()
{
return getUrlComponents().second;
}
void ScVbaHyperlink::setSubAddress( const OUString& rSubAddress )
{
UrlComponents aUrlComp = getUrlComponents();
aUrlComp.second = rSubAddress;
setUrlComponents( aUrlComp );
}
OUString SAL_CALL ScVbaHyperlink::getScreenTip()
{
return maScreenTip;
}
void SAL_CALL ScVbaHyperlink::setScreenTip( const OUString& rScreenTip )
{
maScreenTip = rScreenTip;
}
OUString ScVbaHyperlink::getTextToDisplay()
{
ensureTextField();
OUString aTextToDisplay;
mxTextField->getPropertyValue(u"Representation"_ustr) >>= aTextToDisplay;
return aTextToDisplay;
}
void ScVbaHyperlink::setTextToDisplay( const OUString& rTextToDisplay )
{
ensureTextField();
mxTextField->setPropertyValue(u"Representation"_ustr, uno::Any( rTextToDisplay ) );
}
sal_Int32 SAL_CALL ScVbaHyperlink::getType()
{
return mnType;
}
uno::Reference< excel::XRange > SAL_CALL ScVbaHyperlink::getRange()
{
if( mnType == office::MsoHyperlinkType::msoHyperlinkRange )
{
// if constructed from Hyperlinks object, range has been passed as parent
uno::Reference< excel::XRange > xAnchorRange( getParent(), uno::UNO_QUERY );
if( !xAnchorRange.is() )
{
// if constructed via service c'tor, create new range based on cell
uno::Reference< table::XCellRange > xRange( mxCell, uno::UNO_QUERY_THROW );
// FIXME: need to pass current worksheet as the parent of XRange.
xAnchorRange.set( new ScVbaRange( uno::Reference< XHelperInterface >(), mxContext, xRange ) );
}
return xAnchorRange;
}
// error if called at a shape Hyperlink object
throw uno::RuntimeException();
}
uno::Reference< msforms::XShape > SAL_CALL ScVbaHyperlink::getShape()
{
// error if called at a range Hyperlink object
return uno::Reference< msforms::XShape >( getParent(), uno::UNO_QUERY_THROW );
}
VBAHELPER_IMPL_XHELPERINTERFACE( ScVbaHyperlink, u"ooo.vba.excel.Hyperlink"_ustr )
// private --------------------------------------------------------------------
void ScVbaHyperlink::ensureTextField()
{
if( !mxTextField.is() )
throw uno::RuntimeException();
}
ScVbaHyperlink::UrlComponents ScVbaHyperlink::getUrlComponents()
{
ensureTextField();
OUString aUrl;
mxTextField->getPropertyValue(u"URL"_ustr) >>= aUrl;
sal_Int32 nHashPos = aUrl.indexOf( '#' );
if( nHashPos < 0 )
return UrlComponents( aUrl, OUString() );
return UrlComponents( aUrl.copy( 0, nHashPos ), aUrl.copy( nHashPos + 1 ) );
}
void ScVbaHyperlink::setUrlComponents( const UrlComponents& rUrlComp )
{
ensureTextField();
OUStringBuffer aUrl( rUrlComp.first );
if( !rUrlComp.second.isEmpty() )
aUrl.append( "#" + rUrlComp.second );
mxTextField->setPropertyValue(u"URL"_ustr, uno::Any( aUrl.makeStringAndClear() ) );
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
Calc_ScVbaHyperlink_get_implementation(
css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const& args)
{
return cppu::acquire(new ScVbaHyperlink(args, context));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */