photosgallery/viewframework/commandhandlers/commoncommandhandlers/inc/glxcommandhandlerhelp.h
changeset 0 4e91876724a2
child 25 191387a8b767
equal deleted inserted replaced
-1:000000000000 0:4e91876724a2
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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:    Help command handler
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 /**
       
    22  * @internal reviewed 03/07/2007 by David Holland
       
    23  */
       
    24 
       
    25 #ifndef C_GLXCOMMANDHANDLERMOREHELP_H
       
    26 #define C_GLXCOMMANDHANDLERMOREHELP_H
       
    27 
       
    28 // INCLUDES
       
    29 #include <e32base.h>
       
    30 #include <glxcommandhandler.h>
       
    31 
       
    32 // temp help ids files
       
    33 #include <photos.hlp.hrh>
       
    34 
       
    35 #include <hlplch.h>
       
    36 
       
    37 // FORWARD DECLARATIONS
       
    38 
       
    39 // CLASS DECLARATION
       
    40 
       
    41 // class
       
    42 
       
    43 /**
       
    44   * TGlxHelpContext
       
    45   * Help contexts for views
       
    46   *  @author M Byrne
       
    47   */
       
    48 NONSHARABLE_CLASS (TGlxHelpContext)
       
    49     {
       
    50 public:
       
    51     IMPORT_C TGlxHelpContext();
       
    52     
       
    53 public:
       
    54     TUid iMajor;
       
    55     /** Help context for browsing */
       
    56     TCoeContextName iBrowseContext;
       
    57     
       
    58     /** Help context for viewing if applicable */
       
    59     TCoeContextName iViewContext;
       
    60     };
       
    61 
       
    62 //class
       
    63 
       
    64 /**
       
    65  *  CGlxCommandHandlerHelp class 
       
    66  *  Help command handler
       
    67  *  @glxdrmcommandhandler.lib
       
    68  *  @author M Byrne
       
    69  */
       
    70 NONSHARABLE_CLASS (CGlxCommandHandlerHelp)
       
    71     : public CGlxCommandHandler                                                      
       
    72     {
       
    73 public : //constructor and desctructor
       
    74     /**
       
    75      * Two-phase constructor
       
    76      * @param aHelpContext help context for view
       
    77      * @param aMediaListOwner object that provides the media list
       
    78      */
       
    79     IMPORT_C static CGlxCommandHandlerHelp* NewL(TGlxHelpContext aHelpContext);
       
    80         
       
    81     /** Destructor */
       
    82     IMPORT_C ~CGlxCommandHandlerHelp();
       
    83     
       
    84     /** Activate command handler
       
    85       * @param aViewId id of view activating cmd handler
       
    86       */
       
    87     void DoActivateL(TInt aViewId);
       
    88     
       
    89     /**
       
    90       * Deactivate command handler
       
    91       */
       
    92     void Deactivate();
       
    93     
       
    94 protected:
       
    95     /** see @ref MGlxCommandHandler::ExecuteL */
       
    96     TBool ExecuteL(TInt aCommandId);
       
    97     
       
    98     /** see @ref MGlxCommandHandler::DynInitMenuPaneL */
       
    99     void DynInitMenuPaneL(TInt aResourceId, CEikMenuPane* aMenuPane);
       
   100     
       
   101     /** see @ref MGlxCommandHandler::OfferKeyEventL */
       
   102     TKeyResponse OfferKeyEventL(const TKeyEvent& /*aKeyEvent*/, 
       
   103                                                 TEventCode /*aType*/);
       
   104     
       
   105     /** see @ref MGlxCommandHandler::PreDynInitMenuPaneL */
       
   106     virtual void PreDynInitMenuPaneL( TInt aResourceId );
       
   107     
       
   108     /**
       
   109      * See @ref MGlxCommandHandler::GetRequiredAttributesL
       
   110      * No implementation required
       
   111      */
       
   112     void GetRequiredAttributesL(RArray< TMPXAttribute >& /*aAttributes*/,
       
   113                                 TBool /*aFilterUsingSelection*/,
       
   114                                 TBool /*aFilterUsingCommandId*/, 
       
   115                                 TInt /*aCommandId*/) const {}
       
   116 
       
   117 private:
       
   118     /** Constructor */
       
   119     CGlxCommandHandlerHelp(TGlxHelpContext aHelpContext);
       
   120     
       
   121     /**
       
   122       * Launch help application
       
   123       */
       
   124     void LaunchHelpL();
       
   125 
       
   126 private:
       
   127     /** Help contexts for the plugin */
       
   128     TGlxHelpContext iHelpContext;
       
   129     
       
   130     /** flag to indicate whether full-screen view active
       
   131      based on dummy view-state commands */
       
   132     TBool iInFullScreen;
       
   133     };
       
   134     
       
   135 #endif // C_GLXCOMMANDHANDLERMOREHELP_H
       
   136 
       
   137 
       
   138