1 hlplch.h

     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // Help Launcher module

    15 // 

    16 //

    17 

    18 #ifndef __HLPLCH_H__

    19 #define __HLPLCH_H__

    20 

    21 #if !defined(__APGTASK_H__)

    22 #include <apgtask.h>

    23 #endif

    24 

    25 #if !defined(__EIKDLL_H__)

    26 #include <eikdll.h>

    27 #endif

    28 

    29 #if !defined(__WSERV_H__)

    30 #include <w32std.h>

    31 #endif

    32 

    33 #if !defined(__COEHELP_H__)

    34 #include <coehelp.h>

    35 #endif

    36 

    37 /** Help application UID. 

    38 @internalComponent

    39 @released

    40 */

    41 const TUid KHlpAppUid={ 0x10005234 };

    42 

    43 /** UID of window message to send to application. 

    44 @internalComponent

    45 @released

    46 */

    47 const TUid KHlpAppWsMsg={ 0x100055c7 };

    48 

    49 /** Maximum length of command line to launch application. 

    50 @internalComponent

    51 @released

    52 */

    53 const TInt KMaxCmdLineLength = 512;

    54 

    55 // resource file name

    56 _LIT(KHelpLauncherResource, "z:\\resource\\apps\\lch.rsc");

    57 

    58 class CHlpCmdLine : public CBase

    59 /**

    60 @internalComponent

    61 @released

    62 */

    63 	{

    64 public:

    65 	static CHlpCmdLine* NewL(CArrayFix<TCoeHelpContext>* aContextList);

    66 	static CHlpCmdLine* NewLC(CArrayFix<TCoeHelpContext>* aContextList);

    67 	~CHlpCmdLine();

    68 public:

    69 	TPtr8 CmdLineL();

    70 private:

    71 	void BuildCmdLineL();

    72 	void AddContextL(TCoeHelpContext& aContext);

    73 private:

    74 	void ConstructL();

    75 	CHlpCmdLine(CArrayFix<TCoeHelpContext>* aContextList);

    76 private:

    77 	CArrayFix<TCoeHelpContext>* iContextList;

    78 	CBufFlat* iCmdLine;

    79 	};

    80 

    81 class HlpLauncher

    82 /** Launches the help application.

    83 

    84 It assumes that such an application is at z:\\Sys\\Bin\\CsHelp.exe

    85 

    86 @publishedAll

    87 @released

    88 */

    89 	{

    90 public:

    91 	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, CArrayFix<TCoeHelpContext>* aContextList);

    92 	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, TUid aUid);

    93 	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession);

    94 private:

    95 	static void DoLaunchHelpApplicationL(RWsSession& aWsSession, const TDesC8& aCmdLine);

    96 	};

    97 

    98 #endif