eric6/Documentation/Source/eric6.QScintilla.EditorButtonsWidget.html

<!DOCTYPE html>
<html><head>
<title>eric6.QScintilla.EditorButtonsWidget</title>
<meta charset="UTF-8">
<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>eric6.QScintilla.EditorButtonsWidget</h1>

<p>
Module implementing a widget containing various buttons for accessing
editor actions.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EditorButtonsWidget">EditorButtonsWidget</a></td>
<td>Class implementing a widget containing various buttons for accessing editor actions.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EditorButtonsWidget" ID="EditorButtonsWidget"></a>
<h2>EditorButtonsWidget</h2>

<p>
    Class implementing a widget containing various buttons for accessing
    editor actions.
</p>
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#EditorButtonsWidget.__init__">EditorButtonsWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__addButton">__addButton</a></td>
<td>Private method to add a format button.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__addSeparator">__addSeparator</a></td>
<td>Private method to add a separator line.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__createButtons">__createButtons</a></td>
<td>Private slot to create the various tool buttons.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__editorSelectionChanged">__editorSelectionChanged</a></td>
<td>Private slot to handle a change of the editor's selection.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__editorSettingsRead">__editorSettingsRead</a></td>
<td>Private slot to handle a change of the editor related settings.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__enableScrollerButtons">__enableScrollerButtons</a></td>
<td>Private method to set the enabled state of the scroll buttons.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__formatClicked">__formatClicked</a></td>
<td>Private slot to handle a format button being clicked.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__headerMenuTriggered">__headerMenuTriggered</a></td>
<td>Private method handling the selection of a header menu entry.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__slide">__slide</a></td>
<td>Private method to move the sliding widget.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__slideDown">__slideDown</a></td>
<td>Private slot to move the widget downwards, i.e.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__slideUp">__slideUp</a></td>
<td>Private slot to move the widget upwards, i.e.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.__updateButtonStates">__updateButtonStates</a></td>
<td>Private slot to change the button states.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.resizeEvent">resizeEvent</a></td>
<td>Protected method to handle resize events.</td>
</tr>
<tr>
<td><a href="#EditorButtonsWidget.show">show</a></td>
<td>Public slot to show the widget.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EditorButtonsWidget.__init__" ID="EditorButtonsWidget.__init__"></a>
<h4>EditorButtonsWidget (Constructor)</h4>
<b>EditorButtonsWidget</b>(<i>editor, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="EditorButtonsWidget.__addButton" ID="EditorButtonsWidget.__addButton"></a>
<h4>EditorButtonsWidget.__addButton</h4>
<b>__addButton</b>(<i>formatName, iconName, toolTip</i>)

<p>
        Private method to add a format button.
</p>
<dl>

<dt><i>formatName</i> (str)</dt>
<dd>
unique name of the format
</dd>
<dt><i>iconName</i> (str)</dt>
<dd>
name of the icon for the button
</dd>
<dt><i>toolTip</i> (str)</dt>
<dd>
text for the tool tip
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
generated button
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QToolButton
</dd>
</dl>
<a NAME="EditorButtonsWidget.__addSeparator" ID="EditorButtonsWidget.__addSeparator"></a>
<h4>EditorButtonsWidget.__addSeparator</h4>
<b>__addSeparator</b>(<i></i>)

<p>
        Private method to add a separator line.
</p>
<a NAME="EditorButtonsWidget.__createButtons" ID="EditorButtonsWidget.__createButtons"></a>
<h4>EditorButtonsWidget.__createButtons</h4>
<b>__createButtons</b>(<i></i>)

<p>
        Private slot to create the various tool buttons.
</p>
<a NAME="EditorButtonsWidget.__editorSelectionChanged" ID="EditorButtonsWidget.__editorSelectionChanged"></a>
<h4>EditorButtonsWidget.__editorSelectionChanged</h4>
<b>__editorSelectionChanged</b>(<i></i>)

<p>
        Private slot to handle a change of the editor's selection.
</p>
<a NAME="EditorButtonsWidget.__editorSettingsRead" ID="EditorButtonsWidget.__editorSettingsRead"></a>
<h4>EditorButtonsWidget.__editorSettingsRead</h4>
<b>__editorSettingsRead</b>(<i></i>)

<p>
        Private slot to handle a change of the editor related settings.
</p>
<a NAME="EditorButtonsWidget.__enableScrollerButtons" ID="EditorButtonsWidget.__enableScrollerButtons"></a>
<h4>EditorButtonsWidget.__enableScrollerButtons</h4>
<b>__enableScrollerButtons</b>(<i></i>)

<p>
        Private method to set the enabled state of the scroll buttons.
</p>
<a NAME="EditorButtonsWidget.__formatClicked" ID="EditorButtonsWidget.__formatClicked"></a>
<h4>EditorButtonsWidget.__formatClicked</h4>
<b>__formatClicked</b>(<i>formatName</i>)

<p>
        Private slot to handle a format button being clicked.
</p>
<dl>

<dt><i>formatName</i> (str)</dt>
<dd>
format type of the button
</dd>
</dl>
<a NAME="EditorButtonsWidget.__headerMenuTriggered" ID="EditorButtonsWidget.__headerMenuTriggered"></a>
<h4>EditorButtonsWidget.__headerMenuTriggered</h4>
<b>__headerMenuTriggered</b>(<i>act</i>)

<p>
        Private method handling the selection of a header menu entry.
</p>
<dl>

<dt><i>act</i> (QAction)</dt>
<dd>
action of the headers menu that was triggered
</dd>
</dl>
<a NAME="EditorButtonsWidget.__slide" ID="EditorButtonsWidget.__slide"></a>
<h4>EditorButtonsWidget.__slide</h4>
<b>__slide</b>(<i>up</i>)

<p>
        Private method to move the sliding widget.
</p>
<dl>

<dt><i>up</i></dt>
<dd>
flag indicating to move upwards (boolean)
</dd>
</dl>
<a NAME="EditorButtonsWidget.__slideDown" ID="EditorButtonsWidget.__slideDown"></a>
<h4>EditorButtonsWidget.__slideDown</h4>
<b>__slideDown</b>(<i></i>)

<p>
        Private slot to move the widget downwards, i.e. show contents to
        the top.
</p>
<a NAME="EditorButtonsWidget.__slideUp" ID="EditorButtonsWidget.__slideUp"></a>
<h4>EditorButtonsWidget.__slideUp</h4>
<b>__slideUp</b>(<i></i>)

<p>
        Private slot to move the widget upwards, i.e. show contents to the
        bottom.
</p>
<a NAME="EditorButtonsWidget.__updateButtonStates" ID="EditorButtonsWidget.__updateButtonStates"></a>
<h4>EditorButtonsWidget.__updateButtonStates</h4>
<b>__updateButtonStates</b>(<i></i>)

<p>
        Private slot to change the button states.
</p>
<a NAME="EditorButtonsWidget.resizeEvent" ID="EditorButtonsWidget.resizeEvent"></a>
<h4>EditorButtonsWidget.resizeEvent</h4>
<b>resizeEvent</b>(<i>evt</i>)

<p>
        Protected method to handle resize events.
</p>
<dl>

<dt><i>evt</i></dt>
<dd>
reference to the resize event (QResizeEvent)
</dd>
</dl>
<a NAME="EditorButtonsWidget.show" ID="EditorButtonsWidget.show"></a>
<h4>EditorButtonsWidget.show</h4>
<b>show</b>(<i></i>)

<p>
        Public slot to show the widget.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>