Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.ClosedTabsManager.html
Documentation/Source/eric6.Helpviewer.ClosedTabsManager.html
- changeset 3673
- e26d7d0c1088
- child 5653
- c023821bb25f
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.ClosedTabsManager</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.ClosedTabsManager</h1> | |
| 23 <p> | |
| 24 Module implementing a class to manage closed tabs. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ClosedTab">ClosedTab</a></td> | |
| 34 <td>Class implementing a structure to store data about a closed tab.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#ClosedTabsManager">ClosedTabsManager</a></td> | |
| 37 <td>Class implementing a manager for closed tabs.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 <table> | |
| 42 <tr><td>None</td></tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="ClosedTab" ID="ClosedTab"></a> | |
| 46 <h2>ClosedTab</h2> | |
| 47 <p> | |
| 48 Class implementing a structure to store data about a closed tab. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 object | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#ClosedTab.__init__">ClosedTab</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ClosedTab.__eq__">__eq__</a></td> | |
| 67 <td>Special method implementing the equality operator.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <h3>Static Methods</h3> | |
| 71 <table> | |
| 72 <tr><td>None</td></tr> | |
| 73 </table> | |
| 74 <a NAME="ClosedTab.__init__" ID="ClosedTab.__init__"></a> | |
| 75 <h4>ClosedTab (Constructor)</h4> | |
| 76 <b>ClosedTab</b>(<i>url=QUrl(), title="", position=-1</i>) | |
| 77 <p> | |
| 78 Constructor | |
| 79 </p><dl> | |
| 80 <dt><i>url</i></dt> | |
| 81 <dd> | |
| 82 URL of the closed tab (QUrl) | |
| 83 </dd><dt><i>title</i></dt> | |
| 84 <dd> | |
| 85 title of the closed tab (string) | |
| 86 </dd><dt><i>position</i></dt> | |
| 87 <dd> | |
| 88 index of the closed tab (integer) | |
| 89 </dd> | |
| 90 </dl><a NAME="ClosedTab.__eq__" ID="ClosedTab.__eq__"></a> | |
| 91 <h4>ClosedTab.__eq__</h4> | |
| 92 <b>__eq__</b>(<i>other</i>) | |
| 93 <p> | |
| 94 Special method implementing the equality operator. | |
| 95 </p><dl> | |
| 96 <dt><i>other</i></dt> | |
| 97 <dd> | |
| 98 reference to the object to compare against (ClosedTab) | |
| 99 </dd> | |
| 100 </dl><dl> | |
| 101 <dt>Returns:</dt> | |
| 102 <dd> | |
| 103 flag indicating equality of the tabs (boolean) | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <div align="right"><a href="#top">Up</a></div> | |
| 107 <hr /><hr /> | |
| 108 <a NAME="ClosedTabsManager" ID="ClosedTabsManager"></a> | |
| 109 <h2>ClosedTabsManager</h2> | |
| 110 <p> | |
| 111 Class implementing a manager for closed tabs. | |
| 112 </p><h3>Signals</h3> | |
| 113 <dl> | |
| 114 <dt>closedTabAvailable(boolean)</dt> | |
| 115 <dd> | |
| 116 emitted to signal a change of | |
| 117 availability of closed tabs | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <h3>Derived from</h3> | |
| 121 QObject | |
| 122 <h3>Class Attributes</h3> | |
| 123 <table> | |
| 124 <tr><td>None</td></tr> | |
| 125 </table> | |
| 126 <h3>Class Methods</h3> | |
| 127 <table> | |
| 128 <tr><td>None</td></tr> | |
| 129 </table> | |
| 130 <h3>Methods</h3> | |
| 131 <table> | |
| 132 <tr> | |
| 133 <td><a href="#ClosedTabsManager.__init__">ClosedTabsManager</a></td> | |
| 134 <td>Constructor</td> | |
| 135 </tr><tr> | |
| 136 <td><a href="#ClosedTabsManager.allClosedTabs">allClosedTabs</a></td> | |
| 137 <td>Public method to get a list of all closed tabs.</td> | |
| 138 </tr><tr> | |
| 139 <td><a href="#ClosedTabsManager.clearList">clearList</a></td> | |
| 140 <td>Public method to clear the list of closed tabs.</td> | |
| 141 </tr><tr> | |
| 142 <td><a href="#ClosedTabsManager.getClosedTabAt">getClosedTabAt</a></td> | |
| 143 <td>Public method to get the indexed closed tab.</td> | |
| 144 </tr><tr> | |
| 145 <td><a href="#ClosedTabsManager.isClosedTabAvailable">isClosedTabAvailable</a></td> | |
| 146 <td>Public method to check for closed tabs.</td> | |
| 147 </tr><tr> | |
| 148 <td><a href="#ClosedTabsManager.recordBrowser">recordBrowser</a></td> | |
| 149 <td>Public method to record the data of a browser about to be closed.</td> | |
| 150 </tr> | |
| 151 </table> | |
| 152 <h3>Static Methods</h3> | |
| 153 <table> | |
| 154 <tr><td>None</td></tr> | |
| 155 </table> | |
| 156 <a NAME="ClosedTabsManager.__init__" ID="ClosedTabsManager.__init__"></a> | |
| 157 <h4>ClosedTabsManager (Constructor)</h4> | |
| 158 <b>ClosedTabsManager</b>(<i>parent=None</i>) | |
| 159 <p> | |
| 160 Constructor | |
| 161 </p><dl> | |
| 162 <dt><i>parent</i></dt> | |
| 163 <dd> | |
| 164 reference to the parent object (QObject) | |
| 165 </dd> | |
| 166 </dl><a NAME="ClosedTabsManager.allClosedTabs" ID="ClosedTabsManager.allClosedTabs"></a> | |
| 167 <h4>ClosedTabsManager.allClosedTabs</h4> | |
| 168 <b>allClosedTabs</b>(<i></i>) | |
| 169 <p> | |
| 170 Public method to get a list of all closed tabs. | |
| 171 </p><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 list of closed tabs (list of ClosedTab) | |
| 175 </dd> | |
| 176 </dl><a NAME="ClosedTabsManager.clearList" ID="ClosedTabsManager.clearList"></a> | |
| 177 <h4>ClosedTabsManager.clearList</h4> | |
| 178 <b>clearList</b>(<i></i>) | |
| 179 <p> | |
| 180 Public method to clear the list of closed tabs. | |
| 181 </p><a NAME="ClosedTabsManager.getClosedTabAt" ID="ClosedTabsManager.getClosedTabAt"></a> | |
| 182 <h4>ClosedTabsManager.getClosedTabAt</h4> | |
| 183 <b>getClosedTabAt</b>(<i>index</i>) | |
| 184 <p> | |
| 185 Public method to get the indexed closed tab. | |
| 186 </p><dl> | |
| 187 <dt><i>index</i></dt> | |
| 188 <dd> | |
| 189 index of the tab to return (integer) | |
| 190 </dd> | |
| 191 </dl><dl> | |
| 192 <dt>Returns:</dt> | |
| 193 <dd> | |
| 194 requested tab (ClosedTab) | |
| 195 </dd> | |
| 196 </dl><a NAME="ClosedTabsManager.isClosedTabAvailable" ID="ClosedTabsManager.isClosedTabAvailable"></a> | |
| 197 <h4>ClosedTabsManager.isClosedTabAvailable</h4> | |
| 198 <b>isClosedTabAvailable</b>(<i></i>) | |
| 199 <p> | |
| 200 Public method to check for closed tabs. | |
| 201 </p><dl> | |
| 202 <dt>Returns:</dt> | |
| 203 <dd> | |
| 204 flag indicating the availability of closed tab data (boolean) | |
| 205 </dd> | |
| 206 </dl><a NAME="ClosedTabsManager.recordBrowser" ID="ClosedTabsManager.recordBrowser"></a> | |
| 207 <h4>ClosedTabsManager.recordBrowser</h4> | |
| 208 <b>recordBrowser</b>(<i>browser, position</i>) | |
| 209 <p> | |
| 210 Public method to record the data of a browser about to be closed. | |
| 211 </p><dl> | |
| 212 <dt><i>browser</i></dt> | |
| 213 <dd> | |
| 214 reference to the browser to be closed (HelpBrowser) | |
| 215 </dd><dt><i>position</i></dt> | |
| 216 <dd> | |
| 217 index of the tab to be closed (integer) | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <div align="right"><a href="#top">Up</a></div> | |
| 221 <hr /> | |
| 222 </body></html> |
