~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gobject/html/GBinding.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2014-03-24 20:58:34 UTC
  • mfrom: (1.66.13)
  • Revision ID: package-import@ubuntu.com-20140324205834-8hsgok8k36ftocqa
Tags: 2.40.0-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
50
50
</td>
51
51
</tr>
52
52
<tr>
53
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
53
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
54
54
</td>
55
55
<td class="function_name">
56
56
<a class="link" href="GBinding.html#g-binding-get-source-property" title="g_binding_get_source_property ()">g_binding_get_source_property</a> <span class="c_punctuation">()</span>
65
65
</td>
66
66
</tr>
67
67
<tr>
68
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
68
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
69
69
</td>
70
70
<td class="function_name">
71
71
<a class="link" href="GBinding.html#g-binding-get-target-property" title="g_binding_get_target_property ()">g_binding_get_target_property</a> <span class="c_punctuation">()</span>
97
97
</tr>
98
98
<tr>
99
99
<td class="function_type">
100
 
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
100
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
101
101
</td>
102
102
<td class="function_name">
103
103
<span class="c_punctuation">(</span><a class="link" href="GBinding.html#GBindingTransformFunc" title="GBindingTransformFunc ()">*GBindingTransformFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
144
144
</tr>
145
145
<tr>
146
146
<td class="property_type">
147
 
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
147
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
148
148
<td class="property_name"><a class="link" href="GBinding.html#GBinding--source-property" title="The “source-property” property">source-property</a></td>
149
149
<td class="property_flags">Read / Write / Construct Only</td>
150
150
</tr>
156
156
</tr>
157
157
<tr>
158
158
<td class="property_type">
159
 
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
 
159
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
160
160
<td class="property_name"><a class="link" href="GBinding.html#GBinding--target-property" title="The “target-property” property">target-property</a></td>
161
161
<td class="property_flags">Read / Write / Construct Only</td>
162
162
</tr>
345
345
<hr>
346
346
<div class="refsect2">
347
347
<a name="g-binding-get-source-property"></a><h3>g_binding_get_source_property ()</h3>
348
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
348
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
349
349
g_binding_get_source_property (<em class="parameter"><code><a class="link" href="GBinding.html" title="GBinding"><span class="type">GBinding</span></a> *binding</code></em>);</pre>
350
350
<p>Retrieves the name of the property of <a class="link" href="GBinding.html#GBinding--source" title="The “source” property"><span class="type">“source”</span></a> used as the source
351
351
of the binding.</p>
402
402
<hr>
403
403
<div class="refsect2">
404
404
<a name="g-binding-get-target-property"></a><h3>g_binding_get_target_property ()</h3>
405
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
405
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
406
406
g_binding_get_target_property (<em class="parameter"><code><a class="link" href="GBinding.html" title="GBinding"><span class="type">GBinding</span></a> *binding</code></em>);</pre>
407
407
<p>Retrieves the name of the property of <a class="link" href="GBinding.html#GBinding--target" title="The “target” property"><span class="type">“target”</span></a> used as the target
408
408
of the binding.</p>
490
490
<div class="refsect2">
491
491
<a name="g-object-bind-property"></a><h3>g_object_bind_property ()</h3>
492
492
<pre class="programlisting"><a class="link" href="GBinding.html" title="GBinding"><span class="returnvalue">GBinding</span></a> *
493
 
g_object_bind_property (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> source</code></em>,
494
 
                        <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_property</code></em>,
495
 
                        <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> target</code></em>,
496
 
                        <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_property</code></em>,
 
493
g_object_bind_property (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> source</code></em>,
 
494
                        <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_property</code></em>,
 
495
                        <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> target</code></em>,
 
496
                        <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_property</code></em>,
497
497
                        <em class="parameter"><code><a class="link" href="GBinding.html#GBindingFlags" title="enum GBindingFlags"><span class="type">GBindingFlags</span></a> flags</code></em>);</pre>
498
498
<p>Creates a binding between <em class="parameter"><code>source_property</code></em>
499
499
 on <em class="parameter"><code>source</code></em>
587
587
<hr>
588
588
<div class="refsect2">
589
589
<a name="GBindingTransformFunc"></a><h3>GBindingTransformFunc ()</h3>
590
 
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
590
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
591
591
<span class="c_punctuation">(</span>*GBindingTransformFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GBinding.html" title="GBinding"><span class="type">GBinding</span></a> *binding</code></em>,
592
592
                          <em class="parameter"><code>const <a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *from_value</code></em>,
593
593
                          <em class="parameter"><code><a class="link" href="gobject-Generic-values.html#GValue" title="GValue"><span class="type">GValue</span></a> *to_value</code></em>,
594
 
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
594
                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
595
595
<p>A function to be called to transform <em class="parameter"><code>from_value</code></em>
596
596
 to <em class="parameter"><code>to_value</code></em>
597
597
. If
642
642
</div>
643
643
<div class="refsect3">
644
644
<a name="id-1.4.15.9.9.6"></a><h4>Returns</h4>
645
 
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the transformation was successful, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
645
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the transformation was successful, and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
646
646
otherwise</p>
647
647
<p></p>
648
648
</div>
652
652
<div class="refsect2">
653
653
<a name="g-object-bind-property-full"></a><h3>g_object_bind_property_full ()</h3>
654
654
<pre class="programlisting"><a class="link" href="GBinding.html" title="GBinding"><span class="returnvalue">GBinding</span></a> *
655
 
g_object_bind_property_full (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> source</code></em>,
656
 
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_property</code></em>,
657
 
                             <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> target</code></em>,
658
 
                             <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_property</code></em>,
 
655
g_object_bind_property_full (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> source</code></em>,
 
656
                             <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_property</code></em>,
 
657
                             <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> target</code></em>,
 
658
                             <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_property</code></em>,
659
659
                             <em class="parameter"><code><a class="link" href="GBinding.html#GBindingFlags" title="enum GBindingFlags"><span class="type">GBindingFlags</span></a> flags</code></em>,
660
660
                             <em class="parameter"><code><a class="link" href="GBinding.html#GBindingTransformFunc" title="GBindingTransformFunc ()"><span class="type">GBindingTransformFunc</span></a> transform_to</code></em>,
661
661
                             <em class="parameter"><code><a class="link" href="GBinding.html#GBindingTransformFunc" title="GBindingTransformFunc ()"><span class="type">GBindingTransformFunc</span></a> transform_from</code></em>,
662
 
                             <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
663
 
                             <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
 
662
                             <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
663
                             <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
664
664
<p>Complete version of <a class="link" href="GBinding.html#g-object-bind-property" title="g_object_bind_property ()"><code class="function">g_object_bind_property()</code></a>.</p>
665
665
<p>Creates a binding between <em class="parameter"><code>source_property</code></em>
666
666
 on <em class="parameter"><code>source</code></em>
738
738
<td class="parameter_description"><p> the transformation function
739
739
from the <em class="parameter"><code>source</code></em>
740
740
to the <em class="parameter"><code>target</code></em>
741
 
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default. </p></td>
 
741
, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default. </p></td>
742
742
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
743
743
</tr>
744
744
<tr>
746
746
<td class="parameter_description"><p> the transformation function
747
747
from the <em class="parameter"><code>target</code></em>
748
748
to the <em class="parameter"><code>source</code></em>
749
 
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default. </p></td>
 
749
, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default. </p></td>
750
750
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
751
751
</tr>
752
752
<tr>
753
753
<td class="parameter_name"><p>user_data</p></td>
754
754
<td class="parameter_description"><p>custom data to be passed to the transformation functions,
755
 
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 
755
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
756
756
<td class="parameter_annotations"> </td>
757
757
</tr>
758
758
<tr>
777
777
<div class="refsect2">
778
778
<a name="g-object-bind-property-with-closures"></a><h3>g_object_bind_property_with_closures ()</h3>
779
779
<pre class="programlisting"><a class="link" href="GBinding.html" title="GBinding"><span class="returnvalue">GBinding</span></a> *
780
 
g_object_bind_property_with_closures (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> source</code></em>,
781
 
                                      <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_property</code></em>,
782
 
                                      <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> target</code></em>,
783
 
                                      <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_property</code></em>,
 
780
g_object_bind_property_with_closures (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> source</code></em>,
 
781
                                      <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *source_property</code></em>,
 
782
                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> target</code></em>,
 
783
                                      <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_property</code></em>,
784
784
                                      <em class="parameter"><code><a class="link" href="GBinding.html#GBindingFlags" title="enum GBindingFlags"><span class="type">GBindingFlags</span></a> flags</code></em>,
785
785
                                      <em class="parameter"><code><a class="link" href="gobject-Closures.html#GClosure" title="struct GClosure"><span class="type">GClosure</span></a> *transform_to</code></em>,
786
786
                                      <em class="parameter"><code><a class="link" href="gobject-Closures.html#GClosure" title="struct GClosure"><span class="type">GClosure</span></a> *transform_from</code></em>);</pre>
836
836
<td class="parameter_description"><p>a <a class="link" href="gobject-Closures.html#GClosure" title="struct GClosure"><span class="type">GClosure</span></a> wrapping the transformation function
837
837
from the <em class="parameter"><code>source</code></em>
838
838
to the <em class="parameter"><code>target</code></em>
839
 
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default</p></td>
 
839
, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default</p></td>
840
840
<td class="parameter_annotations"> </td>
841
841
</tr>
842
842
<tr>
844
844
<td class="parameter_description"><p>a <a class="link" href="gobject-Closures.html#GClosure" title="struct GClosure"><span class="type">GClosure</span></a> wrapping the transformation function
845
845
from the <em class="parameter"><code>target</code></em>
846
846
to the <em class="parameter"><code>source</code></em>
847
 
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default</p></td>
 
847
, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default</p></td>
848
848
<td class="parameter_annotations"> </td>
849
849
</tr>
850
850
</tbody>
914
914
<td class="enum_member_name"><p><a name="G-BINDING-INVERT-BOOLEAN:CAPS"></a>G_BINDING_INVERT_BOOLEAN</p></td>
915
915
<td class="enum_member_description">
916
916
<p>If the two properties being bound are
917
 
  booleans, setting one to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will result in the other being
918
 
  set to <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and vice versa. This flag will only work for
 
917
  booleans, setting one to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will result in the other being
 
918
  set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and vice versa. This flag will only work for
919
919
  boolean properties, and cannot be used when passing custom
920
920
  transformation functions to <a class="link" href="GBinding.html#g-object-bind-property-full" title="g_object_bind_property_full ()"><code class="function">g_object_bind_property_full()</code></a>.</p>
921
921
</td>
947
947
<hr>
948
948
<div class="refsect2">
949
949
<a name="GBinding--source-property"></a><h3>The <code class="literal">“source-property”</code> property</h3>
950
 
<pre class="programlisting">  “source-property”          <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 
950
<pre class="programlisting">  “source-property”          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
951
951
<p>The name of the property of <a class="link" href="GBinding.html#GBinding--source" title="The “source” property"><span class="type">“source”</span></a> that should be used
952
952
as the source of the binding</p>
953
953
<p>Flags: Read / Write / Construct Only</p>
965
965
<hr>
966
966
<div class="refsect2">
967
967
<a name="GBinding--target-property"></a><h3>The <code class="literal">“target-property”</code> property</h3>
968
 
<pre class="programlisting">  “target-property”          <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
 
968
<pre class="programlisting">  “target-property”          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
969
969
<p>The name of the property of <a class="link" href="GBinding.html#GBinding--target" title="The “target” property"><span class="type">“target”</span></a> that should be used
970
970
as the target of the binding</p>
971
971
<p>Flags: Read / Write / Construct Only</p>