Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_t_z_localizer_engine_8h_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/ForumNokia/TZLocalizer/inc/TZLocalizerEngine.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/ForumNokia/TZLocalizer/inc/TZLocalizerEngine.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2008 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="preprocessor">#ifndef CTZLOCALIZERENGINE_H</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#define CTZLOCALIZERENGINE_H</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include <tz.h></span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <TzLocalizer.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <TzLocalizationDataTypes.h></span>
<a name="l00011"></a>00011
<a name="l00012"></a><a class="code" href="class_c_t_z_localizer_engine.html">00012</a> <span class="keyword">class </span><a class="code" href="class_c_t_z_localizer_engine.html">CTZLocalizerEngine</a> : <span class="keyword">public</span> CBase
<a name="l00013"></a>00013 {
<a name="l00014"></a>00014 <span class="keyword">public</span>:
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="keyword">static</span> <a class="code" href="class_c_t_z_localizer_engine.html">CTZLocalizerEngine</a>* NewL();
<a name="l00017"></a>00017 <span class="keyword">static</span> <a class="code" href="class_c_t_z_localizer_engine.html">CTZLocalizerEngine</a>* NewLC();
<a name="l00018"></a>00018
<a name="l00022"></a>00022 <a class="code" href="class_c_t_z_localizer_engine.html#a6ebb47c9b62f27b6eccea64504e3835c">~CTZLocalizerEngine</a>();
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">private</span>: <span class="comment">// Constructors</span>
<a name="l00025"></a>00025 <a class="code" href="class_c_t_z_localizer_engine.html">CTZLocalizerEngine</a>();
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00028"></a>00028 <span class="comment">// CTZLocalizerEngine::ConstructL()</span>
<a name="l00029"></a>00029 <span class="comment">// Connect to Time Zone server. </span>
<a name="l00030"></a>00030 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00031"></a>00031 <span class="keywordtype">void</span> ConstructL();
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">public</span>: <span class="comment">// Methods</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00036"></a>00036 <span class="comment">// CTZLocalizerEngine::ListCitiesL()</span>
<a name="l00037"></a>00037 <span class="comment">// Fills aCityListReturn with the names of the cities of</span>
<a name="l00038"></a>00038 <span class="comment">// whose name match to aSearchPattern.</span>
<a name="l00039"></a>00039 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00040"></a>00040 <span class="keywordtype">void</span> ListCitiesL( <span class="keyword">const</span> TDesC& aSearchPattern,
<a name="l00041"></a>00041 CDesC16ArrayFlat* aCityListReturn );
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00044"></a>00044 <span class="comment">// CTZLocalizerEngine::RemoveCityL()</span>
<a name="l00045"></a>00045 <span class="comment">// Removes a city from the user defined city collection </span>
<a name="l00046"></a>00046 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00047"></a>00047 <span class="keywordtype">void</span> RemoveCityL(<span class="keyword">const</span> TDesC& aCityName );
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00050"></a>00050 <span class="comment">// TPtrC CTZLocalizerEngine::GetCityName(CTzLocalizedCity *aLocalizedCity)</span>
<a name="l00051"></a>00051 <span class="comment">// Get current city name.</span>
<a name="l00052"></a>00052 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00053"></a>00053 TPtrC GetCityName(CTzLocalizedCity *aLocalizedCity);
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00056"></a>00056 <span class="comment">// CTZLocalizerEngine::GetCityTimeZoneId(CTzLocalizedCity *aLocalizedCity)</span>
<a name="l00057"></a>00057 <span class="comment">// Get current city time zone id.</span>
<a name="l00058"></a>00058 <span class="comment">// --------------------------------------------------------- </span>
<a name="l00059"></a>00059 TUint16 GetCityTimeZoneId(CTzLocalizedCity *aLocalizedCity);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00062"></a>00062 <span class="comment">// CTZLocalizerEngine::GetCityGroupId(CTzLocalizedCity *aLocalizedCity)</span>
<a name="l00063"></a>00063 <span class="comment">// Get current city group id.</span>
<a name="l00064"></a>00064 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00065"></a>00065 TUint8 GetCityGroupId(CTzLocalizedCity *aLocalizedCity);
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00068"></a>00068 <span class="comment">// CTZLocalizerEngine::GetCityLocalTime()</span>
<a name="l00069"></a>00069 <span class="comment">// Convert universal time to local time.</span>
<a name="l00070"></a>00070 <span class="comment">// --------------------------------------------------------- </span>
<a name="l00071"></a>00071 HBufC* GetCityLocalTimeL(CTzLocalizedCity *aLocalizedCity);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00074"></a>00074 <span class="comment">// CTZLocalizerEngine::FindCitiesInGroupL()</span>
<a name="l00075"></a>00075 <span class="comment">// Find the cities with same group id.</span>
<a name="l00076"></a>00076 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00077"></a>00077 CDesC16ArrayFlat* FindCitiesInGroupL( TInt aGroupID);
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00080"></a>00080 <span class="comment">// CTZLocalizerEngine::AddCityL()</span>
<a name="l00081"></a>00081 <span class="comment">// Add a new city to the database.</span>
<a name="l00082"></a>00082 <span class="comment">// --------------------------------------------------------- </span>
<a name="l00083"></a>00083 CTzLocalizedCity* AddCityL(TInt aTimeZoneId, <span class="keyword">const</span> TDesC &aCityName, TInt aGroupId=0);
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00086"></a>00086 <span class="comment">// CTZLocalizerEngine::FindCityL()</span>
<a name="l00087"></a>00087 <span class="comment">// Find the specific city.</span>
<a name="l00088"></a>00088 <span class="comment">// --------------------------------------------------------- </span>
<a name="l00089"></a>00089 CTzLocalizedCity* FindCityL(<span class="keyword">const</span> TDesC& aCityName);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00092"></a>00092 <span class="comment">// CTZLocalizerEngine::GetAllTimeZonesL()</span>
<a name="l00093"></a>00093 <span class="comment">// Fetch the localized time zone ID's</span>
<a name="l00094"></a>00094 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00095"></a>00095 CDesC16ArrayFlat* GetAllTimeZonesL();
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00098"></a>00098 <span class="comment">// CTZLocalizerEngine::GetAllGroupID()</span>
<a name="l00099"></a>00099 <span class="comment">// Fetch the localized city group ID's</span>
<a name="l00100"></a>00100 <span class="comment">// --------------------------------------------------------- </span>
<a name="l00101"></a>00101 CDesC16ArrayFlat* GetAllGroupIDL();
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00104"></a>00104 <span class="comment">// CDesC16ArrayFlat* CTZLocalizerEngine::GetAllCitiesL()</span>
<a name="l00105"></a>00105 <span class="comment">// Fetch the localized cities</span>
<a name="l00106"></a>00106 <span class="comment">// --------------------------------------------------------- </span>
<a name="l00107"></a>00107 CDesC16ArrayFlat* GetAllCitiesL();
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">private</span>: <span class="comment">// Data</span>
<a name="l00110"></a>00110
<a name="l00111"></a>00111 };
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="preprocessor">#endif</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span>
<a name="l00115"></a>00115 <span class="comment">// End of File</span>
<a name="l00116"></a>00116
</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>