Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #include "vbahyperlink.hxx"
21 : #include <vbahelper/helperdecl.hxx>
22 : #include <com/sun/star/container/XIndexAccess.hpp>
23 : #include <com/sun/star/text/XText.hpp>
24 : #include <com/sun/star/text/XTextFieldsSupplier.hpp>
25 : #include <com/sun/star/container/XEnumerationAccess.hpp>
26 : #include <ooo/vba/office/MsoHyperlinkType.hpp>
27 : #include <ooo/vba/msforms/XShape.hpp>
28 : #include "vbarange.hxx"
29 :
30 : using namespace ::ooo::vba;
31 : using namespace ::com::sun::star;
32 : using ::rtl::OUString;
33 : using ::rtl::OUStringBuffer;
34 :
35 : // ============================================================================
36 :
37 0 : ScVbaHyperlink::ScVbaHyperlink( const uno::Sequence< uno::Any >& rArgs,
38 : const uno::Reference< uno::XComponentContext >& rxContext ) throw (lang::IllegalArgumentException) :
39 : HyperlinkImpl_BASE( getXSomethingFromArgs< XHelperInterface >( rArgs, 0 ), rxContext ),
40 : mxCell( getXSomethingFromArgs< table::XCell >( rArgs, 1, false ) ),
41 0 : mnType( office::MsoHyperlinkType::msoHyperlinkRange )
42 : {
43 0 : uno::Reference< text::XTextFieldsSupplier > xTextFields( mxCell, uno::UNO_QUERY_THROW );
44 0 : uno::Reference< container::XIndexAccess > xIndex( xTextFields->getTextFields(), uno::UNO_QUERY_THROW );
45 0 : mxTextField.set( xIndex->getByIndex(0), uno::UNO_QUERY_THROW );
46 0 : }
47 :
48 0 : ScVbaHyperlink::ScVbaHyperlink( const uno::Reference< XHelperInterface >& rxAnchor,
49 : const uno::Reference< uno::XComponentContext >& rxContext,
50 : const uno::Any& rAddress, const uno::Any& rSubAddress,
51 : const uno::Any& rScreenTip, const uno::Any& rTextToDisplay ) throw (uno::RuntimeException) :
52 0 : HyperlinkImpl_BASE( rxAnchor, rxContext ) // parent of Hyperlink is the anchor object
53 : {
54 : // extract parameters, Address must not be empty
55 0 : UrlComponents aUrlComp;
56 0 : OUString aTextToDisplay;
57 0 : if( !(rAddress >>= aUrlComp.first) || aUrlComp.first.isEmpty() )
58 0 : throw uno::RuntimeException( OUString( RTL_CONSTASCII_USTRINGPARAM( "Cannot get address" ) ), uno::Reference< uno::XInterface >() );
59 0 : rSubAddress >>= aUrlComp.second;
60 0 : rScreenTip >>= maScreenTip;
61 0 : rTextToDisplay >>= aTextToDisplay;
62 :
63 : // get anchor range or anchor shape
64 0 : uno::Reference< excel::XRange > xAnchorRange( rxAnchor, uno::UNO_QUERY );
65 0 : if( xAnchorRange.is() )
66 : {
67 0 : mnType = office::MsoHyperlinkType::msoHyperlinkRange;
68 : // only single ranges are allowed
69 0 : uno::Reference< table::XCellRange > xUnoRange( ScVbaRange::getCellRange( xAnchorRange ), uno::UNO_QUERY_THROW );
70 : // insert the hyperlink into the top-left cell only
71 0 : mxCell.set( xUnoRange->getCellByPosition( 0, 0 ), uno::UNO_SET_THROW );
72 0 : uno::Reference< text::XText > xText( mxCell, uno::UNO_QUERY_THROW );
73 : // use cell text or URL if no TextToDisplay has been passed
74 0 : if( aTextToDisplay.isEmpty() )
75 : {
76 0 : aTextToDisplay = xText->getString();
77 0 : if( aTextToDisplay.isEmpty() )
78 : {
79 0 : OUStringBuffer aBuffer( aUrlComp.first );
80 0 : if( !aUrlComp.second.isEmpty() )
81 0 : aBuffer.appendAscii( RTL_CONSTASCII_STRINGPARAM( " - " ) ).append( aUrlComp.second );
82 0 : aTextToDisplay = aBuffer.makeStringAndClear();
83 : }
84 : }
85 : // create and initialize a new URL text field
86 0 : uno::Reference< lang::XMultiServiceFactory > xFactory( ScVbaRange::getUnoModel( xAnchorRange ), uno::UNO_QUERY_THROW );
87 0 : uno::Reference< text::XTextContent > xUrlField( xFactory->createInstance( OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.text.TextField.URL" ) ) ), uno::UNO_QUERY_THROW );
88 0 : mxTextField.set( xUrlField, uno::UNO_QUERY_THROW );
89 0 : setUrlComponents( aUrlComp );
90 0 : setTextToDisplay( aTextToDisplay );
91 : // insert the text field into the document
92 0 : xText->setString( OUString() );
93 0 : uno::Reference< text::XTextRange > xRange( xText->createTextCursor(), uno::UNO_QUERY_THROW );
94 0 : xText->insertTextContent( xRange, xUrlField, false );
95 : }
96 : else
97 : {
98 0 : uno::Reference< msforms::XShape > xAnchorShape( rxAnchor, uno::UNO_QUERY_THROW );
99 0 : mnType = office::MsoHyperlinkType::msoHyperlinkShape;
100 : // FIXME: insert hyperlink into shape
101 0 : throw uno::RuntimeException();
102 0 : }
103 0 : }
104 :
105 0 : ScVbaHyperlink::~ScVbaHyperlink()
106 : {
107 0 : }
108 :
109 0 : OUString ScVbaHyperlink::getName() throw (uno::RuntimeException)
110 : {
111 : // it seems this attribute is same as TextToDisplay
112 0 : return getTextToDisplay();
113 : }
114 :
115 0 : void ScVbaHyperlink::setName( const OUString& rName ) throw (uno::RuntimeException)
116 : {
117 0 : setTextToDisplay( rName );
118 0 : }
119 :
120 0 : OUString ScVbaHyperlink::getAddress() throw (uno::RuntimeException)
121 : {
122 0 : return getUrlComponents().first;
123 : }
124 :
125 0 : void ScVbaHyperlink::setAddress( const OUString& rAddress ) throw (uno::RuntimeException)
126 : {
127 0 : UrlComponents aUrlComp = getUrlComponents();
128 0 : aUrlComp.first = rAddress;
129 0 : setUrlComponents( aUrlComp );
130 0 : }
131 :
132 0 : OUString ScVbaHyperlink::getSubAddress() throw (uno::RuntimeException)
133 : {
134 0 : return getUrlComponents().second;
135 : }
136 :
137 0 : void ScVbaHyperlink::setSubAddress( const OUString& rSubAddress ) throw (uno::RuntimeException)
138 : {
139 0 : UrlComponents aUrlComp = getUrlComponents();
140 0 : aUrlComp.second = rSubAddress;
141 0 : setUrlComponents( aUrlComp );
142 0 : }
143 :
144 0 : OUString SAL_CALL ScVbaHyperlink::getScreenTip() throw (uno::RuntimeException)
145 : {
146 0 : return maScreenTip;
147 : }
148 :
149 0 : void SAL_CALL ScVbaHyperlink::setScreenTip( const OUString& rScreenTip ) throw (uno::RuntimeException)
150 : {
151 0 : maScreenTip = rScreenTip;
152 0 : }
153 :
154 0 : OUString ScVbaHyperlink::getTextToDisplay() throw (uno::RuntimeException)
155 : {
156 0 : ensureTextField();
157 0 : OUString aTextToDisplay;
158 0 : mxTextField->getPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "Representation" ) ) ) >>= aTextToDisplay;
159 0 : return aTextToDisplay;
160 : }
161 :
162 0 : void ScVbaHyperlink::setTextToDisplay( const OUString& rTextToDisplay ) throw (uno::RuntimeException)
163 : {
164 0 : ensureTextField();
165 0 : mxTextField->setPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "Representation" ) ), uno::Any( rTextToDisplay ) );
166 0 : }
167 :
168 0 : sal_Int32 SAL_CALL ScVbaHyperlink::getType() throw (uno::RuntimeException)
169 : {
170 0 : return mnType;
171 : }
172 :
173 0 : uno::Reference< excel::XRange > SAL_CALL ScVbaHyperlink::getRange() throw (uno::RuntimeException)
174 : {
175 0 : if( mnType == office::MsoHyperlinkType::msoHyperlinkRange )
176 : {
177 : // if constructed from Hyperlinks object, range has been passed as parent
178 0 : uno::Reference< excel::XRange > xAnchorRange( getParent(), uno::UNO_QUERY );
179 0 : if( !xAnchorRange.is() )
180 : {
181 : // if constructed via service c'tor, create new range based on cell
182 0 : uno::Reference< table::XCellRange > xRange( mxCell, uno::UNO_QUERY_THROW );
183 : // FIXME: need to pass current worksheet as the parent of XRange.
184 0 : xAnchorRange.set( new ScVbaRange( uno::Reference< XHelperInterface >(), mxContext, xRange ) );
185 : }
186 0 : return xAnchorRange;
187 : }
188 : // error if called at a shape Hyperlink object
189 0 : throw uno::RuntimeException();
190 : }
191 :
192 0 : uno::Reference< msforms::XShape > SAL_CALL ScVbaHyperlink::getShape() throw (uno::RuntimeException)
193 : {
194 : // error if called at a range Hyperlink object
195 0 : return uno::Reference< msforms::XShape >( getParent(), uno::UNO_QUERY_THROW );
196 : }
197 :
198 0 : VBAHELPER_IMPL_XHELPERINTERFACE( ScVbaHyperlink, "ooo.vba.excel.Hyperlink" )
199 :
200 : // private --------------------------------------------------------------------
201 :
202 0 : void ScVbaHyperlink::ensureTextField() throw (uno::RuntimeException)
203 : {
204 0 : if( !mxTextField.is() )
205 0 : throw uno::RuntimeException();
206 0 : }
207 :
208 0 : ScVbaHyperlink::UrlComponents ScVbaHyperlink::getUrlComponents() throw (uno::RuntimeException)
209 : {
210 0 : ensureTextField();
211 0 : OUString aUrl;
212 0 : mxTextField->getPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "URL" ) ) ) >>= aUrl;
213 0 : sal_Int32 nHashPos = aUrl.indexOf( '#' );
214 0 : if( nHashPos < 0 )
215 0 : return UrlComponents( aUrl, OUString() );
216 0 : return UrlComponents( aUrl.copy( 0, nHashPos ), aUrl.copy( nHashPos + 1 ) );
217 : }
218 :
219 0 : void ScVbaHyperlink::setUrlComponents( const UrlComponents& rUrlComp ) throw (uno::RuntimeException)
220 : {
221 0 : ensureTextField();
222 0 : OUStringBuffer aUrl( rUrlComp.first );
223 0 : if( !rUrlComp.second.isEmpty() )
224 0 : aUrl.append( sal_Unicode( '#' ) ).append( rUrlComp.second );
225 0 : mxTextField->setPropertyValue( OUString( RTL_CONSTASCII_USTRINGPARAM( "URL" ) ), uno::Any( aUrl.makeStringAndClear() ) );
226 0 : }
227 :
228 : namespace hyperlink
229 : {
230 : namespace sdecl = comphelper::service_decl;
231 0 : sdecl::vba_service_class_<ScVbaHyperlink, sdecl::with_args<true> > serviceImpl;
232 0 : extern sdecl::ServiceDecl const serviceDecl(
233 : serviceImpl,
234 : "ScVbaHyperlink",
235 : "ooo.vba.excel.Hyperlink" );
236 0 : }
237 :
238 : // ============================================================================
239 :
240 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
