RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html

branch
server_client_variant
changeset 204
b4bf79b956bc
parent 55
d501156be247
child 321
d51e810107ec
equal deleted inserted replaced
203:c38750e1bafd 204:b4bf79b956bc
78 <h4>HelpDialog (Constructor)</h4> 78 <h4>HelpDialog (Constructor)</h4>
79 <b>HelpDialog</b>(<i>title, helpfile, parent=None</i>) 79 <b>HelpDialog</b>(<i>title, helpfile, parent=None</i>)
80 <p> 80 <p>
81 Constructor 81 Constructor
82 </p><dl> 82 </p><dl>
83 <dt><i>title</i></dt> 83 <dt><i>title</i> (str)</dt>
84 <dd> 84 <dd>
85 window title (string) 85 window title
86 </dd><dt><i>helpfile</i></dt> 86 </dd><dt><i>helpfile</i> (str)</dt>
87 <dd> 87 <dd>
88 filename of the helpfile (string) 88 filename of the helpfile
89 </dd><dt><i>parent</i></dt> 89 </dd><dt><i>parent</i> (QWidget)</dt>
90 <dd> 90 <dd>
91 reference to the parent widget (QWidget) 91 reference to the parent widget
92 </dd> 92 </dd>
93 </dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> 93 </dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a>
94 <h4>HelpDialog.findNextPrev</h4> 94 <h4>HelpDialog.findNextPrev</h4>
95 <b>findNextPrev</b>(<i>txt, case, word, backwards</i>) 95 <b>findNextPrev</b>(<i>txt, case, word, backwards</i>)
96 <p> 96 <p>
97 Public slot to find the next occurrence of a text. 97 Public slot to find the next occurrence of a text.
98 </p><dl> 98 </p><dl>
99 <dt><i>txt</i></dt> 99 <dt><i>txt</i> (str)</dt>
100 <dd> 100 <dd>
101 text to search for (string) 101 text to search for
102 </dd><dt><i>case</i></dt> 102 </dd><dt><i>case</i> (bool)</dt>
103 <dd> 103 <dd>
104 flag indicating a case sensitive search (boolean) 104 flag indicating a case sensitive search
105 </dd><dt><i>word</i></dt> 105 </dd><dt><i>word</i> (bool)</dt>
106 <dd> 106 <dd>
107 flag indicating a word based search (boolean) 107 flag indicating a word based search
108 </dd><dt><i>backwards</i></dt> 108 </dd><dt><i>backwards</i> (bool)</dt>
109 <dd> 109 <dd>
110 flag indicating a backwards search (boolean) 110 flag indicating a backwards search
111 </dd> 111 </dd>
112 </dl><dl> 112 </dl><dl>
113 <dt>Returns:</dt> 113 <dt>Returns:</dt>
114 <dd> 114 <dd>
115 flag indicating the search found another occurrence (boolean) 115 flag indicating the search found another occurrence
116 </dd>
117 </dl><dl>
118 <dt>Return Type:</dt>
119 <dd>
120 bool
116 </dd> 121 </dd>
117 </dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> 122 </dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a>
118 <h4>HelpDialog.helpWidget</h4> 123 <h4>HelpDialog.helpWidget</h4>
119 <b>helpWidget</b>(<i></i>) 124 <b>helpWidget</b>(<i></i>)
120 <p> 125 <p>
121 Public method to get a reference to the help widget. 126 Public method to get a reference to the help widget.
122 </p><dl> 127 </p><dl>
123 <dt>Returns:</dt> 128 <dt>Returns:</dt>
124 <dd> 129 <dd>
125 reference to the help widget (QTextEdit) 130 reference to the help widget
131 </dd>
132 </dl><dl>
133 <dt>Return Type:</dt>
134 <dd>
135 QTextEdit
126 </dd> 136 </dd>
127 </dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> 137 </dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a>
128 <h4>HelpDialog.on_buttonBox_clicked</h4> 138 <h4>HelpDialog.on_buttonBox_clicked</h4>
129 <b>on_buttonBox_clicked</b>(<i>button</i>) 139 <b>on_buttonBox_clicked</b>(<i>button</i>)
130 <p> 140 <p>
131 Private slot called by a button of the button box clicked. 141 Private slot called by a button of the button box clicked.
132 </p><dl> 142 </p><dl>
133 <dt><i>button</i></dt> 143 <dt><i>button</i> (QAbstractButton)</dt>
134 <dd> 144 <dd>
135 button that was clicked (QAbstractButton) 145 button that was clicked
136 </dd> 146 </dd>
137 </dl> 147 </dl>
138 <div align="right"><a href="#top">Up</a></div> 148 <div align="right"><a href="#top">Up</a></div>
139 <hr /> 149 <hr />
140 </body></html> 150 </body></html>

eric ide

mercurial