include/vcl/toolkit/fixedhyper.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 #ifndef INCLUDED_VCL_FIXEDHYPER_HXX
  21 #define INCLUDED_VCL_FIXEDHYPER_HXX
  22
  23 #if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION)
  24 #error "don't use this in new code"
  25 #endif
  26
  27 #include <vcl/dllapi.h>
  28 #include <vcl/fixed.hxx>
  29
  30 class VCL_DLLPUBLIC FixedHyperlink : public FixedText
  31 {
  32 private:
  33     long                m_nTextLen;
  34     PointerStyle        m_aOldPointer;
  35     Link<FixedHyperlink&,void> m_aClickHdl;
  36     OUString            m_sURL;
  37
  38     /** initializes the font (link color and underline).
  39
  40         Called by the Ctors.
  41     */
  42     void                Initialize();
  43
  44     /** is position X position hitting text */
  45     SAL_DLLPRIVATE bool ImplIsOverText(Point rPosition);
  46
  47     DECL_LINK(HandleClick, FixedHyperlink&, void);
  48
  49 protected:
  50     /** overwrites Window::MouseMove().
  51
  52         Changes the pointer only over the text.
  53     */
  54     virtual void        MouseMove( const MouseEvent& rMEvt ) override;
  55
  56     /** overwrites Window::MouseButtonUp().
  57
  58         Calls the set link if the mouse is over the text.
  59     */
  60     virtual void        MouseButtonUp( const MouseEvent& rMEvt ) override;
  61
  62     /** overwrites Window::RequestHelp().
  63
  64         Shows tooltip only if the mouse is over the text.
  65     */
  66     virtual void        RequestHelp( const HelpEvent& rHEvt ) override;
  67
  68 public:
  69     /** ctors
  70
  71         With WinBits.
  72     */
  73     FixedHyperlink( vcl::Window* pParent, WinBits nWinStyle = 0 );
  74
  75     /** overwrites Window::GetFocus().
  76
  77         Changes the color of the text and shows a focus rectangle.
  78     */
  79     virtual void        GetFocus() override;
  80
  81     /** overwrites Window::LoseFocus().
  82
  83         Changes the color of the text and hides the focus rectangle.
  84     */
  85     virtual void        LoseFocus() override;
  86
  87     /** overwrites Window::KeyInput().
  88
  89         KEY_RETURN and KEY_SPACE calls the link handler.
  90     */
  91     virtual void        KeyInput( const KeyEvent& rKEvt ) override;
  92
  93     virtual bool        set_property(const OString &rKey, const OUString &rValue) override;
  94
  95
  96     /** sets m_aClickHdl with rLink.
  97
  98         m_aClickHdl is called if the text is clicked.
  99     */
 100     void         SetClickHdl( const Link<FixedHyperlink&,void>& rLink ) { m_aClickHdl = rLink; }
 101     const Link<FixedHyperlink&,void>& GetClickHdl() const { return m_aClickHdl; }
 102
 103     // ::FixedHyperbaseLink
 104
 105     /** sets the URL of the hyperlink and uses it as tooltip. */
 106     void                SetURL(const OUString& rNewURL);
 107
 108     /** returns the URL of the hyperlink.
 109
 110         @return
 111             m_sURL
 112     */
 113     const OUString&     GetURL() const { return m_sURL;}
 114
 115     /** sets new text and recalculates the text length. */
 116     virtual void        SetText(const OUString& rNewDescription) override;
 117 };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */