PageRenderTime 27ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 1ms

/eric4-4.4.19/eric/Documentation/Source/eric4.Plugins.WizardPlugins.QRegExpWizard.QRegExpWizardDialog.html

#
HTML | 412 lines | 409 code | 3 blank | 0 comment | 0 complexity | 0795bb9e62cc9bce9de9e9f80e126809 MD5 | raw file
Possible License(s): GPL-3.0, LGPL-2.1, BSD-2-Clause
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
  3. 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  4. <html><head>
  5. <title>eric4.Plugins.WizardPlugins.QRegExpWizard.QRegExpWizardDialog</title>
  6. <style>
  7. body {
  8. background:white;
  9. margin: 0em 1em 10em 1em;
  10. color: black;
  11. }
  12. h1 { color: white; background: #4FA4FF; }
  13. h2 { color: white; background: #4FA4FF; }
  14. h3 { color: white; background: #00557F; }
  15. h4 { color: white; background: #00557F; }
  16. a { color: #AA5500; }
  17. </style>
  18. </head>
  19. <body><a NAME="top" ID="top"></a>
  20. <h1>eric4.Plugins.WizardPlugins.QRegExpWizard.QRegExpWizardDialog</h1>
  21. <p>
  22. Module implementing the QRegExp wizard dialog.
  23. </p>
  24. <h3>Global Attributes</h3>
  25. <table>
  26. <tr><td>None</td></tr>
  27. </table>
  28. <h3>Classes</h3>
  29. <table>
  30. <tr>
  31. <td><a href="#QRegExpWizardDialog">QRegExpWizardDialog</a></td>
  32. <td>Class for the dialog variant.</td>
  33. </tr><tr>
  34. <td><a href="#QRegExpWizardWidget">QRegExpWizardWidget</a></td>
  35. <td>Class implementing the QRegExp wizard dialog.</td>
  36. </tr><tr>
  37. <td><a href="#QRegExpWizardWindow">QRegExpWizardWindow</a></td>
  38. <td>Main window class for the standalone dialog.</td>
  39. </tr>
  40. </table>
  41. <h3>Functions</h3>
  42. <table>
  43. <tr><td>None</td></tr>
  44. </table>
  45. <hr /><hr />
  46. <a NAME="QRegExpWizardDialog" ID="QRegExpWizardDialog"></a>
  47. <h2>QRegExpWizardDialog</h2>
  48. <p>
  49. Class for the dialog variant.
  50. </p>
  51. <h3>Derived from</h3>
  52. QDialog
  53. <h3>Class Attributes</h3>
  54. <table>
  55. <tr><td>None</td></tr>
  56. </table>
  57. <h3>Class Methods</h3>
  58. <table>
  59. <tr><td>None</td></tr>
  60. </table>
  61. <h3>Methods</h3>
  62. <table>
  63. <tr>
  64. <td><a href="#QRegExpWizardDialog.__init__">QRegExpWizardDialog</a></td>
  65. <td>Constructor</td>
  66. </tr><tr>
  67. <td><a href="#QRegExpWizardDialog.getCode">getCode</a></td>
  68. <td>Public method to get the source code.</td>
  69. </tr>
  70. </table>
  71. <h3>Static Methods</h3>
  72. <table>
  73. <tr><td>None</td></tr>
  74. </table>
  75. <a NAME="QRegExpWizardDialog.__init__" ID="QRegExpWizardDialog.__init__"></a>
  76. <h4>QRegExpWizardDialog (Constructor)</h4>
  77. <b>QRegExpWizardDialog</b>(<i>parent = None, fromEric = True</i>)
  78. <p>
  79. Constructor
  80. </p><dl>
  81. <dt><i>parent</i></dt>
  82. <dd>
  83. parent widget (QWidget)
  84. </dd><dt><i>fromEric</i></dt>
  85. <dd>
  86. flag indicating a call from within eric4
  87. </dd>
  88. </dl><a NAME="QRegExpWizardDialog.getCode" ID="QRegExpWizardDialog.getCode"></a>
  89. <h4>QRegExpWizardDialog.getCode</h4>
  90. <b>getCode</b>(<i>indLevel, indString</i>)
  91. <p>
  92. Public method to get the source code.
  93. </p><dl>
  94. <dt><i>indLevel</i></dt>
  95. <dd>
  96. indentation level (int)
  97. </dd><dt><i>indString</i></dt>
  98. <dd>
  99. string used for indentation (space or tab) (string)
  100. </dd>
  101. </dl><dl>
  102. <dt>Returns:</dt>
  103. <dd>
  104. generated code (string)
  105. </dd>
  106. </dl>
  107. <div align="right"><a href="#top">Up</a></div>
  108. <hr /><hr />
  109. <a NAME="QRegExpWizardWidget" ID="QRegExpWizardWidget"></a>
  110. <h2>QRegExpWizardWidget</h2>
  111. <p>
  112. Class implementing the QRegExp wizard dialog.
  113. </p>
  114. <h3>Derived from</h3>
  115. QWidget, Ui_QRegExpWizardDialog
  116. <h3>Class Attributes</h3>
  117. <table>
  118. <tr><td>None</td></tr>
  119. </table>
  120. <h3>Class Methods</h3>
  121. <table>
  122. <tr><td>None</td></tr>
  123. </table>
  124. <h3>Methods</h3>
  125. <table>
  126. <tr>
  127. <td><a href="#QRegExpWizardWidget.__init__">QRegExpWizardWidget</a></td>
  128. <td>Constructor</td>
  129. </tr><tr>
  130. <td><a href="#QRegExpWizardWidget.__insertString">__insertString</a></td>
  131. <td>Private method to insert a string into line edit and move cursor.</td>
  132. </tr><tr>
  133. <td><a href="#QRegExpWizardWidget.getCode">getCode</a></td>
  134. <td>Public method to get the source code.</td>
  135. </tr><tr>
  136. <td><a href="#QRegExpWizardWidget.on_altnButton_clicked">on_altnButton_clicked</a></td>
  137. <td>Private slot to handle the alternatives toolbutton.</td>
  138. </tr><tr>
  139. <td><a href="#QRegExpWizardWidget.on_anycharButton_clicked">on_anycharButton_clicked</a></td>
  140. <td>Private slot to handle the any character toolbutton.</td>
  141. </tr><tr>
  142. <td><a href="#QRegExpWizardWidget.on_beglineButton_clicked">on_beglineButton_clicked</a></td>
  143. <td>Private slot to handle the begin line toolbutton.</td>
  144. </tr><tr>
  145. <td><a href="#QRegExpWizardWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
  146. <td>Private slot called by a button of the button box clicked.</td>
  147. </tr><tr>
  148. <td><a href="#QRegExpWizardWidget.on_charButton_clicked">on_charButton_clicked</a></td>
  149. <td>Private slot to handle the characters toolbutton.</td>
  150. </tr><tr>
  151. <td><a href="#QRegExpWizardWidget.on_copyButton_clicked">on_copyButton_clicked</a></td>
  152. <td>Private slot to copy the regexp string into the clipboard.</td>
  153. </tr><tr>
  154. <td><a href="#QRegExpWizardWidget.on_endlineButton_clicked">on_endlineButton_clicked</a></td>
  155. <td>Private slot to handle the end line toolbutton.</td>
  156. </tr><tr>
  157. <td><a href="#QRegExpWizardWidget.on_executeButton_clicked">on_executeButton_clicked</a></td>
  158. <td>Private slot to execute the entered regexp on the test text.</td>
  159. </tr><tr>
  160. <td><a href="#QRegExpWizardWidget.on_groupButton_clicked">on_groupButton_clicked</a></td>
  161. <td>Private slot to handle the group toolbutton.</td>
  162. </tr><tr>
  163. <td><a href="#QRegExpWizardWidget.on_loadButton_clicked">on_loadButton_clicked</a></td>
  164. <td>Private slot to load a regexp from a file.</td>
  165. </tr><tr>
  166. <td><a href="#QRegExpWizardWidget.on_neglookaheadButton_clicked">on_neglookaheadButton_clicked</a></td>
  167. <td>Private slot to handle the negative lookahead toolbutton.</td>
  168. </tr><tr>
  169. <td><a href="#QRegExpWizardWidget.on_nextButton_clicked">on_nextButton_clicked</a></td>
  170. <td>Private slot to find the next match.</td>
  171. </tr><tr>
  172. <td><a href="#QRegExpWizardWidget.on_nonGroupButton_clicked">on_nonGroupButton_clicked</a></td>
  173. <td>Private slot to handle the non group toolbutton.</td>
  174. </tr><tr>
  175. <td><a href="#QRegExpWizardWidget.on_nonwordboundButton_clicked">on_nonwordboundButton_clicked</a></td>
  176. <td>Private slot to handle the non word boundary toolbutton.</td>
  177. </tr><tr>
  178. <td><a href="#QRegExpWizardWidget.on_poslookaheadButton_clicked">on_poslookaheadButton_clicked</a></td>
  179. <td>Private slot to handle the positive lookahead toolbutton.</td>
  180. </tr><tr>
  181. <td><a href="#QRegExpWizardWidget.on_regexpLineEdit_textChanged">on_regexpLineEdit_textChanged</a></td>
  182. <td>Private slot called when the regexp changes.</td>
  183. </tr><tr>
  184. <td><a href="#QRegExpWizardWidget.on_repeatButton_clicked">on_repeatButton_clicked</a></td>
  185. <td>Private slot to handle the repeat toolbutton.</td>
  186. </tr><tr>
  187. <td><a href="#QRegExpWizardWidget.on_saveButton_clicked">on_saveButton_clicked</a></td>
  188. <td>Private slot to save the regexp to a file.</td>
  189. </tr><tr>
  190. <td><a href="#QRegExpWizardWidget.on_validateButton_clicked">on_validateButton_clicked</a></td>
  191. <td>Private slot to validate the entered regexp.</td>
  192. </tr><tr>
  193. <td><a href="#QRegExpWizardWidget.on_wordboundButton_clicked">on_wordboundButton_clicked</a></td>
  194. <td>Private slot to handle the word boundary toolbutton.</td>
  195. </tr>
  196. </table>
  197. <h3>Static Methods</h3>
  198. <table>
  199. <tr><td>None</td></tr>
  200. </table>
  201. <a NAME="QRegExpWizardWidget.__init__" ID="QRegExpWizardWidget.__init__"></a>
  202. <h4>QRegExpWizardWidget (Constructor)</h4>
  203. <b>QRegExpWizardWidget</b>(<i>parent = None, fromEric = True</i>)
  204. <p>
  205. Constructor
  206. </p><dl>
  207. <dt><i>parent</i></dt>
  208. <dd>
  209. parent widget (QWidget)
  210. </dd><dt><i>fromEric</i></dt>
  211. <dd>
  212. flag indicating a call from within eric4
  213. </dd>
  214. </dl><a NAME="QRegExpWizardWidget.__insertString" ID="QRegExpWizardWidget.__insertString"></a>
  215. <h4>QRegExpWizardWidget.__insertString</h4>
  216. <b>__insertString</b>(<i>s, steps=0</i>)
  217. <p>
  218. Private method to insert a string into line edit and move cursor.
  219. </p><dl>
  220. <dt><i>s</i></dt>
  221. <dd>
  222. string to be inserted into the regexp line edit
  223. (string or QString)
  224. </dd><dt><i>steps</i></dt>
  225. <dd>
  226. number of characters to move the cursor (integer).
  227. Negative steps moves cursor back, positives forward.
  228. </dd>
  229. </dl><a NAME="QRegExpWizardWidget.getCode" ID="QRegExpWizardWidget.getCode"></a>
  230. <h4>QRegExpWizardWidget.getCode</h4>
  231. <b>getCode</b>(<i>indLevel, indString</i>)
  232. <p>
  233. Public method to get the source code.
  234. </p><dl>
  235. <dt><i>indLevel</i></dt>
  236. <dd>
  237. indentation level (int)
  238. </dd><dt><i>indString</i></dt>
  239. <dd>
  240. string used for indentation (space or tab) (string)
  241. </dd>
  242. </dl><dl>
  243. <dt>Returns:</dt>
  244. <dd>
  245. generated code (string)
  246. </dd>
  247. </dl><a NAME="QRegExpWizardWidget.on_altnButton_clicked" ID="QRegExpWizardWidget.on_altnButton_clicked"></a>
  248. <h4>QRegExpWizardWidget.on_altnButton_clicked</h4>
  249. <b>on_altnButton_clicked</b>(<i></i>)
  250. <p>
  251. Private slot to handle the alternatives toolbutton.
  252. </p><a NAME="QRegExpWizardWidget.on_anycharButton_clicked" ID="QRegExpWizardWidget.on_anycharButton_clicked"></a>
  253. <h4>QRegExpWizardWidget.on_anycharButton_clicked</h4>
  254. <b>on_anycharButton_clicked</b>(<i></i>)
  255. <p>
  256. Private slot to handle the any character toolbutton.
  257. </p><a NAME="QRegExpWizardWidget.on_beglineButton_clicked" ID="QRegExpWizardWidget.on_beglineButton_clicked"></a>
  258. <h4>QRegExpWizardWidget.on_beglineButton_clicked</h4>
  259. <b>on_beglineButton_clicked</b>(<i></i>)
  260. <p>
  261. Private slot to handle the begin line toolbutton.
  262. </p><a NAME="QRegExpWizardWidget.on_buttonBox_clicked" ID="QRegExpWizardWidget.on_buttonBox_clicked"></a>
  263. <h4>QRegExpWizardWidget.on_buttonBox_clicked</h4>
  264. <b>on_buttonBox_clicked</b>(<i>button</i>)
  265. <p>
  266. Private slot called by a button of the button box clicked.
  267. </p><dl>
  268. <dt><i>button</i></dt>
  269. <dd>
  270. button that was clicked (QAbstractButton)
  271. </dd>
  272. </dl><a NAME="QRegExpWizardWidget.on_charButton_clicked" ID="QRegExpWizardWidget.on_charButton_clicked"></a>
  273. <h4>QRegExpWizardWidget.on_charButton_clicked</h4>
  274. <b>on_charButton_clicked</b>(<i></i>)
  275. <p>
  276. Private slot to handle the characters toolbutton.
  277. </p><a NAME="QRegExpWizardWidget.on_copyButton_clicked" ID="QRegExpWizardWidget.on_copyButton_clicked"></a>
  278. <h4>QRegExpWizardWidget.on_copyButton_clicked</h4>
  279. <b>on_copyButton_clicked</b>(<i></i>)
  280. <p>
  281. Private slot to copy the regexp string into the clipboard.
  282. </p><p>
  283. This slot is only available, if not called from within eric4.
  284. </p><a NAME="QRegExpWizardWidget.on_endlineButton_clicked" ID="QRegExpWizardWidget.on_endlineButton_clicked"></a>
  285. <h4>QRegExpWizardWidget.on_endlineButton_clicked</h4>
  286. <b>on_endlineButton_clicked</b>(<i></i>)
  287. <p>
  288. Private slot to handle the end line toolbutton.
  289. </p><a NAME="QRegExpWizardWidget.on_executeButton_clicked" ID="QRegExpWizardWidget.on_executeButton_clicked"></a>
  290. <h4>QRegExpWizardWidget.on_executeButton_clicked</h4>
  291. <b>on_executeButton_clicked</b>(<i>startpos = 0</i>)
  292. <p>
  293. Private slot to execute the entered regexp on the test text.
  294. </p><p>
  295. This slot will execute the entered regexp on the entered test
  296. data and will display the result in the table part of the dialog.
  297. </p><dl>
  298. <dt><i>startpos</i></dt>
  299. <dd>
  300. starting position for the regexp matching
  301. </dd>
  302. </dl><a NAME="QRegExpWizardWidget.on_groupButton_clicked" ID="QRegExpWizardWidget.on_groupButton_clicked"></a>
  303. <h4>QRegExpWizardWidget.on_groupButton_clicked</h4>
  304. <b>on_groupButton_clicked</b>(<i></i>)
  305. <p>
  306. Private slot to handle the group toolbutton.
  307. </p><a NAME="QRegExpWizardWidget.on_loadButton_clicked" ID="QRegExpWizardWidget.on_loadButton_clicked"></a>
  308. <h4>QRegExpWizardWidget.on_loadButton_clicked</h4>
  309. <b>on_loadButton_clicked</b>(<i></i>)
  310. <p>
  311. Private slot to load a regexp from a file.
  312. </p><a NAME="QRegExpWizardWidget.on_neglookaheadButton_clicked" ID="QRegExpWizardWidget.on_neglookaheadButton_clicked"></a>
  313. <h4>QRegExpWizardWidget.on_neglookaheadButton_clicked</h4>
  314. <b>on_neglookaheadButton_clicked</b>(<i></i>)
  315. <p>
  316. Private slot to handle the negative lookahead toolbutton.
  317. </p><a NAME="QRegExpWizardWidget.on_nextButton_clicked" ID="QRegExpWizardWidget.on_nextButton_clicked"></a>
  318. <h4>QRegExpWizardWidget.on_nextButton_clicked</h4>
  319. <b>on_nextButton_clicked</b>(<i></i>)
  320. <p>
  321. Private slot to find the next match.
  322. </p><a NAME="QRegExpWizardWidget.on_nonGroupButton_clicked" ID="QRegExpWizardWidget.on_nonGroupButton_clicked"></a>
  323. <h4>QRegExpWizardWidget.on_nonGroupButton_clicked</h4>
  324. <b>on_nonGroupButton_clicked</b>(<i></i>)
  325. <p>
  326. Private slot to handle the non group toolbutton.
  327. </p><a NAME="QRegExpWizardWidget.on_nonwordboundButton_clicked" ID="QRegExpWizardWidget.on_nonwordboundButton_clicked"></a>
  328. <h4>QRegExpWizardWidget.on_nonwordboundButton_clicked</h4>
  329. <b>on_nonwordboundButton_clicked</b>(<i></i>)
  330. <p>
  331. Private slot to handle the non word boundary toolbutton.
  332. </p><a NAME="QRegExpWizardWidget.on_poslookaheadButton_clicked" ID="QRegExpWizardWidget.on_poslookaheadButton_clicked"></a>
  333. <h4>QRegExpWizardWidget.on_poslookaheadButton_clicked</h4>
  334. <b>on_poslookaheadButton_clicked</b>(<i></i>)
  335. <p>
  336. Private slot to handle the positive lookahead toolbutton.
  337. </p><a NAME="QRegExpWizardWidget.on_regexpLineEdit_textChanged" ID="QRegExpWizardWidget.on_regexpLineEdit_textChanged"></a>
  338. <h4>QRegExpWizardWidget.on_regexpLineEdit_textChanged</h4>
  339. <b>on_regexpLineEdit_textChanged</b>(<i>txt</i>)
  340. <p>
  341. Private slot called when the regexp changes.
  342. </p><dl>
  343. <dt><i>txt</i></dt>
  344. <dd>
  345. the new text of the line edit (QString)
  346. </dd>
  347. </dl><a NAME="QRegExpWizardWidget.on_repeatButton_clicked" ID="QRegExpWizardWidget.on_repeatButton_clicked"></a>
  348. <h4>QRegExpWizardWidget.on_repeatButton_clicked</h4>
  349. <b>on_repeatButton_clicked</b>(<i></i>)
  350. <p>
  351. Private slot to handle the repeat toolbutton.
  352. </p><a NAME="QRegExpWizardWidget.on_saveButton_clicked" ID="QRegExpWizardWidget.on_saveButton_clicked"></a>
  353. <h4>QRegExpWizardWidget.on_saveButton_clicked</h4>
  354. <b>on_saveButton_clicked</b>(<i></i>)
  355. <p>
  356. Private slot to save the regexp to a file.
  357. </p><a NAME="QRegExpWizardWidget.on_validateButton_clicked" ID="QRegExpWizardWidget.on_validateButton_clicked"></a>
  358. <h4>QRegExpWizardWidget.on_validateButton_clicked</h4>
  359. <b>on_validateButton_clicked</b>(<i></i>)
  360. <p>
  361. Private slot to validate the entered regexp.
  362. </p><a NAME="QRegExpWizardWidget.on_wordboundButton_clicked" ID="QRegExpWizardWidget.on_wordboundButton_clicked"></a>
  363. <h4>QRegExpWizardWidget.on_wordboundButton_clicked</h4>
  364. <b>on_wordboundButton_clicked</b>(<i></i>)
  365. <p>
  366. Private slot to handle the word boundary toolbutton.
  367. </p>
  368. <div align="right"><a href="#top">Up</a></div>
  369. <hr /><hr />
  370. <a NAME="QRegExpWizardWindow" ID="QRegExpWizardWindow"></a>
  371. <h2>QRegExpWizardWindow</h2>
  372. <p>
  373. Main window class for the standalone dialog.
  374. </p>
  375. <h3>Derived from</h3>
  376. KQMainWindow
  377. <h3>Class Attributes</h3>
  378. <table>
  379. <tr><td>None</td></tr>
  380. </table>
  381. <h3>Class Methods</h3>
  382. <table>
  383. <tr><td>None</td></tr>
  384. </table>
  385. <h3>Methods</h3>
  386. <table>
  387. <tr>
  388. <td><a href="#QRegExpWizardWindow.__init__">QRegExpWizardWindow</a></td>
  389. <td>Constructor</td>
  390. </tr>
  391. </table>
  392. <h3>Static Methods</h3>
  393. <table>
  394. <tr><td>None</td></tr>
  395. </table>
  396. <a NAME="QRegExpWizardWindow.__init__" ID="QRegExpWizardWindow.__init__"></a>
  397. <h4>QRegExpWizardWindow (Constructor)</h4>
  398. <b>QRegExpWizardWindow</b>(<i>parent = None</i>)
  399. <p>
  400. Constructor
  401. </p><dl>
  402. <dt><i>parent</i></dt>
  403. <dd>
  404. reference to the parent widget (QWidget)
  405. </dd>
  406. </dl>
  407. <div align="right"><a href="#top">Up</a></div>
  408. <hr />
  409. </body></html>