LibreOffice Module sfx2 (master) 1
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
SfxHelp Class Referencefinal

#include <sfxhelp.hxx>

Inheritance diagram for SfxHelp:
[legend]
Collaboration diagram for SfxHelp:
[legend]

Public Member Functions

 SfxHelp ()
 
virtual ~SfxHelp () override
 
virtual OUString GetHelpText (const OUString &, const vcl::Window *pWindow) override
 
virtual OUString GetHelpText (const OUString &, const weld::Widget *pWindow) override
 
- Public Member Functions inherited from Help
 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 OUString CreateHelpURL (const OUString &aCommandURL, const OUString &rModuleName)
 
static OUString GetDefaultHelpModule ()
 
static OUString GetCurrentModuleIdentifier ()
 
static bool IsHelpInstalled ()
 
static OUString GetURLHelpText (std::u16string_view)
 
- Static Public Member Functions inherited from Help
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)
 

Private Member Functions

virtual SAL_DLLPRIVATE void SearchKeyword (const OUString &rKeyWord) override
 
virtual SAL_DLLPRIVATE bool Start (const OUString &rURL, weld::Widget *pWidget=nullptr) override
 
virtual SAL_DLLPRIVATE bool Start (const OUString &rURL, const vcl::Window *pWindow) override
 

Static Private Member Functions

static SAL_DLLPRIVATE bool Start_Impl (const OUString &rURL, weld::Widget *pWidget, const OUString &rKeyword)
 
static SAL_DLLPRIVATE OUString GetHelpModuleName_Impl (std::u16string_view rHelpId)
 
static SAL_DLLPRIVATE OUString CreateHelpURL_Impl (const OUString &aCommandURL, const OUString &rModuleName)
 
static SAL_DLLPRIVATE bool Start_Impl (const OUString &rURL, const vcl::Window *pWindow)
 

Private Attributes

bool bIsDebug
 
bool bLaunchingHelp
 

Detailed Description

Definition at line 31 of file sfxhelp.hxx.

Constructor & Destructor Documentation

◆ SfxHelp()

SfxHelp::SfxHelp ( )

Definition at line 342 of file sfxhelp.cxx.

References bIsDebug.

◆ ~SfxHelp()

SfxHelp::~SfxHelp ( )
overridevirtual

Definition at line 354 of file sfxhelp.cxx.

Member Function Documentation

◆ CreateHelpURL()

OUString SfxHelp::CreateHelpURL ( const OUString &  aCommandURL,
const OUString &  rModuleName 
)
static

Definition at line 1380 of file sfxhelp.cxx.

References CreateHelpURL_Impl(), and Application::GetHelp().

Referenced by Start_Impl().

◆ CreateHelpURL_Impl()

OUString SfxHelp::CreateHelpURL_Impl ( const OUString &  aCommandURL,
const OUString &  rModuleName 
)
staticprivate

Definition at line 496 of file sfxhelp.cxx.

References AppendConfigToken(), getDefaultModule_Impl(), and GetHelpAnchor_Impl().

Referenced by CreateHelpURL(), and Start_Impl().

◆ GetCurrentModuleIdentifier()

OUString SfxHelp::GetCurrentModuleIdentifier ( )
static

Definition at line 1391 of file sfxhelp.cxx.

References getCurrentModuleIdentifier_Impl().

Referenced by SfxHelpTextWindow_Impl::InitOnStartupBox(), and SfxApplication::MiscExec_Impl().

◆ GetDefaultHelpModule()

OUString SfxHelp::GetDefaultHelpModule ( )
static

Definition at line 1386 of file sfxhelp.cxx.

References getDefaultModule_Impl().

Referenced by IndexTabPage_Impl::SetFactory().

◆ GetHelpModuleName_Impl()

OUString SfxHelp::GetHelpModuleName_Impl ( std::u16string_view  rHelpId)
staticprivate

Definition at line 448 of file sfxhelp.cxx.

References Exception, getCurrentModuleIdentifier_Impl(), getDefaultModule_Impl(), o3tl::starts_with(), TOOLS_WARN_EXCEPTION, and u.

Referenced by GetHelpText(), and Start_Impl().

◆ GetHelpText() [1/2]

OUString SfxHelp::GetHelpText ( const OUString &  aCommandURL,
const vcl::Window *  pWindow 
)
overridevirtual

Reimplemented from Help.

Definition at line 584 of file sfxhelp.cxx.

References aProperties, bIsDebug, vcl::CommandInfoProvider::GetCommandProperties(), getCurrentModuleIdentifier_Impl(), vcl::Window::GetHelpId(), GetHelpModuleName_Impl(), vcl::Window::GetParent(), and vcl::CommandInfoProvider::GetRealCommandForCommand().

◆ GetHelpText() [2/2]

OUString SfxHelp::GetHelpText ( const OUString &  aCommandURL,
const weld::Widget *  pWindow 
)
overridevirtual

