epoc32/include/mw/hlplch.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/hlplch.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,102 @@
     1.4 +// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// Help Launcher module
    1.18 +// 
    1.19 +//
    1.20 +
    1.21 +#ifndef __HLPLCH_H__
    1.22 +#define __HLPLCH_H__
    1.23 +
    1.24 +#if !defined(__APGTASK_H__)
    1.25 +#include <apgtask.h>
    1.26 +#endif
    1.27 +
    1.28 +#if !defined(__EIKDLL_H__)
    1.29 +#include <eikdll.h>
    1.30 +#endif
    1.31 +
    1.32 +#if !defined(__WSERV_H__)
    1.33 +#include <w32std.h>
    1.34 +#endif
    1.35 +
    1.36 +#if !defined(__COEHELP_H__)
    1.37 +#include <coehelp.h>
    1.38 +#endif
    1.39 +
    1.40 +/** Help application UID. 
    1.41 +@internalComponent
    1.42 +@released
    1.43 +*/
    1.44 +const TUid KHlpAppUid={ 0x10005234 };
    1.45 +
    1.46 +/** UID of window message to send to application. 
    1.47 +@internalComponent
    1.48 +@released
    1.49 +*/
    1.50 +const TUid KHlpAppWsMsg={ 0x100055c7 };
    1.51 +
    1.52 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    1.53 +
    1.54 +/** Maximum length of command line to launch application. 
    1.55 +@internalComponent
    1.56 +@released
    1.57 +*/
    1.58 +const TInt KMaxCmdLineLength = 512;
    1.59 +
    1.60 +// resource file name
    1.61 +_LIT(KHelpLauncherResource, "z:\\resource\\apps\\lch.rsc");
    1.62 +
    1.63 +class CHlpCmdLine : public CBase
    1.64 +/**
    1.65 +@internalComponent
    1.66 +@released
    1.67 +*/
    1.68 +	{
    1.69 +public:
    1.70 +	static CHlpCmdLine* NewL(CArrayFix<TCoeHelpContext>* aContextList);
    1.71 +	static CHlpCmdLine* NewLC(CArrayFix<TCoeHelpContext>* aContextList);
    1.72 +	~CHlpCmdLine();
    1.73 +public:
    1.74 +	TPtr8 CmdLineL();
    1.75 +private:
    1.76 +	void BuildCmdLineL();
    1.77 +	void AddContextL(TCoeHelpContext& aContext);
    1.78 +private:
    1.79 +	void ConstructL();
    1.80 +	CHlpCmdLine(CArrayFix<TCoeHelpContext>* aContextList);
    1.81 +private:
    1.82 +	CArrayFix<TCoeHelpContext>* iContextList;
    1.83 +	CBufFlat* iCmdLine;
    1.84 +	};
    1.85 +	
    1.86 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
    1.87 +
    1.88 +class HlpLauncher
    1.89 +/** Launches the help application.
    1.90 +
    1.91 +It assumes that such an application is at z:\\Sys\\Bin\\CsHelp.exe
    1.92 +
    1.93 +@publishedAll
    1.94 +@released
    1.95 +*/
    1.96 +	{
    1.97 +public:
    1.98 +	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, CArrayFix<TCoeHelpContext>* aContextList);
    1.99 +	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, TUid aUid);
   1.100 +	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession);
   1.101 +private:
   1.102 +	static void DoLaunchHelpApplicationL(RWsSession& aWsSession, const TDesC8& aCmdLine);
   1.103 +	};
   1.104 +
   1.105 +#endif