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 SfxHelp_Impl;
  29 class SfxFrame;
  30 class SFX2_DLLPUBLIC SfxHelp : public Help
  31 {
  32     OUString        aTicket;        // for Plugins
  33     OUString        aUser;
  34     sal_Bool        bIsDebug;
  35     SfxHelp_Impl*   pImp;
  36
  37 private:
  38     SAL_DLLPRIVATE sal_Bool Start_Impl( const OUString& rURL, const Window* pWindow, const OUString& rKeyword );
  39     SAL_DLLPRIVATE virtual sal_Bool SearchKeyword( const OUString& rKeyWord );
  40     SAL_DLLPRIVATE virtual sal_Bool Start( const OUString& rURL, const Window* pWindow );
  41     SAL_DLLPRIVATE OUString GetHelpModuleName_Impl();
  42     SAL_DLLPRIVATE OUString CreateHelpURL_Impl( const OUString& aCommandURL, const OUString& rModuleName );
  43
  44 public:
  45     SfxHelp();
  46     ~SfxHelp();
  47
  48     inline void             SetTicket( const OUString& rTicket )  { aTicket = rTicket; }
  49     inline void             SetUser( const OUString& rUser )      { aUser = rUser; }
  50
  51     virtual OUString        GetHelpText( const OUString&, const Window* pWindow );
  52
  53     static OUString         CreateHelpURL( const OUString& aCommandURL, const OUString& rModuleName );
  54     static OUString         GetDefaultHelpModule();
  55     static OUString         GetCurrentModuleIdentifier();
  56 };
  57
  58 #endif // INCLUDED_SFX2_SFXHELP_HXX
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */