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/xml/classc_import_interface.xml

372 lines
24 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_import_interface" kind="class" language="C++" prot="public" abstract="yes">
<compoundname>cImportInterface</compoundname>
<basecompoundref refid="classc_interface" prot="public" virt="non-virtual">cInterface</basecompoundref>
<derivedcompoundref refid="classc_bleib_fit_plugin" prot="public" virt="non-virtual">cBleibFitPlugin</derivedcompoundref>
<derivedcompoundref refid="classc_ernaehrung_plugin" prot="public" virt="non-virtual">cErnaehrungPlugin</derivedcompoundref>
<includes refid="cimportinterface_8h" local="no">cimportinterface.h</includes>
<sectiondef kind="protected-attrib">
<memberdef kind="variable" id="classc_import_interface_1ae58ec0e6b990aa6624a12af9dc20e8dc" prot="protected" static="no" mutable="no">
<type>bool</type>
<definition>bool cImportInterface::m_bLoaded</definition>
<argsstring></argsstring>
<name>m_bLoaded</name>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>TODO: describe </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="99" column="1" bodyfile="Kooky/cimportinterface.h" bodystart="99" bodyend="-1"/>
<referencedby refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" compoundref="cimportinterface_8h" startline="63" endline="63">loaded</referencedby>
</memberdef>
<memberdef kind="variable" id="classc_import_interface_1ab18dd3e9cf49a07f23f376362fdf317b" prot="protected" static="no" mutable="no">
<type>qint16</type>
<definition>qint16 cImportInterface::m_iLoadedIndex</definition>
<argsstring></argsstring>
<name>m_iLoadedIndex</name>
<briefdescription>
</briefdescription>
<detaileddescription>
<para>TODO: describe </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="100" column="1" bodyfile="Kooky/cimportinterface.h" bodystart="100" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classc_import_interface_1a66f54591d75e8aa458e5afb91b3f3177" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type></type>
<definition>cImportInterface::cImportInterface</definition>
<argsstring>()</argsstring>
<name>cImportInterface</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="35" column="1" bodyfile="Kooky/cimportinterface.h" bodystart="35" bodyend="35"/>
<references refid="classc_import_interface_1a4ec2f198f8488e7daf2e93cf637a580d">detailsCapability</references>
<references refid="classc_import_interface_1a728bcb2a636f78bae2fe7e128a18e983">load</references>
<references refid="classc_import_interface_1a8b48a3821674ff15d7eaf4e03c55409f">search</references>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a4ec2f198f8488e7daf2e93cf637a580d" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>QMap&lt; QString, QString &gt;</type>
<definition>virtual QMap&lt;QString, QString&gt; cImportInterface::detailsCapability</definition>
<argsstring>()=0</argsstring>
<name>detailsCapability</name>
<reimplementedby refid="classc_ernaehrung_plugin_1a9fef4cc5e1c59999833ffb4493cfae3e">detailsCapability</reimplementedby>
<reimplementedby refid="classc_bleib_fit_plugin_1af3db6c6ff6bb28787d67e4cc3e957e90">detailsCapability</reimplementedby>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><simplesect kind="return"><para>QMap&lt;QString, QString&gt; </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="42" column="1"/>
<referencedby refid="classc_import_interface_1a66f54591d75e8aa458e5afb91b3f3177" compoundref="cimportinterface_8h" startline="35" endline="35">cImportInterface</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a8b48a3821674ff15d7eaf4e03c55409f" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>QStringList</type>
<definition>virtual QStringList cImportInterface::search</definition>
<argsstring>(const QString &amp;szSearch, const QString &amp;szDetails=QString(&quot;&quot;))=0</argsstring>
<name>search</name>
<reimplementedby refid="classc_ernaehrung_plugin_1aec19c86cca48415dbef841bc5b3cc15d">search</reimplementedby>
<reimplementedby refid="classc_bleib_fit_plugin_1a71d3dc9fc52a807e33608f2522c1ca31">search</reimplementedby>
<param>
<type>const QString &amp;</type>
<declname>szSearch</declname>
</param>
<param>
<type>const QString &amp;</type>
<declname>szDetails</declname>
<defval>QString(&quot;&quot;)</defval>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>szSearch</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>szDetails</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>QStringList </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="50" column="1"/>
<referencedby refid="classc_import_interface_1a66f54591d75e8aa458e5afb91b3f3177" compoundref="cimportinterface_8h" startline="35" endline="35">cImportInterface</referencedby>
<referencedby refid="classc_import_ingredient_dialog_1aad6f67e1420e7ceba52d6ea72bf70e88" compoundref="cimportingredientdialog_8cpp" startline="73" endline="105">cImportIngredientDialog::on_m_lpSearchButton_clicked</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a728bcb2a636f78bae2fe7e128a18e983" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>bool</type>
<definition>virtual bool cImportInterface::load</definition>
<argsstring>(qint16 iIndex)=0</argsstring>
<name>load</name>
<reimplementedby refid="classc_ernaehrung_plugin_1a2d688c0a56bed5b8f233dd5890a96a3d">load</reimplementedby>
<reimplementedby refid="classc_bleib_fit_plugin_1a15e5627fa41d2f079a96267e559fccee">load</reimplementedby>
<param>
<type>qint16</type>
<declname>iIndex</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>iIndex</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>bool </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="57" column="1"/>
<referencedby refid="classc_import_interface_1a66f54591d75e8aa458e5afb91b3f3177" compoundref="cimportinterface_8h" startline="35" endline="35">cImportInterface</referencedby>
<referencedby refid="classc_import_ingredient_dialog_1a7aaca4be76facdc5c90fd321825a6289" compoundref="cimportingredientdialog_8cpp" startline="107" endline="166">cImportIngredientDialog::onIngredientListSelectionChanged</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type>bool</type>
<definition>bool cImportInterface::loaded</definition>
<argsstring>()</argsstring>
<name>loaded</name>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><simplesect kind="return"><para>bool </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="63" column="1" bodyfile="Kooky/cimportinterface.h" bodystart="63" bodyend="63"/>
<references refid="classc_import_interface_1a1d31c90d6ef27a2b9edfb99e655120ea" compoundref="cimportinterface_8cpp" startline="4" endline="7">group</references>
<references refid="classc_import_interface_1af3f569b605787021a919816978f229bc">ingredientName</references>
<references refid="classc_import_interface_1ae58ec0e6b990aa6624a12af9dc20e8dc" compoundref="cimportinterface_8h" startline="99">m_bLoaded</references>
<references refid="classc_import_interface_1a685fafcac4d7194045e6c9e2d84d7981" compoundref="cimportinterface_8cpp" startline="9" endline="12">name</references>
<references refid="classc_import_interface_1a7a8dbe6a164549272d748d2f77aebc42">value</references>
<references refid="classc_import_interface_1a272c43d684b605f36d36cb20e4039d94" compoundref="cimportinterface_8cpp" startline="14" endline="33">valueStr</references>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a7a8dbe6a164549272d748d2f77aebc42" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>qreal</type>
<definition>virtual qreal cImportInterface::value</definition>
<argsstring>(cIngredient::iIngredient i)=0</argsstring>
<name>value</name>
<reimplementedby refid="classc_ernaehrung_plugin_1a8b4bb34247562c26687bb33e6369eb25">value</reimplementedby>
<reimplementedby refid="classc_bleib_fit_plugin_1adb3cc6882c32a04d6d9f31961f0b8dca">value</reimplementedby>
<param>
<type><ref refid="classc_ingredient_1acf023723841ec66cd6368a25e3174a28" kindref="member">cIngredient::iIngredient</ref></type>
<declname>i</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>i</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>qreal </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="70" column="1"/>
<referencedby refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" compoundref="cimportinterface_8h" startline="63" endline="63">loaded</referencedby>
<referencedby refid="classc_import_ingredient_dialog_1a7aaca4be76facdc5c90fd321825a6289" compoundref="cimportingredientdialog_8cpp" startline="107" endline="166">cImportIngredientDialog::onIngredientListSelectionChanged</referencedby>
<referencedby refid="classc_import_interface_1a272c43d684b605f36d36cb20e4039d94" compoundref="cimportinterface_8cpp" startline="14" endline="33">valueStr</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a272c43d684b605f36d36cb20e4039d94" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>QString</type>
<definition>QString cImportInterface::valueStr</definition>
<argsstring>(cIngredient::iIngredient i)</argsstring>
<name>valueStr</name>
<param>
<type><ref refid="classc_ingredient_1acf023723841ec66cd6368a25e3174a28" kindref="member">cIngredient::iIngredient</ref></type>
<declname>i</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>i</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>qreal </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="77" column="1" bodyfile="Kooky/cimportinterface.cpp" bodystart="14" bodyend="33"/>
<references refid="classc_ingredient_1acf023723841ec66cd6368a25e3174a28a910139fbdcbe825cbd17ab1f8d98bda1" compoundref="cingredient_8h" startline="42">cIngredient::iIngredientCalories</references>
<references refid="classc_ingredient_1acf023723841ec66cd6368a25e3174a28a48d0fa4c3d86c962711ea0ded41e7a93" compoundref="cingredient_8h" startline="196">cIngredient::iIngredientJoule</references>
<references refid="classc_import_interface_1a7a8dbe6a164549272d748d2f77aebc42">value</references>
<referencedby refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" compoundref="cimportinterface_8h" startline="63" endline="63">loaded</referencedby>
<referencedby refid="classc_import_ingredient_dialog_1a7aaca4be76facdc5c90fd321825a6289" compoundref="cimportingredientdialog_8cpp" startline="107" endline="166">cImportIngredientDialog::onIngredientListSelectionChanged</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a685fafcac4d7194045e6c9e2d84d7981" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>QString</type>
<definition>QString cImportInterface::name</definition>
<argsstring>(cIngredient::iIngredient i)</argsstring>
<name>name</name>
<param>
<type><ref refid="classc_ingredient_1acf023723841ec66cd6368a25e3174a28" kindref="member">cIngredient::iIngredient</ref></type>
<declname>i</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>i</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>QString </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="84" column="1" bodyfile="Kooky/cimportinterface.cpp" bodystart="9" bodyend="12"/>
<references refid="classc_ingredient_1a64d6e9c85a6b1527de28ed1f1185be29" compoundref="cingredient_8cpp" startline="267" endline="275">cIngredient::name</references>
<referencedby refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" compoundref="cimportinterface_8h" startline="63" endline="63">loaded</referencedby>
<referencedby refid="classc_import_ingredient_dialog_1a7aaca4be76facdc5c90fd321825a6289" compoundref="cimportingredientdialog_8cpp" startline="107" endline="166">cImportIngredientDialog::onIngredientListSelectionChanged</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1a1d31c90d6ef27a2b9edfb99e655120ea" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>QString</type>
<definition>QString cImportInterface::group</definition>
<argsstring>(cIngredient::iIngredient i)</argsstring>
<name>group</name>
<param>
<type><ref refid="classc_ingredient_1acf023723841ec66cd6368a25e3174a28" kindref="member">cIngredient::iIngredient</ref></type>
<declname>i</declname>
</param>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>i</parametername>
</parameternamelist>
<parameterdescription>
<para></para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>QString </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="91" column="1" bodyfile="Kooky/cimportinterface.cpp" bodystart="4" bodyend="7"/>
<references refid="classc_ingredient_1aa0da12658feecfd205c20e3a0335e9b0" compoundref="cingredient_8cpp" startline="256" endline="264">cIngredient::group</references>
<referencedby refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" compoundref="cimportinterface_8h" startline="63" endline="63">loaded</referencedby>
<referencedby refid="classc_import_ingredient_dialog_1a7aaca4be76facdc5c90fd321825a6289" compoundref="cimportingredientdialog_8cpp" startline="107" endline="166">cImportIngredientDialog::onIngredientListSelectionChanged</referencedby>
</memberdef>
<memberdef kind="function" id="classc_import_interface_1af3f569b605787021a919816978f229bc" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type>QString</type>
<definition>virtual QString cImportInterface::ingredientName</definition>
<argsstring>()=0</argsstring>
<name>ingredientName</name>
<reimplementedby refid="classc_ernaehrung_plugin_1a24c04c0b98fb4186e5b5b012662b39ed">ingredientName</reimplementedby>
<reimplementedby refid="classc_bleib_fit_plugin_1a67b808ffb0884950a8652cc72e8b2d80">ingredientName</reimplementedby>
<briefdescription>
</briefdescription>
<detaileddescription>
<para><simplesect kind="return"><para>QString </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="Kooky/cimportinterface.h" line="97" column="1"/>
<referencedby refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" compoundref="cimportinterface_8h" startline="63" endline="63">loaded</referencedby>
</memberdef>
</sectiondef>
<briefdescription>
<para>Interface class for importing data. </para> </briefdescription>
<detaileddescription>
<para>This class implements basic import functionality for Kooky. All functions may be overwritten by derriving classes.</para><para><simplesect kind="note"><para>Attempts at zen rarely work.</para></simplesect>
<simplesect kind="author"><para>Herwig Birke</para></simplesect>
<simplesect kind="version"><para>1.0</para></simplesect>
<simplesect kind="date"><para>$Date: 2016/02/09 </para></simplesect>
</para> </detaileddescription>
<inheritancegraph>
<node id="132">
<label>cErnaehrungPlugin</label>
<link refid="classc_ernaehrung_plugin"/>
<childnode refid="129" relation="public-inheritance">
</childnode>
</node>
<node id="131">
<label>cBleibFitPlugin</label>
<link refid="classc_bleib_fit_plugin"/>
<childnode refid="129" relation="public-inheritance">
</childnode>
</node>
<node id="130">
<label>cInterface</label>
<link refid="classc_interface"/>
</node>
<node id="129">
<label>cImportInterface</label>
<link refid="classc_import_interface"/>
<childnode refid="130" relation="public-inheritance">
</childnode>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="134">
<label>cInterface</label>
<link refid="classc_interface"/>
</node>
<node id="133">
<label>cImportInterface</label>
<link refid="classc_import_interface"/>
<childnode refid="134" relation="public-inheritance">
</childnode>
</node>
</collaborationgraph>
<location file="Kooky/cimportinterface.h" line="33" column="1" bodyfile="Kooky/cimportinterface.h" bodystart="32" bodyend="101"/>
<listofallmembers>
<member refid="classc_import_interface_1a66f54591d75e8aa458e5afb91b3f3177" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>cImportInterface</name></member>
<member refid="classc_interface_1a040fbd069a2c2356faeda1c2d9ac88df" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>config</name></member>
<member refid="classc_import_interface_1a4ec2f198f8488e7daf2e93cf637a580d" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>detailsCapability</name></member>
<member refid="classc_import_interface_1a1d31c90d6ef27a2b9edfb99e655120ea" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>group</name></member>
<member refid="classc_import_interface_1af3f569b605787021a919816978f229bc" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>ingredientName</name></member>
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31a" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>iType</name></member>
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31aa242858255f85f84d2c9791f376bf738a" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>iTypeDB</name></member>
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31aa4b8e5dcb2c471b3fb96ea37d8263612f" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>iTypeExport</name></member>
<member refid="classc_interface_1a41462a3131755963add9ba3026e7d31aa493982726026a437f9042749a76f456a" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>iTypeImport</name></member>
<member refid="classc_import_interface_1a728bcb2a636f78bae2fe7e128a18e983" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>load</name></member>
<member refid="classc_import_interface_1a898e0fc3651bbf855ee28756e69d48fb" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>loaded</name></member>
<member refid="classc_import_interface_1ae58ec0e6b990aa6624a12af9dc20e8dc" prot="protected" virt="non-virtual"><scope>cImportInterface</scope><name>m_bLoaded</name></member>
<member refid="classc_import_interface_1ab18dd3e9cf49a07f23f376362fdf317b" prot="protected" virt="non-virtual"><scope>cImportInterface</scope><name>m_iLoadedIndex</name></member>
<member refid="classc_import_interface_1a685fafcac4d7194045e6c9e2d84d7981" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>name</name></member>
<member refid="classc_interface_1a615b50a526c2d4ca73b13f8991371813" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>pluginAPIVersion</name></member>
<member refid="classc_interface_1a17e5a0cf99317ab45f624e68b4a6ecca" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>pluginName</name></member>
<member refid="classc_interface_1af5e408cdaff527a872ce6d02a96301a4" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>pluginType</name></member>
<member refid="classc_interface_1aadc382036174c2a25bb2c23733830d33" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>pluginVersion</name></member>
<member refid="classc_import_interface_1a8b48a3821674ff15d7eaf4e03c55409f" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>search</name></member>
<member refid="classc_import_interface_1a7a8dbe6a164549272d748d2f77aebc42" prot="public" virt="pure-virtual"><scope>cImportInterface</scope><name>value</name></member>
<member refid="classc_import_interface_1a272c43d684b605f36d36cb20e4039d94" prot="public" virt="non-virtual"><scope>cImportInterface</scope><name>valueStr</name></member>
</listofallmembers>
</compounddef>
</doxygen>