Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GladeEditorProperty: Glade User Interface Designer Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Glade User Interface Designer Reference Manual">
<link rel="up" href="dockables.html" title="Part III. Dockable Glade UI Widgets">
<link rel="prev" href="gladeui-glade-editor.html" title="GladeEditor">
<link rel="next" href="GladePalette.html" title="GladePalette">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GladeEditorProperty.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GladeEditorProperty.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GladeEditorProperty.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GladeEditorProperty.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GladeEditorProperty.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="dockables.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gladeui-glade-editor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GladePalette.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GladeEditorProperty"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GladeEditorProperty.top_of_page"></a>GladeEditorProperty</span></h2>
<p>GladeEditorProperty — A generic widget to edit a <a class="link" href="GladeProperty.html" title="GladeProperty"><span class="type">GladeProperty</span></a>.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GladeEditorProperty.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GladeEditorProperty.html#GLADE-MAKE-EPROP-TYPE:CAPS" title="GLADE_MAKE_EPROP_TYPE()">GLADE_MAKE_EPROP_TYPE</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GladeEditorProperty.html#glade-editor-property-load" title="glade_editor_property_load ()">glade_editor_property_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GladeEditorProperty.html#glade-editor-property-load-by-widget" title="glade_editor_property_load_by_widget ()">glade_editor_property_load_by_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GladeEditorProperty.html#glade-editor-property-commit" title="glade_editor_property_commit ()">glade_editor_property_commit</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty--custom-text" title="The “custom-text” property">custom-text</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty--disable-check" title="The “disable-check” property">disable-check</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty--property-class" title="The “property-class” property">property-class</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty--use-command" title="The “use-command” property">use-command</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty-commit" title="The “commit” signal">commit</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty-value-changed" title="The “value-changed” signal">value-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GladeEditorProperty.html#GladeEditorProperty-struct" title="struct GladeEditorProperty">GladeEditorProperty</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkBox.html#GtkBox-struct">GtkBox</a>
                    <span class="lineart">╰──</span> GladeEditorProperty
</pre>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GladeEditorProperty implements
 AtkImplementorIface,  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>,  <a href="/usr/share/gtk-doc/html/gtk3/gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a> and  GladeEditable.</p>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.description"></a><h2>Description</h2>
<p>The <a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> is a factory that will create the correct
control for the <a class="link" href="gladeui-GladePropertyClass.html#GladePropertyClass" title="GladePropertyClass"><span class="type">GladePropertyClass</span></a> it was created for and provides
a simple unified api to them.</p>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GLADE-MAKE-EPROP-TYPE:CAPS"></a><h3>GLADE_MAKE_EPROP_TYPE()</h3>
<pre class="programlisting">#define             GLADE_MAKE_EPROP_TYPE(func, type, parent)</pre>
</div>
<hr>
<div class="refsect2">
<a name="glade-editor-property-load"></a><h3>glade_editor_property_load ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glade_editor_property_load (<em class="parameter"><code><a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> *eprop</code></em>,
                            <em class="parameter"><code><a class="link" href="GladeProperty.html" title="GladeProperty"><span class="type">GladeProperty</span></a> *property</code></em>);</pre>
<p>Loads <em class="parameter"><code>property</code></em>
 values into <em class="parameter"><code>eprop</code></em>
 and connects.
(the editor property will watch the property's value
until its loaded with another property or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</p>
<div class="refsect3">
<a name="glade-editor-property-load.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>eprop</p></td>
<td class="parameter_description"><p>A <a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>A <a class="link" href="GladeProperty.html" title="GladeProperty"><span class="type">GladeProperty</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="glade-editor-property-load-by-widget"></a><h3>glade_editor_property_load_by_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glade_editor_property_load_by_widget (<em class="parameter"><code><a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> *eprop</code></em>,
                                      <em class="parameter"><code><a class="link" href="GladeWidget.html" title="GladeWidget"><span class="type">GladeWidget</span></a> *widget</code></em>);</pre>
<p>Convenience function to load the appropriate <a class="link" href="GladeProperty.html" title="GladeProperty"><span class="type">GladeProperty</span></a> into
<em class="parameter"><code>eprop</code></em>
 from <em class="parameter"><code>widget</code></em>
</p>
<div class="refsect3">
<a name="glade-editor-property-load-by-widget.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>eprop</p></td>
<td class="parameter_description"><p>A <a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>A <a class="link" href="GladeWidget.html" title="GladeWidget"><span class="type">GladeWidget</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="glade-editor-property-commit"></a><h3>glade_editor_property_commit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
glade_editor_property_commit (<em class="parameter"><code><a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> *eprop</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>Commits <em class="parameter"><code>value</code></em>
 to the property currently being edited by <em class="parameter"><code>eprop</code></em>
.</p>
<div class="refsect3">
<a name="glade-editor-property-commit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>eprop</p></td>
<td class="parameter_description"><p>A <a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to commit</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GladeEditorProperty-struct"></a><h3>struct GladeEditorProperty</h3>
<pre class="programlisting">struct GladeEditorProperty;</pre>
</div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GladeEditorProperty--custom-text"></a><h3>The <code class="literal">“custom-text”</code> property</h3>
<pre class="programlisting">  “custom-text”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Custom Text to display in the property label.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GladeEditorProperty--disable-check"></a><h3>The <code class="literal">“disable-check”</code> property</h3>
<pre class="programlisting">  “disable-check”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether to explicitly disable the check button.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GladeEditorProperty--property-class"></a><h3>The <code class="literal">“property-class”</code> property</h3>
<pre class="programlisting">  “property-class”           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>The GladePropertyClass this GladeEditorProperty was created for.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="GladeEditorProperty--use-command"></a><h3>The <code class="literal">“use-command”</code> property</h3>
<pre class="programlisting">  “use-command”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether we should use the command API for the undo/redo stack.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GladeEditorProperty.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GladeEditorProperty-commit"></a><h3>The <code class="literal">“commit”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> *gladeeditorproperty,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             arg1,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             user_data)</pre>
<p>Emitted when a property's value is committed, can be useful to serialize
commands before and after the property's commit command from custom editors.</p>
<div class="refsect3">
<a name="GladeEditorProperty-commit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>gladeeditorproperty</p></td>
<td class="parameter_description"><p>the <a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> which changed value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>the new <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to commit.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GladeEditorProperty-value-changed"></a><h3>The <code class="literal">“value-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> *gladeeditorproperty,
               <a class="link" href="GladeProperty.html" title="GladeProperty"><span class="type">GladeProperty</span></a>       *arg1,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             user_data)</pre>
<p>Emitted when a contained property changes value</p>
<div class="refsect3">
<a name="GladeEditorProperty-value-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>gladeeditorproperty</p></td>
<td class="parameter_description"><p>the <a class="link" href="GladeEditorProperty.html" title="GladeEditorProperty"><span class="type">GladeEditorProperty</span></a> which changed value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>the <a class="link" href="GladeProperty.html" title="GladeProperty"><span class="type">GladeProperty</span></a> that's value changed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>