menufw/menufwui/matrixmenu/inc/mmappui.h
branchRCL_3
changeset 19 79311d856354
parent 17 b8fae6b8a148
equal deleted inserted replaced
18:d05a55b217df 19:79311d856354
    69  *
    69  *
    70  *  @since S60 v5.0
    70  *  @since S60 v5.0
    71  */
    71  */
    72 NONSHARABLE_CLASS(CMmAppUi) : public CAknAppUi,
    72 NONSHARABLE_CLASS(CMmAppUi) : public CAknAppUi,
    73                             public MHnControllerInterface,
    73                             public MHnControllerInterface,
    74 							public MAknToolbarObserver,
    74                             public MAknToolbarObserver,
    75                             public MMmWidgetObserver,
    75                             public MMmWidgetObserver,
    76                             public MMmActionRequest,
    76                             public MMmActionRequest,
    77                             public MAknsSkinChangeObserver
    77                             public MAknsSkinChangeObserver
    78 	{
    78   {
    79 
    79 
    80 public:
    80 public:
    81 
    81 
    82 	/**
    82   /**
    83 	 * 2nd phase constructor.
    83    * 2nd phase constructor.
    84 	 *
    84    *
    85 	 * @since S60 v5.0
    85    * @since S60 v5.0
    86 	 */
    86    */
    87 	void ConstructL();
    87   void ConstructL();
    88 
    88 
    89 	/**
    89   /**
    90 	 * C++ default constructor. This needs to be public due to
    90    * C++ default constructor. This needs to be public due to
    91 	 * the way the framework constructs the AppUi.
    91    * the way the framework constructs the AppUi.
    92 	 *
    92    *
    93 	 * @since S60 v5.0
    93    * @since S60 v5.0
    94 	 */
    94    */
    95 	CMmAppUi();
    95   CMmAppUi();
    96 
    96 
    97 	/**
    97   /**
    98 	 * Virtual Destructor.
    98    * Virtual Destructor.
    99 	 *
    99    *
   100 	 * @since S60 v5.0
   100    * @since S60 v5.0
   101 	 */
   101    */
   102 	~CMmAppUi();
   102   ~CMmAppUi();
   103 
   103 
   104 // from base class CEikAppUi
   104 // from base class CEikAppUi
   105 
   105 
   106     /**
   106     /**
   107      * From CEikAppUi.
   107      * From CEikAppUi.
   122      * @since S60 v5.0
   122      * @since S60 v5.0
   123      * @param aCommand Not used by this app.
   123      * @param aCommand Not used by this app.
   124      * @param aDocumentName Not used by this app.
   124      * @param aDocumentName Not used by this app.
   125      * @param aTail Command line tail.
   125      * @param aTail Command line tail.
   126      */
   126      */
   127 	TBool ProcessCommandParametersL( TApaCommand aCommand,
   127   TBool ProcessCommandParametersL( TApaCommand aCommand,
   128 									TFileName& aDocumentName,
   128                   TFileName& aDocumentName,
   129 									const TDesC8& aTail );
   129                   const TDesC8& aTail );
   130 
   130 
   131     /**
   131     /**
   132      * From CAknAppUi.
   132      * From CAknAppUi.
   133      * This method is overriden to ignore certain commands in
   133      * This method is overriden to ignore certain commands in
   134      * certain situations. For not ignored commands it simply
   134      * certain situations. For not ignored commands it simply
   136      *
   136      *
   137      * @param aCommand A command ID.
   137      * @param aCommand A command ID.
   138      */
   138      */
   139     void ProcessCommandL(TInt aCommand);
   139     void ProcessCommandL(TInt aCommand);
   140 
   140 
   141 	/**
   141   /**
   142      * From CEikAppUi.
   142      * From CEikAppUi.
   143      * Takes care of Command Line tail handling.
   143      * Takes care of Command Line tail handling.
   144      *
   144      *
   145      * @since S60 v5.0
   145      * @since S60 v5.0
   146      * @param aUid UID of the message.
   146      * @param aUid UID of the message.
   147      * @param aParams Message params.
   147      * @param aParams Message params.
   148      */
   148      */
   149 	void ProcessMessageL( TUid aUid, const TDesC8& aParams );
   149   void ProcessMessageL( TUid aUid, const TDesC8& aParams );
   150 
   150 
   151 	/**
   151   /**
   152      * From MCoeMessageObserver.
   152      * From MCoeMessageObserver.
   153      * Handles window server messages.
   153      * Handles window server messages.
   154      *
   154      *
   155      * @since S60 v5.0
   155      * @since S60 v5.0
   156      * @param aClientHandleOfTargetWindowGroup The window group that the message was sent to.
   156      * @param aClientHandleOfTargetWindowGroup The window group that the message was sent to.
   161     MCoeMessageObserver::TMessageResponse HandleMessageL(
   161     MCoeMessageObserver::TMessageResponse HandleMessageL(
   162          TUint32 aClientHandleOfTargetWindowGroup,
   162          TUint32 aClientHandleOfTargetWindowGroup,
   163          TUid aMessageUid,
   163          TUid aMessageUid,
   164          const TDesC8& aMessageParameters );
   164          const TDesC8& aMessageParameters );
   165 
   165 
   166 	/**
   166   /**
   167      * From MEikMenuObserver (CEikAppUi).
   167      * From MEikMenuObserver (CEikAppUi).
   168      * Handles dynamic menu pane initialization.
   168      * Handles dynamic menu pane initialization.
   169      *
   169      *
   170      * @since S60 v5.0
   170      * @since S60 v5.0
   171      * @param aResourceId Resource ID of the menu pane.
   171      * @param aResourceId Resource ID of the menu pane.
   337     * @since 2.5
   337     * @since 2.5
   338     */
   338     */
   339     void SkinPackageChanged(
   339     void SkinPackageChanged(
   340         const TAknsSkinStatusPackageChangeReason aReason );
   340         const TAknsSkinStatusPackageChangeReason aReason );
   341 
   341 
       
   342     /**
       
   343      * From MMmDragAndDropObserver.
       
   344      * Method is invoked on the observer, when the move item event is needed.
       
   345      *
       
   346      * @since S60 v5.0
       
   347      * @param aRecipientId Index of item on which the move event invokes.
       
   348      * @param aEventParameters Event parameters.
       
   349      */
       
   350     void HandleTriggerMoveItemL( const TInt aRecipientId,
       
   351             CLiwGenericParamList* aEventParameters );
       
   352 
   342 private:
   353 private:
   343 
   354 
   344     /**
   355     /**
   345      * Enum defining possible exit types for ExitMenuL method.
   356      * Enum defining possible exit types for ExitMenuL method.
   346      *
   357      *
   377         ETransitionFromEditMode,
   388         ETransitionFromEditMode,
   378         EFastTransitionFromEditMode
   389         EFastTransitionFromEditMode
   379         };
   390         };
   380 
   391 
   381     /**
   392     /**
   382 	 * Indicates if edit mode is on.
   393    * Indicates if edit mode is on.
   383 	 *
   394    *
   384 	 * @since S60 v5.0
   395    * @since S60 v5.0
   385 	 * @return Returns edit mode status.
   396    * @return Returns edit mode status.
   386 	 */
   397    */
   387     TBool IsEditMode();
   398     TBool IsEditMode();
   388 
   399 
   389     /**
   400     /**
   390 	 * Adjusts highlight when entering or leaving edit mode.
   401    * Adjusts highlight when entering or leaving edit mode.
   391 	 *
   402    *
   392 	 * @since S60 v5.0
   403    * @since S60 v5.0
   393 	 * @param aOriginalHighlight Highlight that would normally be set
   404    * @param aOriginalHighlight Highlight that would normally be set
   394 	 * @return A modified value of highlight
   405    * @return A modified value of highlight
   395 	 */
   406    */
   396     TInt AdjustEditModeHighlightL( TInt aOriginalHighlight );
   407     TInt AdjustEditModeHighlightL( TInt aOriginalHighlight );
   397 
   408 
   398     /**
   409     /**
   399 	 * Manages the container lookup.
   410    * Manages the container lookup.
   400 	 *
   411    *
   401 	 * @since S60 v5.0
   412    * @since S60 v5.0
   402 	 * @return Pointer to the container to be loaded, of NULL
   413    * @return Pointer to the container to be loaded, of NULL
   403 	 * 		   if a new container should be created.
   414    * 		   if a new container should be created.
   404 	 */
   415    */
   405     CMmWidgetContainer* GetAppropriateContainerToLoadL();
   416     CMmWidgetContainer* GetAppropriateContainerToLoadL();
   406 
   417 
   407     /**
   418     /**
   408      * Submits an asynchronous service request to show user a message
   419      * Submits an asynchronous service request to show user a message
   409      * when Matrix Menu is out of memory.
   420      * when Matrix Menu is out of memory.
   424      */
   435      */
   425     void HideMenuPaneIfVisibleL();
   436     void HideMenuPaneIfVisibleL();
   426 
   437 
   427 // from base class CEikAppUi
   438 // from base class CEikAppUi
   428 
   439 
   429 	/**
   440   /**
   430 	 * From CEikAppUi.
   441    * From CEikAppUi.
   431 	 * Takes care of command handling.
   442    * Takes care of command handling.
   432 	 *
   443    *
   433 	 * @since S60 v5.0
   444    * @since S60 v5.0
   434 	 * @param aCommand Command to be handled.
   445    * @param aCommand Command to be handled.
   435 	 */
   446    */
   436 	void HandleCommandL( TInt aCommand );
   447   void HandleCommandL( TInt aCommand );
   437 
   448 
   438 	/**
   449   /**
   439      * From CEikAppUi.
   450      * From CEikAppUi.
   440      * Handles Window Server events.
   451      * Handles Window Server events.
   441      *
   452      *
   442      * @since S60 v5.0
   453      * @since S60 v5.0
   443      * @param aEvent Event to be handled.
   454      * @param aEvent Event to be handled.
   444      * @param aDestination Destination control.
   455      * @param aDestination Destination control.
   445      */
   456      */
   446     void HandleWsEventL( const TWsEvent& aEvent, CCoeControl* aDestination );
   457     void HandleWsEventL( const TWsEvent& aEvent, CCoeControl* aDestination );
   447 
   458 
   448 	/**
   459   /**
   449      * Indicates if root (main) view is displayed.
   460      * Indicates if root (main) view is displayed.
   450      *
   461      *
   451      * @since S60 v5.0
   462      * @since S60 v5.0
   452      * @return ETrue if root displayed, EFalse otherwise.
   463      * @return ETrue if root displayed, EFalse otherwise.
   453      */
   464      */
   454 	TBool IsRootdisplayedL();
   465   TBool IsRootdisplayedL();
   455 
   466 
   456 	/**
   467   /**
   457 	 * Handles pen down events for an item.
   468    * Handles pen down events for an item.
   458 	 *
   469    *
   459 	 * @since S60 v5.0
   470    * @since S60 v5.0
   460      * @param aIndex Item index.
   471      * @param aIndex Item index.
   461      */
   472      */
   462     void HandleHighlightItemPenDownL( TInt aIndex );
   473     void HandleHighlightItemPenDownL( TInt aIndex );
   463 
   474 
   464     /**
   475     /**
   511      *
   522      *
   512      * @since S60 v5.0
   523      * @since S60 v5.0
   513      */
   524      */
   514     void InsertL();
   525     void InsertL();
   515 
   526 
   516 	/**
   527   /**
   517      * Handles the "Back" softkey event.
   528      * Handles the "Back" softkey event.
   518      *
   529      *
   519      * @since S60 v5.0
   530      * @since S60 v5.0
   520      */
   531      */
   521 	void HandleBackCommandL();
   532   void HandleBackCommandL();
   522 
   533 
   523     /**
   534     /**
   524      * Refreshes toolbar.
   535      * Refreshes toolbar.
   525      *
   536      *
   526      * @since S60 v5.0
   537      * @since S60 v5.0
   730      * @param aKastorEffect Id of the TAT/Kastor effect.
   741      * @param aKastorEffect Id of the TAT/Kastor effect.
   731      *
   742      *
   732      * @since S60 v5.0
   743      * @since S60 v5.0
   733      */
   744      */
   734     void StartLayoutSwitchFullScreen( TInt aKastorEffect
   745     void StartLayoutSwitchFullScreen( TInt aKastorEffect
   735     		= AknTransEffect::ELayoutSwitchStart);
   746         = AknTransEffect::ELayoutSwitchStart);
   736 
   747 
   737     /**
   748     /**
   738      * Ends fullscreen
   749      * Ends fullscreen
   739      *
   750      *
   740      * @since S60 v5.0
   751      * @since S60 v5.0
   930      * Extension manager.
   941      * Extension manager.
   931      * Own.
   942      * Own.
   932      */
   943      */
   933     CMMExtensionManager* iMmExtManager;
   944     CMMExtensionManager* iMmExtManager;
   934 
   945 
   935 	/**
   946   /**
   936      * Screen state.
   947      * Screen state.
   937      */
   948      */
   938     TBool iScreenOn;
   949     TBool iScreenOn;
   939 
   950 
   940     /**
   951     /**
   998      * ETrue if Matrix menu has focus i.e. it is in foreground and is not eclipsed
  1009      * ETrue if Matrix menu has focus i.e. it is in foreground and is not eclipsed
   999      * by any popup note that is not originating from Matrix menu.
  1010      * by any popup note that is not originating from Matrix menu.
  1000      */
  1011      */
  1001     TBool iHasFocus;
  1012     TBool iHasFocus;
  1002 
  1013 
  1003 	/**
  1014   /**
  1004      * ETrue if Matrix is hidden from TS which is used on startup.
  1015      * ETrue if Matrix is hidden from TS which is used on startup.
  1005      */
  1016      */
  1006 	TBool isHiddenFromFS;
  1017   TBool isHiddenFromFS;
  1007 	
  1018 
  1008     /**
  1019     /**
  1009      * Own.
  1020      * Own.
  1010      * Popup menu displayed after long tap.
  1021      * Popup menu displayed after long tap.
  1011      */
  1022      */
  1012     CAknStylusPopUpMenu* iPopupMenu;
  1023     CAknStylusPopUpMenu* iPopupMenu;