Help Class Reference

#include <help.hxx>

Public Member Functions
	Help ()
virtual	~Help ()
virtual bool	Start (const OUString &rHelpId, weld::Widget *pWidget=nullptr)
virtual void	SearchKeyword (const OUString &rKeyWord)
virtual OUString	GetHelpText (const OUString &aHelpURL, const weld::Widget *pWidget)
virtual bool	Start (const OUString &rHelpId, const vcl::Window *pWindow)
virtual OUString	GetHelpText (const OUString &aHelpURL, const vcl::Window *pWindow)

Static Public Member Functions
static void	EnableContextHelp ()
static void	DisableContextHelp ()
static bool	IsContextHelpEnabled ()
static void	EnableExtHelp ()
static void	DisableExtHelp ()
static bool	IsExtHelpEnabled ()
static bool	StartExtHelp ()
static bool	EndExtHelp ()
static void	EnableBalloonHelp ()
static void	DisableBalloonHelp ()
static bool	IsBalloonHelpEnabled ()
static void	ShowBalloon (vcl::Window *pParent, const Point &rScreenPos, const tools::Rectangle &, const OUString &rHelpText)
static void	EnableQuickHelp ()
static void	DisableQuickHelp ()
static bool	IsQuickHelpEnabled ()
static void	ShowQuickHelp (vcl::Window *pParent, const tools::Rectangle &rScreenRect, const OUString &rHelpText, QuickHelpFlags nStyle=QuickHelpFlags::NONE)
static void	HideBalloonAndQuickHelp ()
static void *	ShowPopover (vcl::Window *pParent, const tools::Rectangle &rScreenRect, const OUString &rText, QuickHelpFlags nStyle)
static void	UpdatePopover (void *nId, vcl::Window *pParent, const tools::Rectangle &rScreenRect, const OUString &rText)
static void	HidePopover (vcl::Window const *pParent, void *nId)

Detailed Description

Definition at line 60 of file help.hxx.

Constructor & Destructor Documentation

Help()

Help::Help

(

)

Definition at line 45 of file help.cxx.

~Help()

Help::~Help ( )

virtual

Definition at line 49 of file help.cxx.

Member Function Documentation

DisableBalloonHelp()

void Help::DisableBalloonHelp ( )

static

Definition at line 147 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbBalloonHelp.

DisableContextHelp()

void Help::DisableContextHelp ( )

static

Definition at line 82 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbContextHelp.

DisableExtHelp()

void Help::DisableExtHelp ( )

static

Definition at line 97 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbExtHelp.

DisableQuickHelp()

void Help::DisableQuickHelp ( )

static

Definition at line 170 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbQuickHelp.

EnableBalloonHelp()

void Help::EnableBalloonHelp ( )

static

Definition at line 142 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbBalloonHelp.

EnableContextHelp()

void Help::EnableContextHelp ( )

static

Definition at line 77 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbContextHelp.

EnableExtHelp()

void Help::EnableExtHelp ( )

static

Definition at line 92 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbExtHelp.

EnableQuickHelp()

void Help::EnableQuickHelp ( )

static

Definition at line 165 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbQuickHelp.

EndExtHelp()

bool Help::EndExtHelp ( )

static

Definition at line 125 of file help.cxx.

References vcl::Window::ImplGenerateMouseMove(), ImplGetSVData(), ImplGetSVHelpData(), ImplSVData::maFrameData, ImplSVHelpData::mbBalloonHelp, ImplSVHelpData::mbExtHelp, ImplSVHelpData::mbExtHelpMode, ImplSVHelpData::mbOldBalloonMode, and ImplSVFrameData::mpAppWin.

Referenced by ImplHandleClose(), ImplHandleKey(), and ImplHandleMouseEvent().

GetHelpText() [1/2]

OUString Help::GetHelpText ( const OUString &  aHelpURL, const vcl::Window *  pWindow  )

virtual

Definition at line 67 of file help.cxx.

GetHelpText() [2/2]

OUString Help::GetHelpText ( const OUString &  aHelpURL, const weld::Widget *  pWidget  )

virtual

Definition at line 72 of file help.cxx.

Referenced by vcl::Window::GetHelpText(), HeaderBar::GetHelpText(), StatusBar::GetHelpText(), Menu::ImplGetHelpText(), and ToolBox::ImplGetHelpText().

HideBalloonAndQuickHelp()

void Help::HideBalloonAndQuickHelp ( )

static

Definition at line 193 of file help.cxx.

References ImplDestroyHelpWindow(), ImplGetSVHelpData(), vcl::Window::IsVisible(), and ImplSVHelpData::mpHelpWin.

HidePopover()

void Help::HidePopover ( vcl::Window const *  pParent, void *  nId  )

static

Definition at line 241 of file help.cxx.

References VclPtr< reference_type >::disposeAndClear(), tools::Time::GetSystemTicks(), vcl::Window::Hide(), SalFrame::HidePopover(), vcl::Window::ImplGetFrame(), vcl::Window::ImplGetFrameWindow(), ImplGetSVHelpData(), vcl::Window::ImplUpdateAll(), ImplSVHelpData::mnLastHelpHideTime, and nId.

