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