diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksModel.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksModel.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,440 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Helpviewer.Bookmarks.BookmarksModel</title> +<style> +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' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Helpviewer.Bookmarks.BookmarksModel</h1> +<p> +Module implementing the bookmark model class. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#BookmarksModel">BookmarksModel</a></td> +<td>Class implementing the bookmark model.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="BookmarksModel" ID="BookmarksModel"></a> +<h2>BookmarksModel</h2> +<p> + Class implementing the bookmark model. +</p> +<h3>Derived from</h3> +QAbstractItemModel +<h3>Class Attributes</h3> +<table> +<tr><td>MIMETYPE</td></tr><tr><td>SeparatorRole</td></tr><tr><td>TypeRole</td></tr><tr><td>UrlRole</td></tr><tr><td>UrlStringRole</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#BookmarksModel.__init__">BookmarksModel</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#BookmarksModel.bookmarksManager">bookmarksManager</a></td> +<td>Public method to get a reference to the bookmarks manager.</td> +</tr><tr> +<td><a href="#BookmarksModel.columnCount">columnCount</a></td> +<td>Public method to get the number of columns.</td> +</tr><tr> +<td><a href="#BookmarksModel.data">data</a></td> +<td>Public method to get data from the model.</td> +</tr><tr> +<td><a href="#BookmarksModel.dropMimeData">dropMimeData</a></td> +<td>Public method to accept the mime data of a drop action.</td> +</tr><tr> +<td><a href="#BookmarksModel.entryAdded">entryAdded</a></td> +<td>Public slot to add a bookmark node.</td> +</tr><tr> +<td><a href="#BookmarksModel.entryChanged">entryChanged</a></td> +<td>Public method to change a node.</td> +</tr><tr> +<td><a href="#BookmarksModel.entryRemoved">entryRemoved</a></td> +<td>Public slot to remove a bookmark node.</td> +</tr><tr> +<td><a href="#BookmarksModel.flags">flags</a></td> +<td>Public method to get flags for a node cell.</td> +</tr><tr> +<td><a href="#BookmarksModel.hasChildren">hasChildren</a></td> +<td>Public method to check, if a parent node has some children.</td> +</tr><tr> +<td><a href="#BookmarksModel.headerData">headerData</a></td> +<td>Public method to get the header data.</td> +</tr><tr> +<td><a href="#BookmarksModel.index">index</a></td> +<td>Public method to get a model index for a node cell.</td> +</tr><tr> +<td><a href="#BookmarksModel.mimeData">mimeData</a></td> +<td>Public method to return the mime data.</td> +</tr><tr> +<td><a href="#BookmarksModel.mimeTypes">mimeTypes</a></td> +<td>Public method to report the supported mime types.</td> +</tr><tr> +<td><a href="#BookmarksModel.node">node</a></td> +<td>Public method to get a bookmark node given it's index.</td> +</tr><tr> +<td><a href="#BookmarksModel.nodeIndex">nodeIndex</a></td> +<td>Public method to get a model index.</td> +</tr><tr> +<td><a href="#BookmarksModel.parent">parent</a></td> +<td>Public method to get the index of the parent node.</td> +</tr><tr> +<td><a href="#BookmarksModel.removeRows">removeRows</a></td> +<td>Public method to remove bookmarks from the model.</td> +</tr><tr> +<td><a href="#BookmarksModel.rowCount">rowCount</a></td> +<td>Public method to determine the number of rows.</td> +</tr><tr> +<td><a href="#BookmarksModel.setData">setData</a></td> +<td>Public method to set the data of a node cell.</td> +</tr><tr> +<td><a href="#BookmarksModel.supportedDropActions">supportedDropActions</a></td> +<td>Public method to report the supported drop actions.</td> +</tr> +</table> +<a NAME="BookmarksModel.__init__" ID="BookmarksModel.__init__"></a> +<h4>BookmarksModel (Constructor)</h4> +<b>BookmarksModel</b>(<i>manager, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>manager</i></dt> +<dd> +reference to the bookmark manager object (BookmarksManager) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent object (QObject) +</dd> +</dl><a NAME="BookmarksModel.bookmarksManager" ID="BookmarksModel.bookmarksManager"></a> +<h4>BookmarksModel.bookmarksManager</h4> +<b>bookmarksManager</b>(<i></i>) +<p> + Public method to get a reference to the bookmarks manager. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the bookmarks manager object (BookmarksManager) +</dd> +</dl><a NAME="BookmarksModel.columnCount" ID="BookmarksModel.columnCount"></a> +<h4>BookmarksModel.columnCount</h4> +<b>columnCount</b>(<i>parent = QModelIndex()</i>) +<p> + Public method to get the number of columns. +</p><dl> +<dt><i>parent</i></dt> +<dd> +index of parent (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +number of columns (integer) +</dd> +</dl><a NAME="BookmarksModel.data" ID="BookmarksModel.data"></a> +<h4>BookmarksModel.data</h4> +<b>data</b>(<i>index, role = Qt.DisplayRole</i>) +<p> + Public method to get data from the model. +</p><dl> +<dt><i>index</i></dt> +<dd> +index of bookmark to get data for (QModelIndex) +</dd><dt><i>role</i></dt> +<dd> +data role (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +bookmark data +</dd> +</dl><a NAME="BookmarksModel.dropMimeData" ID="BookmarksModel.dropMimeData"></a> +<h4>BookmarksModel.dropMimeData</h4> +<b>dropMimeData</b>(<i>data, action, row, column, parent</i>) +<p> + Public method to accept the mime data of a drop action. +</p><dl> +<dt><i>data</i></dt> +<dd> +reference to the mime data (QMimeData) +</dd><dt><i>action</i></dt> +<dd> +drop action requested (Qt.DropAction) +</dd><dt><i>row</i></dt> +<dd> +row number (integer) +</dd><dt><i>column</i></dt> +<dd> +column number (integer) +</dd><dt><i>parent</i></dt> +<dd> +index of the parent node (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating successful acceptance of the data (boolean) +</dd> +</dl><a NAME="BookmarksModel.entryAdded" ID="BookmarksModel.entryAdded"></a> +<h4>BookmarksModel.entryAdded</h4> +<b>entryAdded</b>(<i>node</i>) +<p> + Public slot to add a bookmark node. +</p><dl> +<dt><i>node</i></dt> +<dd> +reference to the bookmark node to add (BookmarkNode) +</dd> +</dl><a NAME="BookmarksModel.entryChanged" ID="BookmarksModel.entryChanged"></a> +<h4>BookmarksModel.entryChanged</h4> +<b>entryChanged</b>(<i>node</i>) +<p> + Public method to change a node. +</p><dl> +<dt><i>node</i></dt> +<dd> +reference to the bookmark node to change (BookmarkNode) +</dd> +</dl><a NAME="BookmarksModel.entryRemoved" ID="BookmarksModel.entryRemoved"></a> +<h4>BookmarksModel.entryRemoved</h4> +<b>entryRemoved</b>(<i>parent, row, node</i>) +<p> + Public slot to remove a bookmark node. +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent bookmark node (BookmarkNode) +</dd><dt><i>row</i></dt> +<dd> +row number of the node (integer) +</dd><dt><i>node</i></dt> +<dd> +reference to the bookmark node to remove (BookmarkNode) +</dd> +</dl><a NAME="BookmarksModel.flags" ID="BookmarksModel.flags"></a> +<h4>BookmarksModel.flags</h4> +<b>flags</b>(<i>index</i>) +<p> + Public method to get flags for a node cell. +</p><dl> +<dt><i>index</i></dt> +<dd> +index of the node cell (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flags (Qt.ItemFlags) +</dd> +</dl><a NAME="BookmarksModel.hasChildren" ID="BookmarksModel.hasChildren"></a> +<h4>BookmarksModel.hasChildren</h4> +<b>hasChildren</b>(<i>parent = QModelIndex()</i>) +<p> + Public method to check, if a parent node has some children. +</p><dl> +<dt><i>parent</i></dt> +<dd> +index of the parent node (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating the presence of children (boolean) +</dd> +</dl><a NAME="BookmarksModel.headerData" ID="BookmarksModel.headerData"></a> +<h4>BookmarksModel.headerData</h4> +<b>headerData</b>(<i>section, orientation, role = Qt.DisplayRole</i>) +<p> + Public method to get the header data. +</p><dl> +<dt><i>section</i></dt> +<dd> +section number (integer) +</dd><dt><i>orientation</i></dt> +<dd> +header orientation (Qt.Orientation) +</dd><dt><i>role</i></dt> +<dd> +data role (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +header data +</dd> +</dl><a NAME="BookmarksModel.index" ID="BookmarksModel.index"></a> +<h4>BookmarksModel.index</h4> +<b>index</b>(<i>row, column, parent = QModelIndex()</i>) +<p> + Public method to get a model index for a node cell. +</p><dl> +<dt><i>row</i></dt> +<dd> +row number (integer) +</dd><dt><i>column</i></dt> +<dd> +column number (integer) +</dd><dt><i>parent</i></dt> +<dd> +index of the parent (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +index (QModelIndex) +</dd> +</dl><a NAME="BookmarksModel.mimeData" ID="BookmarksModel.mimeData"></a> +<h4>BookmarksModel.mimeData</h4> +<b>mimeData</b>(<i>indexes</i>) +<p> + Public method to return the mime data. +</p><dl> +<dt><i>indexes</i></dt> +<dd> +list of indexes (QModelIndexList) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +mime data (QMimeData) +</dd> +</dl><a NAME="BookmarksModel.mimeTypes" ID="BookmarksModel.mimeTypes"></a> +<h4>BookmarksModel.mimeTypes</h4> +<b>mimeTypes</b>(<i></i>) +<p> + Public method to report the supported mime types. +</p><dl> +<dt>Returns:</dt> +<dd> +supported mime types (list of strings) +</dd> +</dl><a NAME="BookmarksModel.node" ID="BookmarksModel.node"></a> +<h4>BookmarksModel.node</h4> +<b>node</b>(<i>index</i>) +<p> + Public method to get a bookmark node given it's index. +</p><dl> +<dt><i>index</i></dt> +<dd> +index of the node (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +bookmark node (BookmarkNode) +</dd> +</dl><a NAME="BookmarksModel.nodeIndex" ID="BookmarksModel.nodeIndex"></a> +<h4>BookmarksModel.nodeIndex</h4> +<b>nodeIndex</b>(<i>node</i>) +<p> + Public method to get a model index. +</p><dl> +<dt><i>node</i></dt> +<dd> +reference to the node to get the index for (BookmarkNode) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +model index (QModelIndex) +</dd> +</dl><a NAME="BookmarksModel.parent" ID="BookmarksModel.parent"></a> +<h4>BookmarksModel.parent</h4> +<b>parent</b>(<i>index = QModelIndex()</i>) +<p> + Public method to get the index of the parent node. +</p><dl> +<dt><i>index</i></dt> +<dd> +index of the child node (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +index of the parent node (QModelIndex) +</dd> +</dl><a NAME="BookmarksModel.removeRows" ID="BookmarksModel.removeRows"></a> +<h4>BookmarksModel.removeRows</h4> +<b>removeRows</b>(<i>row, count, parent = QModelIndex()</i>) +<p> + Public method to remove bookmarks from the model. +</p><dl> +<dt><i>row</i></dt> +<dd> +row of the first bookmark to remove (integer) +</dd><dt><i>count</i></dt> +<dd> +number of bookmarks to remove (integer) +</dd><dt><i>index</i></dt> +<dd> +of the parent bookmark node (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating successful removal (boolean) +</dd> +</dl><a NAME="BookmarksModel.rowCount" ID="BookmarksModel.rowCount"></a> +<h4>BookmarksModel.rowCount</h4> +<b>rowCount</b>(<i>parent = QModelIndex()</i>) +<p> + Public method to determine the number of rows. +</p><dl> +<dt><i>parent</i></dt> +<dd> +index of parent (QModelIndex) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +number of rows (integer) +</dd> +</dl><a NAME="BookmarksModel.setData" ID="BookmarksModel.setData"></a> +<h4>BookmarksModel.setData</h4> +<b>setData</b>(<i>index, value, role = Qt.EditRole</i>) +<p> + Public method to set the data of a node cell. +</p><dl> +<dt><i>index</i></dt> +<dd> +index of the node cell (QModelIndex) +</dd><dt><i>value</i></dt> +<dd> +value to be set +</dd><dt><i>role</i></dt> +<dd> +role of the data (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl><a NAME="BookmarksModel.supportedDropActions" ID="BookmarksModel.supportedDropActions"></a> +<h4>BookmarksModel.supportedDropActions</h4> +<b>supportedDropActions</b>(<i></i>) +<p> + Public method to report the supported drop actions. +</p><dl> +<dt>Returns:</dt> +<dd> +supported drop actions (Qt.DropAction) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file