Documentation/Source/eric5.Helpviewer.HelpUtilities.html

<!DOCTYPE html>
<html><head>
<title>eric5.Helpviewer.HelpUtilities</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>eric5.Helpviewer.HelpUtilities</h1>
<p>
Module implementing some global helper functions.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#ensureUniqueFilename">ensureUniqueFilename</a></td>
<td>Module function to generate an unique file name based on a pattern.</td>
</tr><tr>
<td><a href="#filterCharsFromFilename">filterCharsFromFilename</a></td>
<td>Module function to filter illegal characters.</td>
</tr><tr>
<td><a href="#getFileNameFromUrl">getFileNameFromUrl</a></td>
<td>Module function to generate a file name based on the given URL.</td>
</tr>
</table>
<hr /><hr />
<a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a>
<h2>ensureUniqueFilename</h2>
<b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>)
<p>
    Module function to generate an unique file name based on a pattern.
</p><dl>
<dt><i>name</i></dt>
<dd>
desired file name (string)
</dd><dt><i>appendFormat</i></dt>
<dd>
format pattern to be used to make the unique name
        (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
unique file name
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a>
<h2>filterCharsFromFilename</h2>
<b>filterCharsFromFilename</b>(<i>name</i>)
<p>
    Module function to filter illegal characters.
</p><dl>
<dt><i>name</i></dt>
<dd>
name to be sanitized (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
sanitized name (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a>
<h2>getFileNameFromUrl</h2>
<b>getFileNameFromUrl</b>(<i>url</i>)
<p>
    Module function to generate a file name based on the given URL.
</p><dl>
<dt><i>url</i></dt>
<dd>
URL (QUrl)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
file name (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>