--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Tasks.TaskPropertiesDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Tasks.TaskPropertiesDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Tasks.TaskPropertiesDialog</h1> + +<p> +Module implementing the task properties dialog. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#TaskPropertiesDialog">TaskPropertiesDialog</a></td> +<td>Class implementing the task properties dialog.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="TaskPropertiesDialog" ID="TaskPropertiesDialog"></a> +<h2>TaskPropertiesDialog</h2> + +<p> + Class implementing the task properties dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_TaskPropertiesDialog +<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="#TaskPropertiesDialog.__init__">TaskPropertiesDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#TaskPropertiesDialog.__setMode">__setMode</a></td> +<td>Private method to show or hide dialog elements depending on the task kind.</td> +</tr> +<tr> +<td><a href="#TaskPropertiesDialog.getData">getData</a></td> +<td>Public method to retrieve the dialogs data.</td> +</tr> +<tr> +<td><a href="#TaskPropertiesDialog.isManualTaskMode">isManualTaskMode</a></td> +<td>Public method to check, if the dialog is in manual task mode.</td> +</tr> +<tr> +<td><a href="#TaskPropertiesDialog.setSubTaskMode">setSubTaskMode</a></td> +<td>Public slot to set the sub-task mode.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="TaskPropertiesDialog.__init__" ID="TaskPropertiesDialog.__init__"></a> +<h4>TaskPropertiesDialog (Constructor)</h4> +<b>TaskPropertiesDialog</b>(<i>task=None, parent=None, projectOpen=False</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>task</i> (Task)</dt> +<dd> +the task object to be shown +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +the parent widget +</dd> +<dt><i>projectOpen</i> (bool)</dt> +<dd> +flag indicating status of the project +</dd> +</dl> +<a NAME="TaskPropertiesDialog.__setMode" ID="TaskPropertiesDialog.__setMode"></a> +<h4>TaskPropertiesDialog.__setMode</h4> +<b>__setMode</b>(<i>isFileTask, projectOpen</i>) + +<p> + Private method to show or hide dialog elements depending on the task + kind. +</p> +<dl> + +<dt><i>isFileTask</i> (bool)</dt> +<dd> +flag indicating a file task (i.e. extracted task) +</dd> +<dt><i>projectOpen</i> (bool)</dt> +<dd> +flag indicating status of the project +</dd> +</dl> +<a NAME="TaskPropertiesDialog.getData" ID="TaskPropertiesDialog.getData"></a> +<h4>TaskPropertiesDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to retrieve the dialogs data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of description, priority, type, completion flag, + project flag and long text +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, TaskPriority, TaskType, bool, bool, str) +</dd> +</dl> +<a NAME="TaskPropertiesDialog.isManualTaskMode" ID="TaskPropertiesDialog.isManualTaskMode"></a> +<h4>TaskPropertiesDialog.isManualTaskMode</h4> +<b>isManualTaskMode</b>(<i></i>) + +<p> + Public method to check, if the dialog is in manual task mode. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating manual task mode +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="TaskPropertiesDialog.setSubTaskMode" ID="TaskPropertiesDialog.setSubTaskMode"></a> +<h4>TaskPropertiesDialog.setSubTaskMode</h4> +<b>setSubTaskMode</b>(<i>projectTask</i>) + +<p> + Public slot to set the sub-task mode. +</p> +<dl> + +<dt><i>projectTask</i></dt> +<dd> +flag indicating a project related task (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file