Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_menu_app_8cpp_source.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/AppFramework/Apparc/MenuApp/MenuApp.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<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>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#include "MenuApp.h"</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="keyword">const</span> TUid KUidMenuApp = { 0xE800008C };
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// Called by the UI framework to get the application's UID</span>
<a name="l00023"></a>00023 TUid CExampleApplication::AppDllUid()<span class="keyword"> const</span>
<a name="l00024"></a>00024 <span class="keyword"> </span>{
<a name="l00025"></a>00025 <span class="keywordflow">return</span> KUidMenuApp;
<a name="l00026"></a>00026 }
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="comment">// Called by the UI framework at application start-up to</span>
<a name="l00029"></a>00029 <span class="comment">// create an instance of the document class.</span>
<a name="l00030"></a>00030 CApaDocument* CExampleApplication::CreateDocumentL()
<a name="l00031"></a>00031 {
<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>);
<a name="l00033"></a>00033 }
<a name="l00034"></a>00034
<a name="l00035"></a>00035 CExampleDocument::CExampleDocument(CEikApplication& aApp)
<a name="l00036"></a>00036 : CEikDocument(aApp)
<a name="l00037"></a>00037 {}
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">// Called by the UI framework to construct</span>
<a name="l00040"></a>00040 <span class="comment">// the application UI class. Note that the app UI's</span>
<a name="l00041"></a>00041 <span class="comment">// ConstructL() is called by the UI framework.</span>
<a name="l00042"></a>00042 CEikAppUi* CExampleDocument::CreateAppUiL()
<a name="l00043"></a>00043 {
<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>;
<a name="l00045"></a>00045 }
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">// Second phase constructor of the application UI class.</span>
<a name="l00048"></a>00048 <span class="comment">// It creates and owns a single view.</span>
<a name="l00049"></a>00049 <span class="keywordtype">void</span> CExampleAppUi::ConstructL()
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 BaseConstructL();
<a name="l00052"></a>00052 iAppView = CExampleAppView::NewL(ClientRect());
<a name="l00053"></a>00053 <span class="comment">// Connect to the application architecture server</span>
<a name="l00054"></a>00054 User::LeaveIfError(iApaLsSession.Connect());
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// The application UI class owns one view, and is responsible</span>
<a name="l00058"></a>00058 <span class="comment">// for destroying it. </span>
<a name="l00059"></a>00059 CExampleAppUi::~CExampleAppUi()
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 <span class="comment">// Close the session with the apparc server</span>
<a name="l00062"></a>00062 iApaLsSession.Close();
<a name="l00063"></a>00063 <span class="keyword">delete</span> iAppView;
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">// Called by the UI framework when a command has been issued.</span>
<a name="l00067"></a>00067 <span class="keywordtype">void</span> CExampleAppUi::HandleCommandL(TInt aCommand)
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keywordflow">switch</span> (aCommand)
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 <span class="comment">// Handles the exit command</span>
<a name="l00072"></a>00072 <span class="keywordflow">case</span> EEikCmdExit:
<a name="l00073"></a>00073 Exit();
<a name="l00074"></a>00074 <span class="keywordflow">break</span>;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// any other command is the UID of a selected application</span>
<a name="l00077"></a>00077 <span class="keywordflow">default</span>:
<a name="l00078"></a>00078 TUid appUid;
<a name="l00079"></a>00079 <span class="comment">// Get the application Uid</span>
<a name="l00080"></a>00080 appUid.iUid = aCommand;
<a name="l00081"></a>00081 TApaAppInfo info;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="comment">// Get the application info based on the application UID</span>
<a name="l00084"></a>00084 TInt ret = iApaLsSession.GetAppInfo(info,appUid);
<a name="l00085"></a>00085 <span class="keywordflow">if</span>(ret==KErrNone)
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087 CApaCommandLine* cmdLn = CApaCommandLine::NewLC();
<a name="l00088"></a>00088 <span class="comment">// Launch the application</span>
<a name="l00089"></a>00089 cmdLn->SetExecutableNameL(info.iFullName);
<a name="l00090"></a>00090 User::LeaveIfError(iApaLsSession.StartApp(*cmdLn));
<a name="l00091"></a>00091 CleanupStack::PopAndDestroy(cmdLn);
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">// Called by the UI framework to initialise the menu pane dynamically</span>
<a name="l00097"></a>00097 <span class="keywordtype">void</span> CExampleAppUi::DynInitMenuPaneL(TInt aResourceId, CEikMenuPane* aMenuPane)
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <span class="keywordflow">if</span>(aResourceId == R_EXAMPLE_FIRST_MENU)
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 CEikMenuPaneItem::SData extraItem;
<a name="l00102"></a>00102 TRequestStatus status;
<a name="l00103"></a>00103 <span class="comment">// Notify when the application list is fully populated</span>
<a name="l00104"></a>00104 iApaLsSession.RegisterListPopulationCompleteObserver(status);
<a name="l00105"></a>00105 User::WaitForRequest(status);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keywordflow">if</span> (status == KErrNone)
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109 <span class="comment">// Get the list of applications present on the device</span>
<a name="l00110"></a>00110 TInt ret = iApaLsSession.GetAllApps();
<a name="l00111"></a>00111 <span class="keywordflow">if</span>(ret==KErrNone)
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113
<a name="l00114"></a>00114 TApaAppInfo appInfo;
<a name="l00115"></a>00115 <span class="comment">// Retrieve the next application in the application list</span>
<a name="l00116"></a>00116 <span class="keywordflow">while</span> ((iApaLsSession.GetNextApp(appInfo)) == KErrNone)
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <span class="comment">// Set the menu item flags</span>
<a name="l00119"></a>00119 extraItem.iCascadeId = 0;
<a name="l00120"></a>00120 extraItem.iFlags = EEikMenuItemSymbolIndeterminate|EEikMenuItemSymbolOn;
<a name="l00121"></a>00121 <span class="comment">// Set the command Id with the application Uid value</span>
<a name="l00122"></a>00122 extraItem.iCommandId = appInfo.iUid.iUid;
<a name="l00123"></a>00123 <span class="comment">// Set the application name in the menu pane item</span>
<a name="l00124"></a>00124 extraItem.iText = appInfo.iCaption;
<a name="l00125"></a>00125 <span class="comment">// Create the application menu item in the menu pane</span>
<a name="l00126"></a>00126 aMenuPane->AddMenuItemL(extraItem);
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129 }
<a name="l00130"></a>00130 <span class="comment">// Set the exit command Id</span>
<a name="l00131"></a>00131 extraItem.iCommandId = EEikCmdExit;
<a name="l00132"></a>00132 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KText,<span class="stringliteral">"Close"</span>);
<a name="l00133"></a>00133 extraItem.iText = KText;
<a name="l00134"></a>00134 <span class="comment">// Create the close menu item in the menu pane </span>
<a name="l00135"></a>00135 aMenuPane->AddMenuItemL(extraItem);
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139
<a name="l00140"></a>00140 CExampleAppView::CExampleAppView()
<a name="l00141"></a>00141 {}
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">// Static function wraps up two-phase construction for the view.</span>
<a name="l00144"></a>00144 <a class="code" href="class_c_example_app_view.html">CExampleAppView</a>* CExampleAppView::NewL(<span class="keyword">const</span> TRect& aRect)
<a name="l00145"></a>00145 {
<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">CExampleAppView</a>();
<a name="l00147"></a>00147 CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00148"></a>00148 <span class="keyword">self</span>->ConstructL(aRect);
<a name="l00149"></a>00149 CleanupStack::Pop();
<a name="l00150"></a>00150 <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00151"></a>00151 }
<a name="l00152"></a>00152
<a name="l00153"></a>00153 CExampleAppView::~CExampleAppView()
<a name="l00154"></a>00154 {}
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="comment">// Standard initialisation for a window-owning control.</span>
<a name="l00157"></a>00157 <span class="keywordtype">void</span> CExampleAppView::ConstructL(<span class="keyword">const</span> TRect& aRect)
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 <span class="comment">// Create the window owned by the view.</span>
<a name="l00160"></a>00160 CreateWindowL();
<a name="l00161"></a>00161 <span class="comment">// Set the view's size and position.</span>
<a name="l00162"></a>00162 SetRect(aRect);
<a name="l00163"></a>00163 <span class="comment">// Activate the view.</span>
<a name="l00164"></a>00164 ActivateL();
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166
<a name="l00167"></a>00167 <span class="comment">// Draws the view with a simple outline rectangle and then</span>
<a name="l00168"></a>00168 <span class="comment">// draws the welcome text centred.</span>
<a name="l00169"></a>00169 <span class="keywordtype">void</span> CExampleAppView::Draw(<span class="keyword">const</span> TRect& <span class="comment">/*aRect*/</span>)<span class="keyword"> const</span>
<a name="l00170"></a>00170 <span class="keyword"> </span>{
<a name="l00171"></a>00171 CWindowGc& gc = SystemGc();
<a name="l00172"></a>00172 TRect drawRect = Rect();
<a name="l00173"></a>00173 <span class="keyword">const</span> CFont* fontUsed;
<a name="l00174"></a>00174 gc.Clear();
<a name="l00175"></a>00175 drawRect.Shrink(10,10);
<a name="l00176"></a>00176 gc.DrawRect(drawRect);
<a name="l00177"></a>00177 fontUsed = iEikonEnv->TitleFont();
<a name="l00178"></a>00178 gc.UseFont(fontUsed);
<a name="l00179"></a>00179 TInt baselineOffset=(drawRect.Height())/2;
<a name="l00180"></a>00180 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KText,<span class="stringliteral">"Welcome to the menu application example"</span>);
<a name="l00181"></a>00181 gc.DrawText(KText,drawRect,baselineOffset,CGraphicsContext::ECenter, 0);
<a name="l00182"></a>00182 gc.DiscardFont();
<a name="l00183"></a>00183 }
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>