Sun, 08 Oct 2017 17:57:18 +0200
Updated source docu.
44
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
1 | <!DOCTYPE html> |
17 | 2 | <html><head> |
3 | <title>Plugin_Refactoring_Rope.RefactoringRope.HelpDialog</title> | |
44
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
4 | <meta charset="UTF-8"> |
17 | 5 | <style> |
6 | body { | |
7 | background: #EDECE6; | |
8 | margin: 0em 1em 10em 1em; | |
9 | color: black; | |
10 | } | |
11 | ||
12 | h1 { color: white; background: #85774A; } | |
13 | h2 { color: white; background: #85774A; } | |
14 | h3 { color: white; background: #9D936E; } | |
15 | h4 { color: white; background: #9D936E; } | |
16 | ||
17 | a { color: #BA6D36; } | |
18 | ||
19 | </style> | |
20 | </head> | |
21 | <body><a NAME="top" ID="top"></a> | |
22 | <h1>Plugin_Refactoring_Rope.RefactoringRope.HelpDialog</h1> | |
23 | <p> | |
24 | Module implementing a dialog to show help about rope. | |
25 | </p> | |
26 | <h3>Global Attributes</h3> | |
27 | <table> | |
28 | <tr><td>None</td></tr> | |
29 | </table> | |
30 | <h3>Classes</h3> | |
31 | <table> | |
32 | <tr> | |
33 | <td><a href="#HelpDialog">HelpDialog</a></td> | |
34 | <td>Class implementing a dialog to show help about rope.</td> | |
35 | </tr> | |
36 | </table> | |
37 | <h3>Functions</h3> | |
38 | <table> | |
39 | <tr><td>None</td></tr> | |
40 | </table> | |
41 | <hr /><hr /> | |
42 | <a NAME="HelpDialog" ID="HelpDialog"></a> | |
43 | <h2>HelpDialog</h2> | |
44 | <p> | |
45 | Class implementing a dialog to show help about rope. | |
46 | </p> | |
47 | <h3>Derived from</h3> | |
48 | QDialog, Ui_HelpDialog | |
49 | <h3>Class Attributes</h3> | |
50 | <table> | |
51 | <tr><td>None</td></tr> | |
52 | </table> | |
44
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
53 | <h3>Class Methods</h3> |
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
54 | <table> |
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
55 | <tr><td>None</td></tr> |
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
56 | </table> |
17 | 57 | <h3>Methods</h3> |
58 | <table> | |
59 | <tr> | |
60 | <td><a href="#HelpDialog.__init__">HelpDialog</a></td> | |
61 | <td>Constructor</td> | |
62 | </tr><tr> | |
63 | <td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td> | |
64 | <td>Public slot to find the next occurrence of a text.</td> | |
65 | </tr><tr> | |
66 | <td><a href="#HelpDialog.helpWidget">helpWidget</a></td> | |
67 | <td>Public method to get a reference to the help widget.</td> | |
68 | </tr><tr> | |
69 | <td><a href="#HelpDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
70 | <td>Private slot called by a button of the button box clicked.</td> | |
71 | </tr> | |
72 | </table> | |
44
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
73 | <h3>Static Methods</h3> |
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
74 | <table> |
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
75 | <tr><td>None</td></tr> |
8aa985c8dee5
Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
24
diff
changeset
|
76 | </table> |
17 | 77 | <a NAME="HelpDialog.__init__" ID="HelpDialog.__init__"></a> |
78 | <h4>HelpDialog (Constructor)</h4> | |
24
e18b36080a37
Updated source docu after making the code PEP-8 compliant.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
79 | <b>HelpDialog</b>(<i>title, helpfile, parent=None</i>) |
17 | 80 | <p> |
81 | Constructor | |
82 | </p><dl> | |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
83 | <dt><i>title</i> (str)</dt> |
17 | 84 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
85 | window title |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
86 | </dd><dt><i>helpfile</i> (str)</dt> |
17 | 87 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
88 | filename of the helpfile |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
89 | </dd><dt><i>parent</i> (QWidget)</dt> |
17 | 90 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
91 | reference to the parent widget |
17 | 92 | </dd> |
93 | </dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> | |
94 | <h4>HelpDialog.findNextPrev</h4> | |
95 | <b>findNextPrev</b>(<i>txt, case, word, backwards</i>) | |
96 | <p> | |
97 | Public slot to find the next occurrence of a text. | |
98 | </p><dl> | |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
99 | <dt><i>txt</i> (str)</dt> |
17 | 100 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
101 | text to search for |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
102 | </dd><dt><i>case</i> (bool)</dt> |
17 | 103 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
104 | flag indicating a case sensitive search |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
105 | </dd><dt><i>word</i> (bool)</dt> |
17 | 106 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
107 | flag indicating a word based search |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
108 | </dd><dt><i>backwards</i> (bool)</dt> |
17 | 109 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
110 | flag indicating a backwards search |
17 | 111 | </dd> |
55
d501156be247
Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
44
diff
changeset
|
112 | </dl><dl> |
d501156be247
Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
44
diff
changeset
|
113 | <dt>Returns:</dt> |
d501156be247
Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
44
diff
changeset
|
114 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
115 | flag indicating the search found another occurrence |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
116 | </dd> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
117 | </dl><dl> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
118 | <dt>Return Type:</dt> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
119 | <dd> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
120 | bool |
55
d501156be247
Fixed code style issues.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
44
diff
changeset
|
121 | </dd> |
17 | 122 | </dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> |
123 | <h4>HelpDialog.helpWidget</h4> | |
124 | <b>helpWidget</b>(<i></i>) | |
125 | <p> | |
126 | Public method to get a reference to the help widget. | |
127 | </p><dl> | |
128 | <dt>Returns:</dt> | |
129 | <dd> | |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
130 | reference to the help widget |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
131 | </dd> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
132 | </dl><dl> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
133 | <dt>Return Type:</dt> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
134 | <dd> |
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
135 | QTextEdit |
17 | 136 | </dd> |
137 | </dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> | |
138 | <h4>HelpDialog.on_buttonBox_clicked</h4> | |
139 | <b>on_buttonBox_clicked</b>(<i>button</i>) | |
140 | <p> | |
141 | Private slot called by a button of the button box clicked. | |
142 | </p><dl> | |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
143 | <dt><i>button</i> (QAbstractButton)</dt> |
17 | 144 | <dd> |
204
b4bf79b956bc
Regenerated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
55
diff
changeset
|
145 | button that was clicked |
17 | 146 | </dd> |
147 | </dl> | |
148 | <div align="right"><a href="#top">Up</a></div> | |
149 | <hr /> | |
150 | </body></html> |