eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8152
0c740fcffd34
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html	Mon Feb 01 10:38:16 2021 +0100
@@ -425,7 +425,7 @@
         Private method to get the selected action mode.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 selected action mode (string, one of filter or find)
 </dd>
@@ -477,7 +477,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of the color to use (string)
 </dd>
@@ -545,7 +545,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 HTML table containing details
 </dd>
@@ -589,7 +589,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing the column and color index for
             the given node and a list of tuples indicating the edges
@@ -599,7 +599,7 @@
 </dl>
 <a NAME="HgLogBrowserDialog.__generateIcon" ID="HgLogBrowserDialog.__generateIcon"></a>
 <h4>HgLogBrowserDialog.__generateIcon</h4>
-<b>__generateIcon</b>(<i>column, color, bottomedges, topedges, dotColor, currentRev, closed, isDraft</i>)
+<b>__generateIcon</b>(<i>column, color, bottomedges, topedges, dotColor, currentRev, closed, isPushableDraft</i>)
 
 <p>
         Private method to generate an icon containing the revision tree for the
@@ -637,13 +637,14 @@
 flag indicating to draw an icon for a closed
             branch
 </dd>
-<dt><i>isDraft</i> (bool)</dt>
+<dt><i>isPushableDraft</i> (bool)</dt>
 <dd>
-flag indicating an entry of phase 'draft'
+flag indicating an entry of phase 'draft',
+            that can by pushed
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 icon for the node
 </dd>
@@ -656,64 +657,73 @@
 </dl>
 <a NAME="HgLogBrowserDialog.__generateLogItem" ID="HgLogBrowserDialog.__generateLogItem"></a>
 <h4>HgLogBrowserDialog.__generateLogItem</h4>
-<b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths, parents, branches, tags, phase, bookmarks, latestTag</i>)
+<b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths, parents, branches, tags, phase, bookmarks, latestTag, canPush=False</i>)
 
 <p>
         Private method to generate a log tree entry.
 </p>
 <dl>
 
-<dt><i>author</i></dt>
+<dt><i>author</i> (str)</dt>
 <dd>
-author info (string)
+author info
 </dd>
-<dt><i>date</i></dt>
+<dt><i>date</i> (str)</dt>
 <dd>
-date info (string)
+date info
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (list of str)</dt>
 <dd>
-text of the log message (list of strings)
+text of the log message
 </dd>
-<dt><i>revision</i></dt>
+<dt><i>revision</i> (str)</dt>
 <dd>
-revision info (string)
+revision info
 </dd>
-<dt><i>changedPaths</i></dt>
+<dt><i>changedPaths</i> (dict)</dt>
 <dd>
 list of dictionary objects containing
             info about the changed files/directories
 </dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of int)</dt>
 <dd>
-list of parent revisions (list of integers)
+list of parent revisions
 </dd>
-<dt><i>branches</i></dt>
+<dt><i>branches</i> (list of str)</dt>
 <dd>
-list of branches (list of strings)
+list of branches
 </dd>
-<dt><i>tags</i></dt>
+<dt><i>tags</i> (str)</dt>
 <dd>
-list of tags (string)
+list of tags
 </dd>
-<dt><i>phase</i></dt>
+<dt><i>phase</i> (str)</dt>
 <dd>
-phase of the entry (string)
+phase of the entry
 </dd>
-<dt><i>bookmarks</i></dt>
+<dt><i>bookmarks</i> (str)</dt>
 <dd>
-list of bookmarks (string)
+list of bookmarks
 </dd>
-<dt><i>latestTag</i></dt>
+<dt><i>latestTag</i> (list of str)</dt>
 <dd>
 the latest tag(s) reachable from the changeset
-            (list of strings)
+</dd>
+<dt><i>canPush</i> (bool)</dt>
+<dd>
+flag indicating that changesets can be pushed
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
-reference to the generated item (QTreeWidgetItem)
+reference to the generated item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem
 </dd>
 </dl>
 <a NAME="HgLogBrowserDialog.__generatorFinished" ID="HgLogBrowserDialog.__generatorFinished"></a>
@@ -745,7 +755,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 color name
 </dd>
@@ -776,7 +786,7 @@
 <dd>
 revision number to start from (integer, string)
 </dd>
-<dt><i>noEntries=</i></dt>
+<dt><i>noEntries</i></dt>
 <dd>
 number of entries to get (0 = default) (int)
 </dd>
@@ -797,7 +807,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 list of parent revisions (list of integers)
 </dd>
@@ -817,7 +827,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing the revision and changeset ID
 </dd>
@@ -900,7 +910,7 @@
 </dd>
 </dl>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 processed file name (string)
 </dd>
@@ -920,7 +930,7 @@
         Private slot to prepare the filed search data.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple of field index, search expression and flag indicating
             that the field index is a data role (integer, string, boolean)
@@ -1404,29 +1414,28 @@
 </p>
 <a NAME="HgLogBrowserDialog.start" ID="HgLogBrowserDialog.start"></a>
 <h4>HgLogBrowserDialog.start</h4>
-<b>start</b>(<i>fn, bundle=None, isFile=False, noEntries=0</i>)
+<b>start</b>(<i>name=None, bundle=None, isFile=False, noEntries=0</i>)
 
 <p>
         Public slot to start the hg log command.
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename to show the log for (string)
+file/directory name to show the log for
 </dd>
-<dt><i>bundle=</i></dt>
+<dt><i>bundle</i> (str)</dt>
 <dd>
-name of a bundle file (string)
+name of a bundle file
 </dd>
-<dt><i>isFile=</i></dt>
+<dt><i>isFile</i> (bool)</dt>
 <dd>
 flag indicating log for a file is to be shown
-            (boolean)
 </dd>
-<dt><i>noEntries=</i></dt>
+<dt><i>noEntries</i> (int)</dt>
 <dd>
-number of entries to get (0 = default) (int)
+number of entries to get (0 = default)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial