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