git.maemo.org Git - mdictionary/blob - doc/html/CommonDictInterface_8h_source.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: CommonDictInterface.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
  22       <li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
  41     </ul>
  42   </div>
  43 <h1>CommonDictInterface.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*******************************************************************************</span>
  44 <a name="l00002"></a>00002 <span class="comment"></span>
  45 <a name="l00003"></a>00003 <span class="comment">    This file is part of mDictionary.</span>
  46 <a name="l00004"></a>00004 <span class="comment"></span>
  47 <a name="l00005"></a>00005 <span class="comment">    mDictionary is free software: you can redistribute it and/or modify</span>
  48 <a name="l00006"></a>00006 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  49 <a name="l00007"></a>00007 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
  50 <a name="l00008"></a>00008 <span class="comment">    (at your option) any later version.</span>
  51 <a name="l00009"></a>00009 <span class="comment"></span>
  52 <a name="l00010"></a>00010 <span class="comment">    mDictionary is distributed in the hope that it will be useful,</span>
  53 <a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  54 <a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  55 <a name="l00013"></a>00013 <span class="comment">    GNU General Public License for more details.</span>
  56 <a name="l00014"></a>00014 <span class="comment"></span>
  57 <a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU General Public License</span>
  58 <a name="l00016"></a>00016 <span class="comment">    along with mDictionary.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  59 <a name="l00017"></a>00017 <span class="comment"></span>
  60 <a name="l00018"></a>00018 <span class="comment">    Copyright 2010 Comarch S.A.</span>
  61 <a name="l00019"></a>00019 <span class="comment"></span>
  62 <a name="l00020"></a>00020 <span class="comment">*******************************************************************************/</span>
  63 <a name="l00021"></a>00021
  64 <a name="l00028"></a>00028 <span class="preprocessor">#ifndef COMMONDICTINTERFACE_H</span>
  65 <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define COMMONDICTINTERFACE_H</span>
  66 <a name="l00030"></a>00030 <span class="preprocessor"></span>
  67 <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;QString&gt;</span>
  68 <a name="l00032"></a>00032 <span class="preprocessor">#include &lt;QDialog&gt;</span>
  69 <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;QObject&gt;</span>
  70 <a name="l00034"></a>00034 <span class="preprocessor">#include &lt;QList&gt;</span>
  71 <a name="l00035"></a>00035 <span class="preprocessor">#include &quot;translation.h&quot;</span>
  72 <a name="l00036"></a>00036
  73 <a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a>;
  74 <a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>;
  75 <a name="l00039"></a>00039
  76 <a name="l00040"></a>00040
  77 <a name="l00042"></a><a class="code" href="classCommonDictInterface.html">00042</a> <span class="keyword">class </span><a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a> : <span class="keyword">public</span> QObject {
  78 <a name="l00043"></a>00043   Q_OBJECT
  79 <a name="l00044"></a>00044   <span class="keyword">public</span>:
  80 <a name="l00045"></a>00045     <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>(QObject *parent = 0):QObject(parent) {}
  81 <a name="l00046"></a>00046
  82 <a name="l00048"></a>00048     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#a7f8b41dbaa0a5bdcb500c048ca501246" title="returns source language code iso 639-2">langFrom</a>() <span class="keyword">const</span> = 0;
  83 <a name="l00049"></a>00049
  84 <a name="l00051"></a>00051     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#a9ca51f27e6f4fc159a733849d2434707" title="returns destination language code iso 639-2">langTo</a>() <span class="keyword">const</span> = 0;
  85 <a name="l00052"></a>00052
  86 <a name="l00054"></a>00054     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#ab4ee01f92feb9cacb38cb3f326e7944a" title="returns dictionary name (like &amp;quot;old english&amp;quot; or so">name</a>() <span class="keyword">const</span> = 0;
  87 <a name="l00055"></a>00055
  88 <a name="l00057"></a>00057     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#af8739606ccb6314b40861f42bf45643d" title="returns dictionary type (xdxf, google translate, etc)">type</a>() <span class="keyword">const</span> = 0;
  89 <a name="l00058"></a>00058
  90 <a name="l00060"></a>00060     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#aedd525079e04426d5cad9f6b9e117191" title="returns information about dictionary in html (name, authors, etc)">infoNote</a>() <span class="keyword">const</span> = 0;
  91 <a name="l00061"></a>00061
  92 <a name="l00064"></a>00064     <span class="keyword">virtual</span> <a class="code" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a>* <a class="code" href="classCommonDictInterface.html#adbbe216cdb93e0324cf4a6946e8e7af1" title="returns DictDialog object that creates dialogs for adding new dictionary and change...">dictDialog</a>() = 0;
  93 <a name="l00065"></a>00065
  94 <a name="l00066"></a>00066
  95 <a name="l00068"></a>00068     <span class="keyword">virtual</span> <a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>* <a class="code" href="classCommonDictInterface.html#a319be492dd57d6e2828da2424cb57bb0" title="returns new, clean copy of plugin with setting set as in Settings*">getNew</a>(<span class="keyword">const</span> <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>*) <span class="keyword">const</span> = 0;
  96 <a name="l00069"></a>00069
  97 <a name="l00071"></a>00071     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942" title="returns whether plugin can start searching">isAvailable</a>() <span class="keyword">const</span> = 0;
  98 <a name="l00072"></a>00072
  99 <a name="l00074"></a>00074     <span class="keyword">virtual</span> QString <a class="code" href="classCommonDictInterface.html#af40b38d2c1eafd7f5dd70d29e8333f81" title="returns the actual translation of a word given in key">search</a>(QString key) = 0;
 100 <a name="l00075"></a>00075
 101 <a name="l00077"></a>00077     <span class="keyword">virtual</span> uint <a class="code" href="classCommonDictInterface.html#a0b58ce9f287e73155b3b4c43e81ae65a">hash</a>() <span class="keyword">const</span> = 0;
 102 <a name="l00078"></a>00078
 103 <a name="l00080"></a>00080     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#a3ccd6318ae40727de5e66a92cf2fc95e" title="sets unique value (unique for every dictionary not plugin)">setHash</a>(uint) = 0;
 104 <a name="l00081"></a>00081
 105 <a name="l00083"></a>00083     <span class="keyword">virtual</span> <a class="code" href="classSettings.html" title="Plugins or dictionaries may need to keep some of configuration between sessions,...">Settings</a>* <a class="code" href="classCommonDictInterface.html#a7a20fee14fa5255a1e34e213c93afbe7" title="returns current plugin settings">settings</a>() = 0;
 106 <a name="l00084"></a>00084
 107 <a name="l00086"></a>00086     <span class="keyword">virtual</span> QIcon* <a class="code" href="classCommonDictInterface.html#afb5213c49053122f9d8c6d0c1d2c222d" title="returns plugin icon">icon</a>() = 0;
 108 <a name="l00087"></a>00087
 109 <a name="l00088"></a>00088  <span class="keyword">public</span> Q_SLOTS:
 110 <a name="l00097"></a>00097     <span class="keyword">virtual</span> QList&lt;Translation*&gt; <a class="code" href="classCommonDictInterface.html#a27594c22d4df398e98af85b40b7407cb" title="performs search in dictionary">searchWordList</a>(QString word, <span class="keywordtype">int</span> limit=0) = 0;
 111 <a name="l00098"></a>00098
 112 <a name="l00100"></a>00100     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#a017f37eed4270d37cd5df36e546aacc6" title="stops current operation">stop</a>() = 0;
 113 <a name="l00101"></a>00101
 114 <a name="l00102"></a>00102   Q_SIGNALS:
 115 <a name="l00103"></a>00103
 116 <a name="l00105"></a>00105     <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#abeb1426ae67ac8bc43002756b0cc9308" title="emited after dictionary is ready to use afer being loaded">loaded</a>(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>*);
 117 <a name="l00106"></a>00106
 118 <a name="l00108"></a>00108     <span class="keywordtype">void</span> <a class="code" href="classCommonDictInterface.html#aeb500dfe5e18f544a01d5fa5352c3d36" title="emited after change dictionary settings">settingsChanged</a>();
 119 <a name="l00109"></a>00109 };
 120 <a name="l00110"></a>00110
 121 <a name="l00111"></a>00111 Q_DECLARE_INTERFACE(<a class="code" href="classCommonDictInterface.html" title="Interface for dict engines plugins.">CommonDictInterface</a>, <span class="stringliteral">&quot;CommonDictInterface/0.1&quot;</span>);
 122 <a name="l00112"></a>00112
 123 <a name="l00113"></a>00113 <span class="preprocessor">#endif</span>
 124 </pre></div></div>
 125 <!--- window showing the filter options -->
 126 <div id="MSearchSelectWindow"
 127      onmouseover="return searchBox.OnSearchSelectShow()"
 128      onmouseout="return searchBox.OnSearchSelectHide()"
 129      onkeydown="return searchBox.OnSearchSelectKey(event)">
 130 <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>
 131
 132 <!-- iframe showing the search results (closed by default) -->
 133 <div id="MSearchResultsWindow">
 134 <iframe src="" frameborder="0"
 135         name="MSearchResults" id="MSearchResults">
 136 </iframe>
 137 </div>
 138
 139 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
 140 <a href="http://www.doxygen.org/index.html">
 141 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 142 </body>
 143 </html>