1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/* -*- 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 "vbahyperlink.hxx"
#include <vbahelper/helperdecl.hxx>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/text/XText.hpp>
#include <com/sun/star/text/XTextFieldsSupplier.hpp>
#include <com/sun/star/container/XEnumerationAccess.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;
using ::rtl::OUString;
using ::rtl::OUStringBuffer;
// ============================================================================
ScVbaHyperlink::ScVbaHyperlink( const uno::Sequence< uno::Any >& rArgs,
const uno::Reference< uno::XComponentContext >& rxContext ) throw (lang::IllegalArgumentException) :
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 ) throw (uno::RuntimeException) :
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( OUString( RTL_CONSTASCII_USTRINGPARAM( "Cannot get address" ) ), uno::Reference< uno::XInterface >() );
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.appendAscii( RTL_CONSTASCII_STRINGPARAM( " - " ) ).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( OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.text.TextField.URL" ) ) ), 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() throw (uno::RuntimeException)
{
// it seems this attribute is same as TextToDisplay
return getTextToDisplay();
}
void ScVbaHyperlink::setName( const OUString& rName ) throw (uno::RuntimeException)
{
setTextToDisplay( rName );
}
OUString ScVbaHyperlink::getAddress() throw (uno::RuntimeException)
{
return getUrlComponents().first;
}
void ScVbaHyperlink::setAddress( const OUString& rAddress ) throw (uno::RuntimeException)
{
UrlComponents aUrlComp = getUrlComponents();
aUrlComp.first = rAddress;
setUrlComponents( aUrlComp );
}
OUString ScVbaHyperlink::getSubAddress() throw (uno::RuntimeException)
{
return getUrlComponents().second;
}
void ScVbaHyperlink::setSubAddress( const OUString& rSubAddress ) throw (uno::RuntimeException)
{
UrlComponents aUrlComp = getUrlComponents();
aUrlComp.second = rSubAddress;
setUrlComponents( aUrlComp );
}
OUString SAL_CALL ScVbaHyperlink::getScreenTip() throw (uno::RuntimeException)
{
return maScreenTip;
}
void SAL_CALL ScVbaHyperlink::setScreenTip( const OUString& rScreenTip ) throw (uno::RuntimeException)
{
maScreenTip = rScreenTip;
}
OUString ScVbaHyperlink::getTextToDisplay() throw (uno::RuntimeException)
{
ensureTextField();
OUString aTextToDisplay;
mxTextField->getPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "Representation" ) ) ) >>= aTextToDisplay;
return aTextToDisplay;
}
void ScVbaHyperlink::setTextToDisplay( const OUString& rTextToDisplay ) throw (uno::RuntimeException)
{
ensureTextField();
mxTextField->setPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "Representation" ) ), uno::Any( rTextToDisplay ) );
}
sal_Int32 SAL_CALL ScVbaHyperlink::getType() throw (uno::RuntimeException)
{
return mnType;
}
uno::Reference< excel::XRange > SAL_CALL ScVbaHyperlink::getRange() throw (uno::RuntimeException)
{
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() throw (uno::RuntimeException)
{
// error if called at a range Hyperlink object
return uno::Reference< msforms::XShape >( getParent(), uno::UNO_QUERY_THROW );
}
VBAHELPER_IMPL_XHELPERINTERFACE( ScVbaHyperlink, "ooo.vba.excel.Hyperlink" )
// private --------------------------------------------------------------------
void ScVbaHyperlink::ensureTextField() throw (uno::RuntimeException)
{
if( !mxTextField.is() )
throw uno::RuntimeException();
}
ScVbaHyperlink::UrlComponents ScVbaHyperlink::getUrlComponents() throw (uno::RuntimeException)
{
ensureTextField();
OUString aUrl;
mxTextField->getPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "URL" ) ) ) >>= 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 ) throw (uno::RuntimeException)
{
ensureTextField();
OUStringBuffer aUrl( rUrlComp.first );
if( !rUrlComp.second.isEmpty() )
aUrl.append( sal_Unicode( '#' ) ).append( rUrlComp.second );
mxTextField->setPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "URL" ) ), uno::Any( aUrl.makeStringAndClear() ) );
}
namespace hyperlink
{
namespace sdecl = comphelper::service_decl;
sdecl::vba_service_class_<ScVbaHyperlink, sdecl::with_args<true> > serviceImpl;
extern sdecl::ServiceDecl const serviceDecl(
serviceImpl,
"ScVbaHyperlink",
"ooo.vba.excel.Hyperlink" );
}
// ============================================================================
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
