Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_menu_app_8cpp-source.html
changeset 1 25a17d01db0c
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
       
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
       
     3 <title>TB10.1 Example Applications: examples/AppFramework/Apparc/MenuApp/MenuApp.cpp Source File</title>
       
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
       
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
       
     6 </head><body>
       
     7 <!-- Generated by Doxygen 1.5.3 -->
       
     8 <h1>examples/AppFramework/Apparc/MenuApp/MenuApp.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
       
     9 <a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
       
    10 <a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
       
    11 <a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
       
    12 <a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
       
    13 <a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
       
    14 <a name="l00007"></a>00007 <span class="comment">//</span>
       
    15 <a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
       
    16 <a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
       
    17 <a name="l00010"></a>00010 <span class="comment">//</span>
       
    18 <a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
       
    19 <a name="l00012"></a>00012 <span class="comment">//</span>
       
    20 <a name="l00013"></a>00013 <span class="comment">// Description:</span>
       
    21 <a name="l00014"></a>00014 <span class="comment">//</span>
       
    22 <a name="l00015"></a>00015 
       
    23 <a name="l00016"></a>00016 
       
    24 <a name="l00017"></a>00017 <span class="preprocessor">#include "MenuApp.h"</span>
       
    25 <a name="l00018"></a>00018 
       
    26 <a name="l00019"></a>00019 
       
    27 <a name="l00020"></a>00020 <span class="keyword">const</span> TUid KUidMenuApp = { 0xE800008C };
       
    28 <a name="l00021"></a>00021 
       
    29 <a name="l00022"></a>00022 <span class="comment">// Called by the UI framework to get the application's UID</span>
       
    30 <a name="l00023"></a>00023 TUid CExampleApplication::AppDllUid()<span class="keyword"> const</span>
       
    31 <a name="l00024"></a>00024 <span class="keyword">        </span>{
       
    32 <a name="l00025"></a>00025         <span class="keywordflow">return</span> KUidMenuApp;
       
    33 <a name="l00026"></a>00026         }
       
    34 <a name="l00027"></a>00027 
       
    35 <a name="l00028"></a>00028 <span class="comment">// Called by the UI framework at application start-up to</span>
       
    36 <a name="l00029"></a>00029 <span class="comment">// create an instance of the document class.</span>
       
    37 <a name="l00030"></a>00030 CApaDocument* CExampleApplication::CreateDocumentL()
       
    38 <a name="l00031"></a>00031         {
       
    39 <a name="l00032"></a>00032         <span class="keywordflow">return</span> <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_example_document.html">CExampleDocument</a>(*<span class="keyword">this</span>);
       
    40 <a name="l00033"></a>00033         }
       
    41 <a name="l00034"></a>00034 
       
    42 <a name="l00035"></a>00035 <a class="code" href="class_c_example_document.html#57c35ffe8a97fa1e9301c33b8f3735bc">CExampleDocument::CExampleDocument</a>(CEikApplication&amp; aApp)
       
    43 <a name="l00036"></a>00036                 : CEikDocument(aApp)
       
    44 <a name="l00037"></a>00037         {}
       
    45 <a name="l00038"></a>00038 
       
    46 <a name="l00039"></a>00039 <span class="comment">// Called by the UI framework to construct</span>
       
    47 <a name="l00040"></a>00040 <span class="comment">// the application UI class. Note that the app UI's</span>
       
    48 <a name="l00041"></a>00041 <span class="comment">// ConstructL() is called by the UI framework.</span>
       
    49 <a name="l00042"></a>00042 CEikAppUi* CExampleDocument::CreateAppUiL()
       
    50 <a name="l00043"></a>00043         {
       
    51 <a name="l00044"></a>00044         <span class="keywordflow">return</span> <span class="keyword">new</span>(ELeave) <a class="code" href="class_c_example_app_ui.html">CExampleAppUi</a>;
       
    52 <a name="l00045"></a>00045         }
       
    53 <a name="l00046"></a>00046 
       
    54 <a name="l00047"></a>00047 <span class="comment">// Second phase constructor of the application UI class.</span>
       
    55 <a name="l00048"></a>00048 <span class="comment">// It creates and owns a single view.</span>
       
    56 <a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_ui.html#c7d473f79f7509e283327e17c1078042">CExampleAppUi::ConstructL</a>()
       
    57 <a name="l00050"></a>00050         {
       
    58 <a name="l00051"></a>00051         BaseConstructL();
       
    59 <a name="l00052"></a>00052         iAppView = <a class="code" href="class_c_example_app_view.html#33eb6dd234e818598facb0ade331e83f">CExampleAppView::NewL</a>(ClientRect());
       
    60 <a name="l00053"></a>00053         <span class="comment">// Connect to the application architecture server</span>
       
    61 <a name="l00054"></a>00054         User::LeaveIfError(<a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.Connect());
       
    62 <a name="l00055"></a>00055         }
       
    63 <a name="l00056"></a>00056 
       
    64 <a name="l00057"></a>00057 <span class="comment">// The application UI class owns one view, and is responsible</span>
       
    65 <a name="l00058"></a>00058 <span class="comment">// for destroying it. </span>
       
    66 <a name="l00059"></a>00059 <a class="code" href="class_c_example_app_ui.html#8aaaf511fa76f36e9fed17b25bcc287f">CExampleAppUi::~CExampleAppUi</a>()
       
    67 <a name="l00060"></a>00060         {
       
    68 <a name="l00061"></a>00061         <span class="comment">// Close the session with the apparc server</span>
       
    69 <a name="l00062"></a>00062         <a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.Close();
       
    70 <a name="l00063"></a>00063         <span class="keyword">delete</span> iAppView;
       
    71 <a name="l00064"></a>00064         }
       
    72 <a name="l00065"></a>00065 
       
    73 <a name="l00066"></a>00066 <span class="comment">// Called by the UI framework when a command has been issued.</span>
       
    74 <a name="l00067"></a>00067 <span class="keywordtype">void</span> CExampleAppUi::HandleCommandL(TInt aCommand)
       
    75 <a name="l00068"></a>00068         {
       
    76 <a name="l00069"></a>00069         <span class="keywordflow">switch</span> (aCommand)
       
    77 <a name="l00070"></a>00070                 {
       
    78 <a name="l00071"></a>00071                 <span class="comment">// Handles the exit command</span>
       
    79 <a name="l00072"></a>00072                 <span class="keywordflow">case</span> EEikCmdExit:
       
    80 <a name="l00073"></a>00073                         Exit();
       
    81 <a name="l00074"></a>00074                         <span class="keywordflow">break</span>;
       
    82 <a name="l00075"></a>00075 
       
    83 <a name="l00076"></a>00076                 <span class="comment">// any other command is the UID of a selected application</span>
       
    84 <a name="l00077"></a>00077                 <span class="keywordflow">default</span>:
       
    85 <a name="l00078"></a>00078                         TUid appUid;
       
    86 <a name="l00079"></a>00079                         <span class="comment">// Get the application Uid</span>
       
    87 <a name="l00080"></a>00080                         appUid.iUid = aCommand;
       
    88 <a name="l00081"></a>00081                         TApaAppInfo info;
       
    89 <a name="l00082"></a>00082                         
       
    90 <a name="l00083"></a>00083                         <span class="comment">// Get the application info based on the application UID</span>
       
    91 <a name="l00084"></a>00084                         TInt ret = <a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.GetAppInfo(info,appUid);
       
    92 <a name="l00085"></a>00085                         <span class="keywordflow">if</span>(ret==KErrNone)
       
    93 <a name="l00086"></a>00086                                 {
       
    94 <a name="l00087"></a>00087                                 CApaCommandLine* cmdLn = CApaCommandLine::NewLC();
       
    95 <a name="l00088"></a>00088                                 <span class="comment">// Launch the application</span>
       
    96 <a name="l00089"></a>00089                                 cmdLn-&gt;SetExecutableNameL(info.iFullName);
       
    97 <a name="l00090"></a>00090                                 User::LeaveIfError(<a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.StartApp(*cmdLn));
       
    98 <a name="l00091"></a>00091                                 CleanupStack::PopAndDestroy(cmdLn);
       
    99 <a name="l00092"></a>00092                                 }
       
   100 <a name="l00093"></a>00093                 }
       
   101 <a name="l00094"></a>00094         }
       
   102 <a name="l00095"></a>00095         
       
   103 <a name="l00096"></a>00096 <span class="comment">// Called by the UI framework to initialise the menu pane dynamically</span>
       
   104 <a name="l00097"></a>00097 <span class="keywordtype">void</span> CExampleAppUi::DynInitMenuPaneL(TInt aResourceId, CEikMenuPane* aMenuPane)
       
   105 <a name="l00098"></a>00098         {
       
   106 <a name="l00099"></a>00099         <span class="keywordflow">if</span>(aResourceId == R_EXAMPLE_FIRST_MENU)
       
   107 <a name="l00100"></a>00100                 {       
       
   108 <a name="l00101"></a>00101                 CEikMenuPaneItem::SData extraItem;
       
   109 <a name="l00102"></a>00102                 TRequestStatus status;
       
   110 <a name="l00103"></a>00103                 <span class="comment">// Notify when the application list is fully populated</span>
       
   111 <a name="l00104"></a>00104                 <a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.RegisterListPopulationCompleteObserver(status);
       
   112 <a name="l00105"></a>00105                 User::WaitForRequest(status);
       
   113 <a name="l00106"></a>00106 
       
   114 <a name="l00107"></a>00107                 <span class="keywordflow">if</span> (status == KErrNone)         
       
   115 <a name="l00108"></a>00108                         {       
       
   116 <a name="l00109"></a>00109                         <span class="comment">// Get the list of applications present on the device</span>
       
   117 <a name="l00110"></a>00110                         TInt ret = <a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.GetAllApps();
       
   118 <a name="l00111"></a>00111                         <span class="keywordflow">if</span>(ret==KErrNone)
       
   119 <a name="l00112"></a>00112                                 {                       
       
   120 <a name="l00113"></a>00113                 
       
   121 <a name="l00114"></a>00114                                 TApaAppInfo appInfo;
       
   122 <a name="l00115"></a>00115                                 <span class="comment">// Retrieve the next application in the application list</span>
       
   123 <a name="l00116"></a>00116                                 <span class="keywordflow">while</span> ((<a class="code" href="class_c_example_app_ui.html#144eb6a320c034a9bde20e56ba9c8ec7">iApaLsSession</a>.GetNextApp(appInfo)) == KErrNone)
       
   124 <a name="l00117"></a>00117                                         {
       
   125 <a name="l00118"></a>00118                                         <span class="comment">// Set the menu item flags</span>
       
   126 <a name="l00119"></a>00119                                         extraItem.iCascadeId = 0;
       
   127 <a name="l00120"></a>00120                                         extraItem.iFlags = EEikMenuItemSymbolIndeterminate|EEikMenuItemSymbolOn;
       
   128 <a name="l00121"></a>00121                                         <span class="comment">// Set the command Id with the application Uid value</span>
       
   129 <a name="l00122"></a>00122                                         extraItem.iCommandId = appInfo.iUid.iUid;
       
   130 <a name="l00123"></a>00123                                         <span class="comment">// Set the application name in the menu pane item</span>
       
   131 <a name="l00124"></a>00124                                         extraItem.iText = appInfo.iCaption;
       
   132 <a name="l00125"></a>00125                                         <span class="comment">// Create the application menu item in the menu pane</span>
       
   133 <a name="l00126"></a>00126                                         aMenuPane-&gt;AddMenuItemL(extraItem);
       
   134 <a name="l00127"></a>00127                                         }
       
   135 <a name="l00128"></a>00128                                 }
       
   136 <a name="l00129"></a>00129                         }
       
   137 <a name="l00130"></a>00130                 <span class="comment">// Set the exit command Id</span>
       
   138 <a name="l00131"></a>00131                 extraItem.iCommandId = EEikCmdExit;
       
   139 <a name="l00132"></a>00132                 _LIT(KText,<span class="stringliteral">"Close"</span>);
       
   140 <a name="l00133"></a>00133                 extraItem.iText = KText;
       
   141 <a name="l00134"></a>00134                 <span class="comment">// Create the close menu item in the menu pane  </span>
       
   142 <a name="l00135"></a>00135                 aMenuPane-&gt;AddMenuItemL(extraItem);
       
   143 <a name="l00136"></a>00136                 }
       
   144 <a name="l00137"></a>00137         }
       
   145 <a name="l00138"></a>00138 
       
   146 <a name="l00139"></a>00139 
       
   147 <a name="l00140"></a>00140 <a class="code" href="class_c_example_app_view.html#187bc221ae94a9461bb00530660a7feb">CExampleAppView::CExampleAppView</a>()
       
   148 <a name="l00141"></a>00141         {}
       
   149 <a name="l00142"></a>00142 
       
   150 <a name="l00143"></a>00143 <span class="comment">// Static function wraps up two-phase construction for the view.</span>
       
   151 <a name="l00144"></a>00144 <a class="code" href="class_c_example_app_view.html">CExampleAppView</a>* <a class="code" href="class_c_example_app_view.html#33eb6dd234e818598facb0ade331e83f">CExampleAppView::NewL</a>(<span class="keyword">const</span> TRect&amp; aRect)
       
   152 <a name="l00145"></a>00145         {
       
   153 <a name="l00146"></a>00146         <a class="code" href="class_c_example_app_view.html">CExampleAppView</a>* <span class="keyword">self</span> = <span class="keyword">new</span>(ELeave) <a class="code" href="class_c_example_app_view.html#187bc221ae94a9461bb00530660a7feb">CExampleAppView</a>();
       
   154 <a name="l00147"></a>00147         CleanupStack::PushL(<span class="keyword">self</span>);
       
   155 <a name="l00148"></a>00148         <span class="keyword">self</span>-&gt;ConstructL(aRect);
       
   156 <a name="l00149"></a>00149         CleanupStack::Pop();
       
   157 <a name="l00150"></a>00150         <span class="keywordflow">return</span> <span class="keyword">self</span>;
       
   158 <a name="l00151"></a>00151         }
       
   159 <a name="l00152"></a>00152 
       
   160 <a name="l00153"></a>00153 <a class="code" href="class_c_example_app_view.html#c78c771feb302e8d161572f7ec1a7bcd">CExampleAppView::~CExampleAppView</a>()
       
   161 <a name="l00154"></a>00154         {}
       
   162 <a name="l00155"></a>00155 
       
   163 <a name="l00156"></a>00156 <span class="comment">// Standard initialisation for a window-owning control.</span>
       
   164 <a name="l00157"></a>00157 <span class="keywordtype">void</span> <a class="code" href="class_c_example_app_view.html#35add6fa9ced3ba37334889336e294ee">CExampleAppView::ConstructL</a>(<span class="keyword">const</span> TRect&amp; aRect)
       
   165 <a name="l00158"></a>00158     {
       
   166 <a name="l00159"></a>00159         <span class="comment">// Create the window owned by the view.</span>
       
   167 <a name="l00160"></a>00160         CreateWindowL();
       
   168 <a name="l00161"></a>00161         <span class="comment">// Set the view's size and position.</span>
       
   169 <a name="l00162"></a>00162         SetRect(aRect);
       
   170 <a name="l00163"></a>00163         <span class="comment">// Activate the view.</span>
       
   171 <a name="l00164"></a>00164         ActivateL();
       
   172 <a name="l00165"></a>00165         }
       
   173 <a name="l00166"></a>00166         
       
   174 <a name="l00167"></a>00167 <span class="comment">// Draws the view with a simple outline rectangle and then</span>
       
   175 <a name="l00168"></a>00168 <span class="comment">// draws the welcome text centred.</span>
       
   176 <a name="l00169"></a>00169 <span class="keywordtype">void</span> CExampleAppView::Draw(<span class="keyword">const</span> TRect&amp; <span class="comment">/*aRect*/</span>)<span class="keyword"> const</span>
       
   177 <a name="l00170"></a>00170 <span class="keyword">        </span>{
       
   178 <a name="l00171"></a>00171         CWindowGc&amp; gc = SystemGc();
       
   179 <a name="l00172"></a>00172         TRect      drawRect = Rect();
       
   180 <a name="l00173"></a>00173         <span class="keyword">const</span> CFont*     fontUsed;
       
   181 <a name="l00174"></a>00174         gc.Clear();
       
   182 <a name="l00175"></a>00175         drawRect.Shrink(10,10);
       
   183 <a name="l00176"></a>00176         gc.DrawRect(drawRect);
       
   184 <a name="l00177"></a>00177         fontUsed = iEikonEnv-&gt;TitleFont();
       
   185 <a name="l00178"></a>00178         gc.UseFont(fontUsed);
       
   186 <a name="l00179"></a>00179         TInt   baselineOffset=(drawRect.Height())/2;
       
   187 <a name="l00180"></a>00180         _LIT(KText,<span class="stringliteral">"Welcome to the menu application example"</span>);
       
   188 <a name="l00181"></a>00181         gc.DrawText(KText,drawRect,baselineOffset,CGraphicsContext::ECenter, 0);
       
   189 <a name="l00182"></a>00182         gc.DiscardFont();
       
   190 <a name="l00183"></a>00183         }
       
   191 </pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:54 2010 for TB10.1 Example Applications by&nbsp;
       
   192 <a href="http://www.doxygen.org/index.html">
       
   193 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
       
   194 </body>
       
   195 </html>