src/eric7/Documentation/Source/eric7.Debugger.VariablesFilterDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Debugger.VariablesFilterDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Debugger.VariablesFilterDialog</h1>
<p>
Module implementing the variables filter dialog.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#VariablesFilterDialog">VariablesFilterDialog</a></td>
<td>Class implementing the variables filter dialog.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="VariablesFilterDialog" ID="VariablesFilterDialog"></a>
<h2>VariablesFilterDialog</h2>
<p>
    Class implementing the variables filter dialog.
</p>
<p>
    It opens a dialog window for the configuration of the variables type
    filters to be applied during a debugging session. Pressing 'Apply' will
    show the effect of the current selection on the currently shown variables.
    'Reset' will reset the selection to the one the dialog was opened with.
</p>

<h3>Signals</h3>
<dl>

<dt>applyFilterLists(list of str, list of str)</dt>
<dd>
emitted to apply the given
        locals and globals filters to the currently shown variables
</dd>
</dl>
<h3>Derived from</h3>
QDialog, Ui_VariablesFilterDialog
<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="#VariablesFilterDialog.__init__">VariablesFilterDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#VariablesFilterDialog.getSelection">getSelection</a></td>
<td>Public slot to retrieve the current selections.</td>
</tr>
<tr>
<td><a href="#VariablesFilterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot called by a button of the button box clicked.</td>
</tr>
<tr>
<td><a href="#VariablesFilterDialog.setSelection">setSelection</a></td>
<td>Public slot to set the current selection.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="VariablesFilterDialog.__init__" ID="VariablesFilterDialog.__init__"></a>
<h4>VariablesFilterDialog (Constructor)</h4>
<b>VariablesFilterDialog</b>(<i>parent=None, name=None, modal=False</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
<dt><i>name</i> (str)</dt>
<dd>
name of this dialog
</dd>
<dt><i>modal</i> (bool)</dt>
<dd>
flag to indicate a modal dialog
</dd>
</dl>
<a NAME="VariablesFilterDialog.getSelection" ID="VariablesFilterDialog.getSelection"></a>
<h4>VariablesFilterDialog.getSelection</h4>
<b>getSelection</b>(<i></i>)
<p>
        Public slot to retrieve the current selections.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple of lists containing the variable filters. The first list
            is the locals variables filter, the second the globals variables
            filter.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (list of str, list of str)
</dd>
</dl>
<a NAME="VariablesFilterDialog.on_buttonBox_clicked" ID="VariablesFilterDialog.on_buttonBox_clicked"></a>
<h4>VariablesFilterDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
<p>
        Private slot called by a button of the button box clicked.
</p>

<dl>

<dt><i>button</i> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl>
<a NAME="VariablesFilterDialog.setSelection" ID="VariablesFilterDialog.setSelection"></a>
<h4>VariablesFilterDialog.setSelection</h4>
<b>setSelection</b>(<i>lList, gList</i>)
<p>
        Public slot to set the current selection.
</p>

<dl>

<dt><i>lList</i> (list of str)</dt>
<dd>
local variables filter
</dd>
<dt><i>gList</i> (list of str)</dt>
<dd>
global variables filter
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>