GNOME.org

GladeEditorProperty

GladeEditorProperty — A generic widget to edit a GladeProperty.

Synopsis

struct              GladeEditorProperty;
#define             GLADE_MAKE_EPROP_TYPE               (func,
                                                         type,
                                                         parent)
void                glade_editor_property_load          (GladeEditorProperty *eprop,
                                                         GladeProperty *property);
void                glade_editor_property_load_by_widget
                                                        (GladeEditorProperty *eprop,
                                                         GladeWidget *widget);
void                glade_editor_property_commit        (GladeEditorProperty *eprop,
                                                         GValue *value);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GladeEditorProperty

Implemented Interfaces

GladeEditorProperty implements AtkImplementorIface, GtkBuildable, GtkOrientable and GladeEditable.

Properties

  "custom-text"              gchar*                : Read / Write
  "disable-check"            gboolean              : Read / Write / Construct
  "property-class"           gpointer              : Read / Write / Construct Only
  "use-command"              gboolean              : Read / Write

Signals

  "commit"                                         : Run Last
  "value-changed"                                  : Run Last

Description

The GladeEditorProperty is a factory that will create the correct control for the GladePropertyClass it was created for and provides a simple unified api to them.

Details

struct GladeEditorProperty

struct GladeEditorProperty;

GLADE_MAKE_EPROP_TYPE()

#define             GLADE_MAKE_EPROP_TYPE(func, type, parent)

glade_editor_property_load ()

void                glade_editor_property_load          (GladeEditorProperty *eprop,
                                                         GladeProperty *property);

Loads property values into eprop and connects. (the editor property will watch the property's value until its loaded with another property or NULL)

eprop :

 A GladeEditorProperty

property :

 A GladeProperty

glade_editor_property_load_by_widget ()

void                glade_editor_property_load_by_widget
                                                        (GladeEditorProperty *eprop,
                                                         GladeWidget *widget);

Convenience function to load the appropriate GladeProperty into eprop from widget

eprop :

 A GladeEditorProperty

widget :

 A GladeWidget

glade_editor_property_commit ()

void                glade_editor_property_commit        (GladeEditorProperty *eprop,
                                                         GValue *value);

Commits value to the property currently being edited by eprop.

eprop :

 A GladeEditorProperty

value :

 The GValue to commit

Property Details

The "custom-text" property

  "custom-text"              gchar*                : Read / Write

Custom Text to display in the property label.

Default value: NULL

The "disable-check" property

  "disable-check"            gboolean              : Read / Write / Construct

Whether to explicitly disable the check button.

Default value: FALSE

The "property-class" property

  "property-class"           gpointer              : Read / Write / Construct Only

The GladePropertyClass this GladeEditorProperty was created for.

The "use-command" property

  "use-command"              gboolean              : Read / Write

Whether we should use the command API for the undo/redo stack.

Default value: FALSE

Signal Details

The "commit" signal

void                user_function                      (GladeEditorProperty *gladeeditorproperty,
                                                        gpointer             arg1,
                                                        gpointer             user_data)                : Run Last

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.

gladeeditorproperty :

 the GladeEditorProperty which changed value

arg1 :

 the new GValue to commit.

user_data :

 user data set when the signal handler was connected.

The "value-changed" signal

void                user_function                      (GladeEditorProperty *gladeeditorproperty,
                                                        GladeProperty       *arg1,
                                                        gpointer             user_data)                : Run Last

Emitted when a contained property changes value

gladeeditorproperty :

 the GladeEditorProperty which changed value

arg1 :

 the GladeProperty that's value changed.

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.19