diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksMenu.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksMenu.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,211 @@ +<?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.Bookmarks.BookmarksMenu</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Helpviewer.Bookmarks.BookmarksMenu</h1> +<p> +Module implementing the bookmarks menu. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#BookmarksMenu">BookmarksMenu</a></td> +<td>Class implementing the bookmarks menu base class.</td> +</tr><tr> +<td><a href="#BookmarksMenuBarMenu">BookmarksMenuBarMenu</a></td> +<td>Class implementing a dynamically populated menu for bookmarks.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="BookmarksMenu" ID="BookmarksMenu"></a> +<h2>BookmarksMenu</h2> +<p> + Class implementing the bookmarks menu base class. +</p><h4>Signals</h4> +<dl> +<dt>newUrl(const QUrl&, const QString&)</dt> +<dd> +emitted to open a URL in a new tab +</dd><dt>openUrl(const QUrl&, const QString&)</dt> +<dd> +emitted to open a URL in the current + tab +</dd> +</dl> +<h3>Derived from</h3> +E4ModelMenu +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#BookmarksMenu.__init__">BookmarksMenu</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#BookmarksMenu.__activated">__activated</a></td> +<td>Private slot handling the activated signal.</td> +</tr><tr> +<td><a href="#BookmarksMenu.__contextMenuRequested">__contextMenuRequested</a></td> +<td>Private slot to handle the context menu request.</td> +</tr><tr> +<td><a href="#BookmarksMenu.__openAll">__openAll</a></td> +<td>Private slot to open all the menu's items.</td> +</tr><tr> +<td><a href="#BookmarksMenu.__openBookmark">__openBookmark</a></td> +<td>Private slot to open a bookmark in the current browser tab.</td> +</tr><tr> +<td><a href="#BookmarksMenu.__openBookmarkInNewTab">__openBookmarkInNewTab</a></td> +<td>Private slot to open a bookmark in a new browser tab.</td> +</tr><tr> +<td><a href="#BookmarksMenu.__removeBookmark">__removeBookmark</a></td> +<td>Private slot to remove a bookmark.</td> +</tr><tr> +<td><a href="#BookmarksMenu.createBaseMenu">createBaseMenu</a></td> +<td>Public method to get the menu that is used to populate sub menu's.</td> +</tr><tr> +<td><a href="#BookmarksMenu.postPopulated">postPopulated</a></td> +<td>Public method to add any actions after the tree.</td> +</tr> +</table> +<a NAME="BookmarksMenu.__init__" ID="BookmarksMenu.__init__"></a> +<h4>BookmarksMenu (Constructor)</h4> +<b>BookmarksMenu</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="BookmarksMenu.__activated" ID="BookmarksMenu.__activated"></a> +<h4>BookmarksMenu.__activated</h4> +<b>__activated</b>(<i>idx</i>) +<p> + Private slot handling the activated signal. +</p><dl> +<dt><i>idx</i></dt> +<dd> +index of the activated item (QModelIndex) +</dd> +</dl><a NAME="BookmarksMenu.__contextMenuRequested" ID="BookmarksMenu.__contextMenuRequested"></a> +<h4>BookmarksMenu.__contextMenuRequested</h4> +<b>__contextMenuRequested</b>(<i>pos</i>) +<p> + Private slot to handle the context menu request. +</p><dl> +<dt><i>pos</i></dt> +<dd> +position the context menu shall be shown (QPoint) +</dd> +</dl><a NAME="BookmarksMenu.__openAll" ID="BookmarksMenu.__openAll"></a> +<h4>BookmarksMenu.__openAll</h4> +<b>__openAll</b>(<i></i>) +<p> + Private slot to open all the menu's items. +</p><a NAME="BookmarksMenu.__openBookmark" ID="BookmarksMenu.__openBookmark"></a> +<h4>BookmarksMenu.__openBookmark</h4> +<b>__openBookmark</b>(<i></i>) +<p> + Private slot to open a bookmark in the current browser tab. +</p><a NAME="BookmarksMenu.__openBookmarkInNewTab" ID="BookmarksMenu.__openBookmarkInNewTab"></a> +<h4>BookmarksMenu.__openBookmarkInNewTab</h4> +<b>__openBookmarkInNewTab</b>(<i></i>) +<p> + Private slot to open a bookmark in a new browser tab. +</p><a NAME="BookmarksMenu.__removeBookmark" ID="BookmarksMenu.__removeBookmark"></a> +<h4>BookmarksMenu.__removeBookmark</h4> +<b>__removeBookmark</b>(<i></i>) +<p> + Private slot to remove a bookmark. +</p><a NAME="BookmarksMenu.createBaseMenu" ID="BookmarksMenu.createBaseMenu"></a> +<h4>BookmarksMenu.createBaseMenu</h4> +<b>createBaseMenu</b>(<i></i>) +<p> + Public method to get the menu that is used to populate sub menu's. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the menu (BookmarksMenu) +</dd> +</dl><a NAME="BookmarksMenu.postPopulated" ID="BookmarksMenu.postPopulated"></a> +<h4>BookmarksMenu.postPopulated</h4> +<b>postPopulated</b>(<i></i>) +<p> + Public method to add any actions after the tree. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="BookmarksMenuBarMenu" ID="BookmarksMenuBarMenu"></a> +<h2>BookmarksMenuBarMenu</h2> +<p> + Class implementing a dynamically populated menu for bookmarks. +</p> +<h3>Derived from</h3> +BookmarksMenu +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#BookmarksMenuBarMenu.__init__">BookmarksMenuBarMenu</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#BookmarksMenuBarMenu.prePopulated">prePopulated</a></td> +<td>Public method to add any actions before the tree.</td> +</tr><tr> +<td><a href="#BookmarksMenuBarMenu.setInitialActions">setInitialActions</a></td> +<td>Public method to set the list of actions that should appear first in the menu.</td> +</tr> +</table> +<a NAME="BookmarksMenuBarMenu.__init__" ID="BookmarksMenuBarMenu.__init__"></a> +<h4>BookmarksMenuBarMenu (Constructor)</h4> +<b>BookmarksMenuBarMenu</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="BookmarksMenuBarMenu.prePopulated" ID="BookmarksMenuBarMenu.prePopulated"></a> +<h4>BookmarksMenuBarMenu.prePopulated</h4> +<b>prePopulated</b>(<i></i>) +<p> + Public method to add any actions before the tree. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating if any actions were added (boolean) +</dd> +</dl><a NAME="BookmarksMenuBarMenu.setInitialActions" ID="BookmarksMenuBarMenu.setInitialActions"></a> +<h4>BookmarksMenuBarMenu.setInitialActions</h4> +<b>setInitialActions</b>(<i>actions</i>) +<p> + Public method to set the list of actions that should appear first in the menu. +</p><dl> +<dt><i>actions</i></dt> +<dd> +list of initial actions (list of QAction) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file