|
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: CCSXHGenericTOC1 class declaration |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef INC_CSXHGENERICTOC1_H_HEADER_INCLUDED_BC050AFE |
|
20 #define INC_CSXHGENERICTOC1_H_HEADER_INCLUDED_BC050AFE |
|
21 |
|
22 #include "CSXHHelpContentBase.h" |
|
23 #include <badesca.h> |
|
24 |
|
25 |
|
26 class CCSXHHelpDataBase; |
|
27 /** |
|
28 * @class CCSXHGenericTOC1 |
|
29 * This class has the information of TOC1 |
|
30 */ |
|
31 class CCSXHGenericTOC1 : public CCSXHHelpContentBase |
|
32 { |
|
33 public: |
|
34 /** |
|
35 * @function ~CCSXHGenericTOC1 |
|
36 * @since S60 3.2 |
|
37 * Destroy the object and release all memory objects |
|
38 */ |
|
39 ~CCSXHGenericTOC1(); |
|
40 /** |
|
41 * @function FillChildDataL |
|
42 * @since S60 3.2 |
|
43 * Fill the array |
|
44 * @param aArray - A pointer to a Descriptor Array |
|
45 */ |
|
46 IMPORT_C virtual void FillChildDataL(CDesCArray* aArray); |
|
47 /** |
|
48 * @function GetChildL |
|
49 * @since S60 3.2 |
|
50 * Fill the array |
|
51 * @param aName - toc1 Name |
|
52 * @return pointer to toc2 type casted to database class |
|
53 */ |
|
54 IMPORT_C virtual CCSXHHelpContentBase* GetChildL(const TDesC& aName); |
|
55 |
|
56 /** |
|
57 * @function InsertChild |
|
58 * @since S60 3.2 |
|
59 * Insert toc2 objects |
|
60 * @param atoc2 - toc2 objects |
|
61 * @param aDeleteObject - boolean, default True |
|
62 * @return ETrue Successful, EFalse otherwise |
|
63 */ |
|
64 TBool InsertChild(CCSXHHelpContentBase* atoc2,TBool aDeleteObject = ETrue); |
|
65 |
|
66 TBool InsertChildWithPriority(CCSXHHelpContentBase* aChild, TBool aDeleteObject = ETrue); |
|
67 /** |
|
68 * @function ResetChildList |
|
69 * @since S60 3.2 |
|
70 * clear Array, delete the objects |
|
71 * @return ETrue Successful, EFalse otherwise |
|
72 */ |
|
73 virtual void ResetChildList(); |
|
74 |
|
75 |
|
76 protected: |
|
77 /** |
|
78 * @function CCSXHGenericTOC1 |
|
79 * @since S60 3.2 |
|
80 * Construct a CCSXHGenericTOC1 |
|
81 * @param aName - TOC1 Name |
|
82 */ |
|
83 CCSXHGenericTOC1(const TDesC& aName, const TInt32 aPriority = 0); |
|
84 |
|
85 /** |
|
86 * @function InitChildList |
|
87 * @since S60 3.2 |
|
88 * Allocate the Memory for Array |
|
89 */ |
|
90 virtual void InitChildList(); |
|
91 /** |
|
92 * @function CopyChildListL |
|
93 * @since S60 3.2 |
|
94 * Copy the content to Descriptor Array |
|
95 * @param aArray - Descriptor Array |
|
96 */ |
|
97 virtual void CopyChildListL(CDesCArray* aArray); |
|
98 |
|
99 /** |
|
100 * @function ConstructChildList |
|
101 * @since S60 3.2 |
|
102 * Fill the toc2 objects in the array |
|
103 * calls ConstructChildListL internally |
|
104 * @return ETrue on Success, EFalse otherwise |
|
105 */ |
|
106 TBool ConstructChildList(); |
|
107 |
|
108 private: |
|
109 /** |
|
110 * @function ConstructChildListL |
|
111 * @since S60 3.2 |
|
112 * Fill the toc2 objects in the array |
|
113 */ |
|
114 void ConstructChildListL(); |
|
115 |
|
116 protected: |
|
117 |
|
118 RPointerArray<CCSXHHelpContentBase> *iChildList; |
|
119 |
|
120 }; |
|
121 |
|
122 |
|
123 |
|
124 #endif /* INC_CSXHGENERICTOC1_H_HEADER_INCLUDED_BC050AFE */ |