diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Debugger.WatchPointModel.html --- a/eric6/Documentation/Source/eric6.Debugger.WatchPointModel.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Debugger.WatchPointModel.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,33 +18,43 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Debugger.WatchPointModel</h1> + <p> Module implementing the Watch expression model. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#WatchPointModel">WatchPointModel</a></td> <td>Class implementing a custom model for watch expressions.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="WatchPointModel" ID="WatchPointModel"></a> <h2>WatchPointModel</h2> + <p> Class implementing a custom model for watch expressions. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>dataAboutToBeChanged(QModelIndex, QModelIndex)</dt> <dd> emitted to indicate @@ -54,329 +64,438 @@ <h3>Derived from</h3> QAbstractItemModel <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#WatchPointModel.__init__">WatchPointModel</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.addWatchPoint">addWatchPoint</a></td> <td>Public method to add a new watch expression to the list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.columnCount">columnCount</a></td> <td>Public method to get the current column count.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.data">data</a></td> <td>Public method to get the requested data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.deleteAll">deleteAll</a></td> <td>Public method to delete all watch expressions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.deleteWatchPointByIndex">deleteWatchPointByIndex</a></td> <td>Public method to set the values of a watch expression given by index.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.deleteWatchPoints">deleteWatchPoints</a></td> <td>Public method to delete a list of watch expressions given by their indexes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.flags">flags</a></td> <td>Public method to get item flags.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.getWatchPointByIndex">getWatchPointByIndex</a></td> <td>Public method to get the values of a watch expression given by index.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.getWatchPointIndex">getWatchPointIndex</a></td> <td>Public method to get the index of a watch expression given by expression.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.hasChildren">hasChildren</a></td> <td>Public method to check for the presence of child items.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.headerData">headerData</a></td> <td>Public method to get header data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.index">index</a></td> <td>Public method to create an index.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.parent">parent</a></td> <td>Public method to get the parent index.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.rowCount">rowCount</a></td> <td>Public method to get the current row count.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.setWatchPointByIndex">setWatchPointByIndex</a></td> <td>Public method to set the values of a watch expression given by index.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WatchPointModel.setWatchPointEnabledByIndex">setWatchPointEnabledByIndex</a></td> <td>Public method to set the enabled state of a watch expression given by index.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="WatchPointModel.__init__" ID="WatchPointModel.__init__"></a> <h4>WatchPointModel (Constructor)</h4> <b>WatchPointModel</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> reference to the parent widget (QObject) </dd> -</dl><a NAME="WatchPointModel.addWatchPoint" ID="WatchPointModel.addWatchPoint"></a> +</dl> +<a NAME="WatchPointModel.addWatchPoint" ID="WatchPointModel.addWatchPoint"></a> <h4>WatchPointModel.addWatchPoint</h4> <b>addWatchPoint</b>(<i>cond, special, properties</i>) + <p> Public method to add a new watch expression to the list. -</p><dl> +</p> +<dl> + <dt><i>cond</i></dt> <dd> expression of the watch expression (string) -</dd><dt><i>special</i></dt> +</dd> +<dt><i>special</i></dt> <dd> special condition of the watch expression (string) -</dd><dt><i>properties</i></dt> +</dd> +<dt><i>properties</i></dt> <dd> properties of the watch expression (tuple of temporary flag (bool), enabled flag (bool), ignore count (integer)) </dd> -</dl><a NAME="WatchPointModel.columnCount" ID="WatchPointModel.columnCount"></a> +</dl> +<a NAME="WatchPointModel.columnCount" ID="WatchPointModel.columnCount"></a> <h4>WatchPointModel.columnCount</h4> <b>columnCount</b>(<i>parent=None</i>) + <p> Public method to get the current column count. -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> index of the parent item (QModelIndex) (Unused) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> column count (integer) </dd> -</dl><a NAME="WatchPointModel.data" ID="WatchPointModel.data"></a> +</dl> +<a NAME="WatchPointModel.data" ID="WatchPointModel.data"></a> <h4>WatchPointModel.data</h4> <b>data</b>(<i>index, role</i>) + <p> Public method to get the requested data. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the requested data (QModelIndex) -</dd><dt><i>role</i></dt> +</dd> +<dt><i>role</i></dt> <dd> role of the requested data (Qt.ItemDataRole) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the requested data </dd> -</dl><a NAME="WatchPointModel.deleteAll" ID="WatchPointModel.deleteAll"></a> +</dl> +<a NAME="WatchPointModel.deleteAll" ID="WatchPointModel.deleteAll"></a> <h4>WatchPointModel.deleteAll</h4> <b>deleteAll</b>(<i></i>) + <p> Public method to delete all watch expressions. -</p><a NAME="WatchPointModel.deleteWatchPointByIndex" ID="WatchPointModel.deleteWatchPointByIndex"></a> +</p> +<a NAME="WatchPointModel.deleteWatchPointByIndex" ID="WatchPointModel.deleteWatchPointByIndex"></a> <h4>WatchPointModel.deleteWatchPointByIndex</h4> <b>deleteWatchPointByIndex</b>(<i>index</i>) + <p> Public method to set the values of a watch expression given by index. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the watch expression (QModelIndex) </dd> -</dl><a NAME="WatchPointModel.deleteWatchPoints" ID="WatchPointModel.deleteWatchPoints"></a> +</dl> +<a NAME="WatchPointModel.deleteWatchPoints" ID="WatchPointModel.deleteWatchPoints"></a> <h4>WatchPointModel.deleteWatchPoints</h4> <b>deleteWatchPoints</b>(<i>idxList</i>) + <p> Public method to delete a list of watch expressions given by their indexes. -</p><dl> +</p> +<dl> + <dt><i>idxList</i></dt> <dd> list of watch expression indexes (list of QModelIndex) </dd> -</dl><a NAME="WatchPointModel.flags" ID="WatchPointModel.flags"></a> +</dl> +<a NAME="WatchPointModel.flags" ID="WatchPointModel.flags"></a> <h4>WatchPointModel.flags</h4> <b>flags</b>(<i>index</i>) + <p> Public method to get item flags. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the requested flags (QModelIndex) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> item flags for the given index (Qt.ItemFlags) </dd> -</dl><a NAME="WatchPointModel.getWatchPointByIndex" ID="WatchPointModel.getWatchPointByIndex"></a> +</dl> +<a NAME="WatchPointModel.getWatchPointByIndex" ID="WatchPointModel.getWatchPointByIndex"></a> <h4>WatchPointModel.getWatchPointByIndex</h4> <b>getWatchPointByIndex</b>(<i>index</i>) + <p> Public method to get the values of a watch expression given by index. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the watch expression (QModelIndex) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> watch expression (list of six values (expression, special condition, temporary flag, enabled flag, ignore count, index)) </dd> -</dl><a NAME="WatchPointModel.getWatchPointIndex" ID="WatchPointModel.getWatchPointIndex"></a> +</dl> +<a NAME="WatchPointModel.getWatchPointIndex" ID="WatchPointModel.getWatchPointIndex"></a> <h4>WatchPointModel.getWatchPointIndex</h4> <b>getWatchPointIndex</b>(<i>cond, special=""</i>) + <p> Public method to get the index of a watch expression given by expression. -</p><dl> +</p> +<dl> + <dt><i>cond</i></dt> <dd> expression of the watch expression (string) -</dd><dt><i>special</i></dt> +</dd> +<dt><i>special</i></dt> <dd> special condition of the watch expression (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> index (QModelIndex) </dd> -</dl><a NAME="WatchPointModel.hasChildren" ID="WatchPointModel.hasChildren"></a> +</dl> +<a NAME="WatchPointModel.hasChildren" ID="WatchPointModel.hasChildren"></a> <h4>WatchPointModel.hasChildren</h4> <b>hasChildren</b>(<i>parent=None</i>) + <p> Public method to check for the presence of child items. -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> index of parent item (QModelIndex) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating the presence of child items (boolean) </dd> -</dl><a NAME="WatchPointModel.headerData" ID="WatchPointModel.headerData"></a> +</dl> +<a NAME="WatchPointModel.headerData" ID="WatchPointModel.headerData"></a> <h4>WatchPointModel.headerData</h4> <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>) + <p> Public method to get header data. -</p><dl> +</p> +<dl> + <dt><i>section</i></dt> <dd> section number of the requested header data (integer) -</dd><dt><i>orientation</i></dt> +</dd> +<dt><i>orientation</i></dt> <dd> orientation of the header (Qt.Orientation) -</dd><dt><i>role</i></dt> +</dd> +<dt><i>role</i></dt> <dd> role of the requested data (Qt.ItemDataRole) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> header data </dd> -</dl><a NAME="WatchPointModel.index" ID="WatchPointModel.index"></a> +</dl> +<a NAME="WatchPointModel.index" ID="WatchPointModel.index"></a> <h4>WatchPointModel.index</h4> <b>index</b>(<i>row, column, parent=None</i>) + <p> Public method to create an index. -</p><dl> +</p> +<dl> + <dt><i>row</i></dt> <dd> row number for the index (integer) -</dd><dt><i>column</i></dt> +</dd> +<dt><i>column</i></dt> <dd> column number for the index (integer) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> index of the parent item (QModelIndex) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> requested index (QModelIndex) </dd> -</dl><a NAME="WatchPointModel.parent" ID="WatchPointModel.parent"></a> +</dl> +<a NAME="WatchPointModel.parent" ID="WatchPointModel.parent"></a> <h4>WatchPointModel.parent</h4> <b>parent</b>(<i>index</i>) + <p> Public method to get the parent index. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of item to get parent (QModelIndex) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> index of parent (QModelIndex) </dd> -</dl><a NAME="WatchPointModel.rowCount" ID="WatchPointModel.rowCount"></a> +</dl> +<a NAME="WatchPointModel.rowCount" ID="WatchPointModel.rowCount"></a> <h4>WatchPointModel.rowCount</h4> <b>rowCount</b>(<i>parent=None</i>) + <p> Public method to get the current row count. -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> index of the parent item (QModelIndex) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> row count (integer) </dd> -</dl><a NAME="WatchPointModel.setWatchPointByIndex" ID="WatchPointModel.setWatchPointByIndex"></a> +</dl> +<a NAME="WatchPointModel.setWatchPointByIndex" ID="WatchPointModel.setWatchPointByIndex"></a> <h4>WatchPointModel.setWatchPointByIndex</h4> <b>setWatchPointByIndex</b>(<i>index, cond, special, properties</i>) + <p> Public method to set the values of a watch expression given by index. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the watch expression (QModelIndex) -</dd><dt><i>cond</i></dt> +</dd> +<dt><i>cond</i></dt> <dd> expression of the watch expression (string) -</dd><dt><i>special</i></dt> +</dd> +<dt><i>special</i></dt> <dd> special condition of the watch expression (string) -</dd><dt><i>properties</i></dt> +</dd> +<dt><i>properties</i></dt> <dd> properties of the watch expression (tuple of temporary flag (bool), enabled flag (bool), ignore count (integer)) </dd> -</dl><a NAME="WatchPointModel.setWatchPointEnabledByIndex" ID="WatchPointModel.setWatchPointEnabledByIndex"></a> +</dl> +<a NAME="WatchPointModel.setWatchPointEnabledByIndex" ID="WatchPointModel.setWatchPointEnabledByIndex"></a> <h4>WatchPointModel.setWatchPointEnabledByIndex</h4> <b>setWatchPointEnabledByIndex</b>(<i>index, enabled</i>) + <p> Public method to set the enabled state of a watch expression given by index. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> index of the watch expression (QModelIndex) -</dd><dt><i>enabled</i></dt> +</dd> +<dt><i>enabled</i></dt> <dd> flag giving the enabled state (boolean) </dd>