Reimplemented from Help.

Definition at line 625 of file sfxhelp.cxx.

References aProperties, bIsDebug, vcl::CommandInfoProvider::GetCommandProperties(), getCurrentModuleIdentifier_Impl(), GetHelpModuleName_Impl(), vcl::CommandInfoProvider::GetRealCommandForCommand(), and weld::Widget::weld_parent().

◆ GetURLHelpText()

OUString SfxHelp::GetURLHelpText ( std::u16string_view  aURL)
static

Definition at line 666 of file sfxhelp.cxx.

References aURL, SvtSecurityOptions::CtrlClickHyperlink, vcl::KeyCode::GetName(), SvtSecurityOptions::IsOptionSet(), KEY_MOD1, KEY_SPACE, and SfxResId().

◆ IsHelpInstalled()

bool SfxHelp::IsHelpInstalled ( )
static

Definition at line 1396 of file sfxhelp.cxx.

◆ SearchKeyword()

void SfxHelp::SearchKeyword ( const OUString &  rKeyWord)
overrideprivatevirtual

Reimplemented from Help.

Definition at line 684 of file sfxhelp.cxx.

References Start_Impl().

◆ Start() [1/2]

bool SfxHelp::Start ( const OUString &  rURL,
const vcl::Window *  pWindow 
)
overrideprivatevirtual

Reimplemented from Help.

Definition at line 689 of file sfxhelp.cxx.

References bLaunchingHelp, and Start_Impl().

◆ Start() [2/2]

bool SfxHelp::Start ( const OUString &  rURL,
weld::Widget *  pWidget = nullptr 
)
overrideprivatevirtual

Reimplemented from Help.

Definition at line 699 of file sfxhelp.cxx.

References bLaunchingHelp, and Start_Impl().

◆ Start_Impl() [1/2]

bool SfxHelp::Start_Impl ( const OUString &  rURL,
const vcl::Window *  pWindow 
)
staticprivate

Definition at line 1032 of file sfxhelp.cxx.

References AppendConfigToken(), aProperties, comphelper::ConfigurationChanges::create(), CreateHelpURL(), CreateHelpURL_Impl(), TopLevelWindowLocker::decBusy(), vcl::CommandInfoProvider::GetCommandProperties(), getCurrentModuleIdentifier_Impl(), vcl::Window::GetFrameWeld(), vcl::Window::GetHelpId(), GetHelpModuleName_Impl(), vcl::Window::GetParent(), INetURLObject::GetProtocol(), vcl::CommandInfoProvider::GetRealCommandForCommand(), SfxContentHelper::GetResultSet(), VCLUnoHelper::GetWindow(), impl_createHelp(), impl_showOfflineHelp(), impl_showOnlineHelp(), TopLevelWindowLocker::incBusy(), comphelper::LibreOfficeKit::isActive(), SfxContentHelper::IsHelpErrorDocument(), SfxHelpWindow_Impl::loadHelpContent(), RET_OK, SAL_INFO, and SfxHelpWindow_Impl::SetHelpURL().

◆ Start_Impl() [2/2]

bool SfxHelp::Start_Impl ( const OUString &  rURL,
weld::Widget *  pWidget,
const OUString &  rKeyword 
)
staticprivate

Definition at line 1208 of file sfxhelp.cxx.

References AppendConfigToken(), aProperties, comphelper::ConfigurationChanges::create(), CreateHelpURL(), CreateHelpURL_Impl(), TopLevelWindowLocker::decBusy(), vcl::CommandInfoProvider::GetCommandProperties(), getCurrentModuleIdentifier_Impl(), GetHelpModuleName_Impl(), INetURLObject::GetProtocol(), vcl::CommandInfoProvider::GetRealCommandForCommand(), SfxContentHelper::GetResultSet(), VCLUnoHelper::GetWindow(), weld::Widget::help_hierarchy_foreach(), impl_createHelp(), impl_showOfflineHelp(), impl_showOnlineHelp(), TopLevelWindowLocker::incBusy(), comphelper::LibreOfficeKit::isActive(), SfxContentHelper::IsHelpErrorDocument(), SfxHelpWindow_Impl::loadHelpContent(), SfxHelpWindow_Impl::OpenKeyword(), RET_OK, SAL_INFO, and SfxHelpWindow_Impl::SetHelpURL().

Referenced by SearchKeyword(), and Start().

Member Data Documentation

◆ bIsDebug

bool SfxHelp::bIsDebug
private

Definition at line 33 of file sfxhelp.hxx.

Referenced by GetHelpText(), and SfxHelp().

◆ bLaunchingHelp

bool SfxHelp::bLaunchingHelp
private

Definition at line 34 of file sfxhelp.hxx.

Referenced by Start().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:34:23 for LibreOffice Module sfx2 (master) by doxygen 1.9.3