LibreOffice Module vcl (master)  1
helpwin.hxx
Go to the documentation of this file.
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 
29 {
30 private:
31  tools::Rectangle maHelpArea; // If next Help for the same rectangle w/ same text, then keep window
32 
33  tools::Rectangle maTextRect; // For wrapped text in QuickHelp
34 
35  OUString maHelpText;
36 
39 
40  sal_uInt16 mnHelpWinStyle;
42 
43 private:
44  DECL_LINK( TimerHdl, Timer*, void );
45 
46  virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&) override;
47  virtual void RequestHelp( const HelpEvent& rHEvt ) override;
48  virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
49 
50  virtual OUString GetText() const override;
51  void ImplShow();
52 
53  virtual void dispose() override;
54 public:
55  HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle );
56  virtual ~HelpTextWindow() override;
57 
58  const OUString& GetHelpText() const { return maHelpText; }
59  void SetHelpText( const OUString& rHelpText );
60  sal_uInt16 GetWinStyle() const { return mnHelpWinStyle; }
61  QuickHelpFlags GetStyle() const { return mnStyle; }
62 
63  // only remember:
64  void SetHelpArea( const tools::Rectangle& rRect ) { maHelpArea = rRect; }
65 
66  void ShowHelp(bool bNoDelay);
67 
68  Size CalcOutSize() const;
69  const tools::Rectangle& GetHelpArea() const { return maHelpArea; }
70 };
71 
72 void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
73  const OUString& rHelpText,
74  const Point& rScreenPos, const tools::Rectangle& rHelpArea );
75 VCL_DLLPUBLIC void ImplDestroyHelpWindow( bool bUpdateHideTime );
76 void ImplSetHelpWindowPos( vcl::Window* pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
77  const Point& rPos, const tools::Rectangle& rHelpArea );
78 
79 #endif // INCLUDED_VCL_INC_HELPWIN_HXX
80 
81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
HelpTextWindow(vcl::Window *pParent, const OUString &rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle)
Definition: help.cxx:254
tools::Rectangle maTextRect
Definition: helpwin.hxx:33
void ImplShow()
Definition: help.cxx:366
sal_uInt16 mnHelpWinStyle
Definition: helpwin.hxx:40
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
sal_uInt16 GetWinStyle() const
Definition: helpwin.hxx:60
const tools::Rectangle & GetHelpArea() const
Definition: helpwin.hxx:69
void SetHelpText(const OUString &rHelpText)
Definition: help.cxx:325
Timer maHideTimer
Definition: helpwin.hxx:38
QuickHelpFlags mnStyle
Definition: helpwin.hxx:41
virtual OUString GetText() const override
Definition: help.cxx:475
QuickHelpFlags GetStyle() const
Definition: helpwin.hxx:61
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &) override
Definition: help.cxx:374
OUString maHelpText
Definition: helpwin.hxx:35
virtual ~HelpTextWindow() override
Definition: help.cxx:310
QuickHelpFlags
Definition: help.hxx:32
VCL_DLLPUBLIC void ImplDestroyHelpWindow(bool bUpdateHideTime)
Definition: help.cxx:557
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:304
DECL_LINK(TimerHdl, Timer *, void)
Size CalcOutSize() const
Definition: help.cxx:461
virtual void ApplySettings(vcl::RenderContext &rRenderContext) override
Definition: help.cxx:286
void ImplShowHelpWindow(vcl::Window *pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle, const OUString &rHelpText, const Point &rScreenPos, const tools::Rectangle &rHelpArea)
Definition: help.cxx:480
void ImplSetHelpWindowPos(vcl::Window *pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle, const Point &rPos, const tools::Rectangle &rHelpArea)
Definition: help.cxx:577
virtual void RequestHelp(const HelpEvent &rHEvt) override
Definition: help.cxx:469
Timer maShowTimer
Definition: helpwin.hxx:37
const OUString & GetHelpText() const
Definition: helpwin.hxx:58
void ShowHelp(bool bNoDelay)
Definition: help.cxx:420
Definition: timer.hxx:26
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects...
Definition: help.cxx:315
void SetHelpArea(const tools::Rectangle &rRect)
Definition: helpwin.hxx:64
tools::Rectangle maHelpArea
Definition: helpwin.hxx:31