sc/source/ui/vba/vbahyperlink.hxx

   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 #pragma once
  21
  22 #include <ooo/vba/excel/XHyperlink.hpp>
  23
  24 #include <vbahelper/vbahelperinterface.hxx>
  25 #include <tools/long.hxx>
  26
  27 namespace ooo::vba::excel { class XRange; }
  28 namespace com::sun::star::beans { class XPropertySet; }
  29 namespace com::sun::star::table { class XCell; }
  30
  31 typedef InheritedHelperInterfaceWeakImpl< ov::excel::XHyperlink > HyperlinkImpl_BASE;
  32
  33 class ScVbaHyperlink : public HyperlinkImpl_BASE
  34 {
  35 public:
  36     /// @throws css::lang::IllegalArgumentException
  37     /// @throws css::uno::RuntimeException
  38     ScVbaHyperlink(
  39         const css::uno::Sequence< css::uno::Any >& rArgs,
  40         const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  41
  42     /// @throws css::uno::RuntimeException
  43     ScVbaHyperlink(
  44         const css::uno::Reference< ov::XHelperInterface >& rxAnchor,
  45         const css::uno::Reference< css::uno::XComponentContext >& rxContext,
  46         const css::uno::Any& rAddress, const css::uno::Any& rSubAddress,
  47         const css::uno::Any& rScreenTip, const css::uno::Any& rTextToDisplay );
  48
  49     virtual ~ScVbaHyperlink() override;
  50
  51     // Attributes
  52     virtual OUString SAL_CALL getName() override;
  53     virtual void SAL_CALL setName( const OUString& rName ) override;
  54     virtual OUString SAL_CALL getAddress() override;
  55     virtual void SAL_CALL setAddress( const OUString& rAddress ) override;
  56     virtual OUString SAL_CALL getSubAddress() override;
  57     virtual void SAL_CALL setSubAddress( const OUString& rSubAddress ) override;
  58     virtual OUString SAL_CALL getScreenTip() override;
  59     virtual void SAL_CALL setScreenTip( const OUString& rScreenTip ) override;
  60     virtual OUString SAL_CALL getTextToDisplay() override;
  61     virtual void SAL_CALL setTextToDisplay( const OUString& rTextToDisplay ) override;
  62     virtual sal_Int32 SAL_CALL getType() override;
  63     virtual css::uno::Reference< ov::excel::XRange > SAL_CALL getRange() override;
  64     virtual css::uno::Reference< ov::msforms::XShape > SAL_CALL getShape() override;
  65
  66     // XHelperInterface
  67     VBAHELPER_DECL_XHELPERINTERFACE
  68
  69 private:
  70     typedef ::std::pair< OUString, OUString > UrlComponents;
  71
  72     /// @throws css::uno::RuntimeException
  73     void ensureTextField();
  74     /// @throws css::uno::RuntimeException
  75     UrlComponents getUrlComponents();
  76     /// @throws css::uno::RuntimeException
  77     void setUrlComponents( const UrlComponents& rUrlComp );
  78
  79 private:
  80     css::uno::Reference< css::table::XCell > mxCell;
  81     css::uno::Reference< css::beans::XPropertySet > mxTextField;
  82     OUString maScreenTip;
  83     tools::Long mnType;
  84 };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */