Mercurial Repositories > Pyramid Project / file comparison

comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html

ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html

changeset 133
8f183975895d
parent 54
71c83a661c83
child 144
5c3684ee818e
equal deleted inserted replaced
132:c0d53fb9a0e0 133:8f183975895d
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</h1> 23 <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog showing the available routes. 26 Module implementing a dialog showing the available routes.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PyramidRoutesDialog">PyramidRoutesDialog</a></td> 38 <td><a href="#PyramidRoutesDialog">PyramidRoutesDialog</a></td>
34 <td>Class implementing a dialog showing the available routes.</td> 39 <td>Class implementing a dialog showing the available routes.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="PyramidRoutesDialog" ID="PyramidRoutesDialog"></a> 49 <a NAME="PyramidRoutesDialog" ID="PyramidRoutesDialog"></a>
43 <h2>PyramidRoutesDialog</h2> 50 <h2>PyramidRoutesDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog showing the available routes. 53 Class implementing a dialog showing the available routes.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_PyramidRoutesDialog 56 QDialog, Ui_PyramidRoutesDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#PyramidRoutesDialog.__init__">PyramidRoutesDialog</a></td> 72 <td><a href="#PyramidRoutesDialog.__init__">PyramidRoutesDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#PyramidRoutesDialog.__procFinished">__procFinished</a></td> 76 <td><a href="#PyramidRoutesDialog.__procFinished">__procFinished</a></td>
64 <td>Private slot connected to the finished signal.</td> 77 <td>Private slot connected to the finished signal.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#PyramidRoutesDialog.__processBuffer">__processBuffer</a></td> 80 <td><a href="#PyramidRoutesDialog.__processBuffer">__processBuffer</a></td>
67 <td>Private slot to process the output buffer of the proutes command.</td> 81 <td>Private slot to process the output buffer of the proutes command.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#PyramidRoutesDialog.__readStderr">__readStderr</a></td> 84 <td><a href="#PyramidRoutesDialog.__readStderr">__readStderr</a></td>
70 <td>Private slot to handle the readyReadStandardError signal.</td> 85 <td>Private slot to handle the readyReadStandardError signal.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#PyramidRoutesDialog.__readStdout">__readStdout</a></td> 88 <td><a href="#PyramidRoutesDialog.__readStdout">__readStdout</a></td>
73 <td>Private slot to handle the readyReadStandardOutput signal.</td> 89 <td>Private slot to handle the readyReadStandardOutput signal.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#PyramidRoutesDialog.finish">finish</a></td> 92 <td><a href="#PyramidRoutesDialog.finish">finish</a></td>
76 <td>Public slot called when the process finished or the user pressed the button.</td> 93 <td>Public slot called when the process finished or the user pressed the button.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#PyramidRoutesDialog.keyPressEvent">keyPressEvent</a></td> 96 <td><a href="#PyramidRoutesDialog.keyPressEvent">keyPressEvent</a></td>
79 <td>Protected slot to handle a key press event.</td> 97 <td>Protected slot to handle a key press event.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#PyramidRoutesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 100 <td><a href="#PyramidRoutesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
82 <td>Private slot called by a button of the button box clicked.</td> 101 <td>Private slot called by a button of the button box clicked.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#PyramidRoutesDialog.on_input_returnPressed">on_input_returnPressed</a></td> 104 <td><a href="#PyramidRoutesDialog.on_input_returnPressed">on_input_returnPressed</a></td>
85 <td>Private slot to handle the press of the return key in the input field.</td> 105 <td>Private slot to handle the press of the return key in the input field.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#PyramidRoutesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> 108 <td><a href="#PyramidRoutesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
88 <td>Private slot to handle the password checkbox toggled.</td> 109 <td>Private slot to handle the password checkbox toggled.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#PyramidRoutesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> 112 <td><a href="#PyramidRoutesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
91 <td>Private slot to send the input to the subversion process.</td> 113 <td>Private slot to send the input to the subversion process.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#PyramidRoutesDialog.start">start</a></td> 116 <td><a href="#PyramidRoutesDialog.start">start</a></td>
94 <td>Public slot used to start the process.</td> 117 <td>Public slot used to start the process.</td>
95 </tr> 118 </tr>
96 </table> 119 </table>
97 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
98 <table> 121
99 <tr><td>None</td></tr> 122 <table>
100 </table> 123 <tr><td>None</td></tr>
124 </table>
125
101 <a NAME="PyramidRoutesDialog.__init__" ID="PyramidRoutesDialog.__init__"></a> 126 <a NAME="PyramidRoutesDialog.__init__" ID="PyramidRoutesDialog.__init__"></a>
102 <h4>PyramidRoutesDialog (Constructor)</h4> 127 <h4>PyramidRoutesDialog (Constructor)</h4>
103 <b>PyramidRoutesDialog</b>(<i>project, parent=None</i>) 128 <b>PyramidRoutesDialog</b>(<i>project, parent=None</i>)
129
104 <p> 130 <p>
105 Constructor 131 Constructor
106 </p><dl> 132 </p>
133 <dl>
134
107 <dt><i>project</i></dt> 135 <dt><i>project</i></dt>
108 <dd> 136 <dd>
109 reference to the project object 137 reference to the project object
110 (ProjectPyramid.Project.Project) 138 (ProjectPyramid.Project.Project)
111 </dd><dt><i>parent</i></dt> 139 </dd>
140 <dt><i>parent</i></dt>
112 <dd> 141 <dd>
113 reference to the parent widget (QWidget) 142 reference to the parent widget (QWidget)
114 </dd> 143 </dd>
115 </dl><a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a> 144 </dl>
145 <a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a>
116 <h4>PyramidRoutesDialog.__procFinished</h4> 146 <h4>PyramidRoutesDialog.__procFinished</h4>
117 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 147 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
148
118 <p> 149 <p>
119 Private slot connected to the finished signal. 150 Private slot connected to the finished signal.
120 </p><dl> 151 </p>
152 <dl>
153
121 <dt><i>exitCode</i></dt> 154 <dt><i>exitCode</i></dt>
122 <dd> 155 <dd>
123 exit code of the process (integer) 156 exit code of the process (integer)
124 </dd><dt><i>exitStatus</i></dt> 157 </dd>
158 <dt><i>exitStatus</i></dt>
125 <dd> 159 <dd>
126 exit status of the process (QProcess.ExitStatus) 160 exit status of the process (QProcess.ExitStatus)
127 </dd> 161 </dd>
128 </dl><a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a> 162 </dl>
163 <a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a>
129 <h4>PyramidRoutesDialog.__processBuffer</h4> 164 <h4>PyramidRoutesDialog.__processBuffer</h4>
130 <b>__processBuffer</b>(<i></i>) 165 <b>__processBuffer</b>(<i></i>)
166
131 <p> 167 <p>
132 Private slot to process the output buffer of the proutes command. 168 Private slot to process the output buffer of the proutes command.
133 </p><a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a> 169 </p>
170 <a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a>
134 <h4>PyramidRoutesDialog.__readStderr</h4> 171 <h4>PyramidRoutesDialog.__readStderr</h4>
135 <b>__readStderr</b>(<i></i>) 172 <b>__readStderr</b>(<i></i>)
173
136 <p> 174 <p>
137 Private slot to handle the readyReadStandardError signal. 175 Private slot to handle the readyReadStandardError signal.
138 </p><p> 176 </p>
177 <p>
139 It reads the error output of the process and inserts it into the 178 It reads the error output of the process and inserts it into the
140 error pane. 179 error pane.
141 </p><a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a> 180 </p>
181 <a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a>
142 <h4>PyramidRoutesDialog.__readStdout</h4> 182 <h4>PyramidRoutesDialog.__readStdout</h4>
143 <b>__readStdout</b>(<i></i>) 183 <b>__readStdout</b>(<i></i>)
184
144 <p> 185 <p>
145 Private slot to handle the readyReadStandardOutput signal. 186 Private slot to handle the readyReadStandardOutput signal.
146 </p><p> 187 </p>
188 <p>
147 It reads the output of the process and appends it to a buffer for 189 It reads the output of the process and appends it to a buffer for
148 delayed processing. 190 delayed processing.
149 </p><a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a> 191 </p>
192 <a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a>
150 <h4>PyramidRoutesDialog.finish</h4> 193 <h4>PyramidRoutesDialog.finish</h4>
151 <b>finish</b>(<i></i>) 194 <b>finish</b>(<i></i>)
195
152 <p> 196 <p>
153 Public slot called when the process finished or the user pressed the 197 Public slot called when the process finished or the user pressed the
154 button. 198 button.
155 </p><a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a> 199 </p>
200 <a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a>
156 <h4>PyramidRoutesDialog.keyPressEvent</h4> 201 <h4>PyramidRoutesDialog.keyPressEvent</h4>
157 <b>keyPressEvent</b>(<i>evt</i>) 202 <b>keyPressEvent</b>(<i>evt</i>)
203
158 <p> 204 <p>
159 Protected slot to handle a key press event. 205 Protected slot to handle a key press event.
160 </p><dl> 206 </p>
207 <dl>
208
161 <dt><i>evt</i></dt> 209 <dt><i>evt</i></dt>
162 <dd> 210 <dd>
163 the key press event (QKeyEvent) 211 the key press event (QKeyEvent)
164 </dd> 212 </dd>
165 </dl><a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a> 213 </dl>
214 <a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a>
166 <h4>PyramidRoutesDialog.on_buttonBox_clicked</h4> 215 <h4>PyramidRoutesDialog.on_buttonBox_clicked</h4>
167 <b>on_buttonBox_clicked</b>(<i>button</i>) 216 <b>on_buttonBox_clicked</b>(<i>button</i>)
217
168 <p> 218 <p>
169 Private slot called by a button of the button box clicked. 219 Private slot called by a button of the button box clicked.
170 </p><dl> 220 </p>
221 <dl>
222
171 <dt><i>button</i></dt> 223 <dt><i>button</i></dt>
172 <dd> 224 <dd>
173 button that was clicked (QAbstractButton) 225 button that was clicked (QAbstractButton)
174 </dd> 226 </dd>
175 </dl><a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a> 227 </dl>
228 <a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a>
176 <h4>PyramidRoutesDialog.on_input_returnPressed</h4> 229 <h4>PyramidRoutesDialog.on_input_returnPressed</h4>
177 <b>on_input_returnPressed</b>(<i></i>) 230 <b>on_input_returnPressed</b>(<i></i>)
231
178 <p> 232 <p>
179 Private slot to handle the press of the return key in the input field. 233 Private slot to handle the press of the return key in the input field.
180 </p><a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a> 234 </p>
235 <a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a>
181 <h4>PyramidRoutesDialog.on_passwordCheckBox_toggled</h4> 236 <h4>PyramidRoutesDialog.on_passwordCheckBox_toggled</h4>
182 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 237 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
238
183 <p> 239 <p>
184 Private slot to handle the password checkbox toggled. 240 Private slot to handle the password checkbox toggled.
185 </p><dl> 241 </p>
242 <dl>
243
186 <dt><i>isOn</i></dt> 244 <dt><i>isOn</i></dt>
187 <dd> 245 <dd>
188 flag indicating the status of the check box (boolean) 246 flag indicating the status of the check box (boolean)
189 </dd> 247 </dd>
190 </dl><a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a> 248 </dl>
249 <a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a>
191 <h4>PyramidRoutesDialog.on_sendButton_clicked</h4> 250 <h4>PyramidRoutesDialog.on_sendButton_clicked</h4>
192 <b>on_sendButton_clicked</b>(<i></i>) 251 <b>on_sendButton_clicked</b>(<i></i>)
252
193 <p> 253 <p>
194 Private slot to send the input to the subversion process. 254 Private slot to send the input to the subversion process.
195 </p><a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a> 255 </p>
256 <a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a>
196 <h4>PyramidRoutesDialog.start</h4> 257 <h4>PyramidRoutesDialog.start</h4>
197 <b>start</b>(<i>projectPath</i>) 258 <b>start</b>(<i>projectPath</i>)
259
198 <p> 260 <p>
199 Public slot used to start the process. 261 Public slot used to start the process.
200 </p><dl> 262 </p>
263 <dl>
264
201 <dt><i>projectPath</i></dt> 265 <dt><i>projectPath</i></dt>
202 <dd> 266 <dd>
203 path to the Pyramid project (string) 267 path to the Pyramid project (string)
204 </dd> 268 </dd>
205 </dl><dl> 269 </dl>
270 <dl>
206 <dt>Returns:</dt> 271 <dt>Returns:</dt>
207 <dd> 272 <dd>
208 flag indicating a successful start of the process 273 flag indicating a successful start of the process
209 </dd> 274 </dd>
210 </dl> 275 </dl>

Mercurial Repository: Pyramid Project

eric ide

mercurial