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