Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
- changeset 1071
- ac0f74c0b870
- child 1087
- fb8cd56819a9
equal
deleted
inserted
replaced
| 1070:0f4e3c9670f5 | 1071:ac0f74c0b870 |
|---|---|
| 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>eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge</h1> | |
| 24 <p> | |
| 25 Module implementing the purge extension interface. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#Purge">Purge</a></td> | |
| 35 <td>Class implementing the purge extension interface.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="Purge" ID="Purge"></a> | |
| 44 <h2>Purge</h2> | |
| 45 <p> | |
| 46 Class implementing the purge extension interface. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QObject | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#Purge.__init__">Purge</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#Purge.__getEntries">__getEntries</a></td> | |
| 61 <td>Public method to get a list of files/directories being purged.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#Purge.hgPurge">hgPurge</a></td> | |
| 64 <td>Public method to purge files and directories not tracked by Mercurial.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#Purge.hgPurgeList">hgPurgeList</a></td> | |
| 67 <td>Public method to list files and directories not tracked by Mercurial.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#Purge.shutdown">shutdown</a></td> | |
| 70 <td>Public method used to shutdown the purge interface.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <a NAME="Purge.__init__" ID="Purge.__init__"></a> | |
| 74 <h4>Purge (Constructor)</h4> | |
| 75 <b>Purge</b>(<i>vcs</i>) | |
| 76 <p> | |
| 77 Constructor | |
| 78 </p><dl> | |
| 79 <dt><i>vcs</i></dt> | |
| 80 <dd> | |
| 81 reference to the Mercurial vcs object | |
| 82 </dd> | |
| 83 </dl><a NAME="Purge.__getEntries" ID="Purge.__getEntries"></a> | |
| 84 <h4>Purge.__getEntries</h4> | |
| 85 <b>__getEntries</b>(<i>repodir, all</i>) | |
| 86 <p> | |
| 87 Public method to get a list of files/directories being purged. | |
| 88 </p><dl> | |
| 89 <dt><i>repodir</i></dt> | |
| 90 <dd> | |
| 91 directory name of the repository (string) | |
| 92 </dd><dt><i>all</i></dt> | |
| 93 <dd> | |
| 94 flag indicating to delete all files including ignored ones (boolean) | |
| 95 </dd> | |
| 96 </dl><dl> | |
| 97 <dt>Returns:</dt> | |
| 98 <dd> | |
| 99 name of the current patch (string) | |
| 100 </dd> | |
| 101 </dl><a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a> | |
| 102 <h4>Purge.hgPurge</h4> | |
| 103 <b>hgPurge</b>(<i>name, all=False</i>) | |
| 104 <p> | |
| 105 Public method to purge files and directories not tracked by Mercurial. | |
| 106 </p><dl> | |
| 107 <dt><i>name</i></dt> | |
| 108 <dd> | |
| 109 file/directory name (string) | |
| 110 </dd><dt><i>all</i></dt> | |
| 111 <dd> | |
| 112 flag indicating to delete all files including ignored ones (boolean) | |
| 113 </dd> | |
| 114 </dl><a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> | |
| 115 <h4>Purge.hgPurgeList</h4> | |
| 116 <b>hgPurgeList</b>(<i>name, all=False</i>) | |
| 117 <p> | |
| 118 Public method to list files and directories not tracked by Mercurial. | |
| 119 </p><dl> | |
| 120 <dt><i>name</i></dt> | |
| 121 <dd> | |
| 122 file/directory name (string) | |
| 123 </dd><dt><i>all</i></dt> | |
| 124 <dd> | |
| 125 flag indicating to list all files including ignored ones (boolean) | |
| 126 </dd> | |
| 127 </dl><a NAME="Purge.shutdown" ID="Purge.shutdown"></a> | |
| 128 <h4>Purge.shutdown</h4> | |
| 129 <b>shutdown</b>(<i></i>) | |
| 130 <p> | |
| 131 Public method used to shutdown the purge interface. | |
| 132 </p> | |
| 133 <div align="right"><a href="#top">Up</a></div> | |
| 134 <hr /> | |
| 135 </body></html> |
