help.cxx File Reference

#include <comphelper/string.hxx>
#include <sal/log.hxx>
#include <comphelper/diagnose_ex.hxx>
#include <tools/time.hxx>
#include <vcl/window.hxx>
#include <vcl/event.hxx>
#include <vcl/svapp.hxx>
#include <vcl/wrkwin.hxx>
#include <vcl/help.hxx>
#include <vcl/settings.hxx>
#include <helpwin.hxx>
#include <salframe.hxx>
#include <svdata.hxx>

Include dependency graph for help.cxx:

Go to the source code of this file.

Macros
#define	HELPWINSTYLE_QUICK   0
#define	HELPWINSTYLE_BALLOON   1
#define	HELPTEXTMARGIN_QUICK   3
#define	HELPTEXTMARGIN_BALLOON   6
#define	HELPTEXTMAXLEN   150

Functions
	IMPL_LINK (HelpTextWindow, TimerHdl, Timer *, pTimer, void)
void	ImplShowHelpWindow (vcl::Window *pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle, const OUString &rHelpText, const Point &rScreenPos, const tools::Rectangle &rHelpArea)
void	ImplDestroyHelpWindow (bool bUpdateHideTime)
void	ImplDestroyHelpWindow (ImplSVHelpData &rHelpData, bool bUpdateHideTime)
void	ImplSetHelpWindowPos (vcl::Window *pHelpWin, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle, const Point &rPos, const tools::Rectangle &rHelpArea)

Macro Definition Documentation

HELPTEXTMARGIN_BALLOON

#define HELPTEXTMARGIN_BALLOON   6

Definition at line 41 of file help.cxx.

HELPTEXTMARGIN_QUICK

#define HELPTEXTMARGIN_QUICK   3

Definition at line 40 of file help.cxx.

HELPTEXTMAXLEN

#define HELPTEXTMAXLEN   150

Definition at line 43 of file help.cxx.

HELPWINSTYLE_BALLOON

#define HELPWINSTYLE_BALLOON   1

Definition at line 38 of file help.cxx.

HELPWINSTYLE_QUICK

#define HELPWINSTYLE_QUICK   0

Definition at line 37 of file help.cxx.

Function Documentation

IMPL_LINK()

IMPL_LINK	(	HelpTextWindow	,
		TimerHdl	,
		Timer *	,
		pTimer	,
		void
	)

Definition at line 445 of file help.cxx.

References ImplDestroyHelpWindow(), and SAL_WARN_IF.

ImplDestroyHelpWindow() [1/2]

void ImplDestroyHelpWindow

(

bool

bUpdateHideTime

)

Definition at line 563 of file help.cxx.

References ImplDestroyHelpWindow(), and ImplGetSVHelpData().

Referenced by DestroySVHelpData(), vcl::Window::dispose(), Help::HideBalloonAndQuickHelp(), IMPL_LINK(), ImplDestroyHelpWindow(), ImplHandleClose(), ImplHandleKey(), ImplHandleMouseEvent(), ImplHandleMouseFloatMode(), ImplHandleMove(), and ImplShowHelpWindow().

ImplDestroyHelpWindow() [2/2]

void ImplDestroyHelpWindow	(	ImplSVHelpData &	rHelpData,
		bool	bUpdateHideTime
	)

Definition at line 568 of file help.cxx.

References VclPtr< reference_type >::disposeAndClear(), tools::Time::GetSystemTicks(), vcl::Window::Hide(), ImplSVHelpData::mbKeyboardHelp, ImplSVHelpData::mnLastHelpHideTime, and ImplSVHelpData::mpHelpWin.

ImplSetHelpWindowPos()

void ImplSetHelpWindowPos	(	vcl::Window *	pHelpWin,
		sal_uInt16	nHelpWinStyle,
		QuickHelpFlags	nStyle,
		const Point &	rPos,
		const tools::Rectangle &	rHelpArea
	)

Definition at line 582 of file help.cxx.

References vcl::Window::AbsoluteScreenToOutputPixel(), Point::AdjustX(), Point::AdjustY(), tools::Rectangle::Bottom(), Bottom, tools::Rectangle::BottomRight(), tools::Rectangle::Center(), tools::Rectangle::Contains(), vcl::Window::GetDesktopRectPixel(), tools::Rectangle::GetHeight(), vcl::Window::GetParent(), vcl::Window::GetPointerPosPixel(), vcl::Window::GetSizePixel(), Size::Height(), HELPWINSTYLE_QUICK, vcl::Window::ImplGetFrameWindow(), tools::Rectangle::Left(), Left, NoAutoPos, NoEvadePointer, vcl::Window::OutputToAbsoluteScreenPixel(), tools::Rectangle::Right(), Right, vcl::Window::SetPosPixel(), Point::setX(), Point::setY(), tools::Rectangle::Top(), Top, tools::Rectangle::TopLeft(), Size::Width(), Point::X(), and Point::Y().

Referenced by ImplShowHelpWindow(), and Help::UpdatePopover().

ImplShowHelpWindow()

void ImplShowHelpWindow	(	vcl::Window *	pParent,
		sal_uInt16	nHelpWinStyle,
		QuickHelpFlags	nStyle,
		const OUString &	rHelpText,
		const Point &	rScreenPos,
		const tools::Rectangle &	rHelpArea
	)

Definition at line 488 of file help.cxx.

References HelpTextWindow::CalcOutSize(), VclPtr< reference_type >::Create(), tools::Time::GetSystemTicks(), HelpSettings::GetTipDelay(), ImplDestroyHelpWindow(), vcl::Window::ImplGetFrame(), ImplGetSVHelpData(), ImplSetHelpWindowPos(), o3tl::make_unsigned(), ImplSVHelpData::mbRequestingHelp, ImplSVHelpData::mnLastHelpHideTime, ImplSVHelpData::mpHelpWin, SAL_WARN_IF, HelpTextWindow::SetHelpArea(), vcl::Window::SetOutputSizePixel(), HelpTextWindow::ShowHelp(), and SalFrame::ShowTooltip().

Referenced by Help::ShowBalloon(), and Help::ShowQuickHelp().