ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RoutesDialog.html

changeset 19
f8e3c1676f9b
child 61
fe1e8783a95f
diff -r d76a0939be6a -r f8e3c1676f9b ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RoutesDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RoutesDialog.html	Sun Nov 22 14:12:44 2020 +0100
@@ -0,0 +1,234 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Project_Flask.ProjectFlask.RoutesDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Project_Flask.ProjectFlask.RoutesDialog</h1>
+
+<p>
+Module implementing a dialog to show the application routes.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#RoutesDialog">RoutesDialog</a></td>
+<td>Class implementing a dialog to show the application routes.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="RoutesDialog" ID="RoutesDialog"></a>
+<h2>RoutesDialog</h2>
+
+<p>
+    Class implementing a dialog to show the application routes.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_RoutesDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#RoutesDialog.__init__">RoutesDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.__processOutput">__processOutput</a></td>
+<td>Private method to process the flask output and populate the routes list.</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.on_allMethodsCheckBox_toggled">on_allMethodsCheckBox_toggled</a></td>
+<td>Private slot handling the selection to show all methods.</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.on_endpointButton_toggled">on_endpointButton_toggled</a></td>
+<td>Private slot handling the selection of the 'endpoint' sort order.</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.on_matchButton_toggled">on_matchButton_toggled</a></td>
+<td>Private slot handling the selection of the 'match' sort order.</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.on_methodsButton_toggled">on_methodsButton_toggled</a></td>
+<td>Private slot handling the selection of the 'methods' sort order.</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.on_ruleButton_toggled">on_ruleButton_toggled</a></td>
+<td>Private slot handling the selection of the 'rule' sort order.</td>
+</tr>
+<tr>
+<td><a href="#RoutesDialog.showRoutes">showRoutes</a></td>
+<td>Public method to show the list of routes.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="RoutesDialog.__init__" ID="RoutesDialog.__init__"></a>
+<h4>RoutesDialog (Constructor)</h4>
+<b>RoutesDialog</b>(<i>project, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="RoutesDialog.__processOutput" ID="RoutesDialog.__processOutput"></a>
+<h4>RoutesDialog.__processOutput</h4>
+<b>__processOutput</b>(<i>output</i>)
+
+<p>
+        Private method to process the flask output and populate the routes
+        list.
+</p>
+<dl>
+
+<dt><i>output</i> (str)</dt>
+<dd>
+output of the flask process
+</dd>
+</dl>
+<a NAME="RoutesDialog.on_allMethodsCheckBox_toggled" ID="RoutesDialog.on_allMethodsCheckBox_toggled"></a>
+<h4>RoutesDialog.on_allMethodsCheckBox_toggled</h4>
+<b>on_allMethodsCheckBox_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the selection to show all methods.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the button
+</dd>
+</dl>
+<a NAME="RoutesDialog.on_endpointButton_toggled" ID="RoutesDialog.on_endpointButton_toggled"></a>
+<h4>RoutesDialog.on_endpointButton_toggled</h4>
+<b>on_endpointButton_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the selection of the 'endpoint' sort order.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the button
+</dd>
+</dl>
+<a NAME="RoutesDialog.on_matchButton_toggled" ID="RoutesDialog.on_matchButton_toggled"></a>
+<h4>RoutesDialog.on_matchButton_toggled</h4>
+<b>on_matchButton_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the selection of the 'match' sort order.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the button
+</dd>
+</dl>
+<a NAME="RoutesDialog.on_methodsButton_toggled" ID="RoutesDialog.on_methodsButton_toggled"></a>
+<h4>RoutesDialog.on_methodsButton_toggled</h4>
+<b>on_methodsButton_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the selection of the 'methods' sort order.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the button
+</dd>
+</dl>
+<a NAME="RoutesDialog.on_ruleButton_toggled" ID="RoutesDialog.on_ruleButton_toggled"></a>
+<h4>RoutesDialog.on_ruleButton_toggled</h4>
+<b>on_ruleButton_toggled</b>(<i>checked</i>)
+
+<p>
+        Private slot handling the selection of the 'rule' sort order.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the button
+</dd>
+</dl>
+<a NAME="RoutesDialog.showRoutes" ID="RoutesDialog.showRoutes"></a>
+<h4>RoutesDialog.showRoutes</h4>
+<b>showRoutes</b>(<i></i>)
+
+<p>
+        Public method to show the list of routes.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial