Documentation/Source/eric6.ViewManager.ViewManager.html

changeset 6209
05b9989c1977
parent 6123
39cd368143db
child 6934
eae7d1d9cc7b
--- a/Documentation/Source/eric6.ViewManager.ViewManager.html	Mon Apr 02 13:26:53 2018 +0200
+++ b/Documentation/Source/eric6.ViewManager.ViewManager.html	Mon Apr 02 14:06:55 2018 +0200
@@ -709,7 +709,10 @@
 <td>Public method to check the dirty status of all editors.</td>
 </tr><tr>
 <td><a href="#ViewManager.checkDirty">checkDirty</a></td>
-<td>Public method to check dirty status and open a message window.</td>
+<td>Public method to check the dirty status and open a message window.</td>
+</tr><tr>
+<td><a href="#ViewManager.checkFileDirty">checkFileDirty</a></td>
+<td>Public method to check the dirty status of an editor given its file name and open a message window.</td>
 </tr><tr>
 <td><a href="#ViewManager.clearRecent">clearRecent</a></td>
 <td>Public method to clear the recent files menu.</td>
@@ -2227,26 +2230,57 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating successful reset of all dirty flags (boolean)
+flag indicating successful reset of all dirty flags
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ViewManager.checkDirty" ID="ViewManager.checkDirty"></a>
 <h4>ViewManager.checkDirty</h4>
 <b>checkDirty</b>(<i>editor, autosave=False</i>)
 <p>
-        Public method to check dirty status and open a message window.
+        Public method to check the dirty status and open a message window.
 </p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor window to check
-</dd><dt><i>autosave</i></dt>
+</dd><dt><i>autosave</i> (bool)</dt>
 <dd>
 flag indicating that the file should be saved
-            automatically (boolean)
+            automatically
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating successful reset of the dirty flag (boolean)
+flag indicating successful reset of the dirty flag
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="ViewManager.checkFileDirty" ID="ViewManager.checkFileDirty"></a>
+<h4>ViewManager.checkFileDirty</h4>
+<b>checkFileDirty</b>(<i>fn</i>)
+<p>
+        Public method to check the dirty status of an editor given its file
+        name and open a message window.
+</p><dl>
+<dt><i>fn</i> (str)</dt>
+<dd>
+file name of editor to be checked
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating successful reset of the dirty flag
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ViewManager.clearRecent" ID="ViewManager.clearRecent"></a>
 <h4>ViewManager.clearRecent</h4>
@@ -2292,18 +2326,26 @@
 </dd>
 </dl><a NAME="ViewManager.closeEditor" ID="ViewManager.closeEditor"></a>
 <h4>ViewManager.closeEditor</h4>
-<b>closeEditor</b>(<i>editor</i>)
+<b>closeEditor</b>(<i>editor, ignoreDirty=False</i>)
 <p>
         Public method to close an editor window.
 </p><dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor window to be closed
+</dd><dt><i>ignoreDirty</i> (bool)</dt>
+<dd>
+flag indicating to ignore the 'dirty' status
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ViewManager.closeEditorWindow" ID="ViewManager.closeEditorWindow"></a>
 <h4>ViewManager.closeEditorWindow</h4>
@@ -2329,18 +2371,26 @@
 </dd>
 </dl><a NAME="ViewManager.closeWindow" ID="ViewManager.closeWindow"></a>
 <h4>ViewManager.closeWindow</h4>
-<b>closeWindow</b>(<i>fn</i>)
+<b>closeWindow</b>(<i>fn, ignoreDirty=False</i>)
 <p>
         Public method to close an arbitrary source editor.
 </p><dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename of editor to be closed
+file name of the editor to be closed
+</dd><dt><i>ignoreDirty</i> (bool)</dt>
+<dd>
+flag indicating to ignore the 'dirty' status
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ViewManager.editorsCheckFocusInEnabled" ID="ViewManager.editorsCheckFocusInEnabled"></a>
 <h4>ViewManager.editorsCheckFocusInEnabled</h4>

eric ide

mercurial