Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_e_com_interface_definition_8inl_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/ForumNokia/EComCalculator/interface/EComInterfaceDefinition.inl 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/ForumNokia/EComCalculator/interface/EComInterfaceDefinition.inl</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * ============================================================================</span>
<a name="l00003"></a>00003 <span class="comment"> *  Name     : CCalculationInterfaceDefinition from EComInterfaceDefinition.inl</span>
<a name="l00004"></a>00004 <span class="comment"> *  Part of  : EComCalculator</span>
<a name="l00005"></a>00005 <span class="comment"> *  Created  : 17/11/2003 by Forum Nokia</span>
<a name="l00006"></a>00006 <span class="comment"> *  Version  : 1.0</span>
<a name="l00007"></a>00007 <span class="comment"> *  Copyright: Nokia Corporation</span>
<a name="l00008"></a>00008 <span class="comment"> * ============================================================================</span>
<a name="l00009"></a>00009 <span class="comment"> */</span>
<a name="l00010"></a>00010 
<a name="l00011"></a>00011 <span class="comment">// Interface&#39;s (abstract base class&#39;s) destructor</span>
<a name="l00012"></a><a class="code" href="class_c_calculation_interface_definition.html#a7c76e2d8ad48a27b54c8ed32f3e86791">00012</a> <span class="keyword">inline</span> <a class="code" href="class_c_calculation_interface_definition.html#a7c76e2d8ad48a27b54c8ed32f3e86791">CCalculationInterfaceDefinition::~CCalculationInterfaceDefinition</a>()
<a name="l00013"></a>00013     {
<a name="l00014"></a>00014     <span class="comment">// If in the NewL some memory is reserved for member data, it must be</span>
<a name="l00015"></a>00015     <span class="comment">// released here. This interface does not have any instance variables so</span>
<a name="l00016"></a>00016     <span class="comment">// no need to delete anything.</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018     <span class="comment">// Inform the ECOM framework that this specific instance of the</span>
<a name="l00019"></a>00019     <span class="comment">// interface has been destroyed.</span>
<a name="l00020"></a>00020     REComSession::DestroyedImplementation(iDtor_ID_Key);
<a name="l00021"></a>00021     }
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="comment">// Interface&#39;s (abstract base class&#39;s) static factory method implementation.</span>
<a name="l00024"></a>00024 <span class="comment">// Asks ECOM plugin framework to instantiate appropriate concret plugin</span>
<a name="l00025"></a>00025 <span class="comment">// implementation.</span>
<a name="l00026"></a>00026 <span class="keyword">inline</span> <a class="code" href="class_c_calculation_interface_definition.html">CCalculationInterfaceDefinition</a>*
<a name="l00027"></a><a class="code" href="class_c_calculation_interface_definition.html#a0c188739edb316bd3a93843f6d997593">00027</a>     <a class="code" href="class_c_calculation_interface_definition.html#a0c188739edb316bd3a93843f6d997593">CCalculationInterfaceDefinition::NewL</a>(<span class="keyword">const</span> TDesC8&amp; aOperationName)
<a name="l00028"></a>00028     {
<a name="l00029"></a>00029     <span class="comment">// In this example the aOperationName name can be either &quot;sum&quot; or</span>
<a name="l00030"></a>00030     <span class="comment">// &quot;multiply&quot;. Implementations define recognition data in their</span>
<a name="l00031"></a>00031     <span class="comment">// &quot;default_data&quot; section of the resource, so that resolver can decide,</span>
<a name="l00032"></a>00032     <span class="comment">// which implementation to choose. For an example resource definition, see</span>
<a name="l00033"></a>00033     <span class="comment">//     ..\plugin\101F5465.rss</span>
<a name="l00034"></a>00034     <span class="comment">// This NewL uses default resolver, which just compares given</span>
<a name="l00035"></a>00035     <span class="comment">// aOperationName and default_data string in the implementation</span>
<a name="l00036"></a>00036     <span class="comment">// resource file.</span>
<a name="l00037"></a>00037 
<a name="l00038"></a>00038     <span class="comment">// Define options, how the default resolver will find appropriate</span>
<a name="l00039"></a>00039     <span class="comment">// implementation.</span>
<a name="l00040"></a>00040     TEComResolverParams resolverParams;
<a name="l00041"></a>00041     resolverParams.SetDataType(aOperationName);
<a name="l00042"></a>00042     resolverParams.SetWildcardMatch(ETrue);     <span class="comment">// Allow wildcard matching</span>
<a name="l00043"></a>00043 
<a name="l00044"></a>00044     <span class="comment">// Find implementation for our interface.</span>
<a name="l00045"></a>00045     <span class="comment">// - KCalculateInterfaceDefinitionUid is the UID of our custom ECOM</span>
<a name="l00046"></a>00046     <span class="comment">//   interface. It is defined in EComInterfaceDefinition.h</span>
<a name="l00047"></a>00047     <span class="comment">// - This call will leave, if the plugin architecture cannot find</span>
<a name="l00048"></a>00048     <span class="comment">//   implementation.</span>
<a name="l00049"></a>00049     <span class="comment">// - The returned pointer points to one of our interface implementation</span>
<a name="l00050"></a>00050     <span class="comment">//   instances.</span>
<a name="l00051"></a>00051     TAny* ptr = REComSession::CreateImplementationL(
<a name="l00052"></a>00052         KCalculateInterfaceDefinitionUid,
<a name="l00053"></a>00053         _FOFF(<a class="code" href="class_c_calculation_interface_definition.html">CCalculationInterfaceDefinition</a>,iDtor_ID_Key),
<a name="l00054"></a>00054                 <span class="comment">// _FOFF specifies offset of iDtor_ID_Key so that</span>
<a name="l00055"></a>00055                 <span class="comment">// ECOM framework can update its value.</span>
<a name="l00056"></a>00056         resolverParams);
<a name="l00057"></a>00057 
<a name="l00058"></a>00058     <span class="comment">// The type of TAny* ptr should be CCalculationInterfaceDefinition.</span>
<a name="l00059"></a>00059     <span class="keywordflow">return</span> REINTERPRET_CAST(<a class="code" href="class_c_calculation_interface_definition.html">CCalculationInterfaceDefinition</a>*, ptr);
<a name="l00060"></a>00060     }
</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>