Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.ClosedTabsManager.html
Documentation/Source/eric5.Helpviewer.ClosedTabsManager.html
- changeset 1694
- 648466a9451b
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 1693:9bb872e26a33 | 1694:648466a9451b |
|---|---|
| 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.Helpviewer.ClosedTabsManager</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.Helpviewer.ClosedTabsManager</h1> | |
| 24 <p> | |
| 25 Module implementing a class to manage closed tabs. | |
| 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="#ClosedTab">ClosedTab</a></td> | |
| 35 <td>Class implementing a structure to store data about a closed tab.</td> | |
| 36 </tr><tr> | |
| 37 <td><a href="#ClosedTabsManager">ClosedTabsManager</a></td> | |
| 38 <td>Class implementing a manager for closed tabs.</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="ClosedTab" ID="ClosedTab"></a> | |
| 47 <h2>ClosedTab</h2> | |
| 48 <p> | |
| 49 Class implementing a structure to store data about a closed tab. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 object | |
| 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="#ClosedTab.__init__">ClosedTab</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#ClosedTab.__eq__">__eq__</a></td> | |
| 68 <td>Special method implementing the equality operator.</td> | |
| 69 </tr> | |
| 70 </table> | |
| 71 <h3>Static Methods</h3> | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <a NAME="ClosedTab.__init__" ID="ClosedTab.__init__"></a> | |
| 76 <h4>ClosedTab (Constructor)</h4> | |
| 77 <b>ClosedTab</b>(<i>url=QUrl(), title="", position=-1</i>) | |
| 78 <p> | |
| 79 Constructor | |
| 80 </p><dl> | |
| 81 <dt><i>url</i></dt> | |
| 82 <dd> | |
| 83 URL of the closed tab (QUrl) | |
| 84 </dd><dt><i>title</i></dt> | |
| 85 <dd> | |
| 86 title of the closed tab (string) | |
| 87 </dd><dt><i>position</i></dt> | |
| 88 <dd> | |
| 89 index of the closed tab (integer) | |
| 90 </dd> | |
| 91 </dl><a NAME="ClosedTab.__eq__" ID="ClosedTab.__eq__"></a> | |
| 92 <h4>ClosedTab.__eq__</h4> | |
| 93 <b>__eq__</b>(<i>other</i>) | |
| 94 <p> | |
| 95 Special method implementing the equality operator. | |
| 96 </p><dl> | |
| 97 <dt><i>other</i></dt> | |
| 98 <dd> | |
| 99 reference to the object to compare against (ClosedTab) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <div align="right"><a href="#top">Up</a></div> | |
| 103 <hr /><hr /> | |
| 104 <a NAME="ClosedTabsManager" ID="ClosedTabsManager"></a> | |
| 105 <h2>ClosedTabsManager</h2> | |
| 106 <p> | |
| 107 Class implementing a manager for closed tabs. | |
| 108 </p><h3>Signals</h3> | |
| 109 <dl> | |
| 110 <dt>closedTabAvailable(boolean)</dt> | |
| 111 <dd> | |
| 112 emitted to signal a change in availability | |
| 113 of closed tabs | |
| 114 </dd> | |
| 115 </dl> | |
| 116 <h3>Derived from</h3> | |
| 117 QObject | |
| 118 <h3>Class Attributes</h3> | |
| 119 <table> | |
| 120 <tr><td>None</td></tr> | |
| 121 </table> | |
| 122 <h3>Class Methods</h3> | |
| 123 <table> | |
| 124 <tr><td>None</td></tr> | |
| 125 </table> | |
| 126 <h3>Methods</h3> | |
| 127 <table> | |
| 128 <tr> | |
| 129 <td><a href="#ClosedTabsManager.__init__">ClosedTabsManager</a></td> | |
| 130 <td>Constructor</td> | |
| 131 </tr><tr> | |
| 132 <td><a href="#ClosedTabsManager.allClosedTabs">allClosedTabs</a></td> | |
| 133 <td>Public method to get a list of all closed tabs.</td> | |
| 134 </tr><tr> | |
| 135 <td><a href="#ClosedTabsManager.clearList">clearList</a></td> | |
| 136 <td>Public method to clear the list of closed tabs.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#ClosedTabsManager.getClosedTabAt">getClosedTabAt</a></td> | |
| 139 <td>Public method to get the indexed closed tab.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#ClosedTabsManager.isClosedTabAvailable">isClosedTabAvailable</a></td> | |
| 142 <td>Public method to check for closed tabs.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#ClosedTabsManager.recordBrowser">recordBrowser</a></td> | |
| 145 <td>Public method to record the data of a browser about to be closed.</td> | |
| 146 </tr> | |
| 147 </table> | |
| 148 <h3>Static Methods</h3> | |
| 149 <table> | |
| 150 <tr><td>None</td></tr> | |
| 151 </table> | |
| 152 <a NAME="ClosedTabsManager.__init__" ID="ClosedTabsManager.__init__"></a> | |
| 153 <h4>ClosedTabsManager (Constructor)</h4> | |
| 154 <b>ClosedTabsManager</b>(<i>parent=None</i>) | |
| 155 <p> | |
| 156 Constructor | |
| 157 </p><dl> | |
| 158 <dt><i>parent</i></dt> | |
| 159 <dd> | |
| 160 reference to the parent object (QObject) | |
| 161 </dd> | |
| 162 </dl><a NAME="ClosedTabsManager.allClosedTabs" ID="ClosedTabsManager.allClosedTabs"></a> | |
| 163 <h4>ClosedTabsManager.allClosedTabs</h4> | |
| 164 <b>allClosedTabs</b>(<i></i>) | |
| 165 <p> | |
| 166 Public method to get a list of all closed tabs. | |
| 167 </p><dl> | |
| 168 <dt>Returns:</dt> | |
| 169 <dd> | |
| 170 list of closed tabs (list of ClosedTab) | |
| 171 </dd> | |
| 172 </dl><a NAME="ClosedTabsManager.clearList" ID="ClosedTabsManager.clearList"></a> | |
| 173 <h4>ClosedTabsManager.clearList</h4> | |
| 174 <b>clearList</b>(<i></i>) | |
| 175 <p> | |
| 176 Public method to clear the list of closed tabs. | |
| 177 </p><a NAME="ClosedTabsManager.getClosedTabAt" ID="ClosedTabsManager.getClosedTabAt"></a> | |
| 178 <h4>ClosedTabsManager.getClosedTabAt</h4> | |
| 179 <b>getClosedTabAt</b>(<i>index</i>) | |
| 180 <p> | |
| 181 Public method to get the indexed closed tab. | |
| 182 </p><dl> | |
| 183 <dt><i>index</i></dt> | |
| 184 <dd> | |
| 185 index of the tab to return (integer) | |
| 186 </dd> | |
| 187 </dl><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 requested tab (ClosedTab) | |
| 191 </dd> | |
| 192 </dl><a NAME="ClosedTabsManager.isClosedTabAvailable" ID="ClosedTabsManager.isClosedTabAvailable"></a> | |
| 193 <h4>ClosedTabsManager.isClosedTabAvailable</h4> | |
| 194 <b>isClosedTabAvailable</b>(<i></i>) | |
| 195 <p> | |
| 196 Public method to check for closed tabs. | |
| 197 </p><dl> | |
| 198 <dt>Returns:</dt> | |
| 199 <dd> | |
| 200 flag indicating the availability of closed tab data (boolean) | |
| 201 </dd> | |
| 202 </dl><a NAME="ClosedTabsManager.recordBrowser" ID="ClosedTabsManager.recordBrowser"></a> | |
| 203 <h4>ClosedTabsManager.recordBrowser</h4> | |
| 204 <b>recordBrowser</b>(<i>browser, position</i>) | |
| 205 <p> | |
| 206 Public method to record the data of a browser about to be closed. | |
| 207 </p><dl> | |
| 208 <dt><i>browser</i></dt> | |
| 209 <dd> | |
| 210 reference to the browser to be closed (HelpBrowser) | |
| 211 </dd><dt><i>position</i></dt> | |
| 212 <dd> | |
| 213 index of the tab to be closed (integer) | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <div align="right"><a href="#top">Up</a></div> | |
| 217 <hr /> | |
| 218 </body></html> |
