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.
212 lines
14 KiB
XML
212 lines
14 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.11">
|
|
<compounddef id="classc_interface" kind="class" language="C++" prot="public" abstract="yes">
|
|
<compoundname>cInterface</compoundname>
|
|
<derivedcompoundref refid="classc_d_b_interface" prot="public" virt="non-virtual">cDBInterface</derivedcompoundref>
|
|
<derivedcompoundref refid="classc_import_interface" prot="public" virt="non-virtual">cImportInterface</derivedcompoundref>
|
|
<includes refid="c_interface_8h" local="no">cInterface.h</includes>
|
|
<sectiondef kind="public-type">
|
|
<memberdef kind="enum" id="classc_interface_1a41462a3131755963add9ba3026e7d31a" prot="public" static="no">
|
|
<name>iType</name>
|
|
<enumvalue id="classc_interface_1a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a" prot="public">
|
|
<name>iTypeImport</name>
|
|
<initializer>= 0</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>import plugin </para> </detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="classc_interface_1a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f" prot="public">
|
|
<name>iTypeExport</name>
|
|
<initializer>= 1</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>export plugin </para> </detaileddescription>
|
|
</enumvalue>
|
|
<enumvalue id="classc_interface_1a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a" prot="public">
|
|
<name>iTypeDB</name>
|
|
<initializer>= 2</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para>database connector </para> </detaileddescription>
|
|
</enumvalue>
|
|
<briefdescription>
|
|
<para>Defines the type of the interface. </para> </briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="Kooky/cInterface.h" line="39" column="1" bodyfile="Kooky/cInterface.h" bodystart="38" bodyend="43"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="public-func">
|
|
<memberdef kind="function" id="classc_interface_1a615b50a526c2d4ca73b13f8991371813" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>qint16</type>
|
|
<definition>virtual qint16 cInterface::pluginAPIVersion</definition>
|
|
<argsstring>()=0</argsstring>
|
|
<name>pluginAPIVersion</name>
|
|
<reimplementedby refid="classc_ernaehrung_plugin_1a44195e21ed764afb56bbcb4d64af1f3a">pluginAPIVersion</reimplementedby>
|
|
<reimplementedby refid="classc_bleib_fit_plugin_1aad11be7cf80b28becc6024e3827d4f75">pluginAPIVersion</reimplementedby>
|
|
<reimplementedby refid="classc_s_q_lite_plugin_1abe6689a26729e68d2167eb87e3bc2768">pluginAPIVersion</reimplementedby>
|
|
<reimplementedby refid="classc_my_s_q_l_plugin_1afbcc9dc99700cecd230b70d0384b0fd2">pluginAPIVersion</reimplementedby>
|
|
<briefdescription>
|
|
<para>Returns the version of the API. </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>This function must be derived by the subclass.</para></simplesect>
|
|
<simplesect kind="return"><para>qint16 version of the API </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="Kooky/cInterface.h" line="52" column="1"/>
|
|
<referencedby refid="classc_plugin_1a1055ecf4ff0d670e34291e3d5cc48d90" compoundref="cplugin_8cpp" startline="79" endline="86">cPlugin::pluginAPIVersion</referencedby>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classc_interface_1a17e5a0cf99317ab45f624e68b4a6ecca" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>QString</type>
|
|
<definition>virtual QString cInterface::pluginName</definition>
|
|
<argsstring>()=0</argsstring>
|
|
<name>pluginName</name>
|
|
<reimplementedby refid="classc_ernaehrung_plugin_1a67ea2bef7e9d68fe3705baff59c9fec5">pluginName</reimplementedby>
|
|
<reimplementedby refid="classc_bleib_fit_plugin_1aca281bc00f83bc4cd4b620a448825147">pluginName</reimplementedby>
|
|
<reimplementedby refid="classc_s_q_lite_plugin_1a073f7e6b4fa9804c58bdb4a5a758ffa4">pluginName</reimplementedby>
|
|
<reimplementedby refid="classc_my_s_q_l_plugin_1ae8eed8a248ddbb3f8372290571ddfb24">pluginName</reimplementedby>
|
|
<briefdescription>
|
|
<para>Returns the name of the plugin. </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>This function must be derived by the subclass. </para></simplesect>
|
|
<simplesect kind="note"><para>The name must be unique and will also be used to store configuration settings.</para></simplesect>
|
|
<simplesect kind="return"><para>QString name of the plugin. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="Kooky/cInterface.h" line="61" column="1"/>
|
|
<referencedby refid="classc_main_window_1a70fa99ff98426a5cc888a2de3ea83b07" compoundref="cmainwindow_8cpp" startline="258" endline="282">cMainWindow::pluginDBTriggered</referencedby>
|
|
<referencedby refid="classc_plugin_1a73b42f8c99d83faa8a2fe3ed994937a1" compoundref="cplugin_8cpp" startline="70" endline="77">cPlugin::pluginName</referencedby>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classc_interface_1aadc382036174c2a25bb2c23733830d33" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>qint16</type>
|
|
<definition>virtual qint16 cInterface::pluginVersion</definition>
|
|
<argsstring>()=0</argsstring>
|
|
<name>pluginVersion</name>
|
|
<reimplementedby refid="classc_ernaehrung_plugin_1a9f94e9684b541b55e67b87bff7a0a028">pluginVersion</reimplementedby>
|
|
<reimplementedby refid="classc_bleib_fit_plugin_1acb4fbabe875079913c8bbbbe7d9089f6">pluginVersion</reimplementedby>
|
|
<reimplementedby refid="classc_s_q_lite_plugin_1a680ffa394cab1bd545080c4ea72bd442">pluginVersion</reimplementedby>
|
|
<reimplementedby refid="classc_my_s_q_l_plugin_1af9f85d9af71685b373b114d8d2d98c6a">pluginVersion</reimplementedby>
|
|
<briefdescription>
|
|
<para>Version of the plugin. </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>This function must be derived by the subclass.</para></simplesect>
|
|
<simplesect kind="return"><para>qint16 version of the plugin. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="Kooky/cInterface.h" line="69" column="1"/>
|
|
<referencedby refid="classc_plugin_1a87bb0058c550e53f528e1197b5f6ac55" compoundref="cplugin_8cpp" startline="88" endline="95">cPlugin::pluginVersion</referencedby>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classc_interface_1af5e408cdaff527a872ce6d02a96301a4" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type><ref refid="classc_interface_1a41462a3131755963add9ba3026e7d31a" kindref="member">iType</ref></type>
|
|
<definition>virtual iType cInterface::pluginType</definition>
|
|
<argsstring>()=0</argsstring>
|
|
<name>pluginType</name>
|
|
<reimplementedby refid="classc_ernaehrung_plugin_1aadc57be2d4fa422a9cadcbf647926700">pluginType</reimplementedby>
|
|
<reimplementedby refid="classc_bleib_fit_plugin_1af2fc76ea7b59899780c5384721a88ebd">pluginType</reimplementedby>
|
|
<reimplementedby refid="classc_s_q_lite_plugin_1a1ba9b4a2e7dc962bbc67a89dc928fcee">pluginType</reimplementedby>
|
|
<reimplementedby refid="classc_my_s_q_l_plugin_1a76618f3bd8846fab6e3572e30df6fae7">pluginType</reimplementedby>
|
|
<briefdescription>
|
|
<para>Returns the type of the plugin. </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>This function must be derived by the subclass.</para></simplesect>
|
|
<simplesect kind="return"><para>iType type of the plugin (see enum iType). </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="Kooky/cInterface.h" line="77" column="1"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="classc_interface_1a040fbd069a2c2356faeda1c2d9ac88df" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
|
|
<type>bool</type>
|
|
<definition>virtual bool cInterface::config</definition>
|
|
<argsstring>()=0</argsstring>
|
|
<name>config</name>
|
|
<reimplementedby refid="classc_ernaehrung_plugin_1acbadba8cb20826f22cce60af8f4be98f">config</reimplementedby>
|
|
<reimplementedby refid="classc_bleib_fit_plugin_1a4ae455b66593fa29d82025b084c2639b">config</reimplementedby>
|
|
<reimplementedby refid="classc_s_q_lite_plugin_1a0ebe7b647b44908f2717c86900ac679d">config</reimplementedby>
|
|
<reimplementedby refid="classc_my_s_q_l_plugin_1ad8413f2440b3ce4390865bb08d238441">config</reimplementedby>
|
|
<briefdescription>
|
|
<para>Calls the configuration dialog (if any). </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>This function must be derived by the subclass.</para></simplesect>
|
|
<simplesect kind="return"><para>bool true on success, false otherwise. </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="Kooky/cInterface.h" line="86" column="1"/>
|
|
<referencedby refid="classc_main_window_1a70fa99ff98426a5cc888a2de3ea83b07" compoundref="cmainwindow_8cpp" startline="258" endline="282">cMainWindow::pluginDBTriggered</referencedby>
|
|
<referencedby refid="classc_options_plugins_1a102ea2333b1b8cdb69135dbd2ca10bed" compoundref="coptionsplugins_8cpp" startline="130" endline="162">cOptionsPlugins::showConfigDlg</referencedby>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
<para>This is the base class for all plugins. </para> </briefdescription>
|
|
<detaileddescription>
|
|
<para>This class implements basic interface functionality for all Kooky plugins. All functions may be overwritten by derriving classes.</para><para><simplesect kind="note"><para>Do not subclass this class directly, always use the appropriate subclass: <ref refid="classc_d_b_interface" kindref="compound">cDBInterface</ref> for database connectors, <ref refid="classc_import_interface" kindref="compound">cImportInterface</ref> for import plugins and cExportInterface for export plugins.</para></simplesect>
|
|
<simplesect kind="author"><para>Herwig Birke</para></simplesect>
|
|
<simplesect kind="version"><para>1.0</para></simplesect>
|
|
<simplesect kind="date"><para>2016/02/09 </para></simplesect>
|
|
</para> </detaileddescription>
|
|
<inheritancegraph>
|
|
<node id="143">
|
|
<label>cErnaehrungPlugin</label>
|
|
<link refid="classc_ernaehrung_plugin"/>
|
|
<childnode refid="141" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="140">
|
|
<label>cSQLitePlugin</label>
|
|
<link refid="classc_s_q_lite_plugin"/>
|
|
<childnode refid="138" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="139">
|
|
<label>cMySQLPlugin</label>
|
|
<link refid="classc_my_s_q_l_plugin"/>
|
|
<childnode refid="138" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="142">
|
|
<label>cBleibFitPlugin</label>
|
|
<link refid="classc_bleib_fit_plugin"/>
|
|
<childnode refid="141" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="137">
|
|
<label>cInterface</label>
|
|
<link refid="classc_interface"/>
|
|
</node>
|
|
<node id="138">
|
|
<label>cDBInterface</label>
|
|
<link refid="classc_d_b_interface"/>
|
|
<childnode refid="137" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
<node id="141">
|
|
<label>cImportInterface</label>
|
|
<link refid="classc_import_interface"/>
|
|
<childnode refid="137" relation="public-inheritance">
|
|
</childnode>
|
|
</node>
|
|
</inheritancegraph>
|
|
<location file="Kooky/cInterface.h" line="32" column="1" bodyfile="Kooky/cInterface.h" bodystart="31" bodyend="88"/>
|
|
<listofallmembers>
|
|
<member refid="classc_interface_1a040fbd069a2c2356faeda1c2d9ac88df" prot="public" virt="pure-virtual"><scope>cInterface</scope><name>config</name></member>
|
|
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31a" prot="public" virt="non-virtual"><scope>cInterface</scope><name>iType</name></member>
|
|
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a" prot="public" virt="non-virtual"><scope>cInterface</scope><name>iTypeDB</name></member>
|
|
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f" prot="public" virt="non-virtual"><scope>cInterface</scope><name>iTypeExport</name></member>
|
|
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a" prot="public" virt="non-virtual"><scope>cInterface</scope><name>iTypeImport</name></member>
|
|
<member refid="classc_interface_1a615b50a526c2d4ca73b13f8991371813" prot="public" virt="pure-virtual"><scope>cInterface</scope><name>pluginAPIVersion</name></member>
|
|
<member refid="classc_interface_1a17e5a0cf99317ab45f624e68b4a6ecca" prot="public" virt="pure-virtual"><scope>cInterface</scope><name>pluginName</name></member>
|
|
<member refid="classc_interface_1af5e408cdaff527a872ce6d02a96301a4" prot="public" virt="pure-virtual"><scope>cInterface</scope><name>pluginType</name></member>
|
|
<member refid="classc_interface_1aadc382036174c2a25bb2c23733830d33" prot="public" virt="pure-virtual"><scope>cInterface</scope><name>pluginVersion</name></member>
|
|
</listofallmembers>
|
|
</compounddef>
|
|
</doxygen>
|