xref: /trunk/main/vcl/inc/helpwin.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _SV_HELPWIN_HXX
29*cdf0e10cSrcweir #define _SV_HELPWIN_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <vcl/floatwin.hxx>
32*cdf0e10cSrcweir #include <vcl/timer.hxx>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir // ------------------
35*cdf0e10cSrcweir // - HelpTextWindow -
36*cdf0e10cSrcweir // ------------------
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir class HelpTextWindow : public FloatingWindow
39*cdf0e10cSrcweir {
40*cdf0e10cSrcweir private:
41*cdf0e10cSrcweir     Point               maPos;
42*cdf0e10cSrcweir     Rectangle           maHelpArea; // Wenn naechste Hilfe fuers gleiche Rectangle, gleicher Text, dann Fenster stehen lassen
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir     Rectangle           maTextRect; // Bei umgebrochenen Text in QuickHelp
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir     String              maHelpText;
47*cdf0e10cSrcweir     String              maStatusText;
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir     Timer               maShowTimer;
50*cdf0e10cSrcweir     Timer               maHideTimer;
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir     sal_uInt16              mnHelpWinStyle;
53*cdf0e10cSrcweir     sal_uInt16              mnStyle;
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir protected:
56*cdf0e10cSrcweir                         DECL_LINK( TimerHdl, Timer* );
57*cdf0e10cSrcweir     virtual void        Paint( const Rectangle& );
58*cdf0e10cSrcweir     virtual void        RequestHelp( const HelpEvent& rHEvt );
59*cdf0e10cSrcweir     virtual String      GetText() const;
60*cdf0e10cSrcweir     void                ImplShow();
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir public:
63*cdf0e10cSrcweir                         HelpTextWindow( Window* pParent, const String& rText, sal_uInt16 nHelpWinStyle, sal_uInt16 nStyle );
64*cdf0e10cSrcweir                         ~HelpTextWindow();
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir     const String&       GetHelpText() const { return maHelpText; }
67*cdf0e10cSrcweir     void                SetHelpText( const String& rHelpText );
68*cdf0e10cSrcweir     sal_uInt16          GetWinStyle() const { return mnHelpWinStyle; }
69*cdf0e10cSrcweir     sal_uInt16          GetStyle() const { return mnStyle; }
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir     // Nur merken:
72*cdf0e10cSrcweir     void                SetStatusText( const String& rStatusText ) { maStatusText = rStatusText; }
73*cdf0e10cSrcweir     void                SetHelpArea( const Rectangle& rRect ) { maHelpArea = rRect; }
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     void                ShowHelp( sal_uInt16 nDelayMode );
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir     Size                CalcOutSize() const;
78*cdf0e10cSrcweir     const Rectangle&    GetHelpArea() const { return maHelpArea; }
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > CreateAccessible();
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir     sal_Bool                RegisterAccessibleParent();
83*cdf0e10cSrcweir     void                RevokeAccessibleParent();
84*cdf0e10cSrcweir };
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir void ImplShowHelpWindow( Window* pParent, sal_uInt16 nHelpWinStyle, sal_uInt16 nStyle,
87*cdf0e10cSrcweir         const String& rHelpText, const String& rStatusText,
88*cdf0e10cSrcweir         const Point& rScreenPos, const Rectangle* pHelpArea = NULL );
89*cdf0e10cSrcweir void ImplDestroyHelpWindow( bool bUpdateHideTime );
90*cdf0e10cSrcweir void ImplSetHelpWindowPos( Window* pHelpWindow, sal_uInt16 nHelpWinStyle, sal_uInt16 nStyle,
91*cdf0e10cSrcweir                             const Point& rPos, const Rectangle* pHelpArea );
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir #endif // _SV_HELPWIN_HXX
94