--- a/menufw/hierarchynavigator/hnmetadatamodel/inc/hnmdmodel.h Thu Dec 17 08:40:49 2009 +0200
+++ b/menufw/hierarchynavigator/hnmetadatamodel/inc/hnmdmodel.h Thu Jan 07 12:39:41 2010 +0200
@@ -11,7 +11,7 @@
*
* Contributors:
*
-* Description:
+* Description:
*
*/
@@ -21,7 +21,7 @@
#define C_HNMDMODEL_H
#include <e32base.h>
-#include <xmlengelement.h>
+#include <xmlengelement.h>
#include <liwgenericparam.h>
#include <eikenv.h>
#include "hnglobals.h"
@@ -44,19 +44,19 @@
/**
* Type of the property.
- *
+ *
* @ingroup group_hnmetadatamodel
*/
enum TPropertyType
{
EUndefined = 0,
EGenre,
- EVisualItemCount
+ EVisualItemCount
};
/**
* Mode type.
- *
+ *
* @ingroup group_hnmetadatamodel
*/
enum TMdMode
@@ -69,72 +69,72 @@
* Common pointers.
*
* @since S60 5.0
- * @ingroup group_hnmetadatamodel
+ * @ingroup group_hnmetadatamodel
*/
struct THnMdCommonPointers
- {
+ {
/**
* Not own - Localization.
*/
CHnMdLocalization* iLocalization;
-
+
/**
* Not own - Query generator.
*/
THnIdGenerator* iIdGenerator;
-
+
/**
* Not own - Suite model container.
*/
CHnSuiteModelContainer* iContainer;
-
+
/**
* Not own - Meta data model.
*/
CHnMdModel* iModel;
-
+
/**
* Not own - Xml model provider.
*/
CHnXmlModelProvider* iXmlModelProvider;
-
+
/**
* Not own - Cache for bitmap and mask ids.
*/
CHnBitmapIdCache* iBitmapIdCache;
-
+
/**
* Not own - Model event observer.
*/
MHnMdModelEventObserver* iModelEventObserver;
-
+
/**
* Not own - Edit mode interface.
*/
MHnEditModeInterface* iEditModeInterface;
-
+
/**
* Not own - Handler to file server session;
- */
+ */
RFs& iFs;
-
+
/**
* Gets static pointer from TLS.
*/
static THnMdCommonPointers* Static() {return (THnMdCommonPointers*)Dll::Tls(); }
-
+
/**
* Sets pointer to TLS.
- *
+ *
* @param aCmnPtrs Pointer to set
*/
static void SetStatic( THnMdCommonPointers* aCmnPtrs ) { Dll::SetTls(aCmnPtrs); }
-
- private:
+
+ private:
// only model can create it
- friend class CHnMdModel;
-
+ friend class CHnMdModel;
+
/**
* Standard C++ consturctor.
*/
@@ -151,26 +151,26 @@
/**
* Copy constructor declared as private to disallow copying.
- *
+ *
* @param aCmnPtrs Pointer to set.
*/
THnMdCommonPointers( const THnMdCommonPointers& aCmnPtrs ):iFs( aCmnPtrs.iFs ) { }
-
+
/**
* Assignment operator
*/
THnMdCommonPointers& operator=( const THnMdCommonPointers& ){return *this;}
};
-
+
/**
* Id generator.
*
* @lib ?library
* @since S60 5.0
- * @ingroup group_hnmetadatamodel
+ * @ingroup group_hnmetadatamodel
*/
struct THnIdGenerator
- {
+ {
/**
* Standatrd C++ constructor.
*/
@@ -188,7 +188,7 @@
return iId++;
}
private:
-
+
/**
* Copy constructor declared as private to disallow copying.
* @param aGenerator Id generator;
@@ -199,23 +199,23 @@
* Assignment operator.
*/
THnIdGenerator& operator=(const THnIdGenerator&);
-
+
/**
* Id
*/
- TInt iId;
+ TInt iId;
};
/**
* Model event observer.
*
- * @since S60 5.0
+ * @since S60 5.0
* @ingroup group_hnmetadatamodel
*/
class MHnMdModelEventObserver
{
public:
-
+
/**
* Handles modlde event.
*
@@ -223,7 +223,7 @@
* @param aEventName Event name.
* @param aParams Parameters.
*/
- virtual TInt HandleModelEventL( const TDesC& aEventName,
+ virtual TInt HandleModelEventL( const TDesC& aEventName,
CLiwGenericParamList& aParams ) = 0;
};
@@ -231,10 +231,10 @@
* Meta data model
*
* This is the main class of the Meta Data Model component.
- *
+ *
* This class is the entry point for building the meta data model
* and for evaluation.
- *
+ *
* @since S60 5.0
* @ingroup group_hnmetadatamodel
*/
@@ -277,7 +277,7 @@
* @since S60 5.0
*/
virtual ~CHnMdModel();
-
+
/**
* Evaluates the model. Takes filter as a parameter.
*
@@ -288,19 +288,19 @@
/**
* Manages evaluation lock.
- *
+ *
* @param aLock Locks evaluation if set to ETrue.
* @param aEvaluate Runs evaluation if aEvaluate == ETrue.
*/
IMPORT_C void SetEvaluationLockL( TBool aLock, TBool aEvaluate = ETrue );
-
+
/**
* Evaluates the model.
*
* @since S60 5.0
*/
IMPORT_C void EvaluateL();
-
+
/**
* Switches between edit mode and normal mode
*
@@ -308,8 +308,8 @@
* @param aMode Suite model container.
*/
IMPORT_C void SetModeL( TMdMode aMode );
-
-
+
+
/**
* Gets suite's meta data model.
*
@@ -317,7 +317,7 @@
* @return Suite meta data model.
*/
IMPORT_C CHnMdSuite* GetLastSuite();
-
+
/**
* Gets suite's meta data model.
*
@@ -326,7 +326,7 @@
* @return Suite meta data model.
*/
CHnMdSuite* GetSuite( TInt aPosition );
-
+
/**
* Gets suite's parameters..
*
@@ -336,39 +336,39 @@
* @return Suite meta data model.
*/
IMPORT_C CLiwGenericParamList& GetSuiteParameters( TInt aPosition );
-
-
+
+
/**
* Handles back event.
- *
+ *
* @since S60 v3.2
* @param aMulContainer Suite model container.
* @param aGenre Name of the suite.
* @param aIterations Number of iterations.
* @return Error code.
- */
+ */
IMPORT_C TInt HandleBackEventL( CHnSuiteModelContainer* aMulContainer,
const TDesC& aGenre, TInt aIterations = KModelCountForRoot );
-
+
/**
* Handles sis installation event.
- *
+ *
* @since S60 v3.2
* @param aMulContainer Suite model container.
- */
- IMPORT_C void HandleSisInstallationEventL(
+ */
+ IMPORT_C void HandleSisInstallationEventL(
CHnSuiteModelContainer* aMulContainer );
-
+
/**
* Loads a suite from xml data.
- *
+ *
* @since S60 v5.0
* @param aGenre Name of the suite.
* @param aSuiteParams Suite parameters.
* @return Error code.
- */
+ */
IMPORT_C TInt LoadSuiteL( const TDesC& aGenre, CLiwGenericParamList* aSuiteParams = NULL );
-
+
/**
* Check if suite model exists.
*
@@ -377,7 +377,7 @@
* @return ETrue if suite model exists, otherwise EFalse.
*/
IMPORT_C TBool SuiteModelExistsL( const TDesC8& aSuiteModel );
-
+
/**
* Gets suite's meta data model.
*
@@ -393,22 +393,22 @@
* @since S60 5.0
*/
IMPORT_C void DeleteLastSuite();
-
-
+
+
/**
* Realeses localization files.
*
* @since S60 5.0
*/
IMPORT_C void ReleaseLocalization();
-
+
/**
* Reloads localization.
*
* @since S60 5.0
*/
IMPORT_C void ReloadLocalizationL();
-
+
/**
* Informs metadatamodel to ignore evaluations or
* to performing evaluations, according to the
@@ -418,7 +418,7 @@
* @param aIgnore Metadatamodel ignores evaluations when set to ETrue.
*/
IMPORT_C void IgnoreEvaluations( TBool aIgnore );
-
+
/**
* Request that menu goes to foreground when evaluation completes.
*
@@ -435,7 +435,7 @@
* simply means not to bring menu to foreground.
*/
IMPORT_C void QueueForeground( TForegroundGainTriggeringEvent aWhen );
-
+
/**
* Is there a queue for foreground gain.
*
@@ -443,7 +443,7 @@
* @return should foreground be gained after evaluation.
*/
IMPORT_C TBool IsForegroundQueued() const;
-
+
/**
* Notifies this metadata model that suite evaluation has completed.
*
@@ -451,7 +451,7 @@
* has completed
*/
void SuiteModelReadyToShowL( CHnSuiteModel* aJustEvaluatedSuite );
-
+
/**
* Causes all of the loades suites except for the suite at the bottom
* of the stack to be reloaded from their corresponding xml file
@@ -461,10 +461,10 @@
* @param aIgnore aModelContainer Model container object.
*/
void ReloadStackSuitesL( CHnSuiteModelContainer* aModelContainer );
-
+
/**
* Counts number of loaded suites.
- *
+ *
* @since S60 5.0
* @return Number of loaded suites
*/
@@ -476,7 +476,7 @@
* @since S60 5.0
*/
void EvaluateTopSuiteL();
-
+
private:
/**
@@ -497,83 +497,78 @@
CHnSuiteModelContainer * aSuiteModelContainer );
private: // data
-
+
/**
* Id generator.
*/
- THnIdGenerator iIdGenerator;
-
+ THnIdGenerator iIdGenerator;
+
/**
* Own - Localization.
*/
CHnMdLocalization* iLocalization;
-
+
/**
* Own - Xml model provider.
*/
CHnXmlModelProvider* iXmlModelProvider;
-
+
/**
* Own - bitmap and mask ids cache.
*/
CHnBitmapIdCache* iBitmapIdCache;
-
+
/**
* Not Own - Event observer.
*/
MHnMdModelEventObserver* iModelEventObserver;
-
+
/**
* Stores pointers to common objects in the system
* This object is shared throut the whole system.
- */
+ */
THnMdCommonPointers iCmnPtrs;
-
+
/**
* Stores information about mode.
*/
TMdMode iMode;
-
+
/**
* Loaded Suites stack.
* Object and content owned.
*/
RPointerArray<CHnMdSuite> iLoadedSuites;
-
+
/**
* Repository widget type observer.
*/
CHnRepositoryObserver* iRepositoryWidgetTypeObserver;
-
+
/**
* Repository folder change observer.
*/
CHnRepositoryObserver* iRepositoryShowFolderObserver;
-
- /**
- * Repository folder change observer.
- */
- CHnRepositoryObserver* iRepositoryZoomObserver;
-
+
/**
* When set, forces metadatamodel to skip evaluations.
*/
TBool iIgnoreEvaluations;
-
+
/**
* Queues foreground gain action.
*/
TBool iForegroundQueued;
-
+
/**
* Not own - pointer to the suite model that must be evaluated
* before matrix menu can be brought to foreground.
- *
+ *
* When NULL, then any suite evaluation brings menu to foreground.
* It is only meaningful when iForegroundQueued is ETrue.
*/
CHnSuiteModel* iForegroundTriggeringSuite;
-
+
};
#endif // C_HNMDMODEL_H