vcs.maemo.org Git - mdictionary/blob - doc/html/classTranslation.html

   1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <title>mDictionary: Translation Class Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javaScript" src="search/search.js"></script>
  10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  11 </head>
  12 <body onload='searchBox.OnSelectItem(0);'>
  13 <!-- Generated by Doxygen 1.6.3 -->
  14 <script type="text/javascript"><!--
  15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  16 --></script>
  17 <div class="navigation" id="top">
  18   <div class="tabs">
  19     <ul>
  20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  21       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li>
  24         <div id="MSearchBox" class="MSearchBoxInactive">
  25         <img id="MSearchSelect" src="search/search.png"
  26              onmouseover="return searchBox.OnSearchSelectShow()"
  27              onmouseout="return searchBox.OnSearchSelectHide()"
  28              alt=""/>
  29         <input type="text" id="MSearchField" value="Search" accesskey="S"
  30              onfocus="searchBox.OnSearchFieldFocus(true)"
  31              onblur="searchBox.OnSearchFieldFocus(false)"
  32              onkeyup="searchBox.OnSearchFieldChange(event)"/>
  33         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  34         </div>
  35       </li>
  36     </ul>
  37   </div>
  38   <div class="tabs">
  39     <ul>
  40       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  43     </ul>
  44   </div>
  45 </div>
  46 <div class="contents">
  47 <h1>Translation Class Reference</h1><!-- doxytag: class="Translation" -->
  48 <p>/file <a class="el" href="translation_8h_source.html">translation.h</a>
  49 <a href="#_details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="translation_8h_source.html">translation.h</a>&gt;</code></p>
  52 <div class="dynheader">
  53 Inheritance diagram for Translation:</div>
  54 <div class="dynsection">
  55  <div class="center">
  56   <img src="classTranslation.png" usemap="#Translation_map" alt=""/>
  57   <map id="Translation_map" name="Translation_map">
  58 <area href="classBookmarkTranslation.html" alt="BookmarkTranslation" shape="rect" coords="0,56,129,80"/>
  59 <area href="classTranslationXdxf.html" alt="TranslationXdxf" shape="rect" coords="139,56,268,80"/>
  60 </map>
  61  </div>
  62 </div>
  63
  64 <p><a href="classTranslation-members.html">List of all members.</a></p>
  65 <table border="0" cellpadding="0" cellspacing="0">
  66 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  67 <tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTranslation.html#ad79cf5dcb94a31865ec3c31ed2eb5c55">key</a> () const =0</td></tr>
  68 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f0cdfb6b44f44c7eecfd716b6163eb5"></a><!-- doxytag: member="Translation::operator==" ref="a3f0cdfb6b44f44c7eecfd716b6163eb5" args="(Translation *translation)" -->
  69 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (<a class="el" href="classTranslation.html">Translation</a> *translation)</td></tr>
  70 <tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTranslation.html#a8d61ceaea454b600964299d58dac8ad7">dictionaryInfo</a> () const =0</td></tr>
  71 <tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTranslation.html#acee3b3c3cdd8d1055f6d2e2c23c9bea0">toHtml</a> () const =0</td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58a3168e903ad58cc0c86ebe4ba8e6e2"></a><!-- doxytag: member="Translation::isBookmark" ref="a58a3168e903ad58cc0c86ebe4ba8e6e2" args="() const " -->
  73 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTranslation.html#a58a3168e903ad58cc0c86ebe4ba8e6e2">isBookmark</a> () const </td></tr>
  74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">whether given translation is taken from bookmarks <br/></td></tr>
  75 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTranslation.html#a7e0c987ec4b10543084e26dbd9dd964d">setBookmark</a> (bool b)</td></tr>
  76 <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
  77 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeddbbf7ea4d3cc4e96a2965a9acb7b90"></a><!-- doxytag: member="Translation::_bookmark" ref="aeddbbf7ea4d3cc4e96a2965a9acb7b90" args="" -->
  78 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>_bookmark</b></td></tr>
  79 </table>
  80 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  81 <p>/file <a class="el" href="translation_8h_source.html">translation.h</a> </p>
  82 <p>Interface for translation instances</p>
  83 <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTranslation.html" title="/file translation.h">Translation</a></dd></dl>
  84 <dl class="author"><dt><b>Author:</b></dt><dd>Bartosz Szatkowski &lt;<a href="mailto:bulislaw@linux.com">bulislaw@linux.com</a>&gt;</dd></dl>
  85 <p><a class="el" href="classTranslation.html" title="/file translation.h">Translation</a> is kind of GoF proxy, it stores key:translation pair and provide it in lazy way -&gt; key is available always, but translation is fetched as late as possible </p>
  86 <hr/><h2>Member Function Documentation</h2>
  87 <a class="anchor" id="a8d61ceaea454b600964299d58dac8ad7"></a><!-- doxytag: member="Translation::dictionaryInfo" ref="a8d61ceaea454b600964299d58dac8ad7" args="() const =0" -->
  88 <div class="memitem">
  89 <div class="memproto">
  90       <table class="memname">
  91         <tr>
  92           <td class="memname">virtual QString Translation::dictionaryInfo </td>
  93           <td>(</td>
  94           <td class="paramname"></td>
  95           <td>&nbsp;)&nbsp;</td>
  96           <td> const<code> [pure virtual]</code></td>
  97         </tr>
  98       </table>
  99 </div>
 100 <div class="memdoc">
 101 <dl class="return"><dt><b>Returns:</b></dt><dd>dictionary information (plugin name, languages, &lt;logo&gt; etc)\ to be displayed in translation table header </dd></dl>
 102
 103 <p>Implemented in <a class="el" href="classBookmarkTranslation.html#ab8bf0620bcdff42499f370c5914ec988">BookmarkTranslation</a>, and <a class="el" href="classTranslationXdxf.html#a6ed8752805971610dc7c6cfc28366e9d">TranslationXdxf</a>.</p>
 104
 105 </div>
 106 </div>
 107 <a class="anchor" id="ad79cf5dcb94a31865ec3c31ed2eb5c55"></a><!-- doxytag: member="Translation::key" ref="ad79cf5dcb94a31865ec3c31ed2eb5c55" args="() const =0" -->
 108 <div class="memitem">
 109 <div class="memproto">
 110       <table class="memname">
 111         <tr>
 112           <td class="memname">virtual QString Translation::key </td>
 113           <td>(</td>
 114           <td class="paramname"></td>
 115           <td>&nbsp;)&nbsp;</td>
 116           <td> const<code> [pure virtual]</code></td>
 117         </tr>
 118       </table>
 119 </div>
 120 <div class="memdoc">
 121 <dl class="return"><dt><b>Returns:</b></dt><dd>word to be translated </dd></dl>
 122
 123 <p>Implemented in <a class="el" href="classBookmarkTranslation.html#a36a26169f2013b2baa8921803be8f583">BookmarkTranslation</a>, and <a class="el" href="classTranslationXdxf.html#a66eb82634b0128ca003aaa2caa81555a">TranslationXdxf</a>.</p>
 124
 125 </div>
 126 </div>
 127 <a class="anchor" id="a7e0c987ec4b10543084e26dbd9dd964d"></a><!-- doxytag: member="Translation::setBookmark" ref="a7e0c987ec4b10543084e26dbd9dd964d" args="(bool b)" -->
 128 <div class="memitem">
 129 <div class="memproto">
 130       <table class="memname">
 131         <tr>
 132           <td class="memname">void Translation::setBookmark </td>
 133           <td>(</td>
 134           <td class="paramtype">bool&nbsp;</td>
 135           <td class="paramname"> <em>b</em></td>
 136           <td>&nbsp;)&nbsp;</td>
 137           <td><code> [inline]</code></td>
 138         </tr>
 139       </table>
 140 </div>
 141 <div class="memdoc">
 142 <dl><dt><b>Parameters:</b></dt><dd>
 143   <table border="0" cellspacing="2" cellpadding="0">
 144     <tr><td valign="top"></td><td valign="top"><em>b</em>&nbsp;</td><td>if true then translation is from bookmarks </td></tr>
 145   </table>
 146   </dd>
 147 </dl>
 148
 149 </div>
 150 </div>
 151 <a class="anchor" id="acee3b3c3cdd8d1055f6d2e2c23c9bea0"></a><!-- doxytag: member="Translation::toHtml" ref="acee3b3c3cdd8d1055f6d2e2c23c9bea0" args="() const =0" -->
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">virtual QString Translation::toHtml </td>
 157           <td>(</td>
 158           <td class="paramname"></td>
 159           <td>&nbsp;)&nbsp;</td>
 160           <td> const<code> [pure virtual]</code></td>
 161         </tr>
 162       </table>
 163 </div>
 164 <div class="memdoc">
 165 <dl class="return"><dt><b>Returns:</b></dt><dd>parsed raw format into html </dd></dl>
 166
 167 <p>Implemented in <a class="el" href="classBookmarkTranslation.html#a2f610661252e7f7569fd95a2b1e73e40">BookmarkTranslation</a>, and <a class="el" href="classTranslationXdxf.html#a136ccd2e4996a0463349333eb1fa9a92">TranslationXdxf</a>.</p>
 168
 169 </div>
 170 </div>
 171 <hr/>The documentation for this class was generated from the following file:<ul>
 172 <li><a class="el" href="translation_8h_source.html">translation.h</a></li>
 173 </ul>
 174 </div>
 175 <!--- window showing the filter options -->
 176 <div id="MSearchSelectWindow"
 177      onmouseover="return searchBox.OnSearchSelectShow()"
 178      onmouseout="return searchBox.OnSearchSelectHide()"
 179      onkeydown="return searchBox.OnSearchSelectKey(event)">
 180 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a></div>
 181
 182 <!-- iframe showing the search results (closed by default) -->
 183 <div id="MSearchResultsWindow">
 184 <iframe src="" frameborder="0"
 185         name="MSearchResults" id="MSearchResults">
 186 </iframe>
 187 </div>
 188
 189 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
 190 <a href="http://www.doxygen.org/index.html">
 191 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 192 </body>
 193 </html>