Documentation/Source/eric6.WebBrowser.Navigation.NavigationBar.html

<!DOCTYPE html>
<html><head>
<title>eric6.WebBrowser.Navigation.NavigationBar</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.WebBrowser.Navigation.NavigationBar</h1>
<p>
Module implementing the navigation bar widget.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#NavigationBar">NavigationBar</a></td>
<td>Class implementing the navigation bar.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="NavigationBar" ID="NavigationBar"></a>
<h2>NavigationBar</h2>
<p>
    Class implementing the navigation bar.
</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="#NavigationBar.__init__">NavigationBar</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#NavigationBar.__clearHistory">__clearHistory</a></td>
<td>Private slot to clear the history of the current web browser tab.</td>
</tr><tr>
<td><a href="#NavigationBar.__contextMenuRequested">__contextMenuRequested</a></td>
<td>Private method to handle a context menu request.</td>
</tr><tr>
<td><a href="#NavigationBar.__goBack">__goBack</a></td>
<td>Private slot called to handle the backward button.</td>
</tr><tr>
<td><a href="#NavigationBar.__goBackInNewTab">__goBackInNewTab</a></td>
<td>Private slot handling a middle click or Ctrl left click of the backward button.</td>
</tr><tr>
<td><a href="#NavigationBar.__goForward">__goForward</a></td>
<td>Private slot called to handle the forward button.</td>
</tr><tr>
<td><a href="#NavigationBar.__goForwardInNewTab">__goForwardInNewTab</a></td>
<td>Private slot handling a middle click or Ctrl left click of the forward button.</td>
</tr><tr>
<td><a href="#NavigationBar.__goHome">__goHome</a></td>
<td>Private slot called to handle the home button.</td>
</tr><tr>
<td><a href="#NavigationBar.__goHomeInNewTab">__goHomeInNewTab</a></td>
<td>Private slot handling a middle click or Ctrl left click of the home button.</td>
</tr><tr>
<td><a href="#NavigationBar.__navigationMenuActionTriggered">__navigationMenuActionTriggered</a></td>
<td>Private slot to go to the selected page.</td>
</tr><tr>
<td><a href="#NavigationBar.__reload">__reload</a></td>
<td>Private slot called to handle the reload button.</td>
</tr><tr>
<td><a href="#NavigationBar.__showBackMenu">__showBackMenu</a></td>
<td>Private slot showing the backwards navigation menu.</td>
</tr><tr>
<td><a href="#NavigationBar.__showForwardMenu">__showForwardMenu</a></td>
<td>Private slot showing the forwards navigation menu.</td>
</tr><tr>
<td><a href="#NavigationBar.__stopLoad">__stopLoad</a></td>
<td>Private slot called to handle loading of the current page.</td>
</tr><tr>
<td><a href="#NavigationBar.backButton">backButton</a></td>
<td>Public method to get a reference to the back button.</td>
</tr><tr>
<td><a href="#NavigationBar.exitFullScreenButton">exitFullScreenButton</a></td>
<td>Public method to get a reference to the exit full screen button.</td>
</tr><tr>
<td><a href="#NavigationBar.forwardButton">forwardButton</a></td>
<td>Public method to get a reference to the forward button.</td>
</tr><tr>
<td><a href="#NavigationBar.reloadStopButton">reloadStopButton</a></td>
<td>Public method to get a reference to the reload/stop button.</td>
</tr><tr>
<td><a href="#NavigationBar.searchEdit">searchEdit</a></td>
<td>Public method to get a reference to the web search edit.</td>
</tr><tr>
<td><a href="#NavigationBar.superMenuButton">superMenuButton</a></td>
<td>Public method to get a reference to the super menu button.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="NavigationBar.__init__" ID="NavigationBar.__init__"></a>
<h4>NavigationBar (Constructor)</h4>
<b>NavigationBar</b>(<i>mainWindow, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>mainWindow</i> (WebBrowserWindow)</dt>
<dd>
reference to the browser main window
</dd><dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl><a NAME="NavigationBar.__clearHistory" ID="NavigationBar.__clearHistory"></a>
<h4>NavigationBar.__clearHistory</h4>
<b>__clearHistory</b>(<i></i>)
<p>
        Private slot to clear the history of the current web browser tab.
</p><a NAME="NavigationBar.__contextMenuRequested" ID="NavigationBar.__contextMenuRequested"></a>
<h4>NavigationBar.__contextMenuRequested</h4>
<b>__contextMenuRequested</b>(<i>pos</i>)
<p>
        Private method to handle a context menu request.
</p><dl>
<dt><i>pos</i> (QPoint)</dt>
<dd>
position of the request
</dd>
</dl><a NAME="NavigationBar.__goBack" ID="NavigationBar.__goBack"></a>
<h4>NavigationBar.__goBack</h4>
<b>__goBack</b>(<i></i>)
<p>
        Private slot called to handle the backward button.
</p><a NAME="NavigationBar.__goBackInNewTab" ID="NavigationBar.__goBackInNewTab"></a>
<h4>NavigationBar.__goBackInNewTab</h4>
<b>__goBackInNewTab</b>(<i></i>)
<p>
        Private slot handling a middle click or Ctrl left click of the
        backward button.
</p><a NAME="NavigationBar.__goForward" ID="NavigationBar.__goForward"></a>
<h4>NavigationBar.__goForward</h4>
<b>__goForward</b>(<i></i>)
<p>
        Private slot called to handle the forward button.
</p><a NAME="NavigationBar.__goForwardInNewTab" ID="NavigationBar.__goForwardInNewTab"></a>
<h4>NavigationBar.__goForwardInNewTab</h4>
<b>__goForwardInNewTab</b>(<i></i>)
<p>
        Private slot handling a middle click or Ctrl left click of the
        forward button.
</p><a NAME="NavigationBar.__goHome" ID="NavigationBar.__goHome"></a>
<h4>NavigationBar.__goHome</h4>
<b>__goHome</b>(<i></i>)
<p>
        Private slot called to handle the home button.
</p><a NAME="NavigationBar.__goHomeInNewTab" ID="NavigationBar.__goHomeInNewTab"></a>
<h4>NavigationBar.__goHomeInNewTab</h4>
<b>__goHomeInNewTab</b>(<i></i>)
<p>
        Private slot handling a middle click or Ctrl left click of the
        home button.
</p><a NAME="NavigationBar.__navigationMenuActionTriggered" ID="NavigationBar.__navigationMenuActionTriggered"></a>
<h4>NavigationBar.__navigationMenuActionTriggered</h4>
<b>__navigationMenuActionTriggered</b>(<i>act</i>)
<p>
        Private slot to go to the selected page.
</p><dl>
<dt><i>act</i></dt>
<dd>
reference to the action selected in the navigation menu
            (QAction)
</dd>
</dl><a NAME="NavigationBar.__reload" ID="NavigationBar.__reload"></a>
<h4>NavigationBar.__reload</h4>
<b>__reload</b>(<i></i>)
<p>
        Private slot called to handle the reload button.
</p><a NAME="NavigationBar.__showBackMenu" ID="NavigationBar.__showBackMenu"></a>
<h4>NavigationBar.__showBackMenu</h4>
<b>__showBackMenu</b>(<i></i>)
<p>
        Private slot showing the backwards navigation menu.
</p><a NAME="NavigationBar.__showForwardMenu" ID="NavigationBar.__showForwardMenu"></a>
<h4>NavigationBar.__showForwardMenu</h4>
<b>__showForwardMenu</b>(<i></i>)
<p>
        Private slot showing the forwards navigation menu.
</p><a NAME="NavigationBar.__stopLoad" ID="NavigationBar.__stopLoad"></a>
<h4>NavigationBar.__stopLoad</h4>
<b>__stopLoad</b>(<i></i>)
<p>
        Private slot called to handle loading of the current page.
</p><a NAME="NavigationBar.backButton" ID="NavigationBar.backButton"></a>
<h4>NavigationBar.backButton</h4>
<b>backButton</b>(<i></i>)
<p>
        Public method to get a reference to the back button.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the back button
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
QToolButton
</dd>
</dl><a NAME="NavigationBar.exitFullScreenButton" ID="NavigationBar.exitFullScreenButton"></a>
<h4>NavigationBar.exitFullScreenButton</h4>
<b>exitFullScreenButton</b>(<i></i>)
<p>
        Public method to get a reference to the exit full screen button.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the exit full screen button
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
QToolButton
</dd>
</dl><a NAME="NavigationBar.forwardButton" ID="NavigationBar.forwardButton"></a>
<h4>NavigationBar.forwardButton</h4>
<b>forwardButton</b>(<i></i>)
<p>
        Public method to get a reference to the forward button.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the forward button
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
QToolButton
</dd>
</dl><a NAME="NavigationBar.reloadStopButton" ID="NavigationBar.reloadStopButton"></a>
<h4>NavigationBar.reloadStopButton</h4>
<b>reloadStopButton</b>(<i></i>)
<p>
        Public method to get a reference to the reload/stop button.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the reload/stop button
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
QToolButton
</dd>
</dl><a NAME="NavigationBar.searchEdit" ID="NavigationBar.searchEdit"></a>
<h4>NavigationBar.searchEdit</h4>
<b>searchEdit</b>(<i></i>)
<p>
        Public method to get a reference to the web search edit.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the web search edit
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
WebBrowserWebSearchWidget
</dd>
</dl><a NAME="NavigationBar.superMenuButton" ID="NavigationBar.superMenuButton"></a>
<h4>NavigationBar.superMenuButton</h4>
<b>superMenuButton</b>(<i></i>)
<p>
        Public method to get a reference to the super menu button.
</p><dl>
<dt>Returns:</dt>
<dd>
reference to the super menu button
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
QToolButton
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>