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             : #ifndef INCLUDED_VCL_INC_HELPWIN_HXX
      21             : #define INCLUDED_VCL_INC_HELPWIN_HXX
      22             : 
      23             : #include <vcl/floatwin.hxx>
      24             : #include <vcl/timer.hxx>
      25             : 
      26             : enum class QuickHelpFlags;
      27             : 
      28             : // - HelpTextWindow -
      29             : 
      30             : class HelpTextWindow : public FloatingWindow
      31             : {
      32             : private:
      33             :     Rectangle           maHelpArea; // If next Help for the same rectangle w/ same text, then keep window
      34             : 
      35             :     Rectangle           maTextRect; // For wrapped text in QuickHelp
      36             : 
      37             :     OUString            maHelpText;
      38             :     OUString            maStatusText;
      39             : 
      40             :     Timer               maShowTimer;
      41             :     Timer               maHideTimer;
      42             : 
      43             :     sal_uInt16          mnHelpWinStyle;
      44             :     QuickHelpFlags      mnStyle;
      45             : 
      46             : protected:
      47             :     DECL_LINK_TYPED( TimerHdl, Timer*, void );
      48             : 
      49             :     virtual void Paint(vcl::RenderContext& rRenderContext, const Rectangle&) SAL_OVERRIDE;
      50             :     virtual void RequestHelp( const HelpEvent& rHEvt ) SAL_OVERRIDE;
      51             :     virtual void ApplySettings(vcl::RenderContext& rRenderContext) SAL_OVERRIDE;
      52             : 
      53             :     virtual OUString GetText() const SAL_OVERRIDE;
      54             :     void ImplShow();
      55             : 
      56             : 
      57             : public:
      58             :                         HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle );
      59             :     virtual             ~HelpTextWindow();
      60             :     virtual void        dispose() SAL_OVERRIDE;
      61             : 
      62           0 :     const OUString&     GetHelpText() const { return maHelpText; }
      63             :     void                SetHelpText( const OUString& rHelpText );
      64           0 :     sal_uInt16          GetWinStyle() const { return mnHelpWinStyle; }
      65           0 :     QuickHelpFlags      GetStyle() const { return mnStyle; }
      66             : 
      67             :     // Nur merken:
      68           0 :     void                SetStatusText( const OUString& rStatusText ) { maStatusText = rStatusText; }
      69           0 :     void                SetHelpArea( const Rectangle& rRect ) { maHelpArea = rRect; }
      70             : 
      71             :     void                ShowHelp( sal_uInt16 nDelayMode );
      72             : 
      73             :     Size                CalcOutSize() const;
      74           0 :     const Rectangle&    GetHelpArea() const { return maHelpArea; }
      75             : 
      76             :     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > CreateAccessible() SAL_OVERRIDE;
      77             : };
      78             : 
      79             : void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
      80             :         const OUString& rHelpText, const OUString& rStatusText,
      81             :         const Point& rScreenPos, const Rectangle* pHelpArea = NULL );
      82             : void ImplDestroyHelpWindow( bool bUpdateHideTime );
      83             : void ImplSetHelpWindowPos( vcl::Window* pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
      84             :                             const Point& rPos, const Rectangle* pHelpArea );
      85             : 
      86             : #endif // INCLUDED_VCL_INC_HELPWIN_HXX
      87             : 
      88             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */