395 lines
15 KiB
XML
395 lines
15 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="classc_main_window">
|
|
<title>cMainWindow class Reference</title>
|
|
<para>
|
|
<programlisting>#include <link linkend="cmainwindow_8h"><cmainwindow.h></link></programlisting>
|
|
</para>
|
|
<para>Inheritance diagram for cMainWindow</para>
|
|
<para>
|
|
<figure>
|
|
<title>Inheritance graph</title>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata width="50%" align="center" valign="middle" scalefit="1" fileref="classc_main_window__inherit__graph.png"></imagedata>
|
|
</imageobject>
|
|
</mediaobject>
|
|
</figure>
|
|
</para>
|
|
<para>Collaboration diagram for cMainWindow</para>
|
|
<para>
|
|
<figure>
|
|
<title>Collaboration graph</title>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata width="50%" align="center" valign="middle" scalefit="1" fileref="classc_main_window__coll__graph.png"></imagedata>
|
|
</imageobject>
|
|
</mediaobject>
|
|
</figure>
|
|
</para>
|
|
<section>
|
|
<title>Private Attributes</title>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Ui::cMainWindow * ui</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QList< cPlugin * > m_pluginList</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QStandardItemModel * m_lpIngredientsListModel</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QAction * m_lpIngredientsListNew</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QAction * m_lpIngredientsListImport</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QAction * m_lpIngredientsListDelete</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QAction * m_lpIngredientsListEdit</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QMenu * m_lpIngredientsListMenu</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section>
|
|
<title></title>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para> <link linkend="classc_main_window_1a04f0ed523c7265f8d8b304e33aaa7d6d">cMainWindow</link> (
|
|
QWidget * parent)<para><emphasis>Constructor.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para> <link linkend="classc_main_window_1a5b40588af59f559083925f3f491da1e1">~cMainWindow</link> (
|
|
)<para><emphasis>Destructor.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>QList< <link linkend="classc_plugin">cPlugin</link> * > <link linkend="classc_main_window_1ae82e278f9aa88d228cd049392a314251">pluginList</link> (
|
|
)<para><emphasis>Returns the list of loaded plugins.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section>
|
|
<title></title>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section>
|
|
<title></title>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>void <link linkend="classc_main_window_1a3cc20776b1fd699783bcb1a0e2a33415">init</link> (
|
|
)<para><emphasis>Initialized main windows.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>void <link linkend="classc_main_window_1ac76cac25666ea2a0dc106b7829d560c7">initDefaultSettings</link> (
|
|
)<para><emphasis>Initializes default settings for Kooky.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>void <link linkend="classc_main_window_1a514f42d460641e3295b40867da99c50b">loadPlugins</link> (
|
|
const QString & szPluginDir)<para><emphasis>Loads plugins in the given path.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="classc_plugin">cPlugin</link> * <link linkend="classc_main_window_1a24aea0791cf5bca5bd044bfbb72ef224">plugin</link> (
|
|
QAction * lpAction)<para><emphasis>Finds a plugin with the given action.</emphasis></para>
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
<simplesect>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This class implements the main window and main functionality of Kooky.</para>
|
|
|
|
<para><formalpara><title>Author: </title>
|
|
|
|
<para>Herwig Birke</para>
|
|
</formalpara>
|
|
<formalpara><title>Version: </title>
|
|
|
|
<para>1.0</para>
|
|
</formalpara>
|
|
<formalpara><title>Date: </title>
|
|
|
|
<para>2016/02/09 </para>
|
|
</formalpara>
|
|
</para>
|
|
<para>Definition at line 43 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<section>
|
|
<title>Member Data Documentation</title>
|
|
<simplesect>
|
|
<title>Ui::cMainWindow* cMainWindow::ui</title>
|
|
<para>the main window GUI </para>
|
|
|
|
<para>Definition at line 120 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QList<cPlugin*> cMainWindow::m_pluginList</title>
|
|
<para>List of loaded plugins </para>
|
|
|
|
<para>Definition at line 121 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QStandardItemModel* cMainWindow::m_lpIngredientsListModel</title>
|
|
<para>standard item model for ingredients list </para>
|
|
|
|
<para>Definition at line 122 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QAction* cMainWindow::m_lpIngredientsListNew</title>
|
|
<para>"New Ingredient" Action for ingredients context menu </para>
|
|
|
|
<para>Definition at line 123 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QAction* cMainWindow::m_lpIngredientsListImport</title>
|
|
<para>"Import Ingredient" Action for ingredients context menu </para>
|
|
|
|
<para>Definition at line 124 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QAction* cMainWindow::m_lpIngredientsListDelete</title>
|
|
<para>"Delee Ingredient" Action for ingredients context menu </para>
|
|
|
|
<para>Definition at line 125 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QAction* cMainWindow::m_lpIngredientsListEdit</title>
|
|
<para>"Edit Ingredient" Action for ingredients context menu </para>
|
|
|
|
<para>Definition at line 126 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>QMenu* cMainWindow::m_lpIngredientsListMenu</title>
|
|
<para>Context menu for ingredients list </para>
|
|
|
|
<para>Definition at line 127 of file cmainwindow.h</para>
|
|
<para>The Documentation for this struct was generated from the following file: </para>
|
|
<para><itemizedlist><listitem><para>cmainwindow.h</para></listitem></itemizedlist></para>
|
|
</simplesect>
|
|
</section>
|
|
<section xml:id="classc_main_window_1a04f0ed523c7265f8d8b304e33aaa7d6d">
|
|
<title>cMainWindow::cMainWindow (QWidget *parent=0)</title>
|
|
<para>
|
|
<formalpara>
|
|
<title/>
|
|
<table frame="all">
|
|
<title>Parameters </title>
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>parent</entry>
|
|
<entry>
|
|
<para></para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</formalpara>
|
|
</para>
|
|
|
|
</section>
|
|
<section xml:id="classc_main_window_1ae82e278f9aa88d228cd049392a314251">
|
|
<title>QList< cPlugin * > cMainWindow::pluginList ()</title>
|
|
<para><formalpara><title>Returns: </title>
|
|
|
|
<para>QList<cPlugin *> List of loaded plugins. </para>
|
|
</formalpara>
|
|
</para>
|
|
|
|
</section>
|
|
<section xml:id="classc_main_window_1a514f42d460641e3295b40867da99c50b">
|
|
<title>void cMainWindow::loadPlugins (const QString &szPluginDir)</title>
|
|
<para>
|
|
<formalpara>
|
|
<title/>
|
|
<table frame="all">
|
|
<title>Parameters </title>
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>szPluginDir</entry>
|
|
<entry>
|
|
<para>Path to plugins </para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</formalpara>
|
|
</para>
|
|
|
|
</section>
|
|
<section xml:id="classc_main_window_1a24aea0791cf5bca5bd044bfbb72ef224">
|
|
<title>cPlugin * cMainWindow::plugin (QAction *lpAction)</title>
|
|
<para>
|
|
<formalpara>
|
|
<title/>
|
|
<table frame="all">
|
|
<title>Parameters </title>
|
|
<tgroup cols="2" align="left" colsep="1" rowsep="1">
|
|
<colspec colwidth="1*"/>
|
|
<colspec colwidth="4*"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>lpAction</entry>
|
|
<entry>
|
|
<para>Action of the plugin. </para>
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</formalpara>
|
|
<formalpara><title>Returns: </title>
|
|
|
|
<para><link linkend="classc_plugin">cPlugin</link> Plugin corresponding to the action, NULL if not found. </para>
|
|
</formalpara>
|
|
</para>
|
|
|
|
</section>
|
|
</section>
|