diff -r d6062691d424 -r e0227a7c850e eric7/Documentation/Source/eric7.EricWidgets.EricFileSaveConfirmDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.EricWidgets.EricFileSaveConfirmDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,225 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricWidgets.EricFileSaveConfirmDialog</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>eric7.EricWidgets.EricFileSaveConfirmDialog</h1> + +<p> +Module implementing a dialog to enter a file system path using a file picker. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#EricFileSaveConfirmDialog">EricFileSaveConfirmDialog</a></td> +<td>Class implementing a dialog to enter a file system path using a file picker.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#confirmOverwrite">confirmOverwrite</a></td> +<td>Function to confirm that a file shall be overwritten.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="EricFileSaveConfirmDialog" ID="EricFileSaveConfirmDialog"></a> +<h2>EricFileSaveConfirmDialog</h2> + +<p> + Class implementing a dialog to enter a file system path using a file + picker. +</p> +<h3>Derived from</h3> +QDialog +<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="#EricFileSaveConfirmDialog.__init__">EricFileSaveConfirmDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricFileSaveConfirmDialog.__buttonBoxClicked">__buttonBoxClicked</a></td> +<td>Private slot to handle the user clicking a button.</td> +</tr> +<tr> +<td><a href="#EricFileSaveConfirmDialog.__filenameChanged">__filenameChanged</a></td> +<td>Private slot to handle a change of the file name.</td> +</tr> +<tr> +<td><a href="#EricFileSaveConfirmDialog.selectedAction">selectedAction</a></td> +<td>Public method to get the selected action and associated data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="EricFileSaveConfirmDialog.__init__" ID="EricFileSaveConfirmDialog.__init__"></a> +<h4>EricFileSaveConfirmDialog (Constructor)</h4> +<b>EricFileSaveConfirmDialog</b>(<i>filename, title, message="", picker=True, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +file name to be shown +</dd> +<dt><i>title</i> (str)</dt> +<dd> +title for the dialog +</dd> +<dt><i>message</i> (str)</dt> +<dd> +message to be shown +</dd> +<dt><i>picker</i> (bool)</dt> +<dd> +flag indicating to use a path picker +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="EricFileSaveConfirmDialog.__buttonBoxClicked" ID="EricFileSaveConfirmDialog.__buttonBoxClicked"></a> +<h4>EricFileSaveConfirmDialog.__buttonBoxClicked</h4> +<b>__buttonBoxClicked</b>(<i>button</i>) + +<p> + Private slot to handle the user clicking a button. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +reference to the clicked button +</dd> +</dl> +<a NAME="EricFileSaveConfirmDialog.__filenameChanged" ID="EricFileSaveConfirmDialog.__filenameChanged"></a> +<h4>EricFileSaveConfirmDialog.__filenameChanged</h4> +<b>__filenameChanged</b>(<i>text</i>) + +<p> + Private slot to handle a change of the file name. +</p> +<dl> + +<dt><i>text</i> (str)</dt> +<dd> +new file name +</dd> +</dl> +<a NAME="EricFileSaveConfirmDialog.selectedAction" ID="EricFileSaveConfirmDialog.selectedAction"></a> +<h4>EricFileSaveConfirmDialog.selectedAction</h4> +<b>selectedAction</b>(<i></i>) + +<p> + Public method to get the selected action and associated data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the selected action (cancel, rename, + overwrite) and the filename (in case of 'rename' or 'overwrite') +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="confirmOverwrite" ID="confirmOverwrite"></a> +<h2>confirmOverwrite</h2> +<b>confirmOverwrite</b>(<i>filename, title, message="", picker=True, parent=None</i>) + +<p> + Function to confirm that a file shall be overwritten. +</p> +<dl> + +<dt><i>filename</i> (str)</dt> +<dd> +file name to be shown +</dd> +<dt><i>title</i> (str)</dt> +<dd> +title for the dialog +</dd> +<dt><i>message</i> (str)</dt> +<dd> +message to be shown +</dd> +<dt><i>picker</i> (bool)</dt> +<dd> +flag indicating to use a path picker +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the selected action (cancel, rename, + overwrite) and the filename (in case of 'rename' or 'overwrite') +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file