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
24#include <vcl/timer.hxx>
25
26enum class QuickHelpFlags;
27struct ImplSVHelpData;
28
30class HelpTextWindow final : public FloatingWindow
31{
32private:
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
41
42 sal_uInt16 mnHelpWinStyle;
44
45private:
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;
56public:
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
74void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
75 const OUString& rHelpText,
76 const Point& rScreenPos, const tools::Rectangle& rHelpArea );
77VCL_DLLPUBLIC void ImplDestroyHelpWindow( bool bUpdateHideTime );
78void ImplDestroyHelpWindow(ImplSVHelpData& rHelpData, bool bUpdateHideTime);
79void ImplSetHelpWindowPos( vcl::Window* pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
80 const Point& rPos, const tools::Rectangle& rHelpArea );
81
82#endif // INCLUDED_VCL_INC_HELPWIN_HXX
83
84/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
A tooltip: adds tips to widgets in a floating / popup window.
Definition: helpwin.hxx:31
tools::Rectangle maTextRect
Definition: helpwin.hxx:35
virtual void ApplySettings(vcl::RenderContext &rRenderContext) override
Definition: help.cxx:287
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects.
Definition: help.cxx:316
const tools::Rectangle & GetHelpArea() const
Definition: helpwin.hxx:71
sal_uInt16 mnHelpWinStyle
Definition: helpwin.hxx:42
DECL_LINK(TimerHdl, Timer *, void)
void ShowHelp(bool bNoDelay)
Definition: help.cxx:420
virtual ~HelpTextWindow() override
Definition: help.cxx:311
Size CalcOutSize() const
Definition: help.cxx:460
Timer maHideTimer
Definition: helpwin.hxx:40
tools::Rectangle maHelpArea
Definition: helpwin.hxx:33
QuickHelpFlags GetStyle() const
Definition: helpwin.hxx:63
void SetHelpArea(const tools::Rectangle &rRect)
Definition: helpwin.hxx:66
const OUString & GetHelpText() const
Definition: helpwin.hxx:60
QuickHelpFlags mnStyle
Definition: helpwin.hxx:43
void SetHelpText(const OUString &rHelpText)
Definition: help.cxx:326
HelpTextWindow(vcl::Window *pParent, const OUString &rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle)
Definition: help.cxx:256
OUString maHelpText
Definition: helpwin.hxx:37
void ImplShow()
Definition: help.cxx:366
virtual void RequestHelp(const HelpEvent &rHEvt) override
Definition: help.cxx:468
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &) override
Definition: help.cxx:374
sal_uInt16 GetWinStyle() const
Definition: helpwin.hxx:62
Timer maShowTimer
Definition: helpwin.hxx:39
virtual OUString GetText() const override
Definition: help.cxx:474
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:171
Definition: timer.hxx:27
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
QuickHelpFlags
Definition: help.hxx:33
void ImplSetHelpWindowPos(vcl::Window *pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle, const Point &rPos, const tools::Rectangle &rHelpArea)
Definition: help.cxx:569
VCL_DLLPUBLIC void ImplDestroyHelpWindow(bool bUpdateHideTime)
Definition: help.cxx:550
void ImplShowHelpWindow(vcl::Window *pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle, const OUString &rHelpText, const Point &rScreenPos, const tools::Rectangle &rHelpArea)
Definition: help.cxx:479