Updated source docu.

Sun, 17 Jan 2021 16:25:40 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 17 Jan 2021 16:25:40 +0100
changeset 7994
49aa77e9c593
parent 7993
0304d4bce902
child 7995
d570d9aab754

Updated source docu.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Project.Project.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.UI.FindFileDialog.html file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Sun Jan 17 16:24:59 2021 +0100
+++ b/eric6/APIs/Python3/eric6.api	Sun Jan 17 16:25:40 2021 +0100
@@ -6960,6 +6960,7 @@
 eric6.Project.Project.Project.getEditorLexerAssoc?4(filename)
 eric6.Project.Project.Project.getEolString?4()
 eric6.Project.Project.Project.getFiles?4(start)
+eric6.Project.Project.Project.getFiletypeAssociations?4(associationType)
 eric6.Project.Project.Project.getHash?4()
 eric6.Project.Project.Project.getMainScript?4(normalized=False)
 eric6.Project.Project.Project.getMenu?4(menuName)
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Sun Jan 17 16:24:59 2021 +0100
+++ b/eric6/Documentation/Help/source.qhp	Sun Jan 17 16:25:40 2021 +0100
@@ -11351,6 +11351,7 @@
       <keyword name="Project.getEditorLexerAssoc" id="Project.getEditorLexerAssoc" ref="eric6.Project.Project.html#Project.getEditorLexerAssoc" />
       <keyword name="Project.getEolString" id="Project.getEolString" ref="eric6.Project.Project.html#Project.getEolString" />
       <keyword name="Project.getFiles" id="Project.getFiles" ref="eric6.Project.Project.html#Project.getFiles" />
+      <keyword name="Project.getFiletypeAssociations" id="Project.getFiletypeAssociations" ref="eric6.Project.Project.html#Project.getFiletypeAssociations" />
       <keyword name="Project.getHash" id="Project.getHash" ref="eric6.Project.Project.html#Project.getHash" />
       <keyword name="Project.getMainScript" id="Project.getMainScript" ref="eric6.Project.Project.html#Project.getMainScript" />
       <keyword name="Project.getMenu" id="Project.getMenu" ref="eric6.Project.Project.html#Project.getMenu" />
--- a/eric6/Documentation/Source/eric6.Project.Project.html	Sun Jan 17 16:24:59 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Project.Project.html	Sun Jan 17 16:25:40 2021 +0100
@@ -689,6 +689,10 @@
 <td>Public method to get all files starting with a common prefix.</td>
 </tr>
 <tr>
+<td><a href="#Project.getFiletypeAssociations">getFiletypeAssociations</a></td>
+<td>Public method to get the list of file type associations for the given association type.</td>
+</tr>
+<tr>
 <td><a href="#Project.getHash">getHash</a></td>
 <td>Public method to get the project hash.</td>
 </tr>
@@ -2454,6 +2458,35 @@
 list of files starting with a common prefix (list of strings)
 </dd>
 </dl>
+<a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a>
+<h4>Project.getFiletypeAssociations</h4>
+<b>getFiletypeAssociations</b>(<i>associationType</i>)
+
+<p>
+        Public method to get the list of file type associations for
+        the given association type.
+</p>
+<dl>
+
+<dt><i>associationType</i> (str)</dt>
+<dd>
+type of the association (one of FORMS,
+            INTERFACES, OTHERS, PROTOCOLS, RESOURCES, SOURCES or
+            TRANSLATIONS)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of file patterns for the given type
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="Project.getHash" ID="Project.getHash"></a>
 <h4>Project.getHash</h4>
 <b>getHash</b>(<i></i>)
--- a/eric6/Documentation/Source/eric6.UI.FindFileDialog.html	Sun Jan 17 16:24:59 2021 +0100
+++ b/eric6/Documentation/Source/eric6.UI.FindFileDialog.html	Sun Jan 17 16:25:40 2021 +0100
@@ -286,27 +286,41 @@
 </p>
 <a NAME="FindFileDialog.__getFileList" ID="FindFileDialog.__getFileList"></a>
 <h4>FindFileDialog.__getFileList</h4>
-<b>__getFileList</b>(<i>path, filterRe</i>)
+<b>__getFileList</b>(<i>path, filterRe, excludeHiddenDirs=False, excludeHiddenFiles=False</i>)
 
 <p>
         Private method to get a list of files to search.
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-the root directory to search in (string)
+the root directory to search in
 </dd>
-<dt><i>filterRe</i></dt>
+<dt><i>filterRe</i> (regexp object)</dt>
 <dd>
 regular expression defining the filter
-            criteria (regexp object)
+            criteria
+</dd>
+<dt><i>excludeHiddenDirs</i> (bool)</dt>
+<dd>
+flag indicating to exclude hidden directories
+</dd>
+<dt><i>excludeHiddenFiles</i> (bool)</dt>
+<dd>
+flag indicating to exclude hidden files
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of files to be processed (list of strings)
+list of files to be processed
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="FindFileDialog.__openFile" ID="FindFileDialog.__openFile"></a>

eric ide

mercurial