1 /* |
|
2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: This is a utility class that provides functionality |
|
15 * for parsing command line arguments passed into the |
|
16 * Cshelp application when launched by another application. |
|
17 * |
|
18 */ |
|
19 |
|
20 |
|
21 #ifndef CSHELPCMDLINEPARSER_H |
|
22 #define CSHELPCMDLINEPARSER_H |
|
23 |
|
24 |
|
25 // INCLUDES |
|
26 #include <e32base.h> |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class TCoeHelpContext; |
|
30 |
|
31 // CLASS DECLARATION |
|
32 /** |
|
33 * CCsHlpCmdLineParser class. |
|
34 * to convert a message - that is passed from other app - to contexts |
|
35 * @lib euser.lib |
|
36 * @since 3.2 |
|
37 */ |
|
38 class CCsHlpCmdLineParser : public CBase |
|
39 { |
|
40 public: |
|
41 |
|
42 /** |
|
43 * @function CCsHlpCmdLineParser |
|
44 * @since S60 3.2 |
|
45 * Perform the first phase of two phase construction |
|
46 */ CCsHlpCmdLineParser(); |
|
47 |
|
48 /** |
|
49 * @function ConstructL |
|
50 * @since S60 3.2 |
|
51 * Perform the second phase construction of a CCsHlpCmdLineParser object |
|
52 */ void ConstructL(const TDesC8& aCmdLine); |
|
53 |
|
54 /** |
|
55 * @function ~CCsHlpCmdLineParser |
|
56 * @since S60 3.2 |
|
57 * Destroy the object and release all memory objects |
|
58 */ |
|
59 ~CCsHlpCmdLineParser(); |
|
60 |
|
61 public: |
|
62 /** |
|
63 * Get contexts array |
|
64 * @function ContextListL |
|
65 * @since S60 3.2 |
|
66 * @return help context array |
|
67 */ |
|
68 CArrayFix<TCoeHelpContext>* ContextListL(); |
|
69 |
|
70 private: |
|
71 /** |
|
72 * Get the help Context object |
|
73 * @function GetContext |
|
74 * @since S60 3.2 |
|
75 * @param aContext - Help context object |
|
76 */ |
|
77 void GetContext(TCoeHelpContext& aContext); |
|
78 |
|
79 private: |
|
80 // Parsed data to help context array. |
|
81 CBufFlat* iCmdLine; |
|
82 |
|
83 // Position of iCmdLine |
|
84 TInt iPos; |
|
85 }; |
|
86 |
|
87 #endif // CSHELPCMDLINEPARSER_H |
|
88 |
|
89 // End of File |
|