Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_number_store_8h_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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/Basics/ExtensionPattern/include/NumberStore.h 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/Basics/ExtensionPattern/include/NumberStore.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 1997-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 &quot;Eclipse Public License v1.0&quot;</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 &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</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">// Header file demonstrating Extension DLL pattern</span>
<a name="l00015"></a>00015 <span class="comment">// This is the header file declaring the CNumberStore class.</span>
<a name="l00016"></a>00016 <span class="comment">// This file contains both the original functions and also the functions added by</span>
<a name="l00017"></a>00017 <span class="comment">// the extension.  Therefore this file is modified by the extender of the API.</span>
<a name="l00018"></a>00018 <span class="comment">//</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#if !defined(__NUMBERSTORE_V2__)</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __NUMBERSTORE_V2__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;e32std.h&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;e32base.h&gt;</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="comment">/* class CNumberStore</span>
<a name="l00027"></a>00027 <span class="comment">A trivial class to own two numbers */</span>
<a name="l00028"></a><a class="code" href="class_c_number_store.html">00028</a> <span class="keyword">class </span><a class="code" href="class_c_number_store.html">CNumberStore</a> : <span class="keyword">public</span> CBase
<a name="l00029"></a>00029         {       
<a name="l00030"></a>00030 <span class="keyword">public</span>: <span class="comment">//functions</span>
<a name="l00031"></a>00031         
<a name="l00032"></a>00032         <span class="comment">// Original functions contained in dll from supplier</span>
<a name="l00033"></a>00033         IMPORT_C <a class="code" href="class_c_number_store.html">CNumberStore</a> ();
<a name="l00034"></a>00034         IMPORT_C CNumberStore (TInt aNumber1, TInt aNumber2);
<a name="l00035"></a>00035         IMPORT_C <span class="keywordtype">void</span> SetNumber1 (TInt aNumber1);
<a name="l00036"></a>00036         IMPORT_C <span class="keywordtype">void</span> SetNumber2 (TInt aNumber2);
<a name="l00037"></a>00037         IMPORT_C TInt Number1 () <span class="keyword">const</span>;
<a name="l00038"></a>00038         IMPORT_C TInt Number2 () <span class="keyword">const</span>;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040         <span class="comment">// New functions added as a product specific extension to be implemented elsewhere</span>
<a name="l00041"></a>00041         <span class="comment">// AddNumbers is a &quot;non-intrusive&quot; function that will be fully implemented in the extension</span>
<a name="l00042"></a>00042         IMPORT_C TInt AddNumbers() <span class="keyword">const</span>;
<a name="l00043"></a>00043         <span class="comment">// MultiplyNumbers is an &quot;intrusive&quot; function that will be implemented in the orginal dll as DoMultiplyNumbers</span>
<a name="l00044"></a>00044         IMPORT_C TInt MultiplyNumbers() <span class="keyword">const</span>;
<a name="l00045"></a>00045 
<a name="l00046"></a>00046 <span class="keyword">private</span>: <span class="comment">//functions</span>
<a name="l00047"></a>00047         
<a name="l00048"></a>00048         <span class="comment">// DoMultiplyNumbers is the local implementation of MultiplyNumbers. Private to force all clients to call it</span>
<a name="l00049"></a>00049         <span class="comment">// via the MultiplyNumbers function in the extension dll.  It must be implemented in this DLL as it needs access</span>
<a name="l00050"></a>00050         <span class="comment">// to a constant which is defined in originaldll.dll</span>
<a name="l00051"></a>00051         IMPORT_C TInt DoMultiplyNumbers() <span class="keyword">const</span>;
<a name="l00052"></a>00052 
<a name="l00053"></a>00053 <span class="keyword">private</span>: <span class="comment">//data</span>
<a name="l00054"></a>00054         TInt iNumber1;
<a name="l00055"></a>00055         TInt iNumber2;
<a name="l00056"></a>00056         };
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="preprocessor">#endif //__NUMBERSTORE_V2__</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>