Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html

src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html

branch
eric7
changeset 10430
e440aaf179ce
parent 10399
48014775ad31
child 10472
3aecfec97f7c
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html	Wed Dec 20 15:42:44 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html	Wed Dec 20 19:28:22 2023 +0100
@@ -90,25 +90,25 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (BrowserItem)</dt>
 <dd>
 parent item
 </dd>
-<dt><i>dinfo</i></dt>
+<dt><i>dinfo</i> (str)</dt>
 <dd>
-dinfo is the string for the directory (string)
+dinfo is the string for the directory
 </dd>
-<dt><i>projectType</i></dt>
+<dt><i>projectType</i> (str)</dt>
 <dd>
 type of file/directory in the project
 </dd>
-<dt><i>full</i></dt>
+<dt><i>full</i> (bool)</dt>
 <dd>
-flag indicating full pathname should be displayed (boolean)
+flag indicating full pathname should be displayed
 </dd>
-<dt><i>bold</i></dt>
+<dt><i>bold</i> (bool)</dt>
 <dd>
-flag indicating a highlighted font (boolean)
+flag indicating a highlighted font
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -156,29 +156,29 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (BrowserItem)</dt>
 <dd>
 parent item
 </dd>
-<dt><i>finfo</i></dt>
+<dt><i>finfo</i> (str)</dt>
 <dd>
-the string for the file (string)
+the string for the file
 </dd>
-<dt><i>projectType</i></dt>
+<dt><i>projectType</i> (str)</dt>
 <dd>
 type of file/directory in the project
 </dd>
-<dt><i>full</i></dt>
+<dt><i>full</i> (bool)</dt>
 <dd>
-flag indicating full pathname should be displayed (boolean)
+flag indicating full pathname should be displayed
 </dd>
-<dt><i>bold</i></dt>
+<dt><i>bold</i> (bool)</dt>
 <dd>
-flag indicating a highlighted font (boolean)
+flag indicating a highlighted font
 </dd>
-<dt><i>sourceLanguage</i></dt>
+<dt><i>sourceLanguage</i> (str)</dt>
 <dd>
-source code language of the project (string)
+source code language of the project
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -253,11 +253,11 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
 type of file/directory in the project
 </dd>
-<dt><i>bold</i></dt>
+<dt><i>bold</i> (bool)</dt>
 <dd>
 flag indicating a highlighted font
 </dd>
@@ -271,7 +271,7 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
 type to add to the list
 </dd>
@@ -285,9 +285,9 @@
 </p>
 <dl>
 
-<dt><i>vcsStatus</i></dt>
+<dt><i>vcsStatus</i> (str)</dt>
 <dd>
-VCS status text (string)
+VCS status text
 </dd>
 </dl>
 <a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a>
@@ -303,6 +303,12 @@
 project type
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a>
 <h4>ProjectBrowserItemMixin.getTextColor</h4>
 <b>getTextColor</b>(<i></i>)
@@ -313,7 +319,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-text color (QColor)
+text color
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QColor
 </dd>
 </dl>
 <a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a>
@@ -325,9 +337,9 @@
 </p>
 <dl>
 
-<dt><i>state</i></dt>
+<dt><i>state</i> (str)</dt>
 <dd>
-VCS state (one of A, C, M, U or " ") (string)
+VCS state (one of A, C, M, U or " ")
 </dd>
 </dl>
 <a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a>
@@ -339,9 +351,9 @@
 </p>
 <dl>
 
-<dt><i>vcsStatus</i></dt>
+<dt><i>vcsStatus</i> (str)</dt>
 <dd>
-VCS status text (string)
+VCS status text
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -497,9 +509,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (Project.Project)</dt>
 <dd>
-reference to parent object (Project.Project)
+reference to parent object
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a>
@@ -511,13 +523,13 @@
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (BrowserItem)</dt>
 <dd>
 item to work on
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename belonging to this item (string)
+filename belonging to this item
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a>
@@ -529,11 +541,11 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-pathname of parent item (string)
+pathname of parent item
 </dd>
-<dt><i>itemCache</i></dt>
+<dt><i>itemCache</i> (dict)</dt>
 <dd>
 reference to the item cache used to store
             references to named items
@@ -548,17 +560,17 @@
 </p>
 <dl>
 
-<dt><i>item</i></dt>
+<dt><i>item</i> (BrowserItem)</dt>
 <dd>
 item to work on
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename belonging to this item (string)
+filename belonging to this item
 </dd>
-<dt><i>recursive</i></dt>
+<dt><i>recursive</i> (bool)</dt>
 <dd>
-flag indicating a recursive update (boolean)
+flag indicating a recursive update
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a>
@@ -570,17 +582,17 @@
 </p>
 <dl>
 
-<dt><i>typeString</i></dt>
+<dt><i>typeString</i> (str)</dt>
 <dd>
-string denoting the type of the new item (string)
+string denoting the type of the new item
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the new item (string)
+name of the new item
 </dd>
-<dt><i>additionalTypeStrings</i></dt>
+<dt><i>additionalTypeStrings</i> (list of str)</dt>
 <dd>
-names of additional types (list of string)
+names of additional types
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a>
@@ -592,12 +604,11 @@
 </p>
 <dl>
 
