Updated source docu.

Fri, 14 May 2010 17:30:35 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 14 May 2010 17:30:35 +0200
changeset 249
52df4455a035
parent 248
f4561c24989a
child 250
332afc99e9fa

Updated source docu.

APIs/Python3/eric5.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Project.Project.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.Tasks.TaskViewer.html file | annotate | diff | comparison | revisions
Documentation/Source/eric5.VCS.StatusMonitorThread.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric5.api	Fri May 14 17:26:38 2010 +0200
+++ b/APIs/Python3/eric5.api	Fri May 14 17:30:35 2010 +0200
@@ -2483,7 +2483,7 @@
 eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpGroup_toggled?4(enabled)
 eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpNamespaceEdit_textChanged?4(txt)
 eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog.on_qtHelpTitleEdit_textChanged?4(p0)
-eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog?1(ppath, parms = None, parent = None)
+eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.EricdocConfigDialog?1(project, parms = None, parent = None)
 eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.EricdocExecDialog.on_buttonBox_clicked?4(button)
 eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.EricdocExecDialog.start?4(args, fn)
 eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.EricdocExecDialog?1(cmdname, parent = None)
@@ -2906,7 +2906,7 @@
 eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.HgStatusDialog.start?4(fn)
 eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusDialog.HgStatusDialog?1(vcs, parent = None)
 eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.HgStatusMonitorThread._performMonitor?5()
-eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.HgStatusMonitorThread?1(interval, projectDir, vcs, parent = None)
+eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.HgStatusMonitorThread?1(interval, project, vcs, parent = None)
 eric5.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.HgTagBranchListDialog.closeEvent?4(e)
 eric5.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.HgTagBranchListDialog.keyPressEvent?4(evt)
 eric5.Plugins.VcsPlugins.vcsMercurial.HgTagBranchListDialog.HgTagBranchListDialog.on_buttonBox_clicked?4(button)
@@ -3120,7 +3120,7 @@
 eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.SvnStatusDialog.start?4(fn)
 eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusDialog.SvnStatusDialog?1(vcs, parent = None)
 eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.SvnStatusMonitorThread._performMonitor?5()
-eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.SvnStatusMonitorThread?1(interval, projectDir, vcs, parent = None)
+eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.SvnStatusMonitorThread?1(interval, project, vcs, parent = None)
 eric5.Plugins.VcsPlugins.vcsPySvn.SvnSwitchDialog.SvnSwitchDialog.getParameters?4()
 eric5.Plugins.VcsPlugins.vcsPySvn.SvnSwitchDialog.SvnSwitchDialog?1(taglist, reposURL, standardLayout, parent = None)
 eric5.Plugins.VcsPlugins.vcsPySvn.SvnTagBranchListDialog.SvnTagBranchListDialog.getTagList?4()
@@ -3329,7 +3329,7 @@
 eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.SvnStatusDialog.start?4(fn)
 eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusDialog.SvnStatusDialog?1(vcs, parent = None)
 eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.SvnStatusMonitorThread._performMonitor?5()
-eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.SvnStatusMonitorThread?1(interval, projectDir, vcs, parent = None)
+eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.SvnStatusMonitorThread?1(interval, project, vcs, parent = None)
 eric5.Plugins.VcsPlugins.vcsSubversion.SvnSwitchDialog.SvnSwitchDialog.getParameters?4()
 eric5.Plugins.VcsPlugins.vcsSubversion.SvnSwitchDialog.SvnSwitchDialog?1(taglist, reposURL, standardLayout, parent = None)
 eric5.Plugins.VcsPlugins.vcsSubversion.SvnTagBranchListDialog.SvnTagBranchListDialog.closeEvent?4(e)
@@ -4190,8 +4190,8 @@
 eric5.Project.Project.Project.getProjectSpellLanguage?4()
 eric5.Project.Project.Project.getProjectType?4()
 eric5.Project.Project.Project.getProjectTypes?4()
-eric5.Project.Project.Project.getRelativePath?4(fn)
-eric5.Project.Project.Project.getRelativeUniversalPath?4(fn)
+eric5.Project.Project.Project.getRelativePath?4(path)
+eric5.Project.Project.Project.getRelativeUniversalPath?4(path)
 eric5.Project.Project.Project.getSources?4(normalized = False)
 eric5.Project.Project.Project.getStatusMonitorAutoUpdate?4()
 eric5.Project.Project.Project.getStatusMonitorInterval?4()
@@ -4238,6 +4238,7 @@
 eric5.Project.Project.Project.setStatusMonitorAutoUpdate?4(auto)
 eric5.Project.Project.Project.setStatusMonitorInterval?4(interval)
 eric5.Project.Project.Project.startStatusMonitor?4()
+eric5.Project.Project.Project.startswithProjectPath?4(path)
 eric5.Project.Project.Project.stopStatusMonitor?4()
 eric5.Project.Project.Project.unregisterProjectType?4(type_)
 eric5.Project.Project.Project.updateFileTypes?4()
@@ -5098,7 +5099,7 @@
 eric5.Tasks.TaskViewer.Task.setLongText?4(longtext)
 eric5.Tasks.TaskViewer.Task.setPriority?4(priority)
 eric5.Tasks.TaskViewer.Task.setProjectTask?4(pt)
-eric5.Tasks.TaskViewer.Task?1(description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, ppath = "", longtext = "")
+eric5.Tasks.TaskViewer.Task?1(description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, project = None, longtext = "")
 eric5.Tasks.TaskViewer.TaskFilter.hasActiveFilter?4()
 eric5.Tasks.TaskViewer.TaskFilter.setActive?4(enabled)
 eric5.Tasks.TaskViewer.TaskFilter.setDescriptionFilter?4(filter)
@@ -5820,7 +5821,7 @@
 eric5.VCS.StatusMonitorThread.VcsStatusMonitorThread.setAutoUpdate?4(auto)
 eric5.VCS.StatusMonitorThread.VcsStatusMonitorThread.setInterval?4(interval)
 eric5.VCS.StatusMonitorThread.VcsStatusMonitorThread.stop?4()
-eric5.VCS.StatusMonitorThread.VcsStatusMonitorThread?1(interval, projectDir, vcs, parent = None)
+eric5.VCS.StatusMonitorThread.VcsStatusMonitorThread?1(interval, project, vcs, parent = None)
 eric5.VCS.VersionControl.VersionControl._createStatusMonitorThread?5(interval, project)
 eric5.VCS.VersionControl.VersionControl.addArguments?4(args, argslist)
 eric5.VCS.VersionControl.VersionControl.canBeAdded?7
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Help/source.qhp	Fri May 14 17:30:35 2010 +0200
@@ -4620,6 +4620,7 @@
       <keyword name="Project.setStatusMonitorAutoUpdate" id="Project.setStatusMonitorAutoUpdate" ref="eric5.Project.Project.html#Project.setStatusMonitorAutoUpdate" />
       <keyword name="Project.setStatusMonitorInterval" id="Project.setStatusMonitorInterval" ref="eric5.Project.Project.html#Project.setStatusMonitorInterval" />
       <keyword name="Project.startStatusMonitor" id="Project.startStatusMonitor" ref="eric5.Project.Project.html#Project.startStatusMonitor" />
+      <keyword name="Project.startswithProjectPath" id="Project.startswithProjectPath" ref="eric5.Project.Project.html#Project.startswithProjectPath" />
       <keyword name="Project.stopStatusMonitor" id="Project.stopStatusMonitor" ref="eric5.Project.Project.html#Project.stopStatusMonitor" />
       <keyword name="Project.unregisterProjectType" id="Project.unregisterProjectType" ref="eric5.Project.Project.html#Project.unregisterProjectType" />
       <keyword name="Project.updateFileTypes" id="Project.updateFileTypes" ref="eric5.Project.Project.html#Project.updateFileTypes" />
--- a/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocConfigDialog.html	Fri May 14 17:30:35 2010 +0200
@@ -132,13 +132,13 @@
 </table>
 <a NAME="EricdocConfigDialog.__init__" ID="EricdocConfigDialog.__init__"></a>
 <h4>EricdocConfigDialog (Constructor)</h4>
-<b>EricdocConfigDialog</b>(<i>ppath, parms = None, parent = None</i>)
+<b>EricdocConfigDialog</b>(<i>project, parms = None, parent = None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>ppath</i></dt>
+<dt><i>project</i></dt>
 <dd>
-project path of the current project (string)
+reference to the project object (Project.Project)
 </dd><dt><i>parms</i></dt>
 <dd>
 parameters to set in the dialog
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgStatusMonitorThread.html	Fri May 14 17:30:35 2010 +0200
@@ -63,16 +63,16 @@
 </table>
 <a NAME="HgStatusMonitorThread.__init__" ID="HgStatusMonitorThread.__init__"></a>
 <h4>HgStatusMonitorThread (Constructor)</h4>
-<b>HgStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>)
+<b>HgStatusMonitorThread</b>(<i>interval, project, vcs, parent = None</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>interval</i></dt>
 <dd>
 new interval in seconds (integer)
-</dd><dt><i>projectDir</i></dt>
+</dd><dt><i>project</i></dt>
 <dd>
-project directory to monitor (string)
+reference to the project object (Project)
 </dd><dt><i>vcs</i></dt>
 <dd>
 reference to the version control object
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html	Fri May 14 17:30:35 2010 +0200
@@ -303,7 +303,7 @@
 </p><dl>
 <dt><i>project</i></dt>
 <dd>
-reference to the project object
+reference to the project object (Project)
 </dd><dt><i>interval</i></dt>
 <dd>
 check interval for the monitor thread in seconds (integer)
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnStatusMonitorThread.html	Fri May 14 17:30:35 2010 +0200
@@ -69,16 +69,16 @@
 </table>
 <a NAME="SvnStatusMonitorThread.__init__" ID="SvnStatusMonitorThread.__init__"></a>
 <h4>SvnStatusMonitorThread (Constructor)</h4>
-<b>SvnStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>)
+<b>SvnStatusMonitorThread</b>(<i>interval, project, vcs, parent = None</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>interval</i></dt>
 <dd>
 new interval in seconds (integer)
-</dd><dt><i>projectDir</i></dt>
+</dd><dt><i>project</i></dt>
 <dd>
-project directory to monitor (string)
+reference to the project object (Project)
 </dd><dt><i>vcs</i></dt>
 <dd>
 reference to the version control object
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread.html	Fri May 14 17:30:35 2010 +0200
@@ -63,16 +63,16 @@
 </table>
 <a NAME="SvnStatusMonitorThread.__init__" ID="SvnStatusMonitorThread.__init__"></a>
 <h4>SvnStatusMonitorThread (Constructor)</h4>
-<b>SvnStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>)
+<b>SvnStatusMonitorThread</b>(<i>interval, project, vcs, parent = None</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>interval</i></dt>
 <dd>
 new interval in seconds (integer)
-</dd><dt><i>projectDir</i></dt>
+</dd><dt><i>project</i></dt>
 <dd>
-project directory to monitor (string)
+reference to the project object (Project)
 </dd><dt><i>vcs</i></dt>
 <dd>
 reference to the version control object
--- a/Documentation/Source/eric5.Project.Project.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Project.Project.html	Fri May 14 17:30:35 2010 +0200
@@ -592,6 +592,9 @@
 <td><a href="#Project.startStatusMonitor">startStatusMonitor</a></td>
 <td>Public method to start the VCS status monitor thread.</td>
 </tr><tr>
+<td><a href="#Project.startswithProjectPath">startswithProjectPath</a></td>
+<td>Public method to check, if a path starts with the project path.</td>
+</tr><tr>
 <td><a href="#Project.stopStatusMonitor">stopStatusMonitor</a></td>
 <td>Public method to stop the VCS status monitor thread.</td>
 </tr><tr>
@@ -1605,36 +1608,36 @@
 </dd>
 </dl><a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a>
 <h4>Project.getRelativePath</h4>
-<b>getRelativePath</b>(<i>fn</i>)
+<b>getRelativePath</b>(<i>path</i>)
 <p>
         Public method to convert a file path to a project relative
         file path.
 </p><dl>
-<dt><i>fn</i></dt>
+<dt><i>path</i></dt>
 <dd>
 file or directory name to convert (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-project relative path or unchanged path, if fn doesn't
+project relative path or unchanged path, if path doesn't
             belong to the project (string)
 </dd>
 </dl><a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a>
 <h4>Project.getRelativeUniversalPath</h4>
-<b>getRelativeUniversalPath</b>(<i>fn</i>)
+<b>getRelativeUniversalPath</b>(<i>path</i>)
 <p>
         Public method to convert a file path to a project relative
         file path with universal separators.
 </p><dl>
-<dt><i>fn</i></dt>
+<dt><i>path</i></dt>
 <dd>
 file or directory name to convert (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-project relative path or unchanged path, if fn doesn't
+project relative path or unchanged path, if path doesn't
             belong to the project (string)
 </dd>
 </dl><a NAME="Project.getSources" ID="Project.getSources"></a>
@@ -2212,7 +2215,17 @@
 <b>startStatusMonitor</b>(<i></i>)
 <p>
         Public method to start the VCS status monitor thread.
-</p><a NAME="Project.stopStatusMonitor" ID="Project.stopStatusMonitor"></a>
+</p><a NAME="Project.startswithProjectPath" ID="Project.startswithProjectPath"></a>
+<h4>Project.startswithProjectPath</h4>
+<b>startswithProjectPath</b>(<i>path</i>)
+<p>
+        Public method to check, if a path starts with the project path.
+</p><dl>
+<dt><i>path</i></dt>
+<dd>
+path to be checked (string)
+</dd>
+</dl><a NAME="Project.stopStatusMonitor" ID="Project.stopStatusMonitor"></a>
 <h4>Project.stopStatusMonitor</h4>
 <b>stopStatusMonitor</b>(<i></i>)
 <p>
--- a/Documentation/Source/eric5.Tasks.TaskViewer.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.Tasks.TaskViewer.html	Fri May 14 17:30:35 2010 +0200
@@ -100,7 +100,7 @@
 </table>
 <a NAME="Task.__init__" ID="Task.__init__"></a>
 <h4>Task (Constructor)</h4>
-<b>Task</b>(<i>description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, ppath = "", longtext = ""</i>)
+<b>Task</b>(<i>description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, project = None, longtext = ""</i>)
 <p>
         Constructor
 </p><dl>
@@ -132,9 +132,9 @@
 </dd><dt><i>isBugfixTask</i></dt>
 <dd>
 flag indicating a bugfix task (boolean)
-</dd><dt><i>ppath</i></dt>
+</dd><dt><i>project</i></dt>
 <dd>
-the project path (string)
+reference to the project object (Project)
 </dd><dt><i>longtext</i></dt>
 <dd>
 explanatory text of the task (string)
--- a/Documentation/Source/eric5.VCS.StatusMonitorThread.html	Fri May 14 17:26:38 2010 +0200
+++ b/Documentation/Source/eric5.VCS.StatusMonitorThread.html	Fri May 14 17:30:35 2010 +0200
@@ -97,16 +97,16 @@
 </table>
 <a NAME="VcsStatusMonitorThread.__init__" ID="VcsStatusMonitorThread.__init__"></a>
 <h4>VcsStatusMonitorThread (Constructor)</h4>
-<b>VcsStatusMonitorThread</b>(<i>interval, projectDir, vcs, parent = None</i>)
+<b>VcsStatusMonitorThread</b>(<i>interval, project, vcs, parent = None</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>interval</i></dt>
 <dd>
 new interval in seconds (integer)
-</dd><dt><i>projectDir</i></dt>
+</dd><dt><i>project</i></dt>
 <dd>
-project directory to monitor (string)
+reference to the project object (Project)
 </dd><dt><i>vcs</i></dt>
 <dd>
 reference to the version control object

eric ide

mercurial