~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.VCS.StatusMonitorLed.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
 
3
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 
4
<html><head>
 
5
<title>eric4.VCS.StatusMonitorLed</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.VCS.StatusMonitorLed</h1>
 
24
<p>
 
25
Module implementing a LED to indicate the status of the VCS status monitor thread.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#StatusMonitorLed">StatusMonitorLed</a></td>
 
31
<td>Class implementing a LED to indicate the status of the VCS status monitor thread.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="StatusMonitorLed" ID="StatusMonitorLed"></a>
 
40
<h2>StatusMonitorLed</h2>
 
41
<p>
 
42
    Class implementing a LED to indicate the status of the VCS status monitor thread.
 
43
</p>
 
44
<h3>Derived from</h3>
 
45
E4Led
 
46
<h3>Methods</h3>
 
47
<table>
 
48
<tr>
 
49
<td><a href="#StatusMonitorLed.__init__">StatusMonitorLed</a></td>
 
50
<td>Constructor</td>
 
51
</tr><tr>
 
52
<td><a href="#StatusMonitorLed.__checkActions">__checkActions</a></td>
 
53
<td>Private method to set the enabled status of the context menu actions.</td>
 
54
</tr><tr>
 
55
<td><a href="#StatusMonitorLed.__checkStatus">__checkStatus</a></td>
 
56
<td>Private slot to initiate a new status check.</td>
 
57
</tr><tr>
 
58
<td><a href="#StatusMonitorLed.__projectVcsMonitorStatus">__projectVcsMonitorStatus</a></td>
 
59
<td>Private method to receive the status monitor status.</td>
 
60
</tr><tr>
 
61
<td><a href="#StatusMonitorLed.__setInterval">__setInterval</a></td>
 
62
<td>Private slot to change the status check interval.</td>
 
63
</tr><tr>
 
64
<td><a href="#StatusMonitorLed.__switchOff">__switchOff</a></td>
 
65
<td>Private slot to switch the status monitor thread to Off.</td>
 
66
</tr><tr>
 
67
<td><a href="#StatusMonitorLed.__switchOn">__switchOn</a></td>
 
68
<td>Private slot to switch the status monitor thread to On.</td>
 
69
</tr><tr>
 
70
<td><a href="#StatusMonitorLed._showContextMenu">_showContextMenu</a></td>
 
71
<td>Protected slot to show the context menu.</td>
 
72
</tr>
 
73
</table>
 
74
<p><a NAME="StatusMonitorLed.__init__" ID="StatusMonitorLed.__init__"></a>
 
75
<h4>StatusMonitorLed (Constructor)</h4>
 
76
<b>StatusMonitorLed</b>(<i>project, parent</i>)
 
77
<p>
 
78
        Constructor
 
79
</p><dl>
 
80
<dt><i>project</i></dt>
 
81
<dd>
 
82
reference to the project object (Project.Project)
 
83
</dd><dt><i>parent</i></dt>
 
84
<dd>
 
85
reference to the parent object (QWidget)
 
86
</dd>
 
87
</dl><a NAME="StatusMonitorLed.__checkActions" ID="StatusMonitorLed.__checkActions"></a>
 
88
<h4>StatusMonitorLed.__checkActions</h4>
 
89
<b>__checkActions</b>(<i></i>)
 
90
<p>
 
91
        Private method to set the enabled status of the context menu actions.
 
92
</p><a NAME="StatusMonitorLed.__checkStatus" ID="StatusMonitorLed.__checkStatus"></a>
 
93
<h4>StatusMonitorLed.__checkStatus</h4>
 
94
<b>__checkStatus</b>(<i></i>)
 
95
<p>
 
96
        Private slot to initiate a new status check.
 
97
</p><a NAME="StatusMonitorLed.__projectVcsMonitorStatus" ID="StatusMonitorLed.__projectVcsMonitorStatus"></a>
 
98
<h4>StatusMonitorLed.__projectVcsMonitorStatus</h4>
 
99
<b>__projectVcsMonitorStatus</b>(<i>status, statusMsg</i>)
 
100
<p>
 
101
        Private method to receive the status monitor status.
 
102
</p><dl>
 
103
<dt><i>status</i></dt>
 
104
<dd>
 
105
status of the monitoring thread (QString, ok, nok or off)
 
106
</dd><dt><i>statusMsg</i></dt>
 
107
<dd>
 
108
explanotory text for the signaled status (QString)
 
109
</dd>
 
110
</dl><a NAME="StatusMonitorLed.__setInterval" ID="StatusMonitorLed.__setInterval"></a>
 
111
<h4>StatusMonitorLed.__setInterval</h4>
 
112
<b>__setInterval</b>(<i></i>)
 
113
<p>
 
114
        Private slot to change the status check interval.
 
115
</p><a NAME="StatusMonitorLed.__switchOff" ID="StatusMonitorLed.__switchOff"></a>
 
116
<h4>StatusMonitorLed.__switchOff</h4>
 
117
<b>__switchOff</b>(<i></i>)
 
118
<p>
 
119
        Private slot to switch the status monitor thread to Off.
 
120
</p><a NAME="StatusMonitorLed.__switchOn" ID="StatusMonitorLed.__switchOn"></a>
 
121
<h4>StatusMonitorLed.__switchOn</h4>
 
122
<b>__switchOn</b>(<i></i>)
 
123
<p>
 
124
        Private slot to switch the status monitor thread to On.
 
125
</p><a NAME="StatusMonitorLed._showContextMenu" ID="StatusMonitorLed._showContextMenu"></a>
 
126
<h4>StatusMonitorLed._showContextMenu</h4>
 
127
<b>_showContextMenu</b>(<i>coord</i>)
 
128
<p>
 
129
        Protected slot to show the context menu.
 
130
</p><dl>
 
131
<dt><i>coord</i></dt>
 
132
<dd>
 
133
the position of the mouse pointer (QPoint)
 
134
</dd>
 
135
</dl></p>
 
136
<div align="right"><a href="#top">Up</a></div>
 
137
<hr />
 
138
</body></html>
 
 
b'\\ No newline at end of file'