RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog</title>
<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_Refactoring_Rope.RefactoringRope.GetterSetterDialog</h1>
<p>
Module implementing a dialog to create getter and setter method names.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#GetterSetterDialog">GetterSetterDialog</a></td>
<td>Class implementing a dialog to create getter and setter method names.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a>
<h2>GetterSetterDialog</h2>
<p>
    Class implementing a dialog to create getter and setter method names.
</p>
<h3>Derived from</h3>
QDialog, Ui_GetterSetterDialog
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#GetterSetterDialog.getData">getData</a></td>
<td>Public method to return the getter and setter method names.</td>
</tr><tr>
<td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td>
<td>Slot to react to changes of the type checkbox.</td>
</tr>
</table>
<a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a>
<h4>GetterSetterDialog (Constructor)</h4>
<b>GetterSetterDialog</b>(<i>fieldName, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>fieldName</i></dt>
<dd>
name of the field to create getter and setter
            method names (string)
</dd><dt><i>parent</i></dt>
<dd>
parent widget of the dialog (QWidget)
</dd>
</dl><a NAME="GetterSetterDialog.getData" ID="GetterSetterDialog.getData"></a>
<h4>GetterSetterDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to return the getter and setter method names.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple of two strings with getter and setter method names
</dd>
</dl><a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a>
<h4>GetterSetterDialog.on_typeCheckBox_toggled</h4>
<b>on_typeCheckBox_toggled</b>(<i>checked</i>)
<p>
        Slot to react to changes of the type checkbox.
</p><dl>
<dt><i>checked</i></dt>
<dd>
state of the checkbox (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>