IsBalloonHelpEnabled()

bool Help::IsBalloonHelpEnabled ( )

static

Definition at line 152 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbBalloonHelp.

IsContextHelpEnabled()

bool Help::IsContextHelpEnabled ( )

static

Definition at line 87 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbContextHelp.

IsExtHelpEnabled()

bool Help::IsExtHelpEnabled ( )

static

Definition at line 102 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbExtHelp.

IsQuickHelpEnabled()

bool Help::IsQuickHelpEnabled ( )

static

Definition at line 175 of file help.cxx.

References ImplGetSVHelpData(), and ImplSVHelpData::mbQuickHelp.

SearchKeyword()

void Help::SearchKeyword ( const OUString &  rKeyWord )

virtual

Definition at line 63 of file help.cxx.

ShowBalloon()

void Help::ShowBalloon ( vcl::Window *  pParent, const Point &  rScreenPos, const tools::Rectangle &  rRect, const OUString &  rHelpText  )

static

Definition at line 157 of file help.cxx.

References HELPWINSTYLE_BALLOON, ImplShowHelpWindow(), and NONE.

Referenced by MenuWindow::ImplHandleHelpEvent(), vcl::Window::RequestHelp(), HeaderBar::RequestHelp(), SplitWindow::RequestHelp(), StatusBar::RequestHelp(), TabControl::RequestHelp(), ToolBox::RequestHelp(), and ImplBorderWindow::RequestHelp().

ShowPopover()

void * Help::ShowPopover ( vcl::Window *  pParent, const tools::Rectangle &  rScreenRect, const OUString &  rText, QuickHelpFlags  nStyle  )

static

Definition at line 200 of file help.cxx.

References VclPtr< reference_type >::get(), HELPWINSTYLE_BALLOON, HELPWINSTYLE_QUICK, vcl::Window::ImplGetFrame(), nId, SalFrame::ShowPopover(), TipStyleBalloon, and UpdatePopover().

ShowQuickHelp()

void Help::ShowQuickHelp ( vcl::Window *  pParent, const tools::Rectangle &  rScreenRect, const OUString &  rHelpText, QuickHelpFlags  nStyle = QuickHelpFlags::NONE  )

static

Definition at line 180 of file help.cxx.

References vcl::Window::GetPointerPosPixel(), HELPWINSTYLE_BALLOON, HELPWINSTYLE_QUICK, ImplShowHelpWindow(), NoAutoPos, vcl::Window::OutputToScreenPixel(), and TipStyleBalloon.

Referenced by MenuWindow::ImplHandleHelpEvent(), VclDrawingArea::RequestHelp(), vcl::Window::RequestHelp(), SvImpLBox::RequestHelp(), SvxIconChoiceCtrl_Impl::RequestHelp(), HeaderBar::RequestHelp(), SplitWindow::RequestHelp(), StatusBar::RequestHelp(), TabControl::RequestHelp(), ToolBox::RequestHelp(), SvTreeListBox::RequestHelp(), ImplBorderWindow::RequestHelp(), and Calendar::RequestHelp().

Start() [1/2]

bool Help::Start ( const OUString &  rHelpId, const vcl::Window *  pWindow  )

virtual

Definition at line 53 of file help.cxx.

Start() [2/2]

bool Help::Start ( const OUString &  rHelpId, weld::Widget *  pWidget = nullptr  )

virtual

Definition at line 58 of file help.cxx.

Referenced by SalInstanceWindow::help(), IMPL_LINK(), MenuWindow::ImplHandleHelpEvent(), and vcl::Window::RequestHelp().

StartExtHelp()

bool Help::StartExtHelp ( )

static

Definition at line 107 of file help.cxx.

References vcl::Window::ImplGenerateMouseMove(), ImplGetSVData(), ImplGetSVHelpData(), ImplSVData::maFrameData, ImplSVHelpData::mbBalloonHelp, ImplSVHelpData::mbExtHelp, ImplSVHelpData::mbExtHelpMode, ImplSVHelpData::mbOldBalloonMode, and ImplSVFrameData::mpAppWin.

Referenced by ImplHandleKey().

UpdatePopover()

void Help::UpdatePopover ( void *  nId, vcl::Window *  pParent, const tools::Rectangle &  rScreenRect, const OUString &  rText  )

static

Definition at line 220 of file help.cxx.

References HelpTextWindow::CalcOutSize(), ENSURE_OR_RETURN_VOID, vcl::Window::GetPointerPosPixel(), HelpTextWindow::GetStyle(), HelpTextWindow::GetWinStyle(), vcl::Window::ImplGetFrame(), ImplSetHelpWindowPos(), vcl::Window::Invalidate(), nId, vcl::Window::OutputToScreenPixel(), HelpTextWindow::SetHelpText(), vcl::Window::SetOutputSizePixel(), and SalFrame::UpdatePopover().

Referenced by ShowPopover().

---

The documentation for this class was generated from the following files:

• help.hxx
• help.cxx