1.1 --- a/epoc32/include/app/hlpmodel.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/app/hlpmodel.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -1,9 +1,9 @@
1.4 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 // All rights reserved.
1.6 // This component and the accompanying materials are made available
1.7 -// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// under the terms of "Eclipse Public License v1.0"
1.9 // which accompanies this distribution, and is available
1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.12 //
1.13 // Initial Contributors:
1.14 // Nokia Corporation - initial contribution.
1.15 @@ -22,7 +22,6 @@
1.16 #include <txtmrtsr.h> // For MRichTextStoreResolver
1.17 #include <gdi.h> // For MPictureFactory
1.18 #include <d32dbms.h>
1.19 -
1.20 // Help model includes
1.21 #include "hlpconstants.h"
1.22
1.23 @@ -38,17 +37,59 @@
1.24
1.25 // Typedefs
1.26 /**
1.27 -@internalComponent
1.28 +@publishedAll
1.29 @released
1.30 */
1.31 typedef CArrayPtrFlat<CHlpDatabase> CHlpDatabases;
1.32
1.33 /**
1.34 +@publishedAll
1.35 +@released
1.36 +*/
1.37 +typedef CArrayPtrFlat<CHlpFileEntry> CHlpFileList;
1.38 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.39 +/** Maximum Title column.
1.40 +@publishedAll
1.41 +@released
1.42 +*/
1.43 +const TInt KMaxTitleColumn = 120;
1.44 +#endif
1.45 +
1.46 +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
1.47 +/**
1.48 @internalComponent
1.49 @released
1.50 */
1.51 -typedef CArrayPtrFlat<CHlpFileEntry> CHlpFileList;
1.52 +const TInt KHlpModelDefaultNumberOfImagesForV6Point2Files = 1;
1.53 +/**
1.54 +@internalComponent
1.55 +@released
1.56 +*/
1.57 +const TInt KHlpModelMaximumNumberOfImagesForV6Point2Files = 3;
1.58 +//
1.59 +/** Default zoom factor for small zoom size.
1.60 +@internalComponent
1.61 +@released
1.62 +*/
1.63 +const TInt KHlpModelZoomFactorSmall = 750;
1.64 +/** Default zoom factor for medium zoom size.
1.65 +@internalComponent
1.66 +@released
1.67 +*/
1.68 +const TInt KHlpModelZoomFactorMedium = 1000;
1.69 +/** Default zoom factor for large zoom size.
1.70 +@internalComponent
1.71 +@released
1.72 +*/
1.73 +const TInt KHlpModelZoomFactorLarge = 1250;
1.74
1.75 +/** Default zoom factor for medium zoom size as real number.
1.76 +@internalComponent
1.77 +@released
1.78 +*/
1.79 +const TReal KHlpModelDefaultZoomFactorAsRealNumber = 1000.0;
1.80 +
1.81 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.82
1.83 class MHlpModelObserver
1.84 /** Client callback inteface to receive events from the help model.
1.85 @@ -64,12 +105,10 @@
1.86 virtual void HandleModelEventL(TInt aEvent) = 0;
1.87 };
1.88
1.89 -//
1.90 -// Internal API to handle events reported by the search engine
1.91 -//
1.92 +
1.93 class MHlpDbObserver
1.94 -/**
1.95 -@internalComponent
1.96 +/** Internal API to handle events reported by the search engine
1.97 +@publishedAll
1.98 @released
1.99 */
1.100 {
1.101 @@ -80,7 +119,10 @@
1.102 //
1.103 // Search types (these should be named, but SC cannot be broken until v7.0
1.104 //
1.105 -/** Defines the search types for use with CHlpModel::SearchL(). */
1.106 +/** Defines the search types for use with CHlpModel::SearchL().
1.107 +@publishedAll
1.108 +@released
1.109 +*/
1.110 enum
1.111 {
1.112 /** Gets a list of index entries for all help files.
1.113 @@ -137,6 +179,10 @@
1.114 // Search progress responses (this should be scoped as members of MHlpModelObserver
1.115 // and should also be named, but SC cannot be broken until v7.0
1.116 //
1.117 +/** Search progress responses
1.118 +@publishedAll
1.119 +@released
1.120 +*/
1.121 enum
1.122 {
1.123 ENoRecordsFound,
1.124 @@ -147,7 +193,10 @@
1.125 //
1.126 // Search progress responses (ditto for naming and scoping)
1.127 //
1.128 -/** Help model search result events*/
1.129 +/** Help model search result events
1.130 +@publishedAll
1.131 +@released
1.132 +*/
1.133 enum
1.134 {
1.135 /** The search returned a category list.
1.136 @@ -191,8 +240,13 @@
1.137 /** The search has been cancelled. */
1.138 EHlpSearchCancelled
1.139 };
1.140 +
1.141 + // Constants
1.142
1.143 -/** Defines help model zoom sizes. */
1.144 +/** Defines help model zoom sizes.
1.145 +@publishedAll
1.146 +@released
1.147 +*/
1.148 enum THlpZoomState
1.149 {
1.150 /** Small zoom. */
1.151 @@ -203,20 +257,6 @@
1.152 EHlpZoomStateLarge = 2
1.153 };
1.154
1.155 -// Constants
1.156 -const TInt KHlpModelDefaultNumberOfImagesForV6Point2Files = 1;
1.157 -const TInt KHlpModelMaximumNumberOfImagesForV6Point2Files = 3;
1.158 -//
1.159 -/** Default zoom factor for small zoom size. */
1.160 -const TInt KHlpModelZoomFactorSmall = 750;
1.161 -/** Default zoom factor for medium zoom size. */
1.162 -const TInt KHlpModelZoomFactorMedium = 1000;
1.163 -/** Default zoom factor for large zoom size. */
1.164 -const TInt KHlpModelZoomFactorLarge = 1250;
1.165 -//
1.166 -/** Default zoom factor for medium zoom size as real number. */
1.167 -const TReal KHlpModelDefaultZoomFactorAsRealNumber = 1000.0;
1.168 -
1.169
1.170 class CHlpItem : public CBase
1.171 /** Encapsulates an individual item in a help file.
1.172 @@ -277,9 +317,9 @@
1.173
1.174
1.175
1.176 -///////////////////////////////////////////////////////////////////////////////////////
1.177 +//
1.178 // ----> MHlpTitleArray
1.179 -///////////////////////////////////////////////////////////////////////////////////////
1.180 +//
1.181 class MHlpTitleArray : public MDesCArray
1.182 /** Interface to get a topic ID from an array index.
1.183 @publishedAll
1.184 @@ -296,9 +336,9 @@
1.185
1.186
1.187
1.188 -///////////////////////////////////////////////////////////////////////////////////////
1.189 +//
1.190 // ----> CHlpList
1.191 -///////////////////////////////////////////////////////////////////////////////////////
1.192 +//
1.193 class CHlpList : public CBase, public MHlpTitleArray
1.194 /** A list of help items (CHlpItem objects).
1.195 @publishedAll
1.196 @@ -336,9 +376,9 @@
1.197
1.198
1.199
1.200 -///////////////////////////////////////////////////////////////////////////////////////
1.201 +//
1.202 // ----> CHlpTopic
1.203 -///////////////////////////////////////////////////////////////////////////////////////
1.204 +//
1.205 class CHlpTopic : public CBase
1.206 /** Encapsulates a help topic.
1.207
1.208 @@ -392,9 +432,9 @@
1.209
1.210
1.211
1.212 -///////////////////////////////////////////////////////////////////////////////////////
1.213 +//
1.214 // ----> CHlpModel
1.215 -///////////////////////////////////////////////////////////////////////////////////////
1.216 +//
1.217 class CHlpModel : public CBase, public MHlpDbObserver, public MPictureFactory, public MRichTextStoreResolver
1.218 /** Help model interface.
1.219
1.220 @@ -528,13 +568,9 @@
1.221 CArrayFix<TInt>* iZoomFactors;
1.222 };
1.223
1.224 -
1.225 -
1.226 -
1.227 -
1.228 -///////////////////////////////////////////////////////////////////////////////////////
1.229 +//
1.230 // ----> CHlpModel (inlines)
1.231 -///////////////////////////////////////////////////////////////////////////////////////
1.232 +//
1.233 inline TInt CHlpModel::DatabaseCount() const
1.234 {
1.235 return iDatabases->Count();
1.236 @@ -555,3 +591,4 @@
1.237
1.238
1.239 #endif
1.240 +