Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_m_t_m_txt_settings.html
author Graeme Price <GRAEME.PRICE@NOKIA.COM>
Fri, 15 Oct 2010 14:32:18 +0100
changeset 15 307f4279f433
parent 6 43e37759235e
permissions -rw-r--r--
Initial contribution of the Adaptation Documentation.

<!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: CMTMTxtSettings Class Reference</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 -->
<div class="contents">
<h1>CMTMTxtSettings Class Reference</h1><!-- doxytag: class="CMTMTxtSettings" -->
<p><a href="class_c_m_t_m_txt_settings-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_m_t_m_txt_settings.html#a8bacda6a17021938317daba7326cfb0b">LoadSettingsL</a> (TMsvId aServiceId, <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;aSettings) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_m_t_m_txt_settings.html#ac9c5ff6643fb0a7c7e573da18159b08d">SaveSettingsL</a> (TMsvId aServiceId, const <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;aSettings)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7086d6dd50fa53b827f4a6d13c9a9f7a"></a><!-- doxytag: member="CMTMTxtSettings::DeleteSettingsL" ref="a7086d6dd50fa53b827f4a6d13c9a9f7a" args="(TMsvId aServiceId)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteSettingsL</b> (TMsvId aServiceId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TMsvId&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_m_t_m_txt_settings.html#a281520d5af2750933608c80ceba8b91e">DefaultServiceL</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_m_t_m_txt_settings.html#ab27db4213d9b7e484389146f4f43226b">SetDefaultServiceL</a> (TMsvId aService)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_m_t_m_txt_settings.html#a8de0c6d0a83ffe238b4495281305b3d0">DeleteDefaultServiceSettingL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ca906e13294fc8aae81fb18aee598fc"></a><!-- doxytag: member="CMTMTxtSettings::LoadSettingsL" ref="a4ca906e13294fc8aae81fb18aee598fc" args="(TMsvId aServiceId, TMTMTxtSettings &amp;aSettings) const " -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>LoadSettingsL</b> (TMsvId aServiceId, <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;aSettings) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29737c2c48e6f8244e2172083cd5d997"></a><!-- doxytag: member="CMTMTxtSettings::SaveSettingsL" ref="a29737c2c48e6f8244e2172083cd5d997" args="(TMsvId aServiceId, const TMTMTxtSettings &amp;aSettings)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SaveSettingsL</b> (TMsvId aServiceId, const <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;aSettings)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fe357b7137b50e6c55e02c7171057ab"></a><!-- doxytag: member="CMTMTxtSettings::DeleteSettingsL" ref="a8fe357b7137b50e6c55e02c7171057ab" args="(TMsvId aServiceId)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteSettingsL</b> (TMsvId aServiceId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a601b7a082fda39e4b0215732b36e391f"></a><!-- doxytag: member="CMTMTxtSettings::DefaultServiceL" ref="a601b7a082fda39e4b0215732b36e391f" args="() const " -->
IMPORT_C TMsvId&nbsp;</td><td class="memItemRight" valign="bottom"><b>DefaultServiceL</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f8e159d2c7f02228f738dc4e3ad14f7"></a><!-- doxytag: member="CMTMTxtSettings::SetDefaultServiceL" ref="a9f8e159d2c7f02228f738dc4e3ad14f7" args="(TMsvId aService)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetDefaultServiceL</b> (TMsvId aService)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a533dd7c6ddba26fc49fe2f5dd1738d2f"></a><!-- doxytag: member="CMTMTxtSettings::DeleteDefaultServiceSettingL" ref="a533dd7c6ddba26fc49fe2f5dd1738d2f" args="()" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteDefaultServiceSettingL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ca906e13294fc8aae81fb18aee598fc"></a><!-- doxytag: member="CMTMTxtSettings::LoadSettingsL" ref="a4ca906e13294fc8aae81fb18aee598fc" args="(TMsvId aServiceId, TMTMTxtSettings &amp;aSettings) const " -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>LoadSettingsL</b> (TMsvId aServiceId, <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;aSettings) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29737c2c48e6f8244e2172083cd5d997"></a><!-- doxytag: member="CMTMTxtSettings::SaveSettingsL" ref="a29737c2c48e6f8244e2172083cd5d997" args="(TMsvId aServiceId, const TMTMTxtSettings &amp;aSettings)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SaveSettingsL</b> (TMsvId aServiceId, const <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;aSettings)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fe357b7137b50e6c55e02c7171057ab"></a><!-- doxytag: member="CMTMTxtSettings::DeleteSettingsL" ref="a8fe357b7137b50e6c55e02c7171057ab" args="(TMsvId aServiceId)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteSettingsL</b> (TMsvId aServiceId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a601b7a082fda39e4b0215732b36e391f"></a><!-- doxytag: member="CMTMTxtSettings::DefaultServiceL" ref="a601b7a082fda39e4b0215732b36e391f" args="() const " -->
IMPORT_C TMsvId&nbsp;</td><td class="memItemRight" valign="bottom"><b>DefaultServiceL</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f8e159d2c7f02228f738dc4e3ad14f7"></a><!-- doxytag: member="CMTMTxtSettings::SetDefaultServiceL" ref="a9f8e159d2c7f02228f738dc4e3ad14f7" args="(TMsvId aService)" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetDefaultServiceL</b> (TMsvId aService)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a533dd7c6ddba26fc49fe2f5dd1738d2f"></a><!-- doxytag: member="CMTMTxtSettings::DeleteDefaultServiceSettingL" ref="a533dd7c6ddba26fc49fe2f5dd1738d2f" args="()" -->
IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteDefaultServiceSettingL</b> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61e9913363da6e4e2bec4590ea763f37"></a><!-- doxytag: member="CMTMTxtSettings::NewL" ref="a61e9913363da6e4e2bec4590ea763f37" args="()" -->
static IMPORT_C <a class="el" href="class_c_m_t_m_txt_settings.html">CMTMTxtSettings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace40f80f9922fc043713a40a084e4b6a"></a><!-- doxytag: member="CMTMTxtSettings::NewL" ref="ace40f80f9922fc043713a40a084e4b6a" args="()" -->
static IMPORT_C <a class="el" href="class_c_m_t_m_txt_settings.html">CMTMTxtSettings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace40f80f9922fc043713a40a084e4b6a"></a><!-- doxytag: member="CMTMTxtSettings::NewL" ref="ace40f80f9922fc043713a40a084e4b6a" args="()" -->
static IMPORT_C <a class="el" href="class_c_m_t_m_txt_settings.html">CMTMTxtSettings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>NewL</b> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>From 9.0, this class is used to store/load settings into the central repository. It also saves/loads a setting to identify a default textmtm service. </p>

<p>Definition at line <a class="el" href="_install_2src_2txut_8h_source.html#l00149">149</a> of file <a class="el" href="_install_2src_2txut_8h_source.html">txut.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8bacda6a17021938317daba7326cfb0b"></a><!-- doxytag: member="CMTMTxtSettings::LoadSettingsL" ref="a8bacda6a17021938317daba7326cfb0b" args="(TMsvId aServiceId, TMTMTxtSettings &amp;aSettings) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C void CMTMTxtSettings::LoadSettingsL </td>
          <td>(</td>
          <td class="paramtype">TMsvId&nbsp;</td>
          <td class="paramname"> <em>aServiceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aSettings</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Loads settings for textmtm service.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aServiceId</em>&nbsp;</td><td>ID of service entry</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aSettings</em>&nbsp;</td><td>Service settings </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="txut_8cpp_source.html#l00058">58</a> of file <a class="el" href="txut_8cpp_source.html">txut.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ac9c5ff6643fb0a7c7e573da18159b08d"></a><!-- doxytag: member="CMTMTxtSettings::SaveSettingsL" ref="ac9c5ff6643fb0a7c7e573da18159b08d" args="(TMsvId aServiceId, const TMTMTxtSettings &amp;aSettings)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C void CMTMTxtSettings::SaveSettingsL </td>
          <td>(</td>
          <td class="paramtype">TMsvId&nbsp;</td>
          <td class="paramname"> <em>aServiceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_t_m_t_m_txt_settings.html">TMTMTxtSettings</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>aSettings</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Stores settings for textmtm service.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aServiceId</em>&nbsp;</td><td>ID of service entry</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aSettings</em>&nbsp;</td><td>Service settings </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="txut_8cpp_source.html#l00073">73</a> of file <a class="el" href="txut_8cpp_source.html">txut.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a281520d5af2750933608c80ceba8b91e"></a><!-- doxytag: member="CMTMTxtSettings::DefaultServiceL" ref="a281520d5af2750933608c80ceba8b91e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C TMsvId CMTMTxtSettings::DefaultServiceL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the default textmtm service.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The default service</dd></dl>
<p>KErrNotFound If default service setting does not exist. </p>

<p>Definition at line <a class="el" href="txut_8cpp_source.html#l00113">113</a> of file <a class="el" href="txut_8cpp_source.html">txut.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab27db4213d9b7e484389146f4f43226b"></a><!-- doxytag: member="CMTMTxtSettings::SetDefaultServiceL" ref="ab27db4213d9b7e484389146f4f43226b" args="(TMsvId aService)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C void CMTMTxtSettings::SetDefaultServiceL </td>
          <td>(</td>
          <td class="paramtype">TMsvId&nbsp;</td>
          <td class="paramname"> <em>aService</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the default textmtm service.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aService</em>&nbsp;</td><td>The default service </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="txut_8cpp_source.html#l00101">101</a> of file <a class="el" href="txut_8cpp_source.html">txut.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8de0c6d0a83ffe238b4495281305b3d0"></a><!-- doxytag: member="CMTMTxtSettings::DeleteDefaultServiceSettingL" ref="a8de0c6d0a83ffe238b4495281305b3d0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EXPORT_C void CMTMTxtSettings::DeleteDefaultServiceSettingL </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Remove the default service setting. </p>

<p>Definition at line <a class="el" href="txut_8cpp_source.html#l00124">124</a> of file <a class="el" href="txut_8cpp_source.html">txut.cpp</a>.</p>

</div>
</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>