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