PageRenderTime 66ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 0ms

/eric4-4.4.19/eric/Documentation/Source/eric4.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog.html

#
HTML | 378 lines | 375 code | 3 blank | 0 comment | 0 complexity | ce2d6c1d524838f320e209af7226befe MD5 | raw file
Possible License(s): GPL-3.0, LGPL-2.1, BSD-2-Clause 
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
    3. 

  3. 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
    4. 

  4. <html><head>
    5. 

  5. <title>eric4.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog</title>
    6. 

  6. <style>
    7. 

  7. body {
    8. 

  8.     background:white;
    9. 

  9.     margin: 0em 1em 10em 1em;
    10. 

  10.     color: black;
    11. 

  11. }
    12. 

  12. 

  13. h1 { color: white; background: #4FA4FF; }
    14. 

  14. h2 { color: white; background: #4FA4FF; }
    15. 

  15. h3 { color: white; background: #00557F; }
    16. 

  16. h4 { color: white; background: #00557F; }
    17. 

  17.     
    18. 

  18. a { color: #AA5500; }
    19. 

  19. 

  20. </style>
    21. 

  21. </head>
    22. 

  22. <body><a NAME="top" ID="top"></a>
    23. 

  23. <h1>eric4.Plugins.VcsPlugins.vcsSubversion.SvnRepoBrowserDialog</h1>
    24. 

  24. <p>
    25. 

  25. Module implementing the subversion repository browser dialog.
    26. 

  26. </p>
    27. 

  27. <h3>Global Attributes</h3>
    28. 

  28. <table>
    29. 

  29. <tr><td>None</td></tr>
    30. 

  30. </table>
    31. 

  31. <h3>Classes</h3>
    32. 

  32. <table>
    33. 

  33. <tr>
    34. 

  34. <td><a href="#SvnRepoBrowserDialog">SvnRepoBrowserDialog</a></td>
    35. 

  35. <td>Class implementing the subversion repository browser dialog.</td>
    36. 

  36. </tr>
    37. 

  37. </table>
    38. 

  38. <h3>Functions</h3>
    39. 

  39. <table>
    40. 

  40. <tr><td>None</td></tr>
    41. 

  41. </table>
    42. 

  42. <hr /><hr />
    43. 

  43. <a NAME="SvnRepoBrowserDialog" ID="SvnRepoBrowserDialog"></a>
    44. 

  44. <h2>SvnRepoBrowserDialog</h2>
    45. 

  45. <p>
    46. 

  46.     Class implementing the subversion repository browser dialog.
    47. 

  47. </p>
    48. 

  48. <h3>Derived from</h3>
    49. 

  49. QDialog, Ui_SvnRepoBrowserDialog
    50. 

  50. <h3>Class Attributes</h3>
    51. 

  51. <table>
    52. 

  52. <tr><td>None</td></tr>
    53. 

  53. </table>
    54. 

  54. <h3>Class Methods</h3>
    55. 

  55. <table>
    56. 

  56. <tr><td>None</td></tr>
    57. 

  57. </table>
    58. 

  58. <h3>Methods</h3>
    59. 

  59. <table>
    60. 

  60. <tr>
    61. 

  61. <td><a href="#SvnRepoBrowserDialog.__init__">SvnRepoBrowserDialog</a></td>
    62. 

  62. <td>Constructor</td>
    63. 

  63. </tr><tr>
    64. 

  64. <td><a href="#SvnRepoBrowserDialog.__finish">__finish</a></td>
    65. 

  65. <td>Private slot called when the process finished or the user pressed the button.</td>
    66. 

  66. </tr><tr>
    67. 

  67. <td><a href="#SvnRepoBrowserDialog.__generateItem">__generateItem</a></td>
    68. 

  68. <td>Private method to generate a tree item in the repository tree.</td>
    69. 

  69. </tr><tr>
    70. 

  70. <td><a href="#SvnRepoBrowserDialog.__listRepo">__listRepo</a></td>
    71. 

  71. <td>Private method to perform the svn list command.</td>
    72. 

  72. </tr><tr>
    73. 

  73. <td><a href="#SvnRepoBrowserDialog.__normalizeUrl">__normalizeUrl</a></td>
    74. 

  74. <td>Private method to normalite the url.</td>
    75. 

  75. </tr><tr>
    76. 

  76. <td><a href="#SvnRepoBrowserDialog.__procFinished">__procFinished</a></td>
    77. 

  77. <td>Private slot connected to the finished signal.</td>
    78. 

  78. </tr><tr>
    79. 

  79. <td><a href="#SvnRepoBrowserDialog.__readStderr">__readStderr</a></td>
    80. 

  80. <td>Private slot to handle the readyReadStandardError signal.</td>
    81. 

  81. </tr><tr>
    82. 

  82. <td><a href="#SvnRepoBrowserDialog.__readStdout">__readStdout</a></td>
    83. 

  83. <td>Private slot to handle the readyReadStandardOutput signal.</td>
    84. 

  84. </tr><tr>
    85. 

  85. <td><a href="#SvnRepoBrowserDialog.__repoRoot">__repoRoot</a></td>
    86. 

  86. <td>Private method to get the repository root using the svn info command.</td>
    87. 

  87. </tr><tr>
    88. 

  88. <td><a href="#SvnRepoBrowserDialog.__resizeColumns">__resizeColumns</a></td>
    89. 

  89. <td>Private method to resize the tree columns.</td>
    90. 

  90. </tr><tr>
    91. 

  91. <td><a href="#SvnRepoBrowserDialog.__resort">__resort</a></td>
    92. 

  92. <td>Private method to resort the tree.</td>
    93. 

  93. </tr><tr>
    94. 

  94. <td><a href="#SvnRepoBrowserDialog.accept">accept</a></td>
    95. 

  95. <td>Public slot called when the dialog is accepted.</td>
    96. 

  96. </tr><tr>
    97. 

  97. <td><a href="#SvnRepoBrowserDialog.closeEvent">closeEvent</a></td>
    98. 

  98. <td>Private slot implementing a close event handler.</td>
    99. 

  99. </tr><tr>
    100. 

  100. <td><a href="#SvnRepoBrowserDialog.getSelectedUrl">getSelectedUrl</a></td>
    101. 

  101. <td>Public method to retrieve the selected repository URL.</td>
    102. 

  102. </tr><tr>
    103. 

  103. <td><a href="#SvnRepoBrowserDialog.keyPressEvent">keyPressEvent</a></td>
    104. 

  104. <td>Protected slot to handle a key press event.</td>
    105. 

  105. </tr><tr>
    106. 

  106. <td><a href="#SvnRepoBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td>
    107. 

  107. <td>Private slot to handle the press of the return key in the input field.</td>
    108. 

  108. </tr><tr>
    109. 

  109. <td><a href="#SvnRepoBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
    110. 

  110. <td>Private slot to handle the password checkbox toggled.</td>
    111. 

  111. </tr><tr>
    112. 

  112. <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemCollapsed">on_repoTree_itemCollapsed</a></td>
    113. 

  113. <td>Private slot called when an item is collapsed.</td>
    114. 

  114. </tr><tr>
    115. 

  115. <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemExpanded">on_repoTree_itemExpanded</a></td>
    116. 

  116. <td>Private slot called when an item is expanded.</td>
    117. 

  117. </tr><tr>
    118. 

  118. <td><a href="#SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged">on_repoTree_itemSelectionChanged</a></td>
    119. 

  119. <td>Private slot called when the selection changes.</td>
    120. 

  120. </tr><tr>
    121. 

  121. <td><a href="#SvnRepoBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
    122. 

  122. <td>Private slot to send the input to the subversion process.</td>
    123. 

  123. </tr><tr>
    124. 

  124. <td><a href="#SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged">on_urlCombo_currentIndexChanged</a></td>
    125. 

  125. <td>Private slot called, when a new repository URL is entered or selected.</td>
    126. 

  126. </tr><tr>
    127. 

  127. <td><a href="#SvnRepoBrowserDialog.start">start</a></td>
    128. 

  128. <td>Public slot to start the svn info command.</td>
    129. 

  129. </tr>
    130. 

  130. </table>
    131. 

  131. <h3>Static Methods</h3>
    132. 

  132. <table>
    133. 

  133. <tr><td>None</td></tr>
    134. 

  134. </table>
    135. 

  135. <a NAME="SvnRepoBrowserDialog.__init__" ID="SvnRepoBrowserDialog.__init__"></a>
    136. 

  136. <h4>SvnRepoBrowserDialog (Constructor)</h4>
    137. 

  137. <b>SvnRepoBrowserDialog</b>(<i>vcs, mode = "browse", parent = None</i>)
    138. 

  138. <p>
    139. 

  139.         Constructor
    140. 

  140. </p><dl>
    141. 

  141. <dt><i>vcs</i></dt>
    142. 

  142. <dd>
    143. 

  143. reference to the vcs object
    144. 

  144. </dd><dt><i>mode</i></dt>
    145. 

  145. <dd>
    146. 

  146. mode of the dialog (string, "browse" or "select")
    147. 

  147. </dd><dt><i>parent</i></dt>
    148. 

  148. <dd>
    149. 

  149. parent widget (QWidget)
    150. 

  150. </dd>
    151. 

  151. </dl><a NAME="SvnRepoBrowserDialog.__finish" ID="SvnRepoBrowserDialog.__finish"></a>
    152. 

  152. <h4>SvnRepoBrowserDialog.__finish</h4>
    153. 

  153. <b>__finish</b>(<i></i>)
    154. 

  154. <p>
    155. 

  155.         Private slot called when the process finished or the user pressed the button.
    156. 

  156. </p><a NAME="SvnRepoBrowserDialog.__generateItem" ID="SvnRepoBrowserDialog.__generateItem"></a>
    157. 

  157. <h4>SvnRepoBrowserDialog.__generateItem</h4>
    158. 

  158. <b>__generateItem</b>(<i>repopath, revision, author, size, date, nodekind, url</i>)
    159. 

  159. <p>
    160. 

  160.         Private method to generate a tree item in the repository tree.
    161. 

  161. </p><dl>
    162. 

  162. <dt><i>parent</i></dt>
    163. 

  163. <dd>
    164. 

  164. parent of the item to be created (QTreeWidget or QTreeWidgetItem)
    165. 

  165. </dd><dt><i>repopath</i></dt>
    166. 

  166. <dd>
    167. 

  167. path of the item (string or QString)
    168. 

  168. </dd><dt><i>revision</i></dt>
    169. 

  169. <dd>
    170. 

  170. revision info (string or QString)
    171. 

  171. </dd><dt><i>author</i></dt>
    172. 

  172. <dd>
    173. 

  173. author info (string or QString)
    174. 

  174. </dd><dt><i>size</i></dt>
    175. 

  175. <dd>
    176. 

  176. size info (string or QString)
    177. 

  177. </dd><dt><i>date</i></dt>
    178. 

  178. <dd>
    179. 

  179. date info (string or QString)
    180. 

  180. </dd><dt><i>nodekind</i></dt>
    181. 

  181. <dd>
    182. 

  182. node kind info (string, "dir" or "file")
    183. 

  183. </dd><dt><i>url</i></dt>
    184. 

  184. <dd>
    185. 

  185. url of the entry (string or QString)
    186. 

  186. </dd>
    187. 

  187. </dl><dl>
    188. 

  188. <dt>Returns:</dt>
    189. 

  189. <dd>
    190. 

  190. reference to the generated item (QTreeWidgetItem)
    191. 

  191. </dd>
    192. 

  192. </dl><a NAME="SvnRepoBrowserDialog.__listRepo" ID="SvnRepoBrowserDialog.__listRepo"></a>
    193. 

  193. <h4>SvnRepoBrowserDialog.__listRepo</h4>
    194. 

  194. <b>__listRepo</b>(<i>url, parent = None</i>)
    195. 

  195. <p>
    196. 

  196.         Private method to perform the svn list command.
    197. 

  197. </p><dl>
    198. 

  198. <dt><i>url</i></dt>
    199. 

  199. <dd>
    200. 

  200. the repository URL to browser (string or QString)
    201. 

  201. </dd><dt><i>parent</i></dt>
    202. 

  202. <dd>
    203. 

  203. reference to the item, the data should be appended to
    204. 

  204.             (QTreeWidget or QTreeWidgetItem)
    205. 

  205. </dd>
    206. 

  206. </dl><a NAME="SvnRepoBrowserDialog.__normalizeUrl" ID="SvnRepoBrowserDialog.__normalizeUrl"></a>
    207. 

  207. <h4>SvnRepoBrowserDialog.__normalizeUrl</h4>
    208. 

  208. <b>__normalizeUrl</b>(<i>url</i>)
    209. 

  209. <p>
    210. 

  210.         Private method to normalite the url.
    211. 

  211. </p><dl>
    212. 

  212. <dt><i>url</i></dt>
    213. 

  213. <dd>
    214. 

  214. the url to normalize (string or QString)
    215. 

  215. </dd>
    216. 

  216. </dl><dl>
    217. 

  217. <dt>Returns:</dt>
    218. 

  218. <dd>
    219. 

  219. normalized URL (QString)
    220. 

  220. </dd>
    221. 

  221. </dl><a NAME="SvnRepoBrowserDialog.__procFinished" ID="SvnRepoBrowserDialog.__procFinished"></a>
    222. 

  222. <h4>SvnRepoBrowserDialog.__procFinished</h4>
    223. 

  223. <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
    224. 

  224. <p>
    225. 

  225.         Private slot connected to the finished signal.
    226. 

  226. </p><dl>
    227. 

  227. <dt><i>exitCode</i></dt>
    228. 

  228. <dd>
    229. 

  229. exit code of the process (integer)
    230. 

  230. </dd><dt><i>exitStatus</i></dt>
    231. 

  231. <dd>
    232. 

  232. exit status of the process (QProcess.ExitStatus)
    233. 

  233. </dd>
    234. 

  234. </dl><a NAME="SvnRepoBrowserDialog.__readStderr" ID="SvnRepoBrowserDialog.__readStderr"></a>
    235. 

  235. <h4>SvnRepoBrowserDialog.__readStderr</h4>
    236. 

  236. <b>__readStderr</b>(<i></i>)
    237. 

  237. <p>
    238. 

  238.         Private slot to handle the readyReadStandardError signal.
    239. 

  239. </p><p>
    240. 

  240.         It reads the error output of the process and inserts it into the
    241. 

  241.         error pane.
    242. 

  242. </p><a NAME="SvnRepoBrowserDialog.__readStdout" ID="SvnRepoBrowserDialog.__readStdout"></a>
    243. 

  243. <h4>SvnRepoBrowserDialog.__readStdout</h4>
    244. 

  244. <b>__readStdout</b>(<i></i>)
    245. 

  245. <p>
    246. 

  246.         Private slot to handle the readyReadStandardOutput signal.
    247. 

  247. </p><p>
    248. 

  248.         It reads the output of the process, formats it and inserts it into
    249. 

  249.         the contents pane.
    250. 

  250. </p><a NAME="SvnRepoBrowserDialog.__repoRoot" ID="SvnRepoBrowserDialog.__repoRoot"></a>
    251. 

  251. <h4>SvnRepoBrowserDialog.__repoRoot</h4>
    252. 

  252. <b>__repoRoot</b>(<i>url</i>)
    253. 

  253. <p>
    254. 

  254.         Private method to get the repository root using the svn info command.
    255. 

  255. </p><dl>
    256. 

  256. <dt><i>url</i></dt>
    257. 

  257. <dd>
    258. 

  258. the repository URL to browser (string or QString)
    259. 

  259. </dd>
    260. 

  260. </dl><dl>
    261. 

  261. <dt>Returns:</dt>
    262. 

  262. <dd>
    263. 

  263. repository root (string)
    264. 

  264. </dd>
    265. 

  265. </dl><a NAME="SvnRepoBrowserDialog.__resizeColumns" ID="SvnRepoBrowserDialog.__resizeColumns"></a>
    266. 

  266. <h4>SvnRepoBrowserDialog.__resizeColumns</h4>
    267. 

  267. <b>__resizeColumns</b>(<i></i>)
    268. 

  268. <p>
    269. 

  269.         Private method to resize the tree columns.
    270. 

  270. </p><a NAME="SvnRepoBrowserDialog.__resort" ID="SvnRepoBrowserDialog.__resort"></a>
    271. 

  271. <h4>SvnRepoBrowserDialog.__resort</h4>
    272. 

  272. <b>__resort</b>(<i></i>)
    273. 

  273. <p>
    274. 

  274.         Private method to resort the tree.
    275. 

  275. </p><a NAME="SvnRepoBrowserDialog.accept" ID="SvnRepoBrowserDialog.accept"></a>
    276. 

  276. <h4>SvnRepoBrowserDialog.accept</h4>
    277. 

  277. <b>accept</b>(<i></i>)
    278. 

  278. <p>
    279. 

  279.         Public slot called when the dialog is accepted.
    280. 

  280. </p><a NAME="SvnRepoBrowserDialog.closeEvent" ID="SvnRepoBrowserDialog.closeEvent"></a>
    281. 

  281. <h4>SvnRepoBrowserDialog.closeEvent</h4>
    282. 

  282. <b>closeEvent</b>(<i>e</i>)
    283. 

  283. <p>
    284. 

  284.         Private slot implementing a close event handler.
    285. 

  285. </p><dl>
    286. 

  286. <dt><i>e</i></dt>
    287. 

  287. <dd>
    288. 

  288. close event (QCloseEvent)
    289. 

  289. </dd>
    290. 

  290. </dl><a NAME="SvnRepoBrowserDialog.getSelectedUrl" ID="SvnRepoBrowserDialog.getSelectedUrl"></a>
    291. 

  291. <h4>SvnRepoBrowserDialog.getSelectedUrl</h4>
    292. 

  292. <b>getSelectedUrl</b>(<i></i>)
    293. 

  293. <p>
    294. 

  294.         Public method to retrieve the selected repository URL.
    295. 

  295. </p><dl>
    296. 

  296. <dt>Returns:</dt>
    297. 

  297. <dd>
    298. 

  298. the selected repository URL (QString)
    299. 

  299. </dd>
    300. 

  300. </dl><a NAME="SvnRepoBrowserDialog.keyPressEvent" ID="SvnRepoBrowserDialog.keyPressEvent"></a>
    301. 

  301. <h4>SvnRepoBrowserDialog.keyPressEvent</h4>
    302. 

  302. <b>keyPressEvent</b>(<i>evt</i>)
    303. 

  303. <p>
    304. 

  304.         Protected slot to handle a key press event.
    305. 

  305. </p><dl>
    306. 

  306. <dt><i>evt</i></dt>
    307. 

  307. <dd>
    308. 

  308. the key press event (QKeyEvent)
    309. 

  309. </dd>
    310. 

  310. </dl><a NAME="SvnRepoBrowserDialog.on_input_returnPressed" ID="SvnRepoBrowserDialog.on_input_returnPressed"></a>
    311. 

  311. <h4>SvnRepoBrowserDialog.on_input_returnPressed</h4>
    312. 

  312. <b>on_input_returnPressed</b>(<i></i>)
    313. 

  313. <p>
    314. 

  314.         Private slot to handle the press of the return key in the input field.
    315. 

  315. </p><a NAME="SvnRepoBrowserDialog.on_passwordCheckBox_toggled" ID="SvnRepoBrowserDialog.on_passwordCheckBox_toggled"></a>
    316. 

  316. <h4>SvnRepoBrowserDialog.on_passwordCheckBox_toggled</h4>
    317. 

  317. <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
    318. 

  318. <p>
    319. 

  319.         Private slot to handle the password checkbox toggled.
    320. 

  320. </p><dl>
    321. 

  321. <dt><i>isOn</i></dt>
    322. 

  322. <dd>
    323. 

  323. flag indicating the status of the check box (boolean)
    324. 

  324. </dd>
    325. 

  325. </dl><a NAME="SvnRepoBrowserDialog.on_repoTree_itemCollapsed" ID="SvnRepoBrowserDialog.on_repoTree_itemCollapsed"></a>
    326. 

  326. <h4>SvnRepoBrowserDialog.on_repoTree_itemCollapsed</h4>
    327. 

  327. <b>on_repoTree_itemCollapsed</b>(<i>item</i>)
    328. 

  328. <p>
    329. 

  329.         Private slot called when an item is collapsed.
    330. 

  330. </p><dl>
    331. 

  331. <dt><i>item</i></dt>
    332. 

  332. <dd>
    333. 

  333. reference to the item to be collapsed (QTreeWidgetItem)
    334. 

  334. </dd>
    335. 

  335. </dl><a NAME="SvnRepoBrowserDialog.on_repoTree_itemExpanded" ID="SvnRepoBrowserDialog.on_repoTree_itemExpanded"></a>
    336. 

  336. <h4>SvnRepoBrowserDialog.on_repoTree_itemExpanded</h4>
    337. 

  337. <b>on_repoTree_itemExpanded</b>(<i>item</i>)
    338. 

  338. <p>
    339. 

  339.         Private slot called when an item is expanded.
    340. 

  340. </p><dl>
    341. 

  341. <dt><i>item</i></dt>
    342. 

  342. <dd>
    343. 

  343. reference to the item to be expanded (QTreeWidgetItem)
    344. 

  344. </dd>
    345. 

  345. </dl><a NAME="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged" ID="SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged"></a>
    346. 

  346. <h4>SvnRepoBrowserDialog.on_repoTree_itemSelectionChanged</h4>
    347. 

  347. <b>on_repoTree_itemSelectionChanged</b>(<i></i>)
    348. 

  348. <p>
    349. 

  349.         Private slot called when the selection changes.
    350. 

  350. </p><a NAME="SvnRepoBrowserDialog.on_sendButton_clicked" ID="SvnRepoBrowserDialog.on_sendButton_clicked"></a>
    351. 

  351. <h4>SvnRepoBrowserDialog.on_sendButton_clicked</h4>
    352. 

  352. <b>on_sendButton_clicked</b>(<i></i>)
    353. 

  353. <p>
    354. 

  354.         Private slot to send the input to the subversion process.
    355. 

  355. </p><a NAME="SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged" ID="SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged"></a>
    356. 

  356. <h4>SvnRepoBrowserDialog.on_urlCombo_currentIndexChanged</h4>
    357. 

  357. <b>on_urlCombo_currentIndexChanged</b>(<i>text</i>)
    358. 

  358. <p>
    359. 

  359.         Private slot called, when a new repository URL is entered or selected.
    360. 

  360. </p><dl>
    361. 

  361. <dt><i>text</i></dt>
    362. 

  362. <dd>
    363. 

  363. the text of the current item (QString)
    364. 

  364. </dd>
    365. 

  365. </dl><a NAME="SvnRepoBrowserDialog.start" ID="SvnRepoBrowserDialog.start"></a>
    366. 

  366. <h4>SvnRepoBrowserDialog.start</h4>
    367. 

  367. <b>start</b>(<i>url</i>)
    368. 

  368. <p>
    369. 

  369.         Public slot to start the svn info command.
    370. 

  370. </p><dl>
    371. 

  371. <dt><i>url</i></dt>
    372. 

  372. <dd>
    373. 

  373. the repository URL to browser (string or QString)
    374. 

  374. </dd>
    375. 

  375. </dl>
    376. 

  376. <div align="right"><a href="#top">Up</a></div>
    377. 

  377. <hr />
    378. 

  378. </body></html>
    379.