Documentation/Source/eric6.Helpviewer.HelpLanguagesDialog.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.HelpLanguagesDialog</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.HelpLanguagesDialog</h1>
23 <p>
24 Module implementing a dialog to configure the preferred languages.
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>
33 <td><a href="#HelpLanguagesDialog">HelpLanguagesDialog</a></td>
34 <td>Class implementing a dialog to configure the preferred languages.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="HelpLanguagesDialog" ID="HelpLanguagesDialog"></a>
43 <h2>HelpLanguagesDialog</h2>
44 <p>
45 Class implementing a dialog to configure the preferred languages.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_HelpLanguagesDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr>
56 <td><a href="#HelpLanguagesDialog.defaultAcceptLanguages">defaultAcceptLanguages</a></td>
57 <td>Class method to get the list of default accept languages.</td>
58 </tr><tr>
59 <td><a href="#HelpLanguagesDialog.expand">expand</a></td>
60 <td>Class method to expand a language enum to a readable languages list.</td>
61 </tr><tr>
62 <td><a href="#HelpLanguagesDialog.httpString">httpString</a></td>
63 <td>Class method to convert a list of acceptable languages into a byte array.</td>
64 </tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#HelpLanguagesDialog.__init__">HelpLanguagesDialog</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#HelpLanguagesDialog.__currentChanged">__currentChanged</a></td>
73 <td>Private slot to handle a change of the current selection.</td>
74 </tr><tr>
75 <td><a href="#HelpLanguagesDialog.accept">accept</a></td>
76 <td>Public method to accept the data entered.</td>
77 </tr><tr>
78 <td><a href="#HelpLanguagesDialog.on_addButton_clicked">on_addButton_clicked</a></td>
79 <td>Private slot to add a language to the list of acceptable languages.</td>
80 </tr><tr>
81 <td><a href="#HelpLanguagesDialog.on_downButton_clicked">on_downButton_clicked</a></td>
82 <td>Private slot to move a language down.</td>
83 </tr><tr>
84 <td><a href="#HelpLanguagesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
85 <td>Private slot to remove a language from the list of acceptable languages.</td>
86 </tr><tr>
87 <td><a href="#HelpLanguagesDialog.on_upButton_clicked">on_upButton_clicked</a></td>
88 <td>Private slot to move a language up.</td>
89 </tr>
90 </table>
91 <h3>Static Methods</h3>
92 <table>
93 <tr><td>None</td></tr>
94 </table>
95 <a NAME="HelpLanguagesDialog.defaultAcceptLanguages" ID="HelpLanguagesDialog.defaultAcceptLanguages"></a>
96 <h4>HelpLanguagesDialog.defaultAcceptLanguages (class method)</h4>
97 <b>defaultAcceptLanguages</b>(<i></i>)
98 <p>
99 Class method to get the list of default accept languages.
100 </p><dl>
101 <dt>Returns:</dt>
102 <dd>
103 list of acceptable languages (list of strings)
104 </dd>
105 </dl><a NAME="HelpLanguagesDialog.expand" ID="HelpLanguagesDialog.expand"></a>
106 <h4>HelpLanguagesDialog.expand (class method)</h4>
107 <b>expand</b>(<i>language</i>)
108 <p>
109 Class method to expand a language enum to a readable languages
110 list.
111 </p><dl>
112 <dt><i>language</i></dt>
113 <dd>
114 language number (QLocale.Language)
115 </dd>
116 </dl><dl>
117 <dt>Returns:</dt>
118 <dd>
119 list of expanded language names (list of strings)
120 </dd>
121 </dl><a NAME="HelpLanguagesDialog.httpString" ID="HelpLanguagesDialog.httpString"></a>
122 <h4>HelpLanguagesDialog.httpString (class method)</h4>
123 <b>httpString</b>(<i>languages</i>)
124 <p>
125 Class method to convert a list of acceptable languages into a
126 byte array.
127 </p><p>
128 The byte array can be sent along with the Accept-Language http header
129 (see RFC 2616).
130 </p><dl>
131 <dt><i>languages</i></dt>
132 <dd>
133 list of acceptable languages (list of strings)
134 </dd>
135 </dl><dl>
136 <dt>Returns:</dt>
137 <dd>
138 converted list (QByteArray)
139 </dd>
140 </dl><a NAME="HelpLanguagesDialog.__init__" ID="HelpLanguagesDialog.__init__"></a>
141 <h4>HelpLanguagesDialog (Constructor)</h4>
142 <b>HelpLanguagesDialog</b>(<i>parent=None</i>)
143 <p>
144 Constructor
145 </p><dl>
146 <dt><i>parent</i></dt>
147 <dd>
148 reference to the parent widget (QWidget)
149 </dd>
150 </dl><a NAME="HelpLanguagesDialog.__currentChanged" ID="HelpLanguagesDialog.__currentChanged"></a>
151 <h4>HelpLanguagesDialog.__currentChanged</h4>
152 <b>__currentChanged</b>(<i>current, previous</i>)
153 <p>
154 Private slot to handle a change of the current selection.
155 </p><dl>
156 <dt><i>current</i></dt>
157 <dd>
158 index of the currently selected item (QModelIndex)
159 </dd><dt><i>previous</i></dt>
160 <dd>
161 index of the previously selected item (QModelIndex)
162 </dd>
163 </dl><a NAME="HelpLanguagesDialog.accept" ID="HelpLanguagesDialog.accept"></a>
164 <h4>HelpLanguagesDialog.accept</h4>
165 <b>accept</b>(<i></i>)
166 <p>
167 Public method to accept the data entered.
168 </p><a NAME="HelpLanguagesDialog.on_addButton_clicked" ID="HelpLanguagesDialog.on_addButton_clicked"></a>
169 <h4>HelpLanguagesDialog.on_addButton_clicked</h4>
170 <b>on_addButton_clicked</b>(<i></i>)
171 <p>
172 Private slot to add a language to the list of acceptable languages.
173 </p><a NAME="HelpLanguagesDialog.on_downButton_clicked" ID="HelpLanguagesDialog.on_downButton_clicked"></a>
174 <h4>HelpLanguagesDialog.on_downButton_clicked</h4>
175 <b>on_downButton_clicked</b>(<i></i>)
176 <p>
177 Private slot to move a language down.
178 </p><a NAME="HelpLanguagesDialog.on_removeButton_clicked" ID="HelpLanguagesDialog.on_removeButton_clicked"></a>
179 <h4>HelpLanguagesDialog.on_removeButton_clicked</h4>
180 <b>on_removeButton_clicked</b>(<i></i>)
181 <p>
182 Private slot to remove a language from the list of acceptable
183 languages.
184 </p><a NAME="HelpLanguagesDialog.on_upButton_clicked" ID="HelpLanguagesDialog.on_upButton_clicked"></a>
185 <h4>HelpLanguagesDialog.on_upButton_clicked</h4>
186 <b>on_upButton_clicked</b>(<i></i>)
187 <p>
188 Private slot to move a language up.
189 </p>
190 <div align="right"><a href="#top">Up</a></div>
191 <hr />
192 </body></html>

eric ide

mercurial