--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.ViewManager.BookmarkedFilesDialog.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,168 @@ +<?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.ViewManager.BookmarkedFilesDialog</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.ViewManager.BookmarkedFilesDialog</h1> +<p> +Module implementing a configuration dialog for the bookmarked files menu. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#BookmarkedFilesDialog">BookmarkedFilesDialog</a></td> +<td>Class implementing a configuration dialog for the bookmarked files menu.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="BookmarkedFilesDialog" ID="BookmarkedFilesDialog"></a> +<h2>BookmarkedFilesDialog</h2> +<p> + Class implementing a configuration dialog for the bookmarked files menu. +</p> +<h3>Derived from</h3> +QDialog, Ui_BookmarkedFilesDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#BookmarkedFilesDialog.__init__">BookmarkedFilesDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.__swap">__swap</a></td> +<td>Private method used two swap two list entries given by their index.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.getBookmarkedFiles">getBookmarkedFiles</a></td> +<td>Public method to retrieve the tools list.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_addButton_clicked">on_addButton_clicked</a></td> +<td>Private slot to add a new entry.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_changeButton_clicked">on_changeButton_clicked</a></td> +<td>Private slot to change an entry.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> +<td>Private slot to delete the selected entry.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_downButton_clicked">on_downButton_clicked</a></td> +<td>Private slot to move an entry down in the list.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_fileButton_clicked">on_fileButton_clicked</a></td> +<td>Private slot to handle the file selection via a file selection dialog.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_fileEdit_textChanged">on_fileEdit_textChanged</a></td> +<td>Private slot to handle the textChanged signal of the file edit.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_filesList_currentRowChanged">on_filesList_currentRowChanged</a></td> +<td>Private slot to set the lineedit depending on the selected entry.</td> +</tr><tr> +<td><a href="#BookmarkedFilesDialog.on_upButton_clicked">on_upButton_clicked</a></td> +<td>Private slot to move an entry up in the list.</td> +</tr> +</table> +<a NAME="BookmarkedFilesDialog.__init__" ID="BookmarkedFilesDialog.__init__"></a> +<h4>BookmarkedFilesDialog (Constructor)</h4> +<b>BookmarkedFilesDialog</b>(<i>bookmarks, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>bookmarks</i></dt> +<dd> +list of bookmarked files (list of strings) +</dd><dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl><a NAME="BookmarkedFilesDialog.__swap" ID="BookmarkedFilesDialog.__swap"></a> +<h4>BookmarkedFilesDialog.__swap</h4> +<b>__swap</b>(<i>itm1, itm2</i>) +<p> + Private method used two swap two list entries given by their index. +</p><dl> +<dt><i>itm1</i></dt> +<dd> +index of first entry (int) +</dd><dt><i>itm2</i></dt> +<dd> +index of second entry (int) +</dd> +</dl><a NAME="BookmarkedFilesDialog.getBookmarkedFiles" ID="BookmarkedFilesDialog.getBookmarkedFiles"></a> +<h4>BookmarkedFilesDialog.getBookmarkedFiles</h4> +<b>getBookmarkedFiles</b>(<i></i>) +<p> + Public method to retrieve the tools list. +</p><dl> +<dt>Returns:</dt> +<dd> +a list of filenames (list of strings) +</dd> +</dl><a NAME="BookmarkedFilesDialog.on_addButton_clicked" ID="BookmarkedFilesDialog.on_addButton_clicked"></a> +<h4>BookmarkedFilesDialog.on_addButton_clicked</h4> +<b>on_addButton_clicked</b>(<i></i>) +<p> + Private slot to add a new entry. +</p><a NAME="BookmarkedFilesDialog.on_changeButton_clicked" ID="BookmarkedFilesDialog.on_changeButton_clicked"></a> +<h4>BookmarkedFilesDialog.on_changeButton_clicked</h4> +<b>on_changeButton_clicked</b>(<i></i>) +<p> + Private slot to change an entry. +</p><a NAME="BookmarkedFilesDialog.on_deleteButton_clicked" ID="BookmarkedFilesDialog.on_deleteButton_clicked"></a> +<h4>BookmarkedFilesDialog.on_deleteButton_clicked</h4> +<b>on_deleteButton_clicked</b>(<i></i>) +<p> + Private slot to delete the selected entry. +</p><a NAME="BookmarkedFilesDialog.on_downButton_clicked" ID="BookmarkedFilesDialog.on_downButton_clicked"></a> +<h4>BookmarkedFilesDialog.on_downButton_clicked</h4> +<b>on_downButton_clicked</b>(<i></i>) +<p> + Private slot to move an entry down in the list. +</p><a NAME="BookmarkedFilesDialog.on_fileButton_clicked" ID="BookmarkedFilesDialog.on_fileButton_clicked"></a> +<h4>BookmarkedFilesDialog.on_fileButton_clicked</h4> +<b>on_fileButton_clicked</b>(<i></i>) +<p> + Private slot to handle the file selection via a file selection dialog. +</p><a NAME="BookmarkedFilesDialog.on_fileEdit_textChanged" ID="BookmarkedFilesDialog.on_fileEdit_textChanged"></a> +<h4>BookmarkedFilesDialog.on_fileEdit_textChanged</h4> +<b>on_fileEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle the textChanged signal of the file edit. +</p><dl> +<dt><i>txt</i></dt> +<dd> +the text of the file edit (string) +</dd> +</dl><a NAME="BookmarkedFilesDialog.on_filesList_currentRowChanged" ID="BookmarkedFilesDialog.on_filesList_currentRowChanged"></a> +<h4>BookmarkedFilesDialog.on_filesList_currentRowChanged</h4> +<b>on_filesList_currentRowChanged</b>(<i>row</i>) +<p> + Private slot to set the lineedit depending on the selected entry. +</p><dl> +<dt><i>row</i></dt> +<dd> +the current row (integer) +</dd> +</dl><a NAME="BookmarkedFilesDialog.on_upButton_clicked" ID="BookmarkedFilesDialog.on_upButton_clicked"></a> +<h4>BookmarkedFilesDialog.on_upButton_clicked</h4> +<b>on_upButton_clicked</b>(<i></i>) +<p> + Private slot to move an entry up in the list. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file