classicui_plat/help_launcher_api/inc/HLPLCH.H
author hgs
Thu, 29 Jul 2010 14:21:56 +0800
changeset 46 0e1e0022bd03
parent 45 667edd0b8678
permissions -rw-r--r--
201029_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
// Help Launcher module
hgs
parents:
diff changeset
    15
// 
hgs
parents:
diff changeset
    16
//
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef __HLPLCH_H__
hgs
parents:
diff changeset
    19
#define __HLPLCH_H__
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#if !defined(__APGTASK_H__)
hgs
parents:
diff changeset
    22
#include <apgtask.h>
hgs
parents:
diff changeset
    23
#endif
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#if !defined(__EIKDLL_H__)
hgs
parents:
diff changeset
    26
#include <eikdll.h>
hgs
parents:
diff changeset
    27
#endif
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
#if !defined(__WSERV_H__)
hgs
parents:
diff changeset
    30
#include <w32std.h>
hgs
parents:
diff changeset
    31
#endif
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
#if !defined(__COEHELP_H__)
hgs
parents:
diff changeset
    34
#include <coehelp.h>
hgs
parents:
diff changeset
    35
#endif
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
/** Help application UID. 
hgs
parents:
diff changeset
    38
@internalComponent
hgs
parents:
diff changeset
    39
@released
hgs
parents:
diff changeset
    40
*/
hgs
parents:
diff changeset
    41
const TUid KHlpAppUid={ 0x10005234 };
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
/** UID of window message to send to application. 
hgs
parents:
diff changeset
    44
@internalComponent
hgs
parents:
diff changeset
    45
@released
hgs
parents:
diff changeset
    46
*/
hgs
parents:
diff changeset
    47
const TUid KHlpAppWsMsg={ 0x100055c7 };
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
/** Maximum length of command line to launch application. 
hgs
parents:
diff changeset
    52
@internalComponent
hgs
parents:
diff changeset
    53
@released
hgs
parents:
diff changeset
    54
*/
hgs
parents:
diff changeset
    55
const TInt KMaxCmdLineLength = 512;
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
// resource file name
hgs
parents:
diff changeset
    58
_LIT(KHelpLauncherResource, "z:\\resource\\apps\\lch.rsc");
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
class CHlpCmdLine : public CBase
hgs
parents:
diff changeset
    61
/**
hgs
parents:
diff changeset
    62
@internalComponent
hgs
parents:
diff changeset
    63
@released
hgs
parents:
diff changeset
    64
*/
hgs
parents:
diff changeset
    65
	{
hgs
parents:
diff changeset
    66
public:
hgs
parents:
diff changeset
    67
	static CHlpCmdLine* NewL(CArrayFix<TCoeHelpContext>* aContextList);
hgs
parents:
diff changeset
    68
	static CHlpCmdLine* NewLC(CArrayFix<TCoeHelpContext>* aContextList);
hgs
parents:
diff changeset
    69
	~CHlpCmdLine();
hgs
parents:
diff changeset
    70
public:
hgs
parents:
diff changeset
    71
	TPtr8 CmdLineL();
hgs
parents:
diff changeset
    72
private:
hgs
parents:
diff changeset
    73
	void BuildCmdLineL();
hgs
parents:
diff changeset
    74
	void AddContextL(TCoeHelpContext& aContext);
hgs
parents:
diff changeset
    75
private:
hgs
parents:
diff changeset
    76
	void ConstructL();
hgs
parents:
diff changeset
    77
	CHlpCmdLine(CArrayFix<TCoeHelpContext>* aContextList);
hgs
parents:
diff changeset
    78
private:
hgs
parents:
diff changeset
    79
	CArrayFix<TCoeHelpContext>* iContextList;
hgs
parents:
diff changeset
    80
	CBufFlat* iCmdLine;
hgs
parents:
diff changeset
    81
	};
hgs
parents:
diff changeset
    82
	
hgs
parents:
diff changeset
    83
#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
class HlpLauncher
hgs
parents:
diff changeset
    86
/** Launches the help application.
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
It assumes that such an application is at z:\\Sys\\Bin\\CsHelp.exe
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
@publishedAll
hgs
parents:
diff changeset
    91
@released
hgs
parents:
diff changeset
    92
*/
hgs
parents:
diff changeset
    93
	{
hgs
parents:
diff changeset
    94
public:
hgs
parents:
diff changeset
    95
	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, CArrayFix<TCoeHelpContext>* aContextList);
hgs
parents:
diff changeset
    96
	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession, TUid aUid);
hgs
parents:
diff changeset
    97
	IMPORT_C	static void LaunchHelpApplicationL(RWsSession& aWsSession);
hgs
parents:
diff changeset
    98
private:
hgs
parents:
diff changeset
    99
	static void DoLaunchHelpApplicationL(RWsSession& aWsSession, const TDesC8& aCmdLine);
hgs
parents:
diff changeset
   100
	};
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
#endif