LibreOffice Module vcl (master)  1
Public Member Functions | Static Public Member Functions | List of all members
Help Class Reference

#include <help.hxx>

Public Member Functions

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

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 voidShowPopover (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 ( )

Definition at line 45 of file help.cxx.

Help::~Help ( )
virtual

Definition at line 49 of file help.cxx.

Member Function Documentation

void Help::DisableBalloonHelp ( )
static

Definition at line 145 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbBalloonHelp.

void Help::DisableContextHelp ( )
static

Definition at line 82 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbContextHelp.

void Help::DisableExtHelp ( )
static

Definition at line 97 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbExtHelp.

void Help::DisableQuickHelp ( )
static

Definition at line 168 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbQuickHelp.

void Help::EnableBalloonHelp ( )
static

Definition at line 140 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbBalloonHelp.

void Help::EnableContextHelp ( )
static

Definition at line 77 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbContextHelp.

void Help::EnableExtHelp ( )
static

Definition at line 92 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbExtHelp.

void Help::EnableQuickHelp ( )
static

Definition at line 163 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbQuickHelp.

bool Help::EndExtHelp ( )
static
OUString Help::GetHelpText ( const OUString &  aHelpURL,
const vcl::Window pWindow 
)
virtual
OUString Help::GetHelpText ( const OUString &  aHelpURL,
const weld::Widget pWidget 
)
virtual

Definition at line 72 of file help.cxx.

void Help::HideBalloonAndQuickHelp ( )
static
void Help::HidePopover ( vcl::Window const *  pParent,
void nId 
)
static
bool Help::IsBalloonHelpEnabled ( )
static

Definition at line 150 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbBalloonHelp.

bool Help::IsContextHelpEnabled ( )
static

Definition at line 87 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbContextHelp.

bool Help::IsExtHelpEnabled ( )
static

Definition at line 102 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbExtHelp.

bool Help::IsQuickHelpEnabled ( )
static

Definition at line 173 of file help.cxx.

References ImplGetSVData(), ImplSVData::maHelpData, and ImplSVHelpData::mbQuickHelp.

void Help::SearchKeyword ( const OUString &  rKeyWord)
virtual

Definition at line 63 of file help.cxx.

void Help::ShowBalloon ( vcl::Window pParent,
const Point rScreenPos,
const tools::Rectangle rRect,
const OUString &  rHelpText 
)
static
void * Help::ShowPopover ( vcl::Window pParent,
const tools::Rectangle rScreenRect,
const OUString &  rText,
QuickHelpFlags  nStyle 
)
static
void Help::ShowQuickHelp ( vcl::Window pParent,
const tools::Rectangle rScreenRect,
const OUString &  rHelpText,
QuickHelpFlags  nStyle = QuickHelpFlags::NONE 
)
static
bool Help::Start ( const OUString &  rHelpId,
const vcl::Window pWindow 
)
virtual

Definition at line 53 of file help.cxx.

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

bool Help::Start ( const OUString &  rHelpId,
weld::Widget pWidget 
)
virtual

Definition at line 58 of file help.cxx.

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

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