office-gobmx/vcl/inc/helpwin.hxx
Miklos Vajna b9db7c7236 vcl: document HelpTextWindow
This has little to do with the text window used by Help -> Help.

Change-Id: I68e6870cbc0b1653e673981517c63d8c26371745
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/92227
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
2020-04-15 09:05:19 +02:00

84 lines
3.3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_VCL_INC_HELPWIN_HXX
#define INCLUDED_VCL_INC_HELPWIN_HXX
#include <vcl/floatwin.hxx>
#include <vcl/timer.hxx>
enum class QuickHelpFlags;
struct ImplSVHelpData;
/// A tooltip: adds tips to widgets in a floating / popup window.
class HelpTextWindow final : public FloatingWindow
{
private:
tools::Rectangle maHelpArea; // If next Help for the same rectangle w/ same text, then keep window
tools::Rectangle maTextRect; // For wrapped text in QuickHelp
OUString maHelpText;
Timer maShowTimer;
Timer maHideTimer;
sal_uInt16 mnHelpWinStyle;
QuickHelpFlags mnStyle;
private:
DECL_LINK( TimerHdl, Timer*, void );
virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&) override;
virtual void RequestHelp( const HelpEvent& rHEvt ) override;
virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
virtual OUString GetText() const override;
void ImplShow();
virtual void dispose() override;
public:
HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle );
virtual ~HelpTextWindow() override;
const OUString& GetHelpText() const { return maHelpText; }
void SetHelpText( const OUString& rHelpText );
sal_uInt16 GetWinStyle() const { return mnHelpWinStyle; }
QuickHelpFlags GetStyle() const { return mnStyle; }
// only remember:
void SetHelpArea( const tools::Rectangle& rRect ) { maHelpArea = rRect; }
void ShowHelp(bool bNoDelay);
Size CalcOutSize() const;
const tools::Rectangle& GetHelpArea() const { return maHelpArea; }
};
void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
const OUString& rHelpText,
const Point& rScreenPos, const tools::Rectangle& rHelpArea );
VCL_DLLPUBLIC void ImplDestroyHelpWindow( bool bUpdateHideTime );
void ImplDestroyHelpWindow(ImplSVHelpData& rHelpData, bool bUpdateHideTime);
void ImplSetHelpWindowPos( vcl::Window* pHelpWindow, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
const Point& rPos, const tools::Rectangle& rHelpArea );
#endif // INCLUDED_VCL_INC_HELPWIN_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */