include/sfx2/sfxhelp.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SFX2_SFXHELP_HXX
  20 #define INCLUDED_SFX2_SFXHELP_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <sal/config.h>
  24 #include <sfx2/dllapi.h>
  25 #include <sal/types.h>
  26 #include <vcl/help.hxx>
  27
  28 class SFX2_DLLPUBLIC SfxHelp final : public Help
  29 {
  30     bool            bIsDebug;
  31
  32 private:
  33     SAL_DLLPRIVATE static bool Start_Impl( const OUString& rURL, const vcl::Window* pWindow, const OUString& rKeyword );
  34     SAL_DLLPRIVATE static bool Start_Impl(const OUString& rURL, weld::Widget* pWidget, const OUString& rKeyword);
  35     SAL_DLLPRIVATE virtual void SearchKeyword( const OUString& rKeyWord ) override;
  36     SAL_DLLPRIVATE virtual bool Start( const OUString& rURL, const vcl::Window* pWindow ) override;
  37     SAL_DLLPRIVATE virtual bool Start(const OUString& rURL, weld::Widget* pWidget) override;
  38     SAL_DLLPRIVATE static OUString GetHelpModuleName_Impl(const OUString &rHelpId);
  39     SAL_DLLPRIVATE static OUString CreateHelpURL_Impl( const OUString& aCommandURL, const OUString& rModuleName );
  40
  41 public:
  42     SfxHelp();
  43     virtual ~SfxHelp() override;
  44
  45     virtual OUString        GetHelpText(const OUString&, const vcl::Window* pWindow) override;
  46     virtual OUString        GetHelpText(const OUString&, const weld::Widget* pWindow) override;
  47
  48     static OUString         CreateHelpURL( const OUString& aCommandURL, const OUString& rModuleName );
  49     static OUString         GetDefaultHelpModule();
  50     static OUString         GetCurrentModuleIdentifier();
  51     // Check for built-in help
  52     static bool             IsHelpInstalled();
  53
  54     static OUString GetURLHelpText(const OUString&);
  55 };
  56
  57 #endif // INCLUDED_SFX2_SFXHELP_HXX
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */