|
Nokia N97 SDK Example Applications Guide |
00001 /* 00002 * ============================================================================== 00003 * Name : helpfulform.h 00004 * Part of : Help example 00005 * Interface : 00006 * Description : 00007 * Version : 00008 * 00009 * Copyright (c) 2004 - 2006 Nokia Corporation. 00010 * This material, including documentation and any related 00011 * computer programs, is protected by copyright controlled by 00012 * Nokia Corporation. 00013 * ============================================================================== 00014 */ 00015 00016 #ifndef __HELPFULFORM_H__ 00017 #define __HELPFULFORM_H__ 00018 00019 // INCLUDES 00020 #include <AknForm.h> 00021 00022 /** 00023 * CHelpfulForm 00024 * CHelpfulForm implements context sensitive help for 00025 * itself and the controls it contains 00026 */ 00027 class CHelpfulForm : public CAknForm 00028 { 00029 public: // Constructors and Destructors. 00030 00031 /** 00032 * NewL() 00033 * Construct a CHelpfulForm for the AVKON application 00034 * using two phase construction, and return a pointer to 00035 * the created object 00036 * @param aMenuResource Resource of menu to be added to form menu 00037 * (with Help option) 00038 * @return A pointer to the created instance of CHelpfulForm 00039 */ 00040 static CHelpfulForm* NewL( TInt aMenuResource ); 00041 00042 /** 00043 * NewLC() 00044 * Construct a CHelpfulForm for the AVKON application 00045 * using two phase construction, and return a pointer to 00046 * the created object 00047 * @param aMenuResource Resource of menu to be added to form 00048 * menu (with Help option) 00049 * @return A pointer to the created instance of CHelpfulForm 00050 */ 00051 static CHelpfulForm* NewLC( TInt aMenuResource ); 00052 00053 public: // from AknForm 00054 /** 00055 * ProcessCommandL() 00056 * Handle user menu commands 00057 * @param aCommandId The command identifier to process 00058 */ 00059 void ProcessCommandL( TInt aCommandId ); 00060 00061 /** 00062 * GetHelpContext() 00063 * Identify the help context so that the framework can look up 00064 * the corresponding help topic 00065 * @param aContext Returns the help context 00066 */ 00067 void GetHelpContext( TCoeHelpContext& aContext ) const; 00068 00069 /** 00070 * DynInitMenuPaneL() 00071 * Remove the unused default form options 00072 * @param aResourceId The id of the menu pane 00073 * @param aMenuPane The menu pane itself 00074 */ 00075 void DynInitMenuPaneL( TInt aResourceId, CEikMenuPane* aMenuPane ); 00076 00077 00078 private: // Constructor 00079 00080 /** 00081 * ConstructL() 00082 * Perform the second phase construction of a CHelpfulForm object 00083 * @param aMenuResource The menu resource to be used for the form 00084 */ 00085 void ConstructL( TInt aMenuResource ); 00086 00087 }; 00088 00089 #endif // __HELPFULFORM_H__ 00090 00091 // End of File
|
© Nokia 2009 |