xref: /AOO41X/main/sfx2/inc/sfx2/sfxhelp.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef _SFX_HELP_HXX
28*cdf0e10cSrcweir #define _SFX_HELP_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include "sal/config.h"
31*cdf0e10cSrcweir #include "sfx2/dllapi.h"
32*cdf0e10cSrcweir #include "sal/types.h"
33*cdf0e10cSrcweir #include <vcl/help.hxx>
34*cdf0e10cSrcweir #include <tools/string.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir class SfxHelp_Impl;
37*cdf0e10cSrcweir class SfxFrame;
38*cdf0e10cSrcweir class SFX2_DLLPUBLIC SfxHelp : public Help
39*cdf0e10cSrcweir {
40*cdf0e10cSrcweir     String          aTicket;        // for Plugins
41*cdf0e10cSrcweir     String          aUser;
42*cdf0e10cSrcweir 	String			aLanguageStr;
43*cdf0e10cSrcweir 	String			aCountryStr;
44*cdf0e10cSrcweir 	sal_Bool		bIsDebug;
45*cdf0e10cSrcweir     SfxHelp_Impl*   pImp;
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir private:
48*cdf0e10cSrcweir     SAL_DLLPRIVATE sal_Bool Start_Impl( const String& rURL, const Window* pWindow, const String& rKeyword );
49*cdf0e10cSrcweir 	SAL_DLLPRIVATE virtual sal_Bool	SearchKeyword( const XubString& rKeyWord );
50*cdf0e10cSrcweir     SAL_DLLPRIVATE virtual sal_Bool Start( const String& rURL, const Window* pWindow );
51*cdf0e10cSrcweir     SAL_DLLPRIVATE virtual void OpenHelpAgent( const rtl::OString& sHelpId );
52*cdf0e10cSrcweir 	SAL_DLLPRIVATE String GetHelpModuleName_Impl();
53*cdf0e10cSrcweir 	SAL_DLLPRIVATE String CreateHelpURL_Impl( const String& aCommandURL, const String& rModuleName );
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir public:
56*cdf0e10cSrcweir     SfxHelp();
57*cdf0e10cSrcweir     ~SfxHelp();
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir     inline void             SetTicket( const String& rTicket )  { aTicket = rTicket; }
60*cdf0e10cSrcweir     inline void             SetUser( const String& rUser )      { aUser = rUser; }
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir     virtual XubString       GetHelpText( const String&, const Window* pWindow );
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir     static String           CreateHelpURL( const String& aCommandURL, const String& rModuleName );
65*cdf0e10cSrcweir     using Help::OpenHelpAgent;
66*cdf0e10cSrcweir     static void             OpenHelpAgent( SfxFrame* pFrame, const rtl::OString& sHelpId );
67*cdf0e10cSrcweir     static String           GetDefaultHelpModule();
68*cdf0e10cSrcweir     static ::rtl::OUString  GetCurrentModuleIdentifier();
69*cdf0e10cSrcweir };
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir #endif // #ifndef _SFX_HELP_HXX
72*cdf0e10cSrcweir 
73