-<dt><i>statesList</i></dt>
+<dt><i>statesList</i> (list of str)</dt>
 <dd>
-list of VCS state entries (list of strings) giving
-            the states in the first column and the path relative to the project
-            directory starting with the third column. The allowed status flags
-            are:
+list of VCS state entries giving the states in the
+            first column and the path relative to the project directory starting
+            with the third column. The allowed status flags are:
             <ul>
                 <li>"A" path was added but not yet comitted</li>
                 <li>"M" path has local changes</li>
@@ -618,13 +629,13 @@
 </p>
 <dl>
 
-<dt><i>index</i></dt>
+<dt><i>index</i> (QModelIndex)</dt>
 <dd>
-index of the data to retrieve (QModelIndex)
+index of the data to retrieve
 </dd>
-<dt><i>role</i></dt>
+<dt><i>role</i> (Qt.ItemDataRole)</dt>
 <dd>
-role of data (Qt.ItemDataRole)
+role of data
 </dd>
 </dl>
 <dl>
@@ -633,6 +644,12 @@
 requested data
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
 <a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a>
 <h4>ProjectBrowserModel.directoryChanged</h4>
 <b>directoryChanged</b>(<i>path</i>)
@@ -642,9 +659,9 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-path of the directory (string)
+path of the directory
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a>
@@ -656,15 +673,15 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to search for (string)
+text to search for
 </dd>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
 <dd>
-column to search in (integer)
+column to search in
 </dd>
-<dt><i>parentItem</i></dt>
+<dt><i>parentItem</i> (BrowserItem)</dt>
 <dd>
 reference to parent item
 </dd>
@@ -675,6 +692,12 @@
 reference to the item found
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+BrowserItem
+</dd>
+</dl>
 <a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a>
 <h4>ProjectBrowserModel.findItem</h4>
 <b>findItem</b>(<i>name</i>)
@@ -684,9 +707,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the item (string)
+name of the item
 </dd>
 </dl>
 <dl>
@@ -695,6 +718,12 @@
 reference to the item found
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+BrowserItem
+</dd>
+</dl>
 <a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a>
 <h4>ProjectBrowserModel.findParentItemByName</h4>
 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>)
@@ -708,23 +737,29 @@
 </p>
 <dl>
 
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
 <dd>
 type of the item
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the item (string)
+name of the item
 </dd>
-<dt><i>dontSplit</i></dt>
+<dt><i>dontSplit</i> (bool)</dt>
 <dd>
-flag indicating the name should not be split (boolean)
+flag indicating the name should not be split
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the item found and the new display name (string)
+reference to the item found and the new display name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a>
@@ -736,15 +771,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the item (string)
+name of the item
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-index of the item found (QModelIndex)
+index of the item found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QModelIndex
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a>
@@ -756,19 +797,25 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the item (string)
+name of the item
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-one based line number of the item (integer)
+one based line number of the item
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-index of the item found (QModelIndex)
+index of the item found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QModelIndex
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a>
@@ -780,13 +827,13 @@
 </p>
 <dl>
 
-<dt><i>parentItem</i></dt>
+<dt><i>parentItem</i> (BrowserItem)</dt>
 <dd>
 reference to the item to be populated
 </dd>
-<dt><i>repopulate</i></dt>
+<dt><i>repopulate</i> (bool)</dt>
 <dd>
-flag indicating a repopulation (boolean)
+flag indicating a repopulation
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a>
@@ -798,13 +845,13 @@
 </p>
 <dl>
 
-<dt><i>parentItem</i></dt>
+<dt><i>parentItem</i> (BrowserItem)</dt>
 <dd>
 reference to the directory item to be populated
 </dd>
-<dt><i>repopulate</i></dt>
+<dt><i>repopulate</i> (bool)</dt>
 <dd>
-flag indicating a repopulation (boolean)
+flag indicating a repopulation
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a>
@@ -845,9 +892,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file or directory name of the item (string).
+file or directory name of the item
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a>
@@ -859,13 +906,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-the old display name (string)
+the old display name
 </dd>
-<dt><i>newFilename</i></dt>
+<dt><i>newFilename</i> (str)</dt>
 <dd>
-new filename of the item (string)
+new filename of the item
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a>
@@ -877,9 +924,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the file relative to the project root (string)
+name of the file relative to the project root
 </dd>
 </dl>
 <a NAME="ProjectBrowserModel.setProjectBrowserReference" ID="ProjectBrowserModel.setProjectBrowserReference"></a>
@@ -919,13 +966,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename belonging to this item (string)
+filename belonging to this item
 </dd>
-<dt><i>recursive</i></dt>
+<dt><i>recursive</i> (bool)</dt>
 <dd>
-flag indicating a recursive update (boolean)
+flag indicating a recursive update
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -974,21 +1021,21 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (BrowserItem)</dt>
 <dd>
 parent item
 </dd>
-<dt><i>projectType</i></dt>
+<dt><i>projectType</i> (str)</dt>
 <dd>
 type of file/directory in the project
 </dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be displayed (string)
+text to be displayed
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-path of the directory (string)
+path of the directory
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial