summaryrefslogtreecommitdiffstats
path: root/doxygen/man/man3/ndgui.3
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/man/man3/ndgui.3')
-rw-r--r--doxygen/man/man3/ndgui.3248
1 files changed, 0 insertions, 248 deletions
diff --git a/doxygen/man/man3/ndgui.3 b/doxygen/man/man3/ndgui.3
deleted file mode 100644
index 1290adb..0000000
--- a/doxygen/man/man3/ndgui.3
+++ /dev/null
@@ -1,248 +0,0 @@
-.TH "ndgui" 3 "Wed Nov 9 2011" "ndgui/NetworkDiscovery" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-ndgui \-
-.PP
-the GUI.
-
-.SH SYNOPSIS
-.br
-.PP
-.PP
-\fC#include <ndgui.h>\fP
-.SS "Public Slots"
-
-.in +1c
-.ti -1c
-.RI "void \fBhandleConnectionEstablished\fP (QString ifName)"
-.br
-.RI "\fIhandle if a interface is able to connect \fP"
-.ti -1c
-.RI "void \fBabortBoot\fP (QString msg)"
-.br
-.RI "\fIshow abortBoot dialog \fP"
-.ti -1c
-.RI "void \fBchooseInterfaceDialog\fP (QString msg)"
-.br
-.RI "\fIopens ths chooseInterfaceDialog \fP"
-.ti -1c
-.RI "void \fBhandleAllProcessesFinished\fP ()"
-.br
-.RI "\fIdetermines if we continue the boot sequence or if we show the chooseInterface or abortBoot dialog \fP"
-.ti -1c
-.RI "void \fBrestartSystem\fP ()"
-.br
-.RI "\fIrestart the system \fP"
-.ti -1c
-.RI "void \fBshutDownSystem\fP ()"
-.br
-.RI "\fIshut down the system \fP"
-.ti -1c
-.RI "void \fBcontinueBoot\fP (QString ifName)"
-.br
-.RI "\fIcontinue the boot sequence \fP"
-.ti -1c
-.RI "void \fBcontinueBootWithoutCheck\fP (QString ifName)"
-.br
-.RI "\fIcontinue the boot sequence without further checking if the connection is still possible. \fP"
-.ti -1c
-.RI "void \fBtryAgain\fP ()"
-.br
-.RI "\fIstarts the whole application again. \fP"
-.ti -1c
-.RI "void \fBstartSingleShot\fP ()"
-.br
-.RI "\fIstarts a singleshot event. \fP"
-.ti -1c
-.RI "void \fBstartNetworkDiscovery\fP ()"
-.br
-.RI "\fIstart the network discovery \fP"
-.ti -1c
-.RI "void \fBattachToDOM\fP ()"
-.br
-.RI "\fIstellt ein ndgui/fbgui Objekt zur verwendung durch die html bereit. \fP"
-.ti -1c
-.RI "void \fBloadJQuery\fP ()"
-.br
-.RI "\fIload jQuery and js scripts into the page so that all javascript functions will work. \fP"
-.ti -1c
-.RI "void \fBaddInterface\fP (const QString &ifName)"
-.br
-.RI "\fIadds an interface to the DOM tree. Creates its progress bar and it's status label. \fP"
-.ti -1c
-.RI "void \fBupdateIfStatus\fP (const QString &ifName, const QString &status)"
-.br
-.RI "\fIupdate the status for each interface \fP"
-.ti -1c
-.RI "void \fBupdateStatus\fP (const QString &status)"
-.br
-.RI "\fIupdates the over all status \fP"
-.ti -1c
-.RI "void \fBupdateIfProgressBar\fP (const QString &ifName, const int &percent)"
-.br
-.RI "\fIupdates the progress bar for each interface. \fP"
-.ti -1c
-.RI "void \fBnotifyCall\fP (QString msg)"
-.br
-.RI "\fIjust for debugging. \fP"
-.in -1c
-.SS "Signals"
-
-.in +1c
-.ti -1c
-.RI "void \fBinitFbgui\fP ()"
-.br
-.in -1c
-.SS "Public Member Functions"
-
-.in +1c
-.ti -1c
-.RI "\fBndgui\fP (QMainWindow *parent=0)"
-.br
-.ti -1c
-.RI "\fB~ndgui\fP ()"
-.br
-.ti -1c
-.RI "Q_INVOKABLE QVariantList \fBgetManualConfInterfaces\fP ()"
-.br
-.RI "\fIfills the drop down box of the manual interface configuration dialog. \fP"
-.ti -1c
-.RI "Q_INVOKABLE int \fBip4_setManualConfiguration\fP (QVariantMap result)"
-.br
-.RI "\fItakes the entered manual configuration dates and delivers it to the networkDiscovery for further actions. \fP"
-.ti -1c
-.RI "Q_INVOKABLE QString \fBreadLogFile\fP ()"
-.br
-.RI "\fIread the log file. Log File will be presented inside of a dialog. \fP"
-.ti -1c
-.RI "Q_INVOKABLE QVariantMap \fBgetInterfaceConf\fP (QString ifName)"
-.br
-.RI "\fIreturn a json formated interface configuration \fP"
-.in -1c
-.SH "Detailed Description"
-.PP
-the GUI.
-
-This class is responsible for creating and displaying the user interface. It also connects the webView via QWebBridge to javascript functions inside the html files.
-.SH "Constructor & Destructor Documentation"
-.PP
-.SS "ndgui::ndgui (QMainWindow *parent = \fC0\fP)"constructor
-.SS "ndgui::~ndgui ()"destructor
-.SH "Member Function Documentation"
-.PP
-.SS "void ndgui::abortBoot (QStringmsg)\fC [slot]\fP"
-.PP
-show abortBoot dialog \fBParameters:\fP
-.RS 4
-\fImsg\fP the message, displayed in the dialog.
-.RE
-.PP
-
-.SS "void ndgui::addInterface (const QString &ifName)\fC [slot]\fP"
-.PP
-adds an interface to the DOM tree. Creates its progress bar and it's status label. \fBParameters:\fP
-.RS 4
-\fIifName\fP name of the new interface.
-.RE
-.PP
-
-.SS "void ndgui::attachToDOM ()\fC [slot]\fP"
-.PP
-stellt ein ndgui/fbgui Objekt zur verwendung durch die html bereit.
-.SS "void ndgui::chooseInterfaceDialog (QStringmsg)\fC [slot]\fP"
-.PP
-opens ths chooseInterfaceDialog \fBParameters:\fP
-.RS 4
-\fImsg\fP the interfaces as json formated string. will be displayed in a select box.
-.RE
-.PP
-
-.SS "void ndgui::continueBoot (QStringifName)\fC [slot]\fP"
-.PP
-continue the boot sequence represents the end of the \fBNetworkDiscovery\fP life time. will start the fbgui screen. All networkDiscovery signals will be ignored after this point.
-.SS "void ndgui::continueBootWithoutCheck (QStringifName)\fC [slot]\fP"
-.PP
-continue the boot sequence without further checking if the connection is still possible.
-.SS "QVariantMap ndgui::getInterfaceConf (QStringifName)"
-.PP
-return a json formated interface configuration \fBParameters:\fP
-.RS 4
-\fIifName\fP the name of the interface
-.RE
-.PP
-
-.SS "QVariantList ndgui::getManualConfInterfaces ()"
-.PP
-fills the drop down box of the manual interface configuration dialog.
-.SS "void ndgui::handleAllProcessesFinished ()\fC [slot]\fP"
-.PP
-determines if we continue the boot sequence or if we show the chooseInterface or abortBoot dialog if we have a user choice (_userChoice = true) than networkDiscovery will emit a allProcessesFinished signal if all processes are done. This method determines if user will see an abort boot dialog (no interface names in the ifNameList list) or an choose interface dialog (one or more interface names in the list (add with handleConnectionEstablished)).
-.SS "void ndgui::handleConnectionEstablished (QStringifName)\fC [slot]\fP"
-.PP
-handle if a interface is able to connect if we have a user choice (_userChoice = true) than networkDiscovery will emit connectionEstablished signals. Add the interface name to a _ifNameList. This list holds all interfaces the user can choose out of.
-.SS "void ndgui::initFbgui ()\fC [signal]\fP"
-.SS "int ndgui::ip4_setManualConfiguration (QVariantMapjsonArr)"
-.PP
-takes the entered manual configuration dates and delivers it to the networkDiscovery for further actions. \fBParameters:\fP
-.RS 4
-\fIjsonArr\fP a jsonArr which contains the manual entered interface configuration
-.RE
-.PP
-
-.SS "void ndgui::loadJQuery ()\fC [slot]\fP"
-.PP
-load jQuery and js scripts into the page so that all javascript functions will work.
-.SS "void ndgui::notifyCall (QStringmsg)\fC [slot]\fP"
-.PP
-just for debugging.
-.SS "QString ndgui::readLogFile ()"
-.PP
-read the log file. Log File will be presented inside of a dialog.
-.SS "void ndgui::restartSystem ()\fC [slot]\fP"
-.PP
-restart the system this method will restart the system. triggered through a button click in the gui.
-.SS "void ndgui::shutDownSystem ()\fC [slot]\fP"
-.PP
-shut down the system this method will restart the system. triggered through a button click in the gui.
-.SS "void ndgui::startNetworkDiscovery ()\fC [slot]\fP"
-.PP
-start the network discovery main starting point of the whole procedure. disconnect the loadFinished signal with the startNetworkDiscovery and starts the networkDiscovery.
-.SS "void ndgui::startSingleShot ()\fC [slot]\fP"
-.PP
-starts a singleshot event. is connected to the singleShot event. Triggering this method means that we go on with the main \fBNetworkDiscovery\fP screen. connects the loadFinished signal of the _webView with the startNetworkDiscovery slot and removes the action.
-.SS "void ndgui::tryAgain ()\fC [slot]\fP"
-.PP
-starts the whole application again.
-.SS "void ndgui::updateIfProgressBar (const QString &ifName, const int &percent)\fC [slot]\fP"
-.PP
-updates the progress bar for each interface. \fBParameters:\fP
-.RS 4
-\fIifname\fP the name ot the interface to update
-.br
-\fIpercent\fP the progress in percent
-.RE
-.PP
-
-.SS "void ndgui::updateIfStatus (const QString &ifName, const QString &status)\fC [slot]\fP"
-.PP
-update the status for each interface \fBParameters:\fP
-.RS 4
-\fIifName\fP the name ot the interface to update
-.br
-\fIstatus\fP the new status of the interface.
-.RE
-.PP
-
-.SS "void ndgui::updateStatus (const QString &status)\fC [slot]\fP"
-.PP
-updates the over all status \fBParameters:\fP
-.RS 4
-\fIstatus\fP the new status message
-.RE
-.PP
-
-
-.SH "Author"
-.PP
-Generated automatically by Doxygen for ndgui/NetworkDiscovery from the source code.