Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.HelpUtilities.html
Documentation/Source/eric6.Helpviewer.HelpUtilities.html
- changeset 3673
- e26d7d0c1088
- child 4318
- c2f374ca452b
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.HelpUtilities</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.HelpUtilities</h1> | |
| 23 <p> | |
| 24 Module implementing some global helper functions. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#ensureUniqueFilename">ensureUniqueFilename</a></td> | |
| 38 <td>Module function to generate an unique file name based on a pattern.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#filterCharsFromFilename">filterCharsFromFilename</a></td> | |
| 41 <td>Module function to filter illegal characters.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#getFileNameFromUrl">getFileNameFromUrl</a></td> | |
| 44 <td>Module function to generate a file name based on the given URL.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /><hr /> | |
| 48 <a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a> | |
| 49 <h2>ensureUniqueFilename</h2> | |
| 50 <b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>) | |
| 51 <p> | |
| 52 Module function to generate an unique file name based on a pattern. | |
| 53 </p><dl> | |
| 54 <dt><i>name</i></dt> | |
| 55 <dd> | |
| 56 desired file name (string) | |
| 57 </dd><dt><i>appendFormat</i></dt> | |
| 58 <dd> | |
| 59 format pattern to be used to make the unique name | |
| 60 (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> |
