Documentation/Source/eric5.DocumentationTools.QtHelpGenerator.html

changeset 3018
70924c0bdaf1
parent 2387
2d119e79ab54
equal deleted inserted replaced
3017:6a8cb7632448 3018:70924c0bdaf1
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body><a NAME="top" ID="top"></a>
22 <h1>eric5.DocumentationTools.QtHelpGenerator</h1> 22 <h1>eric5.DocumentationTools.QtHelpGenerator</h1>
23 <p> 23 <p>
24 Module implementing the QtHelp generator for the builtin documentation generator. 24 Module implementing the QtHelp generator for the builtin documentation
25 generator.
25 </p> 26 </p>
26 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
27 <table> 28 <table>
28 <tr><td>HelpCollection</td></tr><tr><td>HelpCollectionFile</td></tr><tr><td>HelpCollectionProjectFile</td></tr><tr><td>HelpHelpFile</td></tr><tr><td>HelpProject</td></tr><tr><td>HelpProjectFile</td></tr> 29 <tr><td>HelpCollection</td></tr><tr><td>HelpCollectionFile</td></tr><tr><td>HelpCollectionProjectFile</td></tr><tr><td>HelpHelpFile</td></tr><tr><td>HelpProject</td></tr><tr><td>HelpProjectFile</td></tr>
29 </table> 30 </table>
40 </table> 41 </table>
41 <hr /><hr /> 42 <hr /><hr />
42 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a> 43 <a NAME="QtHelpGenerator" ID="QtHelpGenerator"></a>
43 <h2>QtHelpGenerator</h2> 44 <h2>QtHelpGenerator</h2>
44 <p> 45 <p>
45 Class implementing the QtHelp generator for the builtin documentation generator. 46 Class implementing the QtHelp generator for the builtin documentation
47 generator.
46 </p> 48 </p>
47 <h3>Derived from</h3> 49 <h3>Derived from</h3>
48 object 50 object
49 <h3>Class Attributes</h3> 51 <h3>Class Attributes</h3>
50 <table> 52 <table>
98 </dd><dt><i>filterName</i></dt> 100 </dd><dt><i>filterName</i></dt>
99 <dd> 101 <dd>
100 name of the custom filter (string) 102 name of the custom filter (string)
101 </dd><dt><i>filterAttributes</i></dt> 103 </dd><dt><i>filterAttributes</i></dt>
102 <dd> 104 <dd>
103 ':' separated list of filter attributes (string) 105 ':' separated list of filter attributes
106 (string)
104 </dd><dt><i>title</i></dt> 107 </dd><dt><i>title</i></dt>
105 <dd> 108 <dd>
106 title to be used for the generated help (string) 109 title to be used for the generated help (string)
107 </dd><dt><i>createCollection</i></dt> 110 </dd><dt><i>createCollection</i></dt>
108 <dd> 111 <dd>
109 flag indicating the generation of the collection 112 flag indicating the generation of the
110 files (boolean) 113 collection files (boolean)
111 </dd> 114 </dd>
112 </dl><a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a> 115 </dl><a NAME="QtHelpGenerator.__convertEol" ID="QtHelpGenerator.__convertEol"></a>
113 <h4>QtHelpGenerator.__convertEol</h4> 116 <h4>QtHelpGenerator.__convertEol</h4>
114 <b>__convertEol</b>(<i>txt, newline</i>) 117 <b>__convertEol</b>(<i>txt, newline</i>)
115 <p> 118 <p>

eric ide

mercurial