Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.HelpUtilities.html
Documentation/Source/eric5.Helpviewer.HelpUtilities.html
- changeset 1953
- 26aa6fd94dc2
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 1952:af4103f0e93f | 1953:26aa6fd94dc2 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.HelpUtilities</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Helpviewer.HelpUtilities</h1> | |
| 24 <p> | |
| 25 Module implementing some global helper functions. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr><td>None</td></tr> | |
| 34 </table> | |
| 35 <h3>Functions</h3> | |
| 36 <table> | |
| 37 <tr> | |
| 38 <td><a href="#ensureUniqueFilename">ensureUniqueFilename</a></td> | |
| 39 <td>Module function to generate an unique file name based on a pattern.</td> | |
| 40 </tr><tr> | |
| 41 <td><a href="#filterCharsFromFilename">filterCharsFromFilename</a></td> | |
| 42 <td>Module function to filter illegal characters.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#getFileNameFromUrl">getFileNameFromUrl</a></td> | |
| 45 <td>Module function to generate a file name based on the given URL.</td> | |
| 46 </tr> | |
| 47 </table> | |
| 48 <hr /><hr /> | |
| 49 <a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a> | |
| 50 <h2>ensureUniqueFilename</h2> | |
| 51 <b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>) | |
| 52 <p> | |
| 53 Module function to generate an unique file name based on a pattern. | |
| 54 </p><dl> | |
| 55 <dt><i>name</i></dt> | |
| 56 <dd> | |
| 57 desired file name (string) | |
| 58 </dd><dt><i>appendFormat</i></dt> | |
| 59 <dd> | |
| 60 format pattern to be used to make the unique name (string) | |
| 61 </dd> | |
| 62 </dl><dl> | |
| 63 <dt>Returns:</dt> | |
| 64 <dd> | |
| 65 unique file name | |
| 66 </dd> | |
| 67 </dl> | |
| 68 <div align="right"><a href="#top">Up</a></div> | |
| 69 <hr /><hr /> | |
| 70 <a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a> | |
| 71 <h2>filterCharsFromFilename</h2> | |
| 72 <b>filterCharsFromFilename</b>(<i>name</i>) | |
| 73 <p> | |
| 74 Module function to filter illegal characters. | |
| 75 </p><dl> | |
| 76 <dt><i>name</i></dt> | |
| 77 <dd> | |
| 78 name to be sanitized (string) | |
| 79 </dd> | |
| 80 </dl><dl> | |
| 81 <dt>Returns:</dt> | |
| 82 <dd> | |
| 83 sanitized name (string) | |
| 84 </dd> | |
| 85 </dl> | |
| 86 <div align="right"><a href="#top">Up</a></div> | |
| 87 <hr /><hr /> | |
| 88 <a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a> | |
| 89 <h2>getFileNameFromUrl</h2> | |
| 90 <b>getFileNameFromUrl</b>(<i>url</i>) | |
| 91 <p> | |
| 92 Module function to generate a file name based on the given URL. | |
| 93 </p><dl> | |
| 94 <dt><i>url</i></dt> | |
| 95 <dd> | |
| 96 URL (QUrl) | |
| 97 </dd> | |
| 98 </dl><dl> | |
| 99 <dt>Returns:</dt> | |
| 100 <dd> | |
| 101 file name (string) | |
| 102 </dd> | |
| 103 </dl> | |
| 104 <div align="right"><a href="#top">Up</a></div> | |
| 105 <hr /> | |
| 106 </body></html> |
