Mercurial Repositories > MQTT Monitor / file comparison

comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html

MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html

changeset 78
a22328182bc2
parent 12
e0175cb7c5d5
child 87
fe391e485681
equal deleted inserted replaced
77:a580238d85de 78:a22328182bc2
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1> 23 <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1>
24
23 <p> 25 <p>
24 Module implementing the MQTT Monitor plug-in. 26 Module implementing the MQTT Monitor plug-in.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
27 <table> 29
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 30 <table>
31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td> 38 <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td>
34 <td>Class implementing the MQTT Monitor plug-in.</td> 39 <td>Class implementing the MQTT Monitor plug-in.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#exeDisplayData">exeDisplayData</a></td> 47 <td><a href="#exeDisplayData">exeDisplayData</a></td>
41 <td>Module function to support the display of some executable info.</td> 48 <td>Module function to support the display of some executable info.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#prepareUninstall">prepareUninstall</a></td> 51 <td><a href="#prepareUninstall">prepareUninstall</a></td>
44 <td>Module function to prepare for an uninstallation.</td> 52 <td>Module function to prepare for an uninstallation.</td>
45 </tr> 53 </tr>
46 </table> 54 </table>
47 <hr /><hr /> 55 <hr />
56 <hr />
48 <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a> 57 <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a>
49 <h2>MqttMonitorPlugin</h2> 58 <h2>MqttMonitorPlugin</h2>
59
50 <p> 60 <p>
51 Class implementing the MQTT Monitor plug-in. 61 Class implementing the MQTT Monitor plug-in.
52 </p> 62 </p>
53 <h3>Derived from</h3> 63 <h3>Derived from</h3>
54 QObject 64 QObject
55 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
66
56 <table> 67 <table>
57 <tr><td>PreferencesKey</td></tr> 68 <tr><td>PreferencesKey</td></tr>
58 </table> 69 </table>
59 <h3>Class Methods</h3> 70 <h3>Class Methods</h3>
71
60 <table> 72 <table>
61 <tr><td>None</td></tr> 73 <tr><td>None</td></tr>
62 </table> 74 </table>
63 <h3>Methods</h3> 75 <h3>Methods</h3>
64 <table> 76
77 <table>
78
65 <tr> 79 <tr>
66 <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td> 80 <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td>
67 <td>Constructor</td> 81 <td>Constructor</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#MqttMonitorPlugin.__activateWidget">__activateWidget</a></td> 84 <td><a href="#MqttMonitorPlugin.__activateWidget">__activateWidget</a></td>
70 <td>Private slot to handle the activation of the MQTT Monitor.</td> 85 <td>Private slot to handle the activation of the MQTT Monitor.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#MqttMonitorPlugin.__initialize">__initialize</a></td> 88 <td><a href="#MqttMonitorPlugin.__initialize">__initialize</a></td>
73 <td>Private slot to (re)initialize the plugin.</td> 89 <td>Private slot to (re)initialize the plugin.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#MqttMonitorPlugin.__loadTranslator">__loadTranslator</a></td> 92 <td><a href="#MqttMonitorPlugin.__loadTranslator">__loadTranslator</a></td>
76 <td>Private method to load the translation file.</td> 93 <td>Private method to load the translation file.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#MqttMonitorPlugin.activate">activate</a></td> 96 <td><a href="#MqttMonitorPlugin.activate">activate</a></td>
79 <td>Public method to activate this plug-in.</td> 97 <td>Public method to activate this plug-in.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#MqttMonitorPlugin.deactivate">deactivate</a></td> 100 <td><a href="#MqttMonitorPlugin.deactivate">deactivate</a></td>
82 <td>Public method to deactivate this plug-in.</td> 101 <td>Public method to deactivate this plug-in.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#MqttMonitorPlugin.getPreferences">getPreferences</a></td> 104 <td><a href="#MqttMonitorPlugin.getPreferences">getPreferences</a></td>
85 <td>Public method to retrieve the various settings.</td> 105 <td>Public method to retrieve the various settings.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#MqttMonitorPlugin.setPreferences">setPreferences</a></td> 108 <td><a href="#MqttMonitorPlugin.setPreferences">setPreferences</a></td>
88 <td>Public method to store the various settings.</td> 109 <td>Public method to store the various settings.</td>
89 </tr> 110 </tr>
90 </table> 111 </table>
91 <h3>Static Methods</h3> 112 <h3>Static Methods</h3>
113
92 <table> 114 <table>
93 <tr><td>None</td></tr> 115 <tr><td>None</td></tr>
94 </table> 116 </table>
117
95 <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a> 118 <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a>
96 <h4>MqttMonitorPlugin (Constructor)</h4> 119 <h4>MqttMonitorPlugin (Constructor)</h4>
97 <b>MqttMonitorPlugin</b>(<i>ui</i>) 120 <b>MqttMonitorPlugin</b>(<i>ui</i>)
121
98 <p> 122 <p>
99 Constructor 123 Constructor
100 </p><dl> 124 </p>
125 <dl>
126
101 <dt><i>ui</i> (UI.UserInterface)</dt> 127 <dt><i>ui</i> (UI.UserInterface)</dt>
102 <dd> 128 <dd>
103 reference to the user interface object 129 reference to the user interface object
104 </dd> 130 </dd>
105 </dl><a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a> 131 </dl>
132 <a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a>
106 <h4>MqttMonitorPlugin.__activateWidget</h4> 133 <h4>MqttMonitorPlugin.__activateWidget</h4>
107 <b>__activateWidget</b>(<i></i>) 134 <b>__activateWidget</b>(<i></i>)
135
108 <p> 136 <p>
109 Private slot to handle the activation of the MQTT Monitor. 137 Private slot to handle the activation of the MQTT Monitor.
110 </p><a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a> 138 </p>
139 <a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a>
111 <h4>MqttMonitorPlugin.__initialize</h4> 140 <h4>MqttMonitorPlugin.__initialize</h4>
112 <b>__initialize</b>(<i></i>) 141 <b>__initialize</b>(<i></i>)
142
113 <p> 143 <p>
114 Private slot to (re)initialize the plugin. 144 Private slot to (re)initialize the plugin.
115 </p><a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a> 145 </p>
146 <a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a>
116 <h4>MqttMonitorPlugin.__loadTranslator</h4> 147 <h4>MqttMonitorPlugin.__loadTranslator</h4>
117 <b>__loadTranslator</b>(<i></i>) 148 <b>__loadTranslator</b>(<i></i>)
149
118 <p> 150 <p>
119 Private method to load the translation file. 151 Private method to load the translation file.
120 </p><a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a> 152 </p>
153 <a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a>
121 <h4>MqttMonitorPlugin.activate</h4> 154 <h4>MqttMonitorPlugin.activate</h4>
122 <b>activate</b>(<i></i>) 155 <b>activate</b>(<i></i>)
156
123 <p> 157 <p>
124 Public method to activate this plug-in. 158 Public method to activate this plug-in.
125 </p><dl> 159 </p>
160 <dl>
126 <dt>Returns:</dt> 161 <dt>Returns:</dt>
127 <dd> 162 <dd>
128 tuple of None and activation status 163 tuple of None and activation status
129 </dd> 164 </dd>
130 </dl><dl> 165 </dl>
166 <dl>
131 <dt>Return Type:</dt> 167 <dt>Return Type:</dt>
132 <dd> 168 <dd>
133 bool 169 bool
134 </dd> 170 </dd>
135 </dl><a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a> 171 </dl>
172 <a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a>
136 <h4>MqttMonitorPlugin.deactivate</h4> 173 <h4>MqttMonitorPlugin.deactivate</h4>
137 <b>deactivate</b>(<i></i>) 174 <b>deactivate</b>(<i></i>)
175
138 <p> 176 <p>
139 Public method to deactivate this plug-in. 177 Public method to deactivate this plug-in.
140 </p><a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a> 178 </p>
179 <a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a>
141 <h4>MqttMonitorPlugin.getPreferences</h4> 180 <h4>MqttMonitorPlugin.getPreferences</h4>
142 <b>getPreferences</b>(<i>key</i>) 181 <b>getPreferences</b>(<i>key</i>)
182
143 <p> 183 <p>
144 Public method to retrieve the various settings. 184 Public method to retrieve the various settings.
145 </p><dl> 185 </p>
186 <dl>
187
146 <dt><i>key</i></dt> 188 <dt><i>key</i></dt>
147 <dd> 189 <dd>
148 the key of the value to get 190 the key of the value to get
149 </dd> 191 </dd>
150 </dl><dl> 192 </dl>
193 <dl>
151 <dt>Returns:</dt> 194 <dt>Returns:</dt>
152 <dd> 195 <dd>
153 the requested setting 196 the requested setting
154 </dd> 197 </dd>
155 </dl><a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a> 198 </dl>
199 <a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a>
156 <h4>MqttMonitorPlugin.setPreferences</h4> 200 <h4>MqttMonitorPlugin.setPreferences</h4>
157 <b>setPreferences</b>(<i>key, value</i>) 201 <b>setPreferences</b>(<i>key, value</i>)
202
158 <p> 203 <p>
159 Public method to store the various settings. 204 Public method to store the various settings.
160 </p><dl> 205 </p>
206 <dl>
207
161 <dt><i>key</i></dt> 208 <dt><i>key</i></dt>
162 <dd> 209 <dd>
163 the key of the setting to be set (string) 210 the key of the setting to be set (string)
164 </dd><dt><i>value</i></dt> 211 </dd>
212 <dt><i>value</i></dt>
165 <dd> 213 <dd>
166 the value to be set 214 the value to be set
167 </dd> 215 </dd>
168 </dl> 216 </dl>
169 <div align="right"><a href="#top">Up</a></div> 217 <div align="right"><a href="#top">Up</a></div>
170 <hr /><hr /> 218 <hr />
219 <hr />
171 <a NAME="exeDisplayData" ID="exeDisplayData"></a> 220 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
172 <h2>exeDisplayData</h2> 221 <h2>exeDisplayData</h2>
173 <b>exeDisplayData</b>(<i></i>) 222 <b>exeDisplayData</b>(<i></i>)
223
174 <p> 224 <p>
175 Module function to support the display of some executable info. 225 Module function to support the display of some executable info.
176 </p><dl> 226 </p>
227 <dl>
177 <dt>Returns:</dt> 228 <dt>Returns:</dt>
178 <dd> 229 <dd>
179 dictionary containing the data to query the presence of 230 dictionary containing the data to query the presence of
180 the executable 231 the executable
181 </dd> 232 </dd>
182 </dl><dl> 233 </dl>
234 <dl>
183 <dt>Return Type:</dt> 235 <dt>Return Type:</dt>
184 <dd> 236 <dd>
185 dict 237 dict
186 </dd> 238 </dd>
187 </dl> 239 </dl>
188 <div align="right"><a href="#top">Up</a></div> 240 <div align="right"><a href="#top">Up</a></div>
189 <hr /><hr /> 241 <hr />
242 <hr />
190 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 243 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
191 <h2>prepareUninstall</h2> 244 <h2>prepareUninstall</h2>
192 <b>prepareUninstall</b>(<i></i>) 245 <b>prepareUninstall</b>(<i></i>)
246
193 <p> 247 <p>
194 Module function to prepare for an uninstallation. 248 Module function to prepare for an uninstallation.
195 </p> 249 </p>
196 <div align="right"><a href="#top">Up</a></div> 250 <div align="right"><a href="#top">Up</a></div>
197 <hr /> 251 <hr />

Mercurial Repository: MQTT Monitor

eric ide

mercurial