eric: src/eric7/Documentation/Source/eric7.Templates.TemplatesFile.html@b51dfacef37f

<!DOCTYPE html>
<html><head>
<title>eric7.Templates.TemplatesFile</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Templates.TemplatesFile</h1>

<p>
Module implementing a class representing the templates JSON file.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>TemplateViewer</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#TemplatesFile">TemplatesFile</a></td>
<td>Class representing the templates JSON file.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="TemplatesFile" ID="TemplatesFile"></a>
<h2>TemplatesFile</h2>

<p>
    Class representing the templates 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="#TemplatesFile.__init__">TemplatesFile</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#TemplatesFile.readFile">readFile</a></td>
<td>Public method to read the templates data from a templates JSON file.</td>
</tr>
<tr>
<td><a href="#TemplatesFile.writeFile">writeFile</a></td>
<td>Public method to write the templates data to a templates JSON file.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="TemplatesFile.__init__" ID="TemplatesFile.__init__"></a>
<h4>TemplatesFile (Constructor)</h4>
<b>TemplatesFile</b>(<i>viewer: TemplateViewer, parent: QObject = None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>viewer</i> (TemplateViewer)</dt>
<dd>
reference to the template viewer object
</dd>
<dt><i>parent</i> (QObject (optional))</dt>
<dd>
reference to the parent object (defaults to None)
</dd>
</dl>
<a NAME="TemplatesFile.readFile" ID="TemplatesFile.readFile"></a>
<h4>TemplatesFile.readFile</h4>
<b>readFile</b>(<i>filename: str</i>)

<p>
        Public method to read the templates data from a templates JSON file.
</p>
<dl>

<dt><i>filename</i> (str)</dt>
<dd>
name of the templates 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="TemplatesFile.writeFile" ID="TemplatesFile.writeFile"></a>
<h4>TemplatesFile.writeFile</h4>
<b>writeFile</b>(<i>filename: str</i>)

<p>
        Public method to write the templates data to a templates JSON file.
</p>
<dl>

<dt><i>filename</i> (str)</dt>
<dd>
name of the templates 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>