epoc32/include/app/hlplch.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.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 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    50 
    51 /** Maximum length of command line to launch application. 
    52 @internalComponent
    53 @released
    54 */
    55 const TInt KMaxCmdLineLength = 512;
    56 
    57 // resource file name
    58 _LIT(KHelpLauncherResource, "z:\\resource\\apps\\lch.rsc");
    59 
    60 class CHlpCmdLine : public CBase
    61 /**
    62 @internalComponent
    63 @released
    64 */
    65 	{
    66 public:
    67 	static CHlpCmdLine* NewL(CArrayFix<TCoeHelpContext>* aContextList);
    68 	static CHlpCmdLine* NewLC(CArrayFix<TCoeHelpContext>* aContextList);
    69 	~CHlpCmdLine();
    70 public:
    71 	TPtr8 CmdLineL();
    72 private:
    73 	void BuildCmdLineL();
    74 	void AddContextL(TCoeHelpContext& aContext);
    75 private:
    76 	void ConstructL();
    77 	CHlpCmdLine(CArrayFix<TCoeHelpContext>* aContextList);
    78 private:
    79 	CArrayFix<TCoeHelpContext>* iContextList;
    80 	CBufFlat* iCmdLine;
    81 	};
    82 	
    83 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
    84 
    85 class HlpLauncher
    86 /** Launches the help application.
    87 
    88 It assumes that such an application is at z:\\Sys\\Bin\\CsHelp.exe
    89 
    90 @publishedAll
    91 @released
    92 */
    93 	{
    94 public:
    95 	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, CArrayFix<TCoeHelpContext>* aContextList);
    96 	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, TUid aUid);
    97 	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession);
    98 private:
    99 	static void DoLaunchHelpApplicationL(RWsSession& aWsSession, const TDesC8& aCmdLine);
   100 	};
   101 
   102 #endif