Documentation/Source/eric5.Helpviewer.HelpLanguagesDialog.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Helpviewer.HelpLanguagesDialog</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Helpviewer.HelpLanguagesDialog</h1>
<p>
Module implementing a dialog to configure the preferred languages.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HelpLanguagesDialog">HelpLanguagesDialog</a></td>
<td>Class implementing a dialog to configure the preferred languages.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="HelpLanguagesDialog" ID="HelpLanguagesDialog"></a>
<h2>HelpLanguagesDialog</h2>
<p>
    Class implementing a dialog to configure the preferred languages.
</p>
<h3>Derived from</h3>
QDialog, Ui_HelpLanguagesDialog
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr>
<td><a href="#HelpLanguagesDialog.defaultAcceptLanguages">defaultAcceptLanguages</a></td>
<td>Class method to get the list of default accept languages.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.expand">expand</a></td>
<td>Class method to expand a language enum to a readable languages list.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.httpString">httpString</a></td>
<td>Class method to convert a list of acceptable languages into a byte array that can be sent along with the Accept-Language http header (see RFC 2616).</td>
</tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#HelpLanguagesDialog.__currentChanged">__currentChanged</a></td>
<td>Private slot to handle a change of the current selection.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.accept">accept</a></td>
<td>Public method to accept the data entered.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add a language to the list of acceptable languages.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.on_downButton_clicked">on_downButton_clicked</a></td>
<td>Private slot to move a language down.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
<td>Private slot to remove a language from the list of acceptable languages.</td>
</tr><tr>
<td><a href="#HelpLanguagesDialog.on_upButton_clicked">on_upButton_clicked</a></td>
<td>Private slot to move a language up.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HelpLanguagesDialog.defaultAcceptLanguages" ID="HelpLanguagesDialog.defaultAcceptLanguages"></a>
<h4>HelpLanguagesDialog.defaultAcceptLanguages (class method)</h4>
<b>defaultAcceptLanguages</b>(<i></i>)
<p>
        Class method to get the list of default accept languages.
</p><dl>
<dt>Returns:</dt>
<dd>
list of acceptable languages (list of strings)
</dd>
</dl><a NAME="HelpLanguagesDialog.expand" ID="HelpLanguagesDialog.expand"></a>
<h4>HelpLanguagesDialog.expand (class method)</h4>
<b>expand</b>(<i>language</i>)
<p>
        Class method to expand a language enum to a readable languages list.
</p><dl>
<dt><i>language</i></dt>
<dd>
language number (QLocale.Language)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of expanded language names (list of strings)
</dd>
</dl><a NAME="HelpLanguagesDialog.httpString" ID="HelpLanguagesDialog.httpString"></a>
<h4>HelpLanguagesDialog.httpString (class method)</h4>
<b>httpString</b>(<i>languages</i>)
<p>
        Class method to convert a list of acceptable languages into a byte array that
        can be sent along with the Accept-Language http header (see RFC 2616).
</p><dl>
<dt><i>languages</i></dt>
<dd>
list of acceptable languages (list of strings)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
converted list (QByteArray)
</dd>
</dl><a NAME="HelpLanguagesDialog.__init__" ID="HelpLanguagesDialog.__init__"></a>
<h4>HelpLanguagesDialog (Constructor)</h4>
<b>HelpLanguagesDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="HelpLanguagesDialog.__currentChanged" ID="HelpLanguagesDialog.__currentChanged"></a>
<h4>HelpLanguagesDialog.__currentChanged</h4>
<b>__currentChanged</b>(<i>current, previous</i>)
<p>
        Private slot to handle a change of the current selection.
</p><dl>
<dt><i>current</i></dt>
<dd>
index of the currently selected item (QModelIndex)
</dd><dt><i>previous</i></dt>
<dd>
index of the previously selected item (QModelIndex)
</dd>
</dl><a NAME="HelpLanguagesDialog.accept" ID="HelpLanguagesDialog.accept"></a>
<h4>HelpLanguagesDialog.accept</h4>
<b>accept</b>(<i></i>)
<p>
        Public method to accept the data entered.
</p><a NAME="HelpLanguagesDialog.on_addButton_clicked" ID="HelpLanguagesDialog.on_addButton_clicked"></a>
<h4>HelpLanguagesDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)
<p>
        Private slot to add a language to the list of acceptable languages.
</p><a NAME="HelpLanguagesDialog.on_downButton_clicked" ID="HelpLanguagesDialog.on_downButton_clicked"></a>
<h4>HelpLanguagesDialog.on_downButton_clicked</h4>
<b>on_downButton_clicked</b>(<i></i>)
<p>
        Private slot to move a language down.
</p><a NAME="HelpLanguagesDialog.on_removeButton_clicked" ID="HelpLanguagesDialog.on_removeButton_clicked"></a>
<h4>HelpLanguagesDialog.on_removeButton_clicked</h4>
<b>on_removeButton_clicked</b>(<i></i>)
<p>
        Private slot to remove a language from the list of acceptable languages.
</p><a NAME="HelpLanguagesDialog.on_upButton_clicked" ID="HelpLanguagesDialog.on_upButton_clicked"></a>
<h4>HelpLanguagesDialog.on_upButton_clicked</h4>
<b>on_upButton_clicked</b>(<i></i>)
<p>
        Private slot to move a language up.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>