You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kooky/doxygen/html/c_interface_8h_source.html

139 lines
13 KiB
HTML

<!-- HTML header for doxygen 1.8.11-->
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kooky: Kooky/cInterface.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="windesign.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo3.jpg"/></td>
<td></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kooky
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('c_interface_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">cInterface.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="c_interface_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef CINTERFACE_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define CINTERFACE_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;QString&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classc_interface.html"> 31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classc_interface.html">cInterface</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classc_interface.html#a41462a3131755963add9ba3026e7d31a"> 38</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="classc_interface.html#a41462a3131755963add9ba3026e7d31a">iType</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a"> 40</a></span>&#160; <a class="code" href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a">iTypeImport</a> = 0, </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f"> 41</a></span>&#160; <a class="code" href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f">iTypeExport</a> = 1, </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a"> 42</a></span>&#160; <a class="code" href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a">iTypeDB</a> = 2, </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; };</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">virtual</span> qint16 <a class="code" href="classc_interface.html#a615b50a526c2d4ca73b13f8991371813">pluginAPIVersion</a>() = 0;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> QString <a class="code" href="classc_interface.html#a17e5a0cf99317ab45f624e68b4a6ecca">pluginName</a>() = 0;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> qint16 <a class="code" href="classc_interface.html#aadc382036174c2a25bb2c23733830d33">pluginVersion</a>() = 0;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classc_interface.html#a41462a3131755963add9ba3026e7d31a">iType</a> <a class="code" href="classc_interface.html#af5e408cdaff527a872ce6d02a96301a4">pluginType</a>() = 0;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classc_interface.html#a040fbd069a2c2356faeda1c2d9ac88df">config</a>() = 0;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;};</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="preprocessor">#endif // CINTERFACE_H</span></div><div class="ttc" id="classc_interface_html_a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f"><div class="ttname"><a href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f">cInterface::iTypeExport</a></div><div class="ttdef"><b>Definition:</b> cInterface.h:41</div></div>
<div class="ttc" id="classc_interface_html_a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a"><div class="ttname"><a href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a">cInterface::iTypeDB</a></div><div class="ttdef"><b>Definition:</b> cInterface.h:42</div></div>
<div class="ttc" id="classc_interface_html_aadc382036174c2a25bb2c23733830d33"><div class="ttname"><a href="classc_interface.html#aadc382036174c2a25bb2c23733830d33">cInterface::pluginVersion</a></div><div class="ttdeci">virtual qint16 pluginVersion()=0</div><div class="ttdoc">Version of the plugin. </div></div>
<div class="ttc" id="classc_interface_html_a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a"><div class="ttname"><a href="classc_interface.html#a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a">cInterface::iTypeImport</a></div><div class="ttdef"><b>Definition:</b> cInterface.h:40</div></div>
<div class="ttc" id="classc_interface_html"><div class="ttname"><a href="classc_interface.html">cInterface</a></div><div class="ttdoc">This is the base class for all plugins. </div><div class="ttdef"><b>Definition:</b> cInterface.h:31</div></div>
<div class="ttc" id="classc_interface_html_a41462a3131755963add9ba3026e7d31a"><div class="ttname"><a href="classc_interface.html#a41462a3131755963add9ba3026e7d31a">cInterface::iType</a></div><div class="ttdeci">iType</div><div class="ttdoc">Defines the type of the interface. </div><div class="ttdef"><b>Definition:</b> cInterface.h:38</div></div>
<div class="ttc" id="classc_interface_html_a615b50a526c2d4ca73b13f8991371813"><div class="ttname"><a href="classc_interface.html#a615b50a526c2d4ca73b13f8991371813">cInterface::pluginAPIVersion</a></div><div class="ttdeci">virtual qint16 pluginAPIVersion()=0</div><div class="ttdoc">Returns the version of the API. </div></div>
<div class="ttc" id="classc_interface_html_af5e408cdaff527a872ce6d02a96301a4"><div class="ttname"><a href="classc_interface.html#af5e408cdaff527a872ce6d02a96301a4">cInterface::pluginType</a></div><div class="ttdeci">virtual iType pluginType()=0</div><div class="ttdoc">Returns the type of the plugin. </div></div>
<div class="ttc" id="classc_interface_html_a17e5a0cf99317ab45f624e68b4a6ecca"><div class="ttname"><a href="classc_interface.html#a17e5a0cf99317ab45f624e68b4a6ecca">cInterface::pluginName</a></div><div class="ttdeci">virtual QString pluginName()=0</div><div class="ttdoc">Returns the name of the plugin. </div></div>
<div class="ttc" id="classc_interface_html_a040fbd069a2c2356faeda1c2d9ac88df"><div class="ttname"><a href="classc_interface.html#a040fbd069a2c2356faeda1c2d9ac88df">cInterface::config</a></div><div class="ttdeci">virtual bool config()=0</div><div class="ttdoc">Calls the configuration dialog (if any). </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.11-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_bb42744f2a7f9443d09426b2c9103c41.html">Kooky</a></li><li class="navelem"><a class="el" href="c_interface_8h.html">cInterface.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>