--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Tasks.TasksFile.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,162 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Tasks.TasksFile</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.TasksFile</h1> + +<p> +Module implementing a class representing the tasks JSON file. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#TasksFile">TasksFile</a></td> +<td>Class representing the tasks JSON file.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="TasksFile" ID="TasksFile"></a> +<h2>TasksFile</h2> + +<p> + Class representing the tasks JSON file. +</p> +<h3>Derived from</h3> +QObject +<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="#TasksFile.__init__">TasksFile</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#TasksFile.readFile">readFile</a></td> +<td>Public method to read the tasks data from a task JSON file.</td> +</tr> +<tr> +<td><a href="#TasksFile.writeFile">writeFile</a></td> +<td>Public method to write the tasks data to a tasks JSON file.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="TasksFile.__init__" ID="TasksFile.__init__"></a> +<h4>TasksFile (Constructor)</h4> +<b>TasksFile</b>(<i>isGlobal: bool, parent: QObject = None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>isGlobal</i> (bool)</dt> +<dd> +flag indicating a file for global tasks +</dd> +<dt><i>parent</i> (QObject (optional))</dt> +<dd> +reference to the parent object (defaults to None) +</dd> +</dl> +<a NAME="TasksFile.readFile" ID="TasksFile.readFile"></a> +<h4>TasksFile.readFile</h4> +<b>readFile</b>(<i>filename: str</i>) + +<p> + Public method to read the tasks data from a task JSON file. +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +name of the project file +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a successful read +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="TasksFile.writeFile" ID="TasksFile.writeFile"></a> +<h4>TasksFile.writeFile</h4> +<b>writeFile</b>(<i>filename: str</i>) + +<p> + Public method to write the tasks data to a tasks JSON file. +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +name of the tasks file +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a successful write +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file