Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.PluginEricapi.html

eric6/Documentation/Source/eric6.Plugins.PluginEricapi.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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>eric6.Plugins.PluginEricapi</h1> 23 <h1>eric6.Plugins.PluginEricapi</h1>
24
23 <p> 25 <p>
24 Module implementing the Ericapi plugin. 26 Module implementing the Ericapi plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
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>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 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>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>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#EricapiPlugin">EricapiPlugin</a></td> 38 <td><a href="#EricapiPlugin">EricapiPlugin</a></td>
34 <td>Class implementing the Ericapi plugin.</td> 39 <td>Class implementing the Ericapi plugin.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 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>Public method to support the display of some executable info.</td> 48 <td>Public method to support the display of some executable info.</td>
42 </tr> 49 </tr>
43 </table> 50 </table>
44 <hr /><hr /> 51 <hr />
52 <hr />
45 <a NAME="EricapiPlugin" ID="EricapiPlugin"></a> 53 <a NAME="EricapiPlugin" ID="EricapiPlugin"></a>
46 <h2>EricapiPlugin</h2> 54 <h2>EricapiPlugin</h2>
55
47 <p> 56 <p>
48 Class implementing the Ericapi plugin. 57 Class implementing the Ericapi plugin.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 QObject 60 QObject
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
72
61 <table> 73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#EricapiPlugin.__init__">EricapiPlugin</a></td> 76 <td><a href="#EricapiPlugin.__init__">EricapiPlugin</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#EricapiPlugin.__doEricapi">__doEricapi</a></td> 80 <td><a href="#EricapiPlugin.__doEricapi">__doEricapi</a></td>
67 <td>Private slot to perform the eric6_api api generation.</td> 81 <td>Private slot to perform the eric6_api api generation.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#EricapiPlugin.__initialize">__initialize</a></td> 84 <td><a href="#EricapiPlugin.__initialize">__initialize</a></td>
70 <td>Private slot to (re)initialize the plugin.</td> 85 <td>Private slot to (re)initialize the plugin.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#EricapiPlugin.__projectShowMenu">__projectShowMenu</a></td> 88 <td><a href="#EricapiPlugin.__projectShowMenu">__projectShowMenu</a></td>
73 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> 89 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#EricapiPlugin.activate">activate</a></td> 92 <td><a href="#EricapiPlugin.activate">activate</a></td>
76 <td>Public method to activate this plugin.</td> 93 <td>Public method to activate this plugin.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#EricapiPlugin.deactivate">deactivate</a></td> 96 <td><a href="#EricapiPlugin.deactivate">deactivate</a></td>
79 <td>Public method to deactivate this plugin.</td> 97 <td>Public method to deactivate this plugin.</td>
80 </tr> 98 </tr>
81 </table> 99 </table>
82 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
101
83 <table> 102 <table>
84 <tr><td>None</td></tr> 103 <tr><td>None</td></tr>
85 </table> 104 </table>
105
86 <a NAME="EricapiPlugin.__init__" ID="EricapiPlugin.__init__"></a> 106 <a NAME="EricapiPlugin.__init__" ID="EricapiPlugin.__init__"></a>
87 <h4>EricapiPlugin (Constructor)</h4> 107 <h4>EricapiPlugin (Constructor)</h4>
88 <b>EricapiPlugin</b>(<i>ui</i>) 108 <b>EricapiPlugin</b>(<i>ui</i>)
109
89 <p> 110 <p>
90 Constructor 111 Constructor
91 </p><dl> 112 </p>
113 <dl>
114
92 <dt><i>ui</i></dt> 115 <dt><i>ui</i></dt>
93 <dd> 116 <dd>
94 reference to the user interface object (UI.UserInterface) 117 reference to the user interface object (UI.UserInterface)
95 </dd> 118 </dd>
96 </dl><a NAME="EricapiPlugin.__doEricapi" ID="EricapiPlugin.__doEricapi"></a> 119 </dl>
120 <a NAME="EricapiPlugin.__doEricapi" ID="EricapiPlugin.__doEricapi"></a>
97 <h4>EricapiPlugin.__doEricapi</h4> 121 <h4>EricapiPlugin.__doEricapi</h4>
98 <b>__doEricapi</b>(<i></i>) 122 <b>__doEricapi</b>(<i></i>)
123
99 <p> 124 <p>
100 Private slot to perform the eric6_api api generation. 125 Private slot to perform the eric6_api api generation.
101 </p><a NAME="EricapiPlugin.__initialize" ID="EricapiPlugin.__initialize"></a> 126 </p>
127 <a NAME="EricapiPlugin.__initialize" ID="EricapiPlugin.__initialize"></a>
102 <h4>EricapiPlugin.__initialize</h4> 128 <h4>EricapiPlugin.__initialize</h4>
103 <b>__initialize</b>(<i></i>) 129 <b>__initialize</b>(<i></i>)
130
104 <p> 131 <p>
105 Private slot to (re)initialize the plugin. 132 Private slot to (re)initialize the plugin.
106 </p><a NAME="EricapiPlugin.__projectShowMenu" ID="EricapiPlugin.__projectShowMenu"></a> 133 </p>
134 <a NAME="EricapiPlugin.__projectShowMenu" ID="EricapiPlugin.__projectShowMenu"></a>
107 <h4>EricapiPlugin.__projectShowMenu</h4> 135 <h4>EricapiPlugin.__projectShowMenu</h4>
108 <b>__projectShowMenu</b>(<i>menuName, menu</i>) 136 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
137
109 <p> 138 <p>
110 Private slot called, when the the project menu or a submenu is 139 Private slot called, when the the project menu or a submenu is
111 about to be shown. 140 about to be shown.
112 </p><dl> 141 </p>
142 <dl>
143
113 <dt><i>menuName</i></dt> 144 <dt><i>menuName</i></dt>
114 <dd> 145 <dd>
115 name of the menu to be shown (string) 146 name of the menu to be shown (string)
116 </dd><dt><i>menu</i></dt> 147 </dd>
148 <dt><i>menu</i></dt>
117 <dd> 149 <dd>
118 reference to the menu (QMenu) 150 reference to the menu (QMenu)
119 </dd> 151 </dd>
120 </dl><a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a> 152 </dl>
153 <a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a>
121 <h4>EricapiPlugin.activate</h4> 154 <h4>EricapiPlugin.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 plugin. 158 Public method to activate this plugin.
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 (boolean) 163 tuple of None and activation status (boolean)
129 </dd> 164 </dd>
130 </dl><a NAME="EricapiPlugin.deactivate" ID="EricapiPlugin.deactivate"></a> 165 </dl>
166 <a NAME="EricapiPlugin.deactivate" ID="EricapiPlugin.deactivate"></a>
131 <h4>EricapiPlugin.deactivate</h4> 167 <h4>EricapiPlugin.deactivate</h4>
132 <b>deactivate</b>(<i></i>) 168 <b>deactivate</b>(<i></i>)
169
133 <p> 170 <p>
134 Public method to deactivate this plugin. 171 Public method to deactivate this plugin.
135 </p> 172 </p>
136 <div align="right"><a href="#top">Up</a></div> 173 <div align="right"><a href="#top">Up</a></div>
137 <hr /><hr /> 174 <hr />
175 <hr />
138 <a NAME="exeDisplayData" ID="exeDisplayData"></a> 176 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
139 <h2>exeDisplayData</h2> 177 <h2>exeDisplayData</h2>
140 <b>exeDisplayData</b>(<i></i>) 178 <b>exeDisplayData</b>(<i></i>)
179
141 <p> 180 <p>
142 Public method to support the display of some executable info. 181 Public method to support the display of some executable info.
143 </p><dl> 182 </p>
183 <dl>
144 <dt>Returns:</dt> 184 <dt>Returns:</dt>
145 <dd> 185 <dd>
146 dictionary containing the data to query the presence of 186 dictionary containing the data to query the presence of
147 the executable 187 the executable
148 </dd> 188 </dd>

Mercurial Repository: eric

eric ide

mercurial