diff options
Diffstat (limited to 'include/sfx2/sfxhelp.hxx')
-rw-r--r-- | include/sfx2/sfxhelp.hxx | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/include/sfx2/sfxhelp.hxx b/include/sfx2/sfxhelp.hxx new file mode 100644 index 000000000000..9de00f008736 --- /dev/null +++ b/include/sfx2/sfxhelp.hxx @@ -0,0 +1,65 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef _SFX_HELP_HXX +#define _SFX_HELP_HXX + +#include <rtl/ustring.hxx> +#include "sal/config.h" +#include "sfx2/dllapi.h" +#include "sal/types.h" +#include <vcl/help.hxx> + +class SfxHelp_Impl; +class SfxFrame; +class SFX2_DLLPUBLIC SfxHelp : public Help +{ + OUString aTicket; // for Plugins + OUString aUser; + OUString aLanguageStr; + OUString aCountryStr; + sal_Bool bIsDebug; + SfxHelp_Impl* pImp; + +private: + SAL_DLLPRIVATE sal_Bool Start_Impl( const OUString& rURL, const Window* pWindow, const OUString& rKeyword ); + SAL_DLLPRIVATE virtual sal_Bool SearchKeyword( const OUString& rKeyWord ); + SAL_DLLPRIVATE virtual sal_Bool Start( const OUString& rURL, const Window* pWindow ); + SAL_DLLPRIVATE virtual void OpenHelpAgent( const OString& sHelpId ); + SAL_DLLPRIVATE OUString GetHelpModuleName_Impl(); + SAL_DLLPRIVATE OUString CreateHelpURL_Impl( const OUString& aCommandURL, const OUString& rModuleName ); + +public: + SfxHelp(); + ~SfxHelp(); + + inline void SetTicket( const OUString& rTicket ) { aTicket = rTicket; } + inline void SetUser( const OUString& rUser ) { aUser = rUser; } + + virtual OUString GetHelpText( const OUString&, const Window* pWindow ); + + static OUString CreateHelpURL( const OUString& aCommandURL, const OUString& rModuleName ); + using Help::OpenHelpAgent; + static void OpenHelpAgent( SfxFrame* pFrame, const OString& sHelpId ); + static OUString GetDefaultHelpModule(); + static OUString GetCurrentModuleIdentifier(); +}; + +#endif // #ifndef _SFX_HELP_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |