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 :
33 : // ============================================================================
34 :
35 0 : ScVbaHyperlink::ScVbaHyperlink( const uno::Sequence< uno::Any >& rArgs,
36 : const uno::Reference< uno::XComponentContext >& rxContext ) throw (lang::IllegalArgumentException) :
37 : HyperlinkImpl_BASE( getXSomethingFromArgs< XHelperInterface >( rArgs, 0 ), rxContext ),
38 : mxCell( getXSomethingFromArgs< table::XCell >( rArgs, 1, false ) ),
39 0 : mnType( office::MsoHyperlinkType::msoHyperlinkRange )
40 : {
41 0 : uno::Reference< text::XTextFieldsSupplier > xTextFields( mxCell, uno::UNO_QUERY_THROW );
42 0 : uno::Reference< container::XIndexAccess > xIndex( xTextFields->getTextFields(), uno::UNO_QUERY_THROW );
43 0 : mxTextField.set( xIndex->getByIndex(0), uno::UNO_QUERY_THROW );
44 0 : }
45 :
46 0 : ScVbaHyperlink::ScVbaHyperlink( const uno::Reference< XHelperInterface >& rxAnchor,
47 : const uno::Reference< uno::XComponentContext >& rxContext,
48 : const uno::Any& rAddress, const uno::Any& rSubAddress,
49 : const uno::Any& rScreenTip, const uno::Any& rTextToDisplay ) throw (uno::RuntimeException) :
50 0 : HyperlinkImpl_BASE( rxAnchor, rxContext ) // parent of Hyperlink is the anchor object
51 : {
52 : // extract parameters, Address must not be empty
53 0 : UrlComponents aUrlComp;
54 0 : OUString aTextToDisplay;
55 0 : if( !(rAddress >>= aUrlComp.first) || aUrlComp.first.isEmpty() )
56 0 : throw uno::RuntimeException("Cannot get address", uno::Reference< uno::XInterface >() );
57 0 : rSubAddress >>= aUrlComp.second;
58 0 : rScreenTip >>= maScreenTip;
59 0 : rTextToDisplay >>= aTextToDisplay;
60 :
61 : // get anchor range or anchor shape
62 0 : uno::Reference< excel::XRange > xAnchorRange( rxAnchor, uno::UNO_QUERY );
63 0 : if( xAnchorRange.is() )
64 : {
65 0 : mnType = office::MsoHyperlinkType::msoHyperlinkRange;
66 : // only single ranges are allowed
67 0 : uno::Reference< table::XCellRange > xUnoRange( ScVbaRange::getCellRange( xAnchorRange ), uno::UNO_QUERY_THROW );
68 : // insert the hyperlink into the top-left cell only
69 0 : mxCell.set( xUnoRange->getCellByPosition( 0, 0 ), uno::UNO_SET_THROW );
70 0 : uno::Reference< text::XText > xText( mxCell, uno::UNO_QUERY_THROW );
71 : // use cell text or URL if no TextToDisplay has been passed
72 0 : if( aTextToDisplay.isEmpty() )
73 : {
74 0 : aTextToDisplay = xText->getString();
75 0 : if( aTextToDisplay.isEmpty() )
76 : {
77 0 : OUStringBuffer aBuffer( aUrlComp.first );
78 0 : if( !aUrlComp.second.isEmpty() )
79 0 : aBuffer.appendAscii( RTL_CONSTASCII_STRINGPARAM( " - " ) ).append( aUrlComp.second );
80 0 : aTextToDisplay = aBuffer.makeStringAndClear();
81 : }
82 : }
83 : // create and initialize a new URL text field
84 0 : uno::Reference< lang::XMultiServiceFactory > xFactory( ScVbaRange::getUnoModel( xAnchorRange ), uno::UNO_QUERY_THROW );
85 0 : uno::Reference< text::XTextContent > xUrlField( xFactory->createInstance("com.sun.star.text.TextField.URL"), uno::UNO_QUERY_THROW );
86 0 : mxTextField.set( xUrlField, uno::UNO_QUERY_THROW );
87 0 : setUrlComponents( aUrlComp );
88 0 : setTextToDisplay( aTextToDisplay );
89 : // insert the text field into the document
90 0 : xText->setString( OUString() );
91 0 : uno::Reference< text::XTextRange > xRange( xText->createTextCursor(), uno::UNO_QUERY_THROW );
92 0 : xText->insertTextContent( xRange, xUrlField, false );
93 : }
94 : else
95 : {
96 0 : uno::Reference< msforms::XShape > xAnchorShape( rxAnchor, uno::UNO_QUERY_THROW );
97 0 : mnType = office::MsoHyperlinkType::msoHyperlinkShape;
98 : // FIXME: insert hyperlink into shape
99 0 : throw uno::RuntimeException();
100 0 : }
101 0 : }
102 :
103 0 : ScVbaHyperlink::~ScVbaHyperlink()
104 : {
105 0 : }
106 :
107 0 : OUString ScVbaHyperlink::getName() throw (uno::RuntimeException)
108 : {
109 : // it seems this attribute is same as TextToDisplay
110 0 : return getTextToDisplay();
111 : }
112 :
113 0 : void ScVbaHyperlink::setName( const OUString& rName ) throw (uno::RuntimeException)
114 : {
115 0 : setTextToDisplay( rName );
116 0 : }
117 :
118 0 : OUString ScVbaHyperlink::getAddress() throw (uno::RuntimeException)
119 : {
120 0 : return getUrlComponents().first;
121 : }
122 :
123 0 : void ScVbaHyperlink::setAddress( const OUString& rAddress ) throw (uno::RuntimeException)
124 : {
125 0 : UrlComponents aUrlComp = getUrlComponents();
126 0 : aUrlComp.first = rAddress;
127 0 : setUrlComponents( aUrlComp );
128 0 : }
129 :
130 0 : OUString ScVbaHyperlink::getSubAddress() throw (uno::RuntimeException)
131 : {
132 0 : return getUrlComponents().second;
133 : }
134 :
135 0 : void ScVbaHyperlink::setSubAddress( const OUString& rSubAddress ) throw (uno::RuntimeException)
136 : {
137 0 : UrlComponents aUrlComp = getUrlComponents();
138 0 : aUrlComp.second = rSubAddress;
139 0 : setUrlComponents( aUrlComp );
140 0 : }
141 :
142 0 : OUString SAL_CALL ScVbaHyperlink::getScreenTip() throw (uno::RuntimeException)
143 : {
144 0 : return maScreenTip;
145 : }
146 :
147 0 : void SAL_CALL ScVbaHyperlink::setScreenTip( const OUString& rScreenTip ) throw (uno::RuntimeException)
148 : {
149 0 : maScreenTip = rScreenTip;
150 0 : }
151 :
152 0 : OUString ScVbaHyperlink::getTextToDisplay() throw (uno::RuntimeException)
153 : {
154 0 : ensureTextField();
155 0 : OUString aTextToDisplay;
156 0 : mxTextField->getPropertyValue("Representation") >>= aTextToDisplay;
157 0 : return aTextToDisplay;
158 : }
159 :
160 0 : void ScVbaHyperlink::setTextToDisplay( const OUString& rTextToDisplay ) throw (uno::RuntimeException)
161 : {
162 0 : ensureTextField();
163 0 : mxTextField->setPropertyValue("Representation", uno::Any( rTextToDisplay ) );
164 0 : }
165 :
166 0 : sal_Int32 SAL_CALL ScVbaHyperlink::getType() throw (uno::RuntimeException)
167 : {
168 0 : return mnType;
169 : }
170 :
171 0 : uno::Reference< excel::XRange > SAL_CALL ScVbaHyperlink::getRange() throw (uno::RuntimeException)
172 : {
173 0 : if( mnType == office::MsoHyperlinkType::msoHyperlinkRange )
174 : {
175 : // if constructed from Hyperlinks object, range has been passed as parent
176 0 : uno::Reference< excel::XRange > xAnchorRange( getParent(), uno::UNO_QUERY );
177 0 : if( !xAnchorRange.is() )
178 : {
179 : // if constructed via service c'tor, create new range based on cell
180 0 : uno::Reference< table::XCellRange > xRange( mxCell, uno::UNO_QUERY_THROW );
181 : // FIXME: need to pass current worksheet as the parent of XRange.
182 0 : xAnchorRange.set( new ScVbaRange( uno::Reference< XHelperInterface >(), mxContext, xRange ) );
183 : }
184 0 : return xAnchorRange;
185 : }
186 : // error if called at a shape Hyperlink object
187 0 : throw uno::RuntimeException();
188 : }
189 :
190 0 : uno::Reference< msforms::XShape > SAL_CALL ScVbaHyperlink::getShape() throw (uno::RuntimeException)
191 : {
192 : // error if called at a range Hyperlink object
193 0 : return uno::Reference< msforms::XShape >( getParent(), uno::UNO_QUERY_THROW );
194 : }
195 :
196 0 : VBAHELPER_IMPL_XHELPERINTERFACE( ScVbaHyperlink, "ooo.vba.excel.Hyperlink" )
197 :
198 : // private --------------------------------------------------------------------
199 :
200 0 : void ScVbaHyperlink::ensureTextField() throw (uno::RuntimeException)
201 : {
202 0 : if( !mxTextField.is() )
203 0 : throw uno::RuntimeException();
204 0 : }
205 :
206 0 : ScVbaHyperlink::UrlComponents ScVbaHyperlink::getUrlComponents() throw (uno::RuntimeException)
207 : {
208 0 : ensureTextField();
209 0 : OUString aUrl;
210 0 : mxTextField->getPropertyValue("URL") >>= aUrl;
211 0 : sal_Int32 nHashPos = aUrl.indexOf( '#' );
212 0 : if( nHashPos < 0 )
213 0 : return UrlComponents( aUrl, OUString() );
214 0 : return UrlComponents( aUrl.copy( 0, nHashPos ), aUrl.copy( nHashPos + 1 ) );
215 : }
216 :
217 0 : void ScVbaHyperlink::setUrlComponents( const UrlComponents& rUrlComp ) throw (uno::RuntimeException)
218 : {
219 0 : ensureTextField();
220 0 : OUStringBuffer aUrl( rUrlComp.first );
221 0 : if( !rUrlComp.second.isEmpty() )
222 0 : aUrl.append( sal_Unicode( '#' ) ).append( rUrlComp.second );
223 0 : mxTextField->setPropertyValue("URL", uno::Any( aUrl.makeStringAndClear() ) );
224 0 : }
225 :
226 : namespace hyperlink
227 : {
228 : namespace sdecl = comphelper::service_decl;
229 2 : sdecl::vba_service_class_<ScVbaHyperlink, sdecl::with_args<true> > serviceImpl;
230 2 : extern sdecl::ServiceDecl const serviceDecl(
231 : serviceImpl,
232 : "ScVbaHyperlink",
233 : "ooo.vba.excel.Hyperlink" );
234 6 : }
235 :
236 : // ============================================================================
237 :
238 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
