Updated documentation

[mdictionary] / doc / html / classCommonDictInterface.html

diff --git a/doc/html/classCommonDictInterface.html b/doc/html/classCommonDictInterface.html
index d5c74a2..22c8d4d 100644 (file)
--- a/doc/html/classCommonDictInterface.html
+++ b/doc/html/classCommonDictInterface.html
@@ -63,15 +63,18 @@ Inheritance diagram for CommonDictInterface:</div>
 <p><a href="classCommonDictInterface-members.html">List of all members.</a></p>
 <table border="0" cellpadding="0" cellspacing="0">
 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top">virtual QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a3ca9313571e0ecab66ce7a7c5d356f4f">searchWordList</a> (QString word, int limit)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performs search in dictionary  <a href="#a3ca9313571e0ecab66ce7a7c5d356f4f"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual QList&lt; <a class="el" href="classTranslation.html">Translation</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a27594c22d4df398e98af85b40b7407cb">searchWordList</a> (QString word, int limit=0)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">performs search in dictionary  <a href="#a27594c22d4df398e98af85b40b7407cb"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a017f37eed4270d37cd5df36e546aacc6"></a><!-- doxytag: member="CommonDictInterface::stop" ref="a017f37eed4270d37cd5df36e546aacc6" args="()=0" -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a017f37eed4270d37cd5df36e546aacc6">stop</a> ()=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stop current operation <br/></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stops current operation <br/></td></tr>
 <tr><td colspan="2"><h2>Signals</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeb1426ae67ac8bc43002756b0cc9308"></a><!-- doxytag: member="CommonDictInterface::loaded" ref="abeb1426ae67ac8bc43002756b0cc9308" args="(CommonDictInterface *)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#abeb1426ae67ac8bc43002756b0cc9308">loaded</a> (<a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *)</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after dictionary is ready to use afer being loaded <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb500dfe5e18f544a01d5fa5352c3d36"></a><!-- doxytag: member="CommonDictInterface::settingsChanged" ref="aeb500dfe5e18f544a01d5fa5352c3d36" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#aeb500dfe5e18f544a01d5fa5352c3d36">settingsChanged</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">emited after change dictionary settings <br/></td></tr>
 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c769e72d6832629d73c987ee9bb5840"></a><!-- doxytag: member="CommonDictInterface::CommonDictInterface" ref="a8c769e72d6832629d73c987ee9bb5840" args="(QObject *parent=0)" -->
 &nbsp;</td><td class="memItemRight" valign="bottom"><b>CommonDictInterface</b> (QObject *parent=0)</td></tr>
@@ -95,7 +98,7 @@ virtual <a class="el" href="classDictDialog.html">DictDialog</a> *&nbsp;</td><td
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns <a class="el" href="classDictDialog.html" title="Interface for plugin dialog provider.">DictDialog</a> object that creates dialogs for adding new dictionary and change plugin settings <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a319be492dd57d6e2828da2424cb57bb0"></a><!-- doxytag: member="CommonDictInterface::getNew" ref="a319be492dd57d6e2828da2424cb57bb0" args="(const Settings *) const =0" -->
 virtual <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a319be492dd57d6e2828da2424cb57bb0">getNew</a> (const <a class="el" href="classSettings.html">Settings</a> *) const =0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns new, clean copy of plugin with setting set as in Settings* <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72115c2e4a6c6e57d8adfbc240a2e942"></a><!-- doxytag: member="CommonDictInterface::isAvailable" ref="a72115c2e4a6c6e57d8adfbc240a2e942" args="() const =0" -->
 virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a72115c2e4a6c6e57d8adfbc240a2e942">isAvailable</a> () const =0</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns whether plugin can start searching <br/></td></tr>
@@ -105,10 +108,13 @@ virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el"
 <tr><td class="memItemLeft" align="right" valign="top">virtual uint&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a0b58ce9f287e73155b3b4c43e81ae65a">hash</a> () const =0</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ccd6318ae40727de5e66a92cf2fc95e"></a><!-- doxytag: member="CommonDictInterface::setHash" ref="a3ccd6318ae40727de5e66a92cf2fc95e" args="(uint)=0" -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a3ccd6318ae40727de5e66a92cf2fc95e">setHash</a> (uint)=0</td></tr>
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set unique value (unique for every dictionary not plugin) <br/></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets unique value (unique for every dictionary not plugin) <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a20fee14fa5255a1e34e213c93afbe7"></a><!-- doxytag: member="CommonDictInterface::settings" ref="a7a20fee14fa5255a1e34e213c93afbe7" args="()=0" -->
 virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#a7a20fee14fa5255a1e34e213c93afbe7">settings</a> ()=0</td></tr>
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns current plugin settings <br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac29057a9001f4acf6fcd6eec883cea62"></a><!-- doxytag: member="CommonDictInterface::icon" ref="ac29057a9001f4acf6fcd6eec883cea62" args="()=0" -->
+virtual QIcon&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCommonDictInterface.html#ac29057a9001f4acf6fcd6eec883cea62">icon</a> ()=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns plugin icon <br/></td></tr>
 </table>
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <p>Interface for dict engines plugins. </p>
@@ -133,7 +139,7 @@ virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td cla
 
 </div>
 </div>
-<a class="anchor" id="a3ca9313571e0ecab66ce7a7c5d356f4f"></a><!-- doxytag: member="CommonDictInterface::searchWordList" ref="a3ca9313571e0ecab66ce7a7c5d356f4f" args="(QString word, int limit)=0" -->
+<a class="anchor" id="a27594c22d4df398e98af85b40b7407cb"></a><!-- doxytag: member="CommonDictInterface::searchWordList" ref="a27594c22d4df398e98af85b40b7407cb" args="(QString word, int limit=0)=0" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -147,7 +153,7 @@ virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td cla
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&nbsp;</td>
-          <td class="paramname"> <em>limit</em></td><td>&nbsp;</td>
+          <td class="paramname"> <em>limit</em> = <code>0</code></td><td>&nbsp;</td>
         </tr>
         <tr>
           <td></td>
@@ -162,7 +168,7 @@ virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td cla
 <dl><dt><b>Parameters:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em>word</em>&nbsp;</td><td>word to search in dictionary </td></tr>
-    <tr><td valign="top"></td><td valign="top"><em>limit</em>&nbsp;</td><td>limit on number of results</td></tr>
+    <tr><td valign="top"></td><td valign="top"><em>limit</em>&nbsp;</td><td>limit on number of results, if limit=0 all matching words are returned</td></tr>
   </table>
   </dd>
 </dl>
@@ -173,8 +179,9 @@ virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td cla
 
 </div>
 </div>
-<hr/>The documentation for this class was generated from the following file:<ul>
+<hr/>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="CommonDictInterface_8h_source.html">CommonDictInterface.h</a></li>
+<li>moc_CommonDictInterface.cpp</li>
 </ul>
 </div>
 <!--- window showing the filter options -->
@@ -182,7 +189,7 @@ virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td cla
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
-<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>Functions</a></div>
+<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>
 
 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
@@ -191,7 +198,7 @@ virtual <a class="el" href="classSettings.html">Settings</a> *&nbsp;</td><td cla
 </iframe>
 </div>
 
-<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Aug 6 11:51:04 2010 for mDictionary by&nbsp;
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 12 14:34:59 2010 for mDictionary by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 </body>