src/eric7/Documentation/Source/eric7.Plugins.PluginAbout.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10064
8c3207703dac
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.PluginAbout</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.PluginAbout</h1>
10
11 <p>
12 Module implementing the About plugin.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <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>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#AboutPlugin">AboutPlugin</a></td>
25 <td>Class implementing the About plugin.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="AboutPlugin" ID="AboutPlugin"></a>
36 <h2>AboutPlugin</h2>
37
38 <p>
39 Class implementing the About plugin.
40 </p>
41 <h3>Derived from</h3>
42 QObject
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#AboutPlugin.__init__">AboutPlugin</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#AboutPlugin.__about">__about</a></td>
63 <td>Private slot to handle the About dialog.</td>
64 </tr>
65 <tr>
66 <td><a href="#AboutPlugin.__aboutQt">__aboutQt</a></td>
67 <td>Private slot to handle the About Qt dialog.</td>
68 </tr>
69 <tr>
70 <td><a href="#AboutPlugin.__initActions">__initActions</a></td>
71 <td>Private method to initialize the actions.</td>
72 </tr>
73 <tr>
74 <td><a href="#AboutPlugin.__initMenu">__initMenu</a></td>
75 <td>Private method to add the actions to the right menu.</td>
76 </tr>
77 <tr>
78 <td><a href="#AboutPlugin.activate">activate</a></td>
79 <td>Public method to activate this plugin.</td>
80 </tr>
81 <tr>
82 <td><a href="#AboutPlugin.deactivate">deactivate</a></td>
83 <td>Public method to deactivate this plugin.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91
92 <a NAME="AboutPlugin.__init__" ID="AboutPlugin.__init__"></a>
93 <h4>AboutPlugin (Constructor)</h4>
94 <b>AboutPlugin</b>(<i>ui</i>)
95
96 <p>
97 Constructor
98 </p>
99 <dl>
100
101 <dt><i>ui</i></dt>
102 <dd>
103 reference to the user interface object (UI.UserInterface)
104 </dd>
105 </dl>
106 <a NAME="AboutPlugin.__about" ID="AboutPlugin.__about"></a>
107 <h4>AboutPlugin.__about</h4>
108 <b>__about</b>(<i></i>)
109
110 <p>
111 Private slot to handle the About dialog.
112 </p>
113 <a NAME="AboutPlugin.__aboutQt" ID="AboutPlugin.__aboutQt"></a>
114 <h4>AboutPlugin.__aboutQt</h4>
115 <b>__aboutQt</b>(<i></i>)
116
117 <p>
118 Private slot to handle the About Qt dialog.
119 </p>
120 <a NAME="AboutPlugin.__initActions" ID="AboutPlugin.__initActions"></a>
121 <h4>AboutPlugin.__initActions</h4>
122 <b>__initActions</b>(<i></i>)
123
124 <p>
125 Private method to initialize the actions.
126 </p>
127 <a NAME="AboutPlugin.__initMenu" ID="AboutPlugin.__initMenu"></a>
128 <h4>AboutPlugin.__initMenu</h4>
129 <b>__initMenu</b>(<i></i>)
130
131 <p>
132 Private method to add the actions to the right menu.
133 </p>
134 <a NAME="AboutPlugin.activate" ID="AboutPlugin.activate"></a>
135 <h4>AboutPlugin.activate</h4>
136 <b>activate</b>(<i></i>)
137
138 <p>
139 Public method to activate this plugin.
140 </p>
141 <dl>
142 <dt>Return:</dt>
143 <dd>
144 tuple of None and activation status (boolean)
145 </dd>
146 </dl>
147 <a NAME="AboutPlugin.deactivate" ID="AboutPlugin.deactivate"></a>
148 <h4>AboutPlugin.deactivate</h4>
149 <b>deactivate</b>(<i></i>)
150
151 <p>
152 Public method to deactivate this plugin.
153 </p>
154 <div align="right"><a href="#top">Up</a></div>
155 <hr />
156 </body></html>

eric ide

mercurial