diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,164 @@ +<?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.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog</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.Plugins.VcsPlugins.vcsSubversion.SvnCommitDialog</h1> +<p> +Module implementing a dialog to enter the commit message. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SvnCommitDialog">SvnCommitDialog</a></td> +<td>Class implementing a dialog to enter the commit message.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SvnCommitDialog" ID="SvnCommitDialog"></a> +<h2>SvnCommitDialog</h2> +<p> + Class implementing a dialog to enter the commit message. +</p><h4>Signals</h4> +<dl> +<dt>accepted()</dt> +<dd> +emitted, if the dialog was accepted +</dd><dt>rejected()</dt> +<dd> +emitted, if the dialog was rejected +</dd> +</dl> +<h3>Derived from</h3> +QWidget, Ui_SvnCommitDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#SvnCommitDialog.__init__">SvnCommitDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SvnCommitDialog.changelistsData">changelistsData</a></td> +<td>Public method to retrieve the changelists data.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.hasChangelists">hasChangelists</a></td> +<td>Public method to check, if the user entered some changelists.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.logMessage">logMessage</a></td> +<td>Public method to retrieve the log message.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td> +<td>Private slot called by the buttonBox accepted signal.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td> +<td>Private slot called by the buttonBox rejected signal.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.on_recentComboBox_activated">on_recentComboBox_activated</a></td> +<td>Private slot to select a commit message from recent ones.</td> +</tr><tr> +<td><a href="#SvnCommitDialog.showEvent">showEvent</a></td> +<td>Public method called when the dialog is about to be shown.</td> +</tr> +</table> +<a NAME="SvnCommitDialog.__init__" ID="SvnCommitDialog.__init__"></a> +<h4>SvnCommitDialog (Constructor)</h4> +<b>SvnCommitDialog</b>(<i>vcs, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>vcs</i></dt> +<dd> +reference to the vcs object +</dd><dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl><a NAME="SvnCommitDialog.changelistsData" ID="SvnCommitDialog.changelistsData"></a> +<h4>SvnCommitDialog.changelistsData</h4> +<b>changelistsData</b>(<i></i>) +<p> + Public method to retrieve the changelists data. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple containing the changelists (QStringList) and a flag + indicating to keep changelists (boolean) +</dd> +</dl><a NAME="SvnCommitDialog.hasChangelists" ID="SvnCommitDialog.hasChangelists"></a> +<h4>SvnCommitDialog.hasChangelists</h4> +<b>hasChangelists</b>(<i></i>) +<p> + Public method to check, if the user entered some changelists. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating availability of changelists (boolean) +</dd> +</dl><a NAME="SvnCommitDialog.logMessage" ID="SvnCommitDialog.logMessage"></a> +<h4>SvnCommitDialog.logMessage</h4> +<b>logMessage</b>(<i></i>) +<p> + Public method to retrieve the log message. +</p><dl> +<dt>Returns:</dt> +<dd> +the log message (QString) +</dd> +</dl><a NAME="SvnCommitDialog.on_buttonBox_accepted" ID="SvnCommitDialog.on_buttonBox_accepted"></a> +<h4>SvnCommitDialog.on_buttonBox_accepted</h4> +<b>on_buttonBox_accepted</b>(<i></i>) +<p> + Private slot called by the buttonBox accepted signal. +</p><a NAME="SvnCommitDialog.on_buttonBox_clicked" ID="SvnCommitDialog.on_buttonBox_clicked"></a> +<h4>SvnCommitDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="SvnCommitDialog.on_buttonBox_rejected" ID="SvnCommitDialog.on_buttonBox_rejected"></a> +<h4>SvnCommitDialog.on_buttonBox_rejected</h4> +<b>on_buttonBox_rejected</b>(<i></i>) +<p> + Private slot called by the buttonBox rejected signal. +</p><a NAME="SvnCommitDialog.on_recentComboBox_activated" ID="SvnCommitDialog.on_recentComboBox_activated"></a> +<h4>SvnCommitDialog.on_recentComboBox_activated</h4> +<b>on_recentComboBox_activated</b>(<i>txt</i>) +<p> + Private slot to select a commit message from recent ones. +</p><a NAME="SvnCommitDialog.showEvent" ID="SvnCommitDialog.showEvent"></a> +<h4>SvnCommitDialog.showEvent</h4> +<b>showEvent</b>(<i>evt</i>) +<p> + Public method called when the dialog is about to be shown. +</p><dl> +<dt><i>evt</i></dt> +<dd> +the event (QShowEvent) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file