Added documentation
[mdictionary] / doc / html / classDictTypeSelectDialog.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: DictTypeSelectDialog 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>DictTypeSelectDialog Class Reference</h1><!-- doxytag: class="DictTypeSelectDialog" -->
48 <p>Implements pluigin selection dialog.  
49 <a href="#_details">More...</a></p>
50
51 <p><code>#include &lt;<a class="el" href="DictTypeSelectDialog_8h_source.html">DictTypeSelectDialog.h</a>&gt;</code></p>
52
53 <p><a href="classDictTypeSelectDialog-members.html">List of all members.</a></p>
54 <table border="0" cellpadding="0" cellspacing="0">
55 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
56 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec7df0dd7f5f6f8855ed13a1f2370bce"></a><!-- doxytag: member="DictTypeSelectDialog::selectedPlugin" ref="aec7df0dd7f5f6f8855ed13a1f2370bce" args="()" -->
57 <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDictTypeSelectDialog.html#aec7df0dd7f5f6f8855ed13a1f2370bce">selectedPlugin</a> ()</td></tr>
58 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns selected by user plugin. <br/></td></tr>
59 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
60 <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDictTypeSelectDialog.html#a9723ce9b67fa215bb4a088d54196e821">addNewDict</a> (QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt; plugins, QWidget *parent=0)</td></tr>
61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shows dialog with list of plugins.  <a href="#a9723ce9b67fa215bb4a088d54196e821"></a><br/></td></tr>
62 <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
63 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee6124200f6aa55060c1e2bc2206a3f3"></a><!-- doxytag: member="DictTypeSelectDialog::DictTypeSelectDialog" ref="aee6124200f6aa55060c1e2bc2206a3f3" args="(QList&lt; CommonDictInterface * &gt; plugins, QWidget *parent=0)" -->
64 &nbsp;</td><td class="memItemRight" valign="bottom"><b>DictTypeSelectDialog</b> (QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt; plugins, QWidget *parent=0)</td></tr>
65 </table>
66 <hr/><a name="_details"></a><h2>Detailed Description</h2>
67 <p>Implements pluigin selection dialog. </p>
68 <p>Shows list of loaded dictionaries plugins. Static function addNewdict will return selected plugin. </p>
69 <hr/><h2>Member Function Documentation</h2>
70 <a class="anchor" id="a9723ce9b67fa215bb4a088d54196e821"></a><!-- doxytag: member="DictTypeSelectDialog::addNewDict" ref="a9723ce9b67fa215bb4a088d54196e821" args="(QList&lt; CommonDictInterface * &gt; plugins, QWidget *parent=0)" -->
71 <div class="memitem">
72 <div class="memproto">
73       <table class="memname">
74         <tr>
75           <td class="memname"><a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * DictTypeSelectDialog::addNewDict </td>
76           <td>(</td>
77           <td class="paramtype">QList&lt; <a class="el" href="classCommonDictInterface.html">CommonDictInterface</a> * &gt;&nbsp;</td>
78           <td class="paramname"> <em>plugins</em>, </td>
79         </tr>
80         <tr>
81           <td class="paramkey"></td>
82           <td></td>
83           <td class="paramtype">QWidget *&nbsp;</td>
84           <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
85         </tr>
86         <tr>
87           <td></td>
88           <td>)</td>
89           <td></td><td></td><td><code> [static]</code></td>
90         </tr>
91       </table>
92 </div>
93 <div class="memdoc">
94
95 <p>Shows dialog with list of plugins. </p>
96 <dl><dt><b>Parameters:</b></dt><dd>
97   <table border="0" cellspacing="2" cellpadding="0">
98     <tr><td valign="top"></td><td valign="top"><em>plugins</em>&nbsp;</td><td>list of loaded plugins </td></tr>
99     <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>widget </td></tr>
100   </table>
101   </dd>
102 </dl>
103 <dl class="return"><dt><b>Returns:</b></dt><dd>selected plugin, if user cancel dialog it returns NULL </dd></dl>
104
105 </div>
106 </div>
107 <hr/>The documentation for this class was generated from the following files:<ul>
108 <li><a class="el" href="DictTypeSelectDialog_8h_source.html">DictTypeSelectDialog.h</a></li>
109 <li>DictTypeSelectDialog.cpp</li>
110 </ul>
111 </div>
112 <!--- window showing the filter options -->
113 <div id="MSearchSelectWindow"
114      onmouseover="return searchBox.OnSearchSelectShow()"
115      onmouseout="return searchBox.OnSearchSelectHide()"
116      onkeydown="return searchBox.OnSearchSelectKey(event)">
117 <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>
118
119 <!-- iframe showing the search results (closed by default) -->
120 <div id="MSearchResultsWindow">
121 <iframe src="" frameborder="0" 
122         name="MSearchResults" id="MSearchResults">
123 </iframe>
124 </div>
125
126 <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Aug 18 16:45:34 2010 for mDictionary by&nbsp;
127 <a href="http://www.doxygen.org/index.html">
128 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
129 </body>
130 </html>