Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Helpviewer.Bookmarks.BookmarkNode.html
Documentation/Source/eric4.Helpviewer.Bookmarks.BookmarkNode.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 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>eric4.Helpviewer.Bookmarks.BookmarkNode</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Helpviewer.Bookmarks.BookmarkNode</h1> | |
| 24 <p> | |
| 25 Module implementing the bookmark node. | |
| 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="#BookmarkNode">BookmarkNode</a></td> | |
| 35 <td>Class implementing the bookmark node type.</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="BookmarkNode" ID="BookmarkNode"></a> | |
| 44 <h2>BookmarkNode</h2> | |
| 45 <p> | |
| 46 Class implementing the bookmark node type. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 object | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>Bookmark</td></tr><tr><td>Folder</td></tr><tr><td>Root</td></tr><tr><td>Separator</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#BookmarkNode.__init__">BookmarkNode</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#BookmarkNode.add">add</a></td> | |
| 61 <td>Public method to add/insert a child node.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#BookmarkNode.children">children</a></td> | |
| 64 <td>Public method to get the list of child nodes.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#BookmarkNode.parent">parent</a></td> | |
| 67 <td>Public method to get a reference to the parent node.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#BookmarkNode.remove">remove</a></td> | |
| 70 <td>Public method to remove a child node.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#BookmarkNode.setType">setType</a></td> | |
| 73 <td>Public method to set the bookmark's type.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#BookmarkNode.type">type</a></td> | |
| 76 <td>Public method to get the bookmark's type.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <a NAME="BookmarkNode.__init__" ID="BookmarkNode.__init__"></a> | |
| 80 <h4>BookmarkNode (Constructor)</h4> | |
| 81 <b>BookmarkNode</b>(<i>type_ = Root, parent = None</i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><dl> | |
| 85 <dt><i>type_</i></dt> | |
| 86 <dd> | |
| 87 type of the bookmark node (BookmarkNode.Type) | |
| 88 </dd><dt><i>parent</i></dt> | |
| 89 <dd> | |
| 90 reference to the parent node (BookmarkNode) | |
| 91 </dd> | |
| 92 </dl><a NAME="BookmarkNode.add" ID="BookmarkNode.add"></a> | |
| 93 <h4>BookmarkNode.add</h4> | |
| 94 <b>add</b>(<i>child, offset = -1</i>) | |
| 95 <p> | |
| 96 Public method to add/insert a child node. | |
| 97 </p><dl> | |
| 98 <dt><i>child</i></dt> | |
| 99 <dd> | |
| 100 reference to the node to add (BookmarkNode) | |
| 101 </dd><dt><i>offset</i></dt> | |
| 102 <dd> | |
| 103 position where to insert child (integer, -1 = append) | |
| 104 </dd> | |
| 105 </dl><a NAME="BookmarkNode.children" ID="BookmarkNode.children"></a> | |
| 106 <h4>BookmarkNode.children</h4> | |
| 107 <b>children</b>(<i></i>) | |
| 108 <p> | |
| 109 Public method to get the list of child nodes. | |
| 110 </p><dl> | |
| 111 <dt>Returns:</dt> | |
| 112 <dd> | |
| 113 list of all child nodes (list of BookmarkNode) | |
| 114 </dd> | |
| 115 </dl><a NAME="BookmarkNode.parent" ID="BookmarkNode.parent"></a> | |
| 116 <h4>BookmarkNode.parent</h4> | |
| 117 <b>parent</b>(<i></i>) | |
| 118 <p> | |
| 119 Public method to get a reference to the parent node. | |
| 120 </p><dl> | |
| 121 <dt>Returns:</dt> | |
| 122 <dd> | |
| 123 reference to the parent node (BookmarkNode) | |
| 124 </dd> | |
| 125 </dl><a NAME="BookmarkNode.remove" ID="BookmarkNode.remove"></a> | |
| 126 <h4>BookmarkNode.remove</h4> | |
| 127 <b>remove</b>(<i>child</i>) | |
| 128 <p> | |
| 129 Public method to remove a child node. | |
| 130 </p><dl> | |
| 131 <dt><i>child</i></dt> | |
| 132 <dd> | |
| 133 reference to the child node (BookmarkNode) | |
| 134 </dd> | |
| 135 </dl><a NAME="BookmarkNode.setType" ID="BookmarkNode.setType"></a> | |
| 136 <h4>BookmarkNode.setType</h4> | |
| 137 <b>setType</b>(<i>type_</i>) | |
| 138 <p> | |
| 139 Public method to set the bookmark's type. | |
| 140 </p><dl> | |
| 141 <dt><i>type_</i></dt> | |
| 142 <dd> | |
| 143 type of the bookmark node (BookmarkNode.Type) | |
| 144 </dd> | |
| 145 </dl><a NAME="BookmarkNode.type" ID="BookmarkNode.type"></a> | |
| 146 <h4>BookmarkNode.type</h4> | |
| 147 <b>type</b>(<i></i>) | |
| 148 <p> | |
| 149 Public method to get the bookmark's type. | |
| 150 </p><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 bookmark type (BookmarkNode.Type) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <div align="right"><a href="#top">Up</a></div> | |
| 157 <hr /> | |
| 158 </body></html> |
