vcl/inc/helpwin.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_INC_HELPWIN_HXX
  21 #define INCLUDED_VCL_INC_HELPWIN_HXX
  22
  23 #include <vcl/toolkit/floatwin.hxx>
  24 #include <vcl/timer.hxx>
  25
  26 enum class QuickHelpFlags;
  27 struct ImplSVHelpData;
  28
  29 /// A tooltip: adds tips to widgets in a floating / popup window.
  30 class HelpTextWindow final : public FloatingWindow
  31 {
  32 private:
  33     tools::Rectangle           maHelpArea; // If next Help for the same rectangle w/ same text, then keep window
  34
  35     tools::Rectangle           maTextRect; // For wrapped text in QuickHelp
  36
  37     OUString            maHelpText;
  38
  39     Timer               maShowTimer;
  40     Timer               maHideTimer;
  41
  42     sal_uInt16          mnHelpWinStyle;
  43     QuickHelpFlags      mnStyle;
  44
  45 private:
  46     DECL_LINK( TimerHdl, Timer*, void );
  47
  48     virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&) override;
  49     virtual void RequestHelp( const HelpEvent& rHEvt ) override;
  50     virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
  51
  52     virtual OUString GetText() const override;
  53     void ImplShow();
  54
  55     virtual void        dispose() override;
  56 public:
  57                         HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle );
  58     virtual             ~HelpTextWindow() override;
  59
  60     const OUString&     GetHelpText() const { return maHelpText; }
  61     void                SetHelpText( const OUString& rHelpText );
  62     sal_uInt16          GetWinStyle() const { return mnHelpWinStyle; }
  63     QuickHelpFlags      GetStyle() const { return mnStyle; }
  64
  65     // only remember:
  66     void                SetHelpArea( const tools::Rectangle& rRect ) { maHelpArea = rRect; }
  67
  68     void                ShowHelp(bool bNoDelay);
  69
  70     Size                CalcOutSize() const;
  71     const tools::Rectangle&    GetHelpArea() const { return maHelpArea; }
  72
  73     void ResetHideTimer();
  74 };
  75
  76 void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
  77         const OUString& rHelpText,
  78         const Point& rScreenPos, const tools::Rectangle& rHelpArea );
  79 VCL_DLLPUBLIC void ImplDestroyHelpWindow( bool bUpdateHideTime );
  80 void ImplDestroyHelpWindow(ImplSVHelpData& rHelpData, bool bUpdateHideTime);
  81 void ImplSetHelpWindowPos( vcl::Window* pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
  82                             const Point& rPos, const tools::Rectangle& rHelpArea );
  83
  84 #endif // INCLUDED_VCL_INC_HELPWIN_HXX
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */