Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.QScintilla.APIsManager.html

Documentation/Source/eric5.QScintilla.APIsManager.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.QScintilla.APIsManager</h1> 23 <h1>eric5.QScintilla.APIsManager</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#65;&#80;&#73;&#115;&#77;&#97;&#110;&#97;&#103;&#101;&#114;. 25 Module implementing the APIsManager.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#APIs">APIs</a></td> 34 <td><a href="#APIs">APIs</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#65;&#80;&#73; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#101;&#110;&#116;&#105;&#116;y.</td> 35 <td>Class implementing an API storage entity.</td>
36 </tr><tr> 36 </tr><tr>
37 <td><a href="#APIsManager">APIsManager</a></td> 37 <td><a href="#APIsManager">APIsManager</a></td>
38 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#65;&#80;&#73;&#115;&#77;&#97;&#110;&#97;&#103;&#101;&#114; &#99;&#108;&#97;&#115;&#115;, w&#104;&#105;&#99;&#104; &#105;&#115; &#116;&#104;&#101; &#99;&#101;&#110;&#116;&#114;&#97;&#108; &#115;&#116;&#111;&#114;&#101; &#102;&#111;&#114; &#65;&#80;&#73; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; &#98;y &#97;&#117;&#116;&#111;&#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110; &#97;&#110;&#100; &#99;&#97;&#108;&#108;&#116;&#105;&#112;&#115;.</td> 38 <td>Class implementing the APIsManager class, which is the central store for API information used by autocompletion and calltips.</td>
39 </tr> 39 </tr>
40 </table> 40 </table>
41 <h3>Functions</h3> 41 <h3>Functions</h3>
42 <table> 42 <table>
43 <tr><td>None</td></tr> 43 <tr><td>None</td></tr>
44 </table> 44 </table>
45 <hr /><hr /> 45 <hr /><hr />
46 <a NAME="APIs" ID="APIs"></a> 46 <a NAME="APIs" ID="APIs"></a>
47 <h2>APIs</h2> 47 <h2>APIs</h2>
48 <p> 48 <p>
49 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97;&#110; &#65;&#80;&#73; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#101;&#110;&#116;&#105;&#116;y. 49 Class implementing an API storage entity.
50 </p><h4>Signals</h4> 50 </p><h4>Signals</h4>
51 <dl> 51 <dl>
52 <dt>apiPreparationCancelled()</dt> 52 <dt>apiPreparationCancelled()</dt>
53 <dd> 53 <dd>
54 &#101;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#101;&#100; 54 emitted after the API preparation has been cancelled
55 </dd><dt>apiPreparationFinished()</dt> 55 </dd><dt>apiPreparationFinished()</dt>
56 <dd> 56 <dd>
57 &#101;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#104;&#97;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100; 57 emitted after the API preparation has finished
58 </dd><dt>apiPreparationStarted()</dt> 58 </dd><dt>apiPreparationStarted()</dt>
59 <dd> 59 <dd>
60 &#101;&#109;&#105;&#116;&#116;&#101;&#100; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#104;&#97;&#115; &#115;&#116;&#97;&#114;&#116;&#101;&#100; 60 emitted after the API preparation has started
61 </dd> 61 </dd>
62 </dl> 62 </dl>
63 <h3>Derived from</h3> 63 <h3>Derived from</h3>
64 QObject 64 QObject
65 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
68 </table> 68 </table>
69 <h3>Methods</h3> 69 <h3>Methods</h3>
70 <table> 70 <table>
71 <tr> 71 <tr>
72 <td><a href="#APIs.__init__">APIs</a></td> 72 <td><a href="#APIs.__init__">APIs</a></td>
73 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 73 <td>Constructor</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td> 75 <td><a href="#APIs.__apiPreparationCancelled">__apiPreparationCancelled</a></td>
76 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100;, &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#101;&#100;.</td> 76 <td>Private method called, after the API preparation process has been cancelled.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td> 78 <td><a href="#APIs.__apiPreparationFinished">__apiPreparationFinished</a></td>
79 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#115;&#97;v&#101; &#97;&#110; &#65;&#80;&#73;, &#97;&#102;&#116;&#101;&#114; &#105;&#116; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#112;&#114;&#101;&#112;&#97;&#114;&#101;&#100;.</td> 79 <td>Private method called to save an API, after it has been prepared.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td> 81 <td><a href="#APIs.__apiPreparationStarted">__apiPreparationStarted</a></td>
82 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#115;&#116;&#97;&#114;&#116;&#101;&#100;.</td> 82 <td>Private method called, when the API preparation process started.</td>
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#APIs.__defaultPreparedName">__defaultPreparedName</a></td> 84 <td><a href="#APIs.__defaultPreparedName">__defaultPreparedName</a></td>
85 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#110;&#97;&#109;&#101; &#111;&#102; &#97; &#112;&#114;&#101;&#112;&#97;&#114;&#101;&#100; &#65;&#80;&#73; &#102;&#105;&#108;&#101;.</td> 85 <td>Private method returning the default name of a prepared API file.</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td> 87 <td><a href="#APIs.__loadAPIs">__loadAPIs</a></td>
88 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#108;&#111;&#97;&#100; &#116;&#104;&#101; &#65;&#80;&#73;&#115;.</td> 88 <td>Private method to load the APIs.</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td> 90 <td><a href="#APIs.cancelPreparation">cancelPreparation</a></td>
91 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#99;&#97;&#110;&#99;&#101;&#108; &#116;&#104;&#101; &#65;&#80;&#73;&#115; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110;.</td> 91 <td>Public slot to cancel the APIs preparation.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td> 93 <td><a href="#APIs.getQsciAPIs">getQsciAPIs</a></td>
94 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#81;&#115;&#99;&#105;&#65;&#80;&#73;&#115; &#111;&#98;&#106;&#101;&#99;&#116;.</td> 94 <td>Public method to get a reference to QsciAPIs object.</td>
95 </tr><tr> 95 </tr><tr>
96 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td> 96 <td><a href="#APIs.installedAPIFiles">installedAPIFiles</a></td>
97 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#101;&#100; &#65;&#80;&#73; &#102;&#105;&#108;&#101;&#115;.</td> 97 <td>Public method to get a list of installed API files.</td>
98 </tr><tr> 98 </tr><tr>
99 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td> 99 <td><a href="#APIs.prepareAPIs">prepareAPIs</a></td>
100 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#116;&#104;&#101; &#65;&#80;&#73;&#115; &#105;&#102; &#110;&#101;&#99;&#101;&#115;&#115;&#97;&#114;y.</td> 100 <td>Public method to prepare the APIs if necessary.</td>
101 </tr><tr> 101 </tr><tr>
102 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td> 102 <td><a href="#APIs.reloadAPIs">reloadAPIs</a></td>
103 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#108;&#111;&#97;&#100; &#116;&#104;&#101; &#65;&#80;&#73; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td> 103 <td>Public method to reload the API information.</td>
104 </tr> 104 </tr>
105 </table> 105 </table>
106 <a NAME="APIs.__init__" ID="APIs.__init__"></a> 106 <a NAME="APIs.__init__" ID="APIs.__init__"></a>
107 <h4>APIs (Constructor)</h4> 107 <h4>APIs (Constructor)</h4>
108 <b>APIs</b>(<i>language, forPreparation = False, parent = None</i>) 108 <b>APIs</b>(<i>language, forPreparation = False, parent = None</i>)
109 <p> 109 <p>
110 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 110 Constructor
111 </p><dl> 111 </p><dl>
112 <dt><i>language</i></dt> 112 <dt><i>language</i></dt>
113 <dd> 113 <dd>
114 &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#65;&#80;&#73;&#115; &#111;&#98;&#106;&#101;&#99;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;) 114 language of the APIs object (string)
115 </dd><dt><i>forPreparation</i></dt> 115 </dd><dt><i>forPreparation</i></dt>
116 <dd> 116 <dd>
117 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#105;&#115; &#111;&#98;&#106;&#101;&#99;&#116; &#105;&#115; &#106;&#117;&#115;&#116; &#110;&#101;&#101;&#100;&#101;&#100; 117 flag indicating this object is just needed
118 &#102;&#111;&#114; &#97; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 118 for a preparation process (boolean)
119 </dd><dt><i>parent</i></dt> 119 </dd><dt><i>parent</i></dt>
120 <dd> 120 <dd>
121 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;) 121 reference to the parent object (QObject)
122 </dd> 122 </dd>
123 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a> 123 </dl><a NAME="APIs.__apiPreparationCancelled" ID="APIs.__apiPreparationCancelled"></a>
124 <h4>APIs.__apiPreparationCancelled</h4> 124 <h4>APIs.__apiPreparationCancelled</h4>
125 <b>__apiPreparationCancelled</b>(<i></i>) 125 <b>__apiPreparationCancelled</b>(<i></i>)
126 <p> 126 <p>
127 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100;, &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#99;&#97;&#110;&#99;&#101;&#108;&#108;&#101;&#100;. 127 Private method called, after the API preparation process has been cancelled.
128 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a> 128 </p><a NAME="APIs.__apiPreparationFinished" ID="APIs.__apiPreparationFinished"></a>
129 <h4>APIs.__apiPreparationFinished</h4> 129 <h4>APIs.__apiPreparationFinished</h4>
130 <b>__apiPreparationFinished</b>(<i></i>) 130 <b>__apiPreparationFinished</b>(<i></i>)
131 <p> 131 <p>
132 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#115;&#97;v&#101; &#97;&#110; &#65;&#80;&#73;, &#97;&#102;&#116;&#101;&#114; &#105;&#116; &#104;&#97;&#115; &#98;&#101;&#101;&#110; &#112;&#114;&#101;&#112;&#97;&#114;&#101;&#100;. 132 Private method called to save an API, after it has been prepared.
133 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a> 133 </p><a NAME="APIs.__apiPreparationStarted" ID="APIs.__apiPreparationStarted"></a>
134 <h4>APIs.__apiPreparationStarted</h4> 134 <h4>APIs.__apiPreparationStarted</h4>
135 <b>__apiPreparationStarted</b>(<i></i>) 135 <b>__apiPreparationStarted</b>(<i></i>)
136 <p> 136 <p>
137 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#65;&#80;&#73; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#115;&#116;&#97;&#114;&#116;&#101;&#100;. 137 Private method called, when the API preparation process started.
138 </p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a> 138 </p><a NAME="APIs.__defaultPreparedName" ID="APIs.__defaultPreparedName"></a>
139 <h4>APIs.__defaultPreparedName</h4> 139 <h4>APIs.__defaultPreparedName</h4>
140 <b>__defaultPreparedName</b>(<i></i>) 140 <b>__defaultPreparedName</b>(<i></i>)
141 <p> 141 <p>
142 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#110;&#97;&#109;&#101; &#111;&#102; &#97; &#112;&#114;&#101;&#112;&#97;&#114;&#101;&#100; &#65;&#80;&#73; &#102;&#105;&#108;&#101;. 142 Private method returning the default name of a prepared API file.
143 </p><dl> 143 </p><dl>
144 <dt>Returns:</dt> 144 <dt>Returns:</dt>
145 <dd> 145 <dd>
146 &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#80;&#114;&#101;&#112;&#97;&#114;&#101;&#100; &#65;&#80;&#73;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 146 complete filename for the Prepared APIs file (string)
147 </dd> 147 </dd>
148 </dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a> 148 </dl><a NAME="APIs.__loadAPIs" ID="APIs.__loadAPIs"></a>
149 <h4>APIs.__loadAPIs</h4> 149 <h4>APIs.__loadAPIs</h4>
150 <b>__loadAPIs</b>(<i></i>) 150 <b>__loadAPIs</b>(<i></i>)
151 <p> 151 <p>
152 &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#108;&#111;&#97;&#100; &#116;&#104;&#101; &#65;&#80;&#73;&#115;. 152 Private method to load the APIs.
153 </p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a> 153 </p><a NAME="APIs.cancelPreparation" ID="APIs.cancelPreparation"></a>
154 <h4>APIs.cancelPreparation</h4> 154 <h4>APIs.cancelPreparation</h4>
155 <b>cancelPreparation</b>(<i></i>) 155 <b>cancelPreparation</b>(<i></i>)
156 <p> 156 <p>
157 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#99;&#97;&#110;&#99;&#101;&#108; &#116;&#104;&#101; &#65;&#80;&#73;&#115; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110;. 157 Public slot to cancel the APIs preparation.
158 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a> 158 </p><a NAME="APIs.getQsciAPIs" ID="APIs.getQsciAPIs"></a>
159 <h4>APIs.getQsciAPIs</h4> 159 <h4>APIs.getQsciAPIs</h4>
160 <b>getQsciAPIs</b>(<i></i>) 160 <b>getQsciAPIs</b>(<i></i>)
161 <p> 161 <p>
162 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#81;&#115;&#99;&#105;&#65;&#80;&#73;&#115; &#111;&#98;&#106;&#101;&#99;&#116;. 162 Public method to get a reference to QsciAPIs object.
163 </p><dl> 163 </p><dl>
164 <dt>Returns:</dt> 164 <dt>Returns:</dt>
165 <dd> 165 <dd>
166 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#81;&#115;&#99;&#105;&#65;&#80;&#73;&#115; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#115;&#99;&#105;&#65;&#80;&#73;&#115;) 166 reference to the QsciAPIs object (QsciAPIs)
167 </dd> 167 </dd>
168 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a> 168 </dl><a NAME="APIs.installedAPIFiles" ID="APIs.installedAPIFiles"></a>
169 <h4>APIs.installedAPIFiles</h4> 169 <h4>APIs.installedAPIFiles</h4>
170 <b>installedAPIFiles</b>(<i></i>) 170 <b>installedAPIFiles</b>(<i></i>)
171 <p> 171 <p>
172 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#101;&#100; &#65;&#80;&#73; &#102;&#105;&#108;&#101;&#115;. 172 Public method to get a list of installed API files.
173 </p><dl> 173 </p><dl>
174 <dt>Returns:</dt> 174 <dt>Returns:</dt>
175 <dd> 175 <dd>
176 &#108;&#105;&#115;&#116; &#111;&#102; &#105;&#110;&#115;&#116;&#97;&#108;&#108;&#101;&#100; &#65;&#80;&#73; &#102;&#105;&#108;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 176 list of installed API files (list of strings)
177 </dd> 177 </dd>
178 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a> 178 </dl><a NAME="APIs.prepareAPIs" ID="APIs.prepareAPIs"></a>
179 <h4>APIs.prepareAPIs</h4> 179 <h4>APIs.prepareAPIs</h4>
180 <b>prepareAPIs</b>(<i>ondemand = False, rawList = None</i>) 180 <b>prepareAPIs</b>(<i>ondemand = False, rawList = None</i>)
181 <p> 181 <p>
182 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#116;&#104;&#101; &#65;&#80;&#73;&#115; &#105;&#102; &#110;&#101;&#99;&#101;&#115;&#115;&#97;&#114;y. 182 Public method to prepare the APIs if necessary.
183 </p><dl> 183 </p><dl>
184 <dt><i>ondemand=</i></dt> 184 <dt><i>ondemand=</i></dt>
185 <dd> 185 <dd>
186 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 186 flag indicating a requested preparation (boolean)
187 </dd><dt><i>rawList=</i></dt> 187 </dd><dt><i>rawList=</i></dt>
188 <dd> 188 <dd>
189 &#108;&#105;&#115;&#116; &#111;&#102; &#114;&#97;w &#65;&#80;&#73; &#102;&#105;&#108;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;) 189 list of raw API files (list of strings)
190 </dd> 190 </dd>
191 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a> 191 </dl><a NAME="APIs.reloadAPIs" ID="APIs.reloadAPIs"></a>
192 <h4>APIs.reloadAPIs</h4> 192 <h4>APIs.reloadAPIs</h4>
193 <b>reloadAPIs</b>(<i></i>) 193 <b>reloadAPIs</b>(<i></i>)
194 <p> 194 <p>
195 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#108;&#111;&#97;&#100; &#116;&#104;&#101; &#65;&#80;&#73; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;. 195 Public method to reload the API information.
196 </p> 196 </p>
197 <div align="right"><a href="#top">Up</a></div> 197 <div align="right"><a href="#top">Up</a></div>
198 <hr /><hr /> 198 <hr /><hr />
199 <a NAME="APIsManager" ID="APIsManager"></a> 199 <a NAME="APIsManager" ID="APIsManager"></a>
200 <h2>APIsManager</h2> 200 <h2>APIsManager</h2>
201 <p> 201 <p>
202 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#65;&#80;&#73;&#115;&#77;&#97;&#110;&#97;&#103;&#101;&#114; &#99;&#108;&#97;&#115;&#115;, w&#104;&#105;&#99;&#104; &#105;&#115; &#116;&#104;&#101; &#99;&#101;&#110;&#116;&#114;&#97;&#108; &#115;&#116;&#111;&#114;&#101; &#102;&#111;&#114; 202 Class implementing the APIsManager class, which is the central store for
203 &#65;&#80;&#73; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#117;&#115;&#101;&#100; &#98;y &#97;&#117;&#116;&#111;&#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110; &#97;&#110;&#100; &#99;&#97;&#108;&#108;&#116;&#105;&#112;&#115;. 203 API information used by autocompletion and calltips.
204 </p> 204 </p>
205 <h3>Derived from</h3> 205 <h3>Derived from</h3>
206 QObject 206 QObject
207 <h3>Class Attributes</h3> 207 <h3>Class Attributes</h3>
208 <table> 208 <table>
210 </table> 210 </table>
211 <h3>Methods</h3> 211 <h3>Methods</h3>
212 <table> 212 <table>
213 <tr> 213 <tr>
214 <td><a href="#APIsManager.__init__">APIsManager</a></td> 214 <td><a href="#APIsManager.__init__">APIsManager</a></td>
215 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 215 <td>Constructor</td>
216 </tr><tr> 216 </tr><tr>
217 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> 217 <td><a href="#APIsManager.getAPIs">getAPIs</a></td>
218 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97;&#110; &#97;&#112;&#105;&#115; &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; &#97;&#117;&#116;&#111;&#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110;/&#99;&#97;&#108;&#108;&#116;&#105;&#112;&#115;.</td> 218 <td>Public method to get an apis object for autocompletion/calltips.</td>
219 </tr><tr> 219 </tr><tr>
220 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td> 220 <td><a href="#APIsManager.reloadAPIs">reloadAPIs</a></td>
221 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#108;&#111;&#97;&#100; &#116;&#104;&#101; &#97;&#112;&#105; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;.</td> 221 <td>Public slot to reload the api information.</td>
222 </tr> 222 </tr>
223 </table> 223 </table>
224 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a> 224 <a NAME="APIsManager.__init__" ID="APIsManager.__init__"></a>
225 <h4>APIsManager (Constructor)</h4> 225 <h4>APIsManager (Constructor)</h4>
226 <b>APIsManager</b>(<i>parent = None</i>) 226 <b>APIsManager</b>(<i>parent = None</i>)
227 <p> 227 <p>
228 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 228 Constructor
229 </p><dl> 229 </p><dl>
230 <dt><i>parent</i></dt> 230 <dt><i>parent</i></dt>
231 <dd> 231 <dd>
232 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;) 232 reference to the parent object (QObject)
233 </dd> 233 </dd>
234 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a> 234 </dl><a NAME="APIsManager.getAPIs" ID="APIsManager.getAPIs"></a>
235 <h4>APIsManager.getAPIs</h4> 235 <h4>APIsManager.getAPIs</h4>
236 <b>getAPIs</b>(<i>language, forPreparation = False</i>) 236 <b>getAPIs</b>(<i>language, forPreparation = False</i>)
237 <p> 237 <p>
238 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97;&#110; &#97;&#112;&#105;&#115; &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; &#97;&#117;&#116;&#111;&#99;&#111;&#109;&#112;&#108;&#101;&#116;&#105;&#111;&#110;/&#99;&#97;&#108;&#108;&#116;&#105;&#112;&#115;. 238 Public method to get an apis object for autocompletion/calltips.
239 </p><p> 239 </p><p>
240 &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#114;&#101;&#97;&#116;&#101;&#115; &#97;&#110;&#100; &#108;&#111;&#97;&#100;&#115; &#97;&#110; &#65;&#80;&#73;&#115; &#111;&#98;&#106;&#101;&#99;&#116; &#100;y&#110;&#97;&#109;&#105;&#99;&#97;&#108;&#108;y &#117;&#112;&#111;&#110; &#114;&#101;&#113;&#117;&#101;&#115;&#116;. 240 This method creates and loads an APIs object dynamically upon request.
241 &#84;&#104;&#105;&#115; &#115;&#97;v&#101;&#115; &#109;&#101;&#109;&#111;&#114;y &#102;&#111;&#114; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;&#115;, &#116;&#104;&#97;&#116; &#109;&#105;&#103;&#104;&#116; &#110;&#111;&#116; &#98;&#101; &#110;&#101;&#101;&#100;&#101;&#100; &#97;&#116; &#116;&#104;&#101; &#109;&#111;&#109;&#101;&#110;&#116;. 241 This saves memory for languages, that might not be needed at the moment.
242 </p><dl> 242 </p><dl>
243 <dt><i>language</i></dt> 243 <dt><i>language</i></dt>
244 <dd> 244 <dd>
245 &#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#97;&#112;&#105; &#111;&#98;&#106;&#101;&#99;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;) 245 the language of the requested api object (string)
246 </dd><dt><i>forPreparation</i></dt> 246 </dd><dt><i>forPreparation</i></dt>
247 <dd> 247 <dd>
248 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#97;&#112;&#105; &#111;&#98;&#106;&#101;&#99;&#116; &#105;&#115; &#106;&#117;&#115;&#116; &#110;&#101;&#101;&#100;&#101;&#100; 248 flag indicating the requested api object is just needed
249 &#102;&#111;&#114; &#97; &#112;&#114;&#101;&#112;&#97;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 249 for a preparation process (boolean)
250 </dd> 250 </dd>
251 </dl><dl> 251 </dl><dl>
252 <dt>Returns:</dt> 252 <dt>Returns:</dt>
253 <dd> 253 <dd>
254 &#116;&#104;&#101; &#97;&#112;&#105;&#115; &#111;&#98;&#106;&#101;&#99;&#116; (&#65;&#80;&#73;&#115;) 254 the apis object (APIs)
255 </dd> 255 </dd>
256 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a> 256 </dl><a NAME="APIsManager.reloadAPIs" ID="APIsManager.reloadAPIs"></a>
257 <h4>APIsManager.reloadAPIs</h4> 257 <h4>APIsManager.reloadAPIs</h4>
258 <b>reloadAPIs</b>(<i></i>) 258 <b>reloadAPIs</b>(<i></i>)
259 <p> 259 <p>
260 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#108;&#111;&#97;&#100; &#116;&#104;&#101; &#97;&#112;&#105; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110;. 260 Public slot to reload the api information.
261 </p> 261 </p>
262 <div align="right"><a href="#top">Up</a></div> 262 <div align="right"><a href="#top">Up</a></div>
263 <hr /> 263 <hr />
264 </body></html> 264 </body></html>

Mercurial Repository: eric

eric ide

mercurial