Mercurial Mercurial > oss > FCL > sftools > depl > docscontent / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_interface_8h-source.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Fri, 22 Jan 2010 18:26:19 +0000
changeset 1 25a17d01db0c
permissions -rw-r--r--
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/SysLibs/ECom/InterfaceDefinition/Interface.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/SysLibs/ECom/InterfaceDefinition/Interface.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 "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 <span class="preprocessor">#ifndef _CEXAMPLEINTERFACE__</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define _CEXAMPLEINTERFACE__</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;e32base.h&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;ecom.h&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;badesca.h&gt;</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="comment">// UID of this interface</span>
<a name="l00024"></a>00024 <span class="keyword">const</span> TUid KCExampleInterfaceUid = {0x10009DC0};
<a name="l00025"></a>00025 
<a name="l00036"></a><a class="code" href="class_c_example_interface.html">00036</a> <span class="keyword">class </span><a class="code" href="class_c_example_interface.html">CExampleInterface</a> : <span class="keyword">public</span> CBase
<a name="l00037"></a>00037         {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00039"></a>00039         <span class="comment">// The interface for passing initialisation parameters</span>
<a name="l00040"></a>00040         <span class="comment">// to the derived class constructor.</span>
<a name="l00041"></a><a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html">00041</a>         <span class="keyword">struct </span><a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html">TExampleInterfaceInitParams</a>
<a name="l00042"></a>00042                 {
<a name="l00043"></a><a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html#3025040f58ba6db63ce88a44b585fb58">00043</a>                 TInt <a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html#3025040f58ba6db63ce88a44b585fb58">integer</a>;
<a name="l00044"></a><a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html#0a8925db64b8e52c1de56602317f87ca">00044</a>                 <span class="keyword">const</span> TDesC* <a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html#0a8925db64b8e52c1de56602317f87ca">descriptor</a>;
<a name="l00045"></a>00045                 };
<a name="l00046"></a>00046 
<a name="l00047"></a>00047         <span class="comment">// Instantiates an object of this type </span>
<a name="l00048"></a>00048         <span class="keyword">static</span> <a class="code" href="class_c_example_interface.html">CExampleInterface</a>* <a class="code" href="class_c_example_interface.html#df5bfdbfe9ff3efd85db940282cf7df8">NewL</a>();
<a name="l00049"></a>00049 
<a name="l00050"></a>00050         <span class="comment">// Instantiates an object of this type </span>
<a name="l00051"></a>00051         <span class="comment">// using the aMatchString as the resolver parameters.</span>
<a name="l00052"></a>00052         <span class="keyword">static</span> <a class="code" href="class_c_example_interface.html">CExampleInterface</a>* <a class="code" href="class_c_example_interface.html#df5bfdbfe9ff3efd85db940282cf7df8">NewL</a>(<span class="keyword">const</span> TDesC8&amp; aMatchString);
<a name="l00053"></a>00053 
<a name="l00054"></a>00054         <span class="comment">// Instantiates an object of this type</span>
<a name="l00055"></a>00055         <span class="comment">// using the aMatchString as the resolver parameters</span>
<a name="l00056"></a>00056         <span class="comment">// and passing the aParams parameters </span>
<a name="l00057"></a>00057         <span class="keyword">static</span> <a class="code" href="class_c_example_interface.html">CExampleInterface</a>* <a class="code" href="class_c_example_interface.html#df5bfdbfe9ff3efd85db940282cf7df8">NewL</a>(<span class="keyword">const</span> TDesC8&amp; aMatchString, <a class="code" href="struct_c_example_interface_1_1_t_example_interface_init_params.html">TExampleInterfaceInitParams</a>&amp; aParams);
<a name="l00058"></a>00058 
<a name="l00059"></a>00059         <span class="comment">// Destructor.</span>
<a name="l00060"></a>00060         <span class="keyword">virtual</span> <a class="code" href="class_c_example_interface.html#f3fe11633934637f63134d066ab2c2bf">~CExampleInterface</a>();
<a name="l00061"></a>00061 
<a name="l00062"></a>00062         <span class="comment">// Request a list of all available implementations which </span>
<a name="l00063"></a>00063         <span class="comment">// satisfy this given interface.</span>
<a name="l00064"></a>00064         <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_c_example_interface.html#969ab4804c42e0abe18f7ce80c06964f">ListAllImplementationsL</a>(RImplInfoPtrArray&amp; aImplInfoArray);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066         <span class="comment">// Pure interface method</span>
<a name="l00067"></a>00067         <span class="comment">// Representative of a method provided on the interface by </span>
<a name="l00068"></a>00068         <span class="comment">// the interface definer.</span>
<a name="l00069"></a>00069         <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoMethodL(TDes&amp; aString) = 0;
<a name="l00070"></a>00070 
<a name="l00071"></a>00071 <span class="keyword">protected</span>:
<a name="l00072"></a>00072         <span class="comment">//Default c'tor</span>
<a name="l00073"></a>00073         <span class="keyword">inline</span> <a class="code" href="class_c_example_interface.html#28522e0c8d8627de22d8afe63300767a">CExampleInterface</a>();
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="keyword">private</span>:
<a name="l00076"></a>00076         <span class="comment">// Unique instance identifier key</span>
<a name="l00077"></a>00077         TUid iDtor_ID_Key;
<a name="l00078"></a>00078         };
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 <span class="preprocessor">#include "interface.inl"</span>
<a name="l00081"></a>00081 
<a name="l00082"></a>00082 <span class="preprocessor">#endif </span>
<a name="l00083"></a>00083 <span class="preprocessor"></span>
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:00 2010 for TB10.1 Example Applications by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
FCL/sftools/depl/docscontent