72 /* |
72 /* |
73 * Check whether master index exist |
73 * Check whether master index exist |
74 * Since Z based helps must exist |
74 * Since Z based helps must exist |
75 * Usage: to determine Help was launched before |
75 * Usage: to determine Help was launched before |
76 */ |
76 */ |
77 TBool IndexFileExists(); |
77 TBool IndexFileExistsL(); |
78 |
78 |
79 /* |
79 /* |
80 * create temporary index file |
80 * create temporary index file |
81 * this file will be saved to C:\\private\\<help-uid>\\<aDrive>\\<lang-id>\\ |
81 * this file will be saved to C:\\private\\<help-uid>\\<aDrive>\\<lang-id>\\ |
82 * @param: aDrive Drive information |
82 * @param: aDrive Drive information |
83 */ |
83 */ |
84 void BeginIndexFile( const TChar& aDrive ); |
84 void BeginIndexFileL( const TChar& aDrive ); |
85 |
85 |
86 /* |
86 /* |
87 * close the temporary index file, and rename it to index.xml formally |
87 * close the temporary index file, and rename it to index.xml formally |
88 * tmp.xml -> index.xml |
88 * tmp.xml -> index.xml |
89 * this function can backup index.xml, once exception happens |
89 * this function can backup index.xml, once exception happens |
100 * Get proper locale, and append it to descriptor |
100 * Get proper locale, and append it to descriptor |
101 * for more information about proper locale |
101 * for more information about proper locale |
102 * please refer to BaflUtils::GetDowngradePathL |
102 * please refer to BaflUtils::GetDowngradePathL |
103 * @param aDir[out] append proper locale |
103 * @param aDir[out] append proper locale |
104 */ |
104 */ |
105 void AppendLocale( TDes& aDir ); |
105 void AppendLocaleL( TDes& aDir ); |
106 |
106 |
107 /* |
107 /* |
108 * Delete master index file, particular in C: or E: or F: (user disk) |
108 * Delete master index file, particular in C: or E: or F: (user disk) |
109 * this will only occur when user remove all custom helps, no more helps folder |
109 * this will only occur when user remove all custom helps, no more helps folder |
110 * in this case, custom index mustn't exist. |
110 * in this case, custom index mustn't exist. |
111 * @param aDrive the file to be deleted |
111 * @param aDrive the file to be deleted |
112 */ |
112 */ |
113 void DeleteIndexFile( const TChar& aDrive ); |
113 void DeleteIndexFileL( const TChar& aDrive ); |
114 |
114 |
115 /* |
115 /* |
116 * Check if helps folder changed |
116 * Check if helps folder changed |
117 * changes include: |
117 * changes include: |
118 * A: install new application |
118 * A: install new application |
119 * B: uninstall (if unistall all helps, custom helps folder will also removed) |
119 * B: uninstall (if unistall all helps, custom helps folder will also removed) |
120 * C: user changed the language |
120 * C: user changed the language |
121 * D: user restored the cell phone |
121 * D: user restored the cell phone |
122 * @param aName[out] return help app private path in C |
122 * @param aName[out] return help app private path in C |
123 */ |
123 */ |
124 TInt CheckDirChange( const TChar& aDrive ); |
124 TInt CheckDirChangeL( const TChar& aDrive ); |
125 |
125 |
126 private: |
126 private: |
127 |
127 |
128 /* |
128 /* |
129 * two-phase constructor, private |
129 * two-phase constructor, private |