Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarkNode.html
Documentation/Source/eric6.Helpviewer.Bookmarks.BookmarkNode.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.Bookmarks.BookmarkNode</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.Bookmarks.BookmarkNode</h1> | |
| 23 <p> | |
| 24 Module implementing the bookmark node. | |
| 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="#BookmarkNode">BookmarkNode</a></td> | |
| 34 <td>Class implementing the bookmark node type.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="BookmarkNode" ID="BookmarkNode"></a> | |
| 43 <h2>BookmarkNode</h2> | |
| 44 <p> | |
| 45 Class implementing the bookmark node type. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 object | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>Bookmark</td></tr><tr><td>Folder</td></tr><tr><td>Root</td></tr><tr><td>Separator</td></tr><tr><td>TsAdded</td></tr><tr><td>TsModified</td></tr><tr><td>TsVisited</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#BookmarkNode.__init__">BookmarkNode</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#BookmarkNode.add">add</a></td> | |
| 64 <td>Public method to add/insert a child node.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#BookmarkNode.children">children</a></td> | |
| 67 <td>Public method to get the list of child nodes.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#BookmarkNode.parent">parent</a></td> | |
| 70 <td>Public method to get a reference to the parent node.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#BookmarkNode.remove">remove</a></td> | |
| 73 <td>Public method to remove a child node.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#BookmarkNode.setType">setType</a></td> | |
| 76 <td>Public method to set the bookmark's type.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#BookmarkNode.type">type</a></td> | |
| 79 <td>Public method to get the bookmark's type.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="BookmarkNode.__init__" ID="BookmarkNode.__init__"></a> | |
| 87 <h4>BookmarkNode (Constructor)</h4> | |
| 88 <b>BookmarkNode</b>(<i>type_=Root, parent=None</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>type_</i></dt> | |
| 93 <dd> | |
| 94 type of the bookmark node (BookmarkNode.Type) | |
| 95 </dd><dt><i>parent</i></dt> | |
| 96 <dd> | |
| 97 reference to the parent node (BookmarkNode) | |
| 98 </dd> | |
| 99 </dl><a NAME="BookmarkNode.add" ID="BookmarkNode.add"></a> | |
| 100 <h4>BookmarkNode.add</h4> | |
| 101 <b>add</b>(<i>child, offset=-1</i>) | |
| 102 <p> | |
| 103 Public method to add/insert a child node. | |
| 104 </p><dl> | |
| 105 <dt><i>child</i></dt> | |
| 106 <dd> | |
| 107 reference to the node to add (BookmarkNode) | |
| 108 </dd><dt><i>offset</i></dt> | |
| 109 <dd> | |
| 110 position where to insert child (integer, -1 = append) | |
| 111 </dd> | |
| 112 </dl><a NAME="BookmarkNode.children" ID="BookmarkNode.children"></a> | |
| 113 <h4>BookmarkNode.children</h4> | |
| 114 <b>children</b>(<i></i>) | |
| 115 <p> | |
| 116 Public method to get the list of child nodes. | |
| 117 </p><dl> | |
| 118 <dt>Returns:</dt> | |
| 119 <dd> | |
| 120 list of all child nodes (list of BookmarkNode) | |
| 121 </dd> | |
| 122 </dl><a NAME="BookmarkNode.parent" ID="BookmarkNode.parent"></a> | |
| 123 <h4>BookmarkNode.parent</h4> | |
| 124 <b>parent</b>(<i></i>) | |
| 125 <p> | |
| 126 Public method to get a reference to the parent node. | |
| 127 </p><dl> | |
| 128 <dt>Returns:</dt> | |
| 129 <dd> | |
| 130 reference to the parent node (BookmarkNode) | |
| 131 </dd> | |
| 132 </dl><a NAME="BookmarkNode.remove" ID="BookmarkNode.remove"></a> | |
| 133 <h4>BookmarkNode.remove</h4> | |
| 134 <b>remove</b>(<i>child</i>) | |
| 135 <p> | |
| 136 Public method to remove a child node. | |
| 137 </p><dl> | |
| 138 <dt><i>child</i></dt> | |
| 139 <dd> | |
| 140 reference to the child node (BookmarkNode) | |
| 141 </dd> | |
| 142 </dl><a NAME="BookmarkNode.setType" ID="BookmarkNode.setType"></a> | |
| 143 <h4>BookmarkNode.setType</h4> | |
| 144 <b>setType</b>(<i>type_</i>) | |
| 145 <p> | |
| 146 Public method to set the bookmark's type. | |
| 147 </p><dl> | |
| 148 <dt><i>type_</i></dt> | |
| 149 <dd> | |
| 150 type of the bookmark node (BookmarkNode.Type) | |
| 151 </dd> | |
| 152 </dl><a NAME="BookmarkNode.type" ID="BookmarkNode.type"></a> | |
| 153 <h4>BookmarkNode.type</h4> | |
| 154 <b>type</b>(<i></i>) | |
| 155 <p> | |
| 156 Public method to get the bookmark's type. | |
| 157 </p><dl> | |
| 158 <dt>Returns:</dt> | |
| 159 <dd> | |
| 160 bookmark type (BookmarkNode.Type) | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <div align="right"><a href="#top">Up</a></div> | |
| 164 <hr /> | |
| 165 </body></html> |
