Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Helpviewer.HelpUtilities.html
eric6/Documentation/Source/eric6.Helpviewer.HelpUtilities.html
- changeset 6942
- 2602857055c5
- parent 4335
- a25c157625c4
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 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><tr> | |
| 46 <td><a href="#parseContentDisposition">parseContentDisposition</a></td> | |
| 47 <td>Function to parse a content disposition header.</td> | |
| 48 </tr> | |
| 49 </table> | |
| 50 <hr /><hr /> | |
| 51 <a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a> | |
| 52 <h2>ensureUniqueFilename</h2> | |
| 53 <b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>) | |
| 54 <p> | |
| 55 Module function to generate an unique file name based on a pattern. | |
| 56 </p><dl> | |
| 57 <dt><i>name</i></dt> | |
| 58 <dd> | |
| 59 desired file name (string) | |
| 60 </dd><dt><i>appendFormat</i></dt> | |
| 61 <dd> | |
| 62 format pattern to be used to make the unique name | |
| 63 (string) | |
| 64 </dd> | |
| 65 </dl><dl> | |
| 66 <dt>Returns:</dt> | |
| 67 <dd> | |
| 68 unique file name | |
| 69 </dd> | |
| 70 </dl> | |
| 71 <div align="right"><a href="#top">Up</a></div> | |
| 72 <hr /><hr /> | |
| 73 <a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a> | |
| 74 <h2>filterCharsFromFilename</h2> | |
| 75 <b>filterCharsFromFilename</b>(<i>name</i>) | |
| 76 <p> | |
| 77 Module function to filter illegal characters. | |
| 78 </p><dl> | |
| 79 <dt><i>name</i></dt> | |
| 80 <dd> | |
| 81 name to be sanitized (string) | |
| 82 </dd> | |
| 83 </dl><dl> | |
| 84 <dt>Returns:</dt> | |
| 85 <dd> | |
| 86 sanitized name (string) | |
| 87 </dd> | |
| 88 </dl> | |
| 89 <div align="right"><a href="#top">Up</a></div> | |
| 90 <hr /><hr /> | |
| 91 <a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a> | |
| 92 <h2>getFileNameFromUrl</h2> | |
| 93 <b>getFileNameFromUrl</b>(<i>url</i>) | |
| 94 <p> | |
| 95 Module function to generate a file name based on the given URL. | |
| 96 </p><dl> | |
| 97 <dt><i>url</i></dt> | |
| 98 <dd> | |
| 99 URL (QUrl) | |
| 100 </dd> | |
| 101 </dl><dl> | |
| 102 <dt>Returns:</dt> | |
| 103 <dd> | |
| 104 file name (string) | |
| 105 </dd> | |
| 106 </dl> | |
| 107 <div align="right"><a href="#top">Up</a></div> | |
| 108 <hr /><hr /> | |
| 109 <a NAME="parseContentDisposition" ID="parseContentDisposition"></a> | |
| 110 <h2>parseContentDisposition</h2> | |
| 111 <b>parseContentDisposition</b>(<i>reply</i>) | |
| 112 <p> | |
| 113 Function to parse a content disposition header. | |
| 114 </p><dl> | |
| 115 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 116 <dd> | |
| 117 network reply to be parsed | |
| 118 </dd> | |
| 119 </dl><dl> | |
| 120 <dt>Returns:</dt> | |
| 121 <dd> | |
| 122 file name parsed from a content disposition header | |
| 123 </dd> | |
| 124 </dl><dl> | |
| 125 <dt>Return Type:</dt> | |
| 126 <dd> | |
| 127 str | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <div align="right"><a href="#top">Up</a></div> | |
| 131 <hr /> | |
| 132 </body></html> |
