~ubuntu-branches/ubuntu/trusty/gobject-introspection/trusty

<a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> * <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-return-type" title="g_callable_info_get_return_type ()">g_callable_info_get_return_type</a> (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);

<pre class="synopsis">#define <a class="link" href="gi-GICallableInfo.html#GI-IS-CALLABLE-INFO:CAPS" title="GI_IS_CALLABLE_INFO()">GI_IS_CALLABLE_INFO</a> (info)

typedef <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo">GICallableInfo</a>;

<a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a> <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-caller-owns" title="g_callable_info_get_caller_owns ()">g_callable_info_get_caller_owns</a> (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);

<span class="returnvalue">gboolean</span> <a class="link" href="gi-GICallableInfo.html#g-callable-info-may-return-null" title="g_callable_info_may_return_null ()">g_callable_info_may_return_null</a> (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);

const <span class="returnvalue">gchar</span> * <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-return-attribute" title="g_callable_info_get_return_attribute ()">g_callable_info_get_return_attribute</a>

(<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);

<span class="returnvalue">gboolean</span> <a class="link" href="gi-GICallableInfo.html#g-callable-info-iterate-return-attributes" title="g_callable_info_iterate_return_attributes ()">g_callable_info_iterate_return_attributes</a>

(<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

<em class="parameter"><code><a class="link" href="gi-GIBaseInfo.html#GIAttributeIter" title="GIAttributeIter"><span class="type">GIAttributeIter</span></a> *iterator</code></em>,

<em class="parameter"><code><span class="type">char</span> **name</code></em>,

<em class="parameter"><code><span class="type">char</span> **value</code></em>);

<span class="returnvalue">gint</span> <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-n-args" title="g_callable_info_get_n_args ()">g_callable_info_get_n_args</a> (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);

<a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="returnvalue">GIArgInfo</span></a> * <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-arg" title="g_callable_info_get_arg ()">g_callable_info_get_arg</a> (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

<em class="parameter"><code><span class="type">gint</span> n</code></em>);

<span class="returnvalue">void</span> <a class="link" href="gi-GICallableInfo.html#g-callable-info-load-arg" title="g_callable_info_load_arg ()">g_callable_info_load_arg</a> (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

<em class="parameter"><code><span class="type">gint</span> n</code></em>,

<em class="parameter"><code><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a> *type</code></em>);

</pre>

</div>

<a name="gi-GICallableInfo.description"></a><h2>Description</h2>

<p>

GICallableInfo represents an entity which is callable.

Currently a function (<a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>), virtual function,

(<span class="type">GIVirtualFunc</span>) or callback (<a class="link" href="gi-girepository.html#GICallbackInfo" title="GICallbackInfo"><span class="type">GICallbackInfo</span></a>).

(<a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="type">GIVFuncInfo</span></a>) or callback (<a class="link" href="gi-girepository.html#GICallbackInfo" title="GICallbackInfo"><span class="type">GICallbackInfo</span></a>).

</p>

<p>

A callable has a list of arguments (<a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="type">GIArgInfo</span></a>), a return type,

direction and a flag which decides if it returns null.

</p>

</div>

<p>

</p>

<a name="gi-gicallableinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>

<a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>

+----GICallableInfo

+----<a class="link" href="gi-GIFunctionInfo.html" title="GIFunctionInfo">GIFunctionInfo</a>

+----<a class="link" href="gi-GISignalInfo.html" title="GISignalInfo">GISignalInfo</a>

+----<a class="link" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">GIVFuncInfo</a>

</pre>

</div>

<p>

</p>

</div>

<a name="gi-GICallableInfo.details"></a><h2>Details</h2>

<a name="GI-IS-CALLABLE-INFO:CAPS"></a><h3>GI_IS_CALLABLE_INFO()</h3>

<pre class="programlisting">#define GI_IS_CALLABLE_INFO(info)</pre>

<p>

</p>

</div>

<hr>

<a name="GICallableInfo"></a><h3>GICallableInfo</h3>

100

<pre class="programlisting">typedef GIBaseInfo GICallableInfo;

101

</pre>

102

<p>

103

Represents a callable, either <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>, <a class="link" href="gi-girepository.html#GICallbackInfo" title="GICallbackInfo"><span class="type">GICallbackInfo</span></a> or

<a class="link" href="gi-givfuncinfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="type">GIVFuncInfo</span></a>.

104

<a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="type">GIVFuncInfo</span></a>.

105

</p>

106

</div>

107

<hr>

108

109

<a name="g-callable-info-get-return-type"></a><h3>g_callable_info_get_return_type ()</h3>

<pre class="programlisting"><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> * g_callable_info_get_return_type (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>

110

111

<p>

112

Obtain the return type of a callable item as a <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>.

113

</p>

121

</tr>

122

<tr>

123

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>. Free the struct by calling

<a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done.. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. </td>

124

<td>the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>. Free the struct by calling

125

<a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>

126

</td>

127

</tr>

128

</tbody>

129

</table></div>

130

</div>

100

131

<hr>

101

132

102

133

<a name="g-callable-info-get-caller-owns"></a><h3>g_callable_info_get_caller_owns ()</h3>

103

134

<pre class="programlisting"><a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a> g_callable_info_get_caller_owns (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>

104

135

<p>

115

146

</tr>

116

147

<tr>

117

148

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

118

<td> <code class="literal">TRUE</code> if the caller owns the return value, <code class="literal">FALSE</code> otherwise.

119

</td>

149

<td>

150

<code class="literal">TRUE</code> if the caller owns the return value, <code class="literal">FALSE</code> otherwise.</td>

120

151

</tr>

121

152

</tbody>

122

153

</table></div>

123

154

</div>

124

155

<hr>

125

156

126

157

<a name="g-callable-info-may-return-null"></a><h3>g_callable_info_may_return_null ()</h3>

127

158

<pre class="programlisting"><span class="returnvalue">gboolean</span> g_callable_info_may_return_null (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>

128

159

<p>

138

169

</tr>

139

170

<tr>

140

171

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

141

<td> <code class="literal">TRUE</code> if callable could return <code class="literal">NULL</code>

142

</td>

143

</tr>

144

</tbody>

145

</table></div>

146

</div>

147

<hr>

148

172

<td>

173

<code class="literal">TRUE</code> if callable could return <code class="literal">NULL</code>

174

</td>

175

</tr>

176

</tbody>

177

</table></div>

178

</div>

179

<hr>

180

181

<a name="g-callable-info-get-return-attribute"></a><h3>g_callable_info_get_return_attribute ()</h3>

182

<pre class="programlisting">const <span class="returnvalue">gchar</span> * g_callable_info_get_return_attribute

183

(<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

184

<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>

185

<p>

186

Retrieve an arbitrary attribute associated with the return value.

187

</p>

188

189

190

<tbody>

191

<tr>

192

193

<td>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a>

194

</td>

195

</tr>

196

<tr>

197

198

<td>a freeform string naming an attribute</td>

199

</tr>

200

<tr>

201

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

202

<td>The value of the attribute, or <code class="literal">NULL</code> if no such attribute exists</td>

203

</tr>

204

</tbody>

205

</table></div>

206

</div>

207

<hr>

208

209

<a name="g-callable-info-iterate-return-attributes"></a><h3>g_callable_info_iterate_return_attributes ()</h3>

210

<pre class="programlisting"><span class="returnvalue">gboolean</span> g_callable_info_iterate_return_attributes

211

(<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

212

<em class="parameter"><code><a class="link" href="gi-GIBaseInfo.html#GIAttributeIter" title="GIAttributeIter"><span class="type">GIAttributeIter</span></a> *iterator</code></em>,

213

<em class="parameter"><code><span class="type">char</span> **name</code></em>,

214

<em class="parameter"><code><span class="type">char</span> **value</code></em>);</pre>

215

<p>

216

Iterate over all attributes associated with the return value. The

217

iterator structure is typically stack allocated, and must have its

218

first member initialized to <code class="literal">NULL</code>.

219

</p>

220

<p>

221

Both the <em class="parameter"><code>name</code></em> and <em class="parameter"><code>value</code></em> should be treated as constants

222

and must not be freed.

223

</p>

224

<p>

225

See <a class="link" href="gi-GIBaseInfo.html#g-base-info-iterate-attributes" title="g_base_info_iterate_attributes ()"><code class="function">g_base_info_iterate_attributes()</code></a> for an example of how to use a

226

similar API.

227

</p>

228

229

230

<tbody>

231

<tr>

232

233

<td>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a>

234

</td>

235

</tr>

236

<tr>

237

<td><p><span class="term"><em class="parameter"><code>iterator</code></em> :</span></p></td>

238

<td>a <a class="link" href="gi-GIBaseInfo.html#GIAttributeIter" title="GIAttributeIter"><span class="type">GIAttributeIter</span></a> structure, must be initialized; see below</td>

239

</tr>

240

<tr>

241

242

<td>Returned name, must not be freed. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>

243

</td>

244

</tr>

245

<tr>

246

<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>

247

248

</td>

249

</tr>

250

<tr>

251

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

252

<td>

253

<code class="literal">TRUE</code> if there are more attributes</td>

254

</tr>

255

</tbody>

256

</table></div>

257

</div>

258

<hr>

259

149

260

<a name="g-callable-info-get-n-args"></a><h3>g_callable_info_get_n_args ()</h3>

150

261

<pre class="programlisting"><span class="returnvalue">gint</span> g_callable_info_get_n_args (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>

151

262

<p>

161

272

</tr>

162

273

<tr>

163

274

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

164

<td> The number of arguments this callable expects.

165

</td>

275

<td>The number of arguments this callable expects.</td>

166

276

</tr>

167

277

</tbody>

168

278

</table></div>

169

279

</div>

170

280

<hr>

171

281

172

282

<a name="g-callable-info-get-arg"></a><h3>g_callable_info_get_arg ()</h3>

173

<pre class="programlisting"><a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="returnvalue">GIArgInfo</span></a> * g_callable_info_get_arg (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

283

174

284

175

285

<p>

176

286

Obtain information about a particular argument of this callable.

185

295

</tr>

186

296

<tr>

187

297

188

<td>the argument index to fetch

189

</td>

298

<td>the argument index to fetch</td>

190

299

</tr>

191

300

<tr>

192

301

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

193

<td> the <a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="type">GIArgInfo</span></a>. Free it with

194

302

<td>the <a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="type">GIArgInfo</span></a>. Free it with

303

304

</td>

195

305

</tr>

196

306

</tbody>

197

307

</table></div>

198

308

</div>

199

309

<hr>

200

310

201

311

<a name="g-callable-info-load-arg"></a><h3>g_callable_info_load_arg ()</h3>

202

312

<pre class="programlisting"><span class="returnvalue">void</span> g_callable_info_load_arg (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

203

313

<em class="parameter"><code><span class="type">gint</span> n</code></em>,

220

330

</tr>

221

331

<tr>

222

332

223

<td>the argument index to fetch

224

</td>

333

<td>the argument index to fetch</td>

225

334

</tr>

226

335

<tr>

227

336

228

<td> Initialize with argument number <em class="parameter"><code>n</code></em>. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates. </td>

337

<td>Initialize with argument number <em class="parameter"><code>n</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates]</span>

338

</td>

229

339

</tr>

230

340

</tbody>

231

341

</table></div>

232

342

</div>

233

343

<hr>

234

344

235

345

<a name="g-callable-info-load-return-type"></a><h3>g_callable_info_load_return_type ()</h3>

236

346

<pre class="programlisting"><span class="returnvalue">void</span> g_callable_info_load_return_type (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,

237

347

<em class="parameter"><code><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a> *type</code></em>);</pre>

253

363

</tr>

254

364

<tr>

255

365

256

<td> Initialized with return type of <em class="parameter"><code>info</code></em>. <acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates. </td>

366

<td>Initialized with return type of <em class="parameter"><code>info</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym> caller-allocates]</span>

367

</td>

257

368

</tr>

258

369

</tbody>

259

370

</table></div>

262

373

</div>

263

374

264

375

<hr>

265

Generated by GTK-Doc V1.14</div>

376

Generated by GTK-Doc V1.16.1</div>

266

377

</body>

267

378

</html>

b'\\ No newline at end of file'

Older »