summaryrefslogtreecommitdiff
path: root/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.callback_function.page
blob: 53f5861d3f08f42f3b2da62a1268e795e9c155f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?xml version="1.0"?>
<page id="DocExamples.callback_function"
      type="topic"
      style="function"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    
    <link type="guide" xref="index" group="function"/>
    <api:function>
      <api:returns>
        <api:type>DocExamples.Enum</api:type>
      </api:returns>
      <api:name>doc_examples_callback_function</api:name>
      <api:arg>
        <api:type>DocExamples.Callback</api:type>
        <api:name>callback</api:name>
      </api:arg>
      <api:arg>
        <api:type>gpointer</api:type>
        <api:name>user_data</api:name>
      </api:arg>
      <api:arg>
        <api:type>GLib.DestroyNotify</api:type>
        <api:name>destroy_notify</api:name>
      </api:arg>
    </api:function>

  </info>
  <title>callback_function</title>
  
<synopsis><code mime="text/x-python">
@accepts(DocExamples.Callback, gpointer, GLib.DestroyNotify)
@returns(DocExamples.Enum)
def callback_function(callback, user_data, destroy_notify):
    # Python wrapper for doc_examples_callback_function()
</code></synopsis>

  
    <p>This is a function that takes a callback. Different languages
will expose this in different ways (e.g. Python keeps the
<code>user_data</code> parameter, while JS doesn't)</p>
  
  
  
  
<dl>
<dt><p>callback :</p></dt>
<dd><p>Just Call Me Maybe</p></dd>
<dt><p>user_data :</p></dt>
<dd><p>your stuff</p></dd>
<dt><p>destroy_notify :</p></dt>
<dd><p>how to get rid of <code>user_data</code></p></dd>
<dt><p>Returns :</p></dt>
<dd><p><link xref="DocExamples.Enum"/>.foo sometimes, <link xref="DocExamples.Enum"/>.bar other times.</p></dd>
</dl>

  
  
</page>