diff -r b26df0282953 -r b712f76dbf9e SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserPage.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserPage.html Mon Apr 21 16:11:49 2014 +0200 @@ -0,0 +1,153 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserPage</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>Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserPage</h1> +<p> +Module implementing Selection Encloser configuration page. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SelectionEncloserPage">SelectionEncloserPage</a></td> +<td>Class implementing Selection Encloser configuration page.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SelectionEncloserPage" ID="SelectionEncloserPage"></a> +<h2>SelectionEncloserPage</h2> +<p> + Class implementing Selection Encloser configuration page. +</p> +<h3>Derived from</h3> +ConfigurationPageBase, Ui_SelectionEncloserPage +<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="#SelectionEncloserPage.__init__">SelectionEncloserPage</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.__moveSelectedEntry">__moveSelectedEntry</a></td> +<td>Private method to move the selected entry up or down.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_addButton_clicked">on_addButton_clicked</a></td> +<td>Private slot to add a menu entry.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_addMenuButton_clicked">on_addMenuButton_clicked</a></td> +<td>Private slot to add a top level menu item.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_deleteButton_clicked">on_deleteButton_clicked</a></td> +<td>Private slot to delete the selected entry.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_downButton_clicked">on_downButton_clicked</a></td> +<td>Private slot to move an entry down.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_editButton_clicked">on_editButton_clicked</a></td> +<td>Slot documentation goes here.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_menuTree_itemSelectionChanged">on_menuTree_itemSelectionChanged</a></td> +<td>Private slot handling the selection of an item.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.on_upButton_clicked">on_upButton_clicked</a></td> +<td>Private slot to move an entry up.</td> +</tr><tr> +<td><a href="#SelectionEncloserPage.save">save</a></td> +<td>Public slot to save the Selection Encloser configuration.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="SelectionEncloserPage.__init__" ID="SelectionEncloserPage.__init__"></a> +<h4>SelectionEncloserPage (Constructor)</h4> +<b>SelectionEncloserPage</b>(<i>plugin</i>) +<p> + Constructor +</p><dl> +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd> +</dl><a NAME="SelectionEncloserPage.__moveSelectedEntry" ID="SelectionEncloserPage.__moveSelectedEntry"></a> +<h4>SelectionEncloserPage.__moveSelectedEntry</h4> +<b>__moveSelectedEntry</b>(<i>moveUp</i>) +<p> + Private method to move the selected entry up or down. +</p><a NAME="SelectionEncloserPage.on_addButton_clicked" ID="SelectionEncloserPage.on_addButton_clicked"></a> +<h4>SelectionEncloserPage.on_addButton_clicked</h4> +<b>on_addButton_clicked</b>(<i></i>) +<p> + Private slot to add a menu entry. +</p><a NAME="SelectionEncloserPage.on_addMenuButton_clicked" ID="SelectionEncloserPage.on_addMenuButton_clicked"></a> +<h4>SelectionEncloserPage.on_addMenuButton_clicked</h4> +<b>on_addMenuButton_clicked</b>(<i></i>) +<p> + Private slot to add a top level menu item. +</p><a NAME="SelectionEncloserPage.on_deleteButton_clicked" ID="SelectionEncloserPage.on_deleteButton_clicked"></a> +<h4>SelectionEncloserPage.on_deleteButton_clicked</h4> +<b>on_deleteButton_clicked</b>(<i></i>) +<p> + Private slot to delete the selected entry. +</p><a NAME="SelectionEncloserPage.on_downButton_clicked" ID="SelectionEncloserPage.on_downButton_clicked"></a> +<h4>SelectionEncloserPage.on_downButton_clicked</h4> +<b>on_downButton_clicked</b>(<i></i>) +<p> + Private slot to move an entry down. +</p><a NAME="SelectionEncloserPage.on_editButton_clicked" ID="SelectionEncloserPage.on_editButton_clicked"></a> +<h4>SelectionEncloserPage.on_editButton_clicked</h4> +<b>on_editButton_clicked</b>(<i></i>) +<p> + Slot documentation goes here. +</p><a NAME="SelectionEncloserPage.on_menuTree_itemSelectionChanged" ID="SelectionEncloserPage.on_menuTree_itemSelectionChanged"></a> +<h4>SelectionEncloserPage.on_menuTree_itemSelectionChanged</h4> +<b>on_menuTree_itemSelectionChanged</b>(<i></i>) +<p> + Private slot handling the selection of an item. +</p><a NAME="SelectionEncloserPage.on_upButton_clicked" ID="SelectionEncloserPage.on_upButton_clicked"></a> +<h4>SelectionEncloserPage.on_upButton_clicked</h4> +<b>on_upButton_clicked</b>(<i></i>) +<p> + Private slot to move an entry up. +</p><a NAME="SelectionEncloserPage.save" ID="SelectionEncloserPage.save"></a> +<h4>SelectionEncloserPage.save</h4> +<b>save</b>(<i></i>) +<p> + Public slot to save the Selection Encloser configuration. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file