GladeEditorProperty

GladeEditorProperty — A generic widget to edit a GladeProperty

Synopsis


#include <glade.h>


            GladeEditorProperty;
GladeEditorProperty* glade_editor_property_new
                                            (GladePropertyClass *class,
                                             gboolean use_command);
void        glade_editor_property_load      (GladeEditorProperty *eprop,
                                             GladeProperty *property);
void        glade_editor_property_load_by_widget
                                            (GladeEditorProperty *eprop,
                                             GladeWidget *widget);
gboolean    glade_editor_property_supported (GParamSpec *pspec);
GladeEditorProperty* glade_editor_property_new_from_widget
                                            (GladeWidget *widget,
                                             const gchar *property,
                                             gboolean use_command);
void        glade_editor_property_hide_info (GladeEditorProperty *eprop);
void        glade_editor_property_show_info (GladeEditorProperty *eprop);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkHBox
                                 +----GladeEditorProperty

Implemented Interfaces

GladeEditorProperty implements AtkImplementorIface.

Properties


  "property-class"       gpointer              : Read / Write / Construct Only
  "show-info"            gboolean              : Read / Write
  "use-command"          gboolean              : Read / Write

Signal Prototypes


"gtk-doc-search"
            void        user_function      (GladeEditorProperty *gladeeditor,
                                            gchar *arg1,
                                            gchar *arg2,
                                            gchar *arg3,
                                            gpointer user_data);

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

GladeEditorProperty

typedef struct _GladeEditorProperty GladeEditorProperty;


glade_editor_property_new ()

GladeEditorProperty* glade_editor_property_new
                                            (GladePropertyClass *class,
                                             gboolean use_command);

This is a factory function to create the correct type of editor property that can edit the said type of GladePropertyClass

class : A GladePropertyClass
use_command : Whether the undo/redo stack applies here.
Returns : A newly created GladeEditorProperty of the correct type

glade_editor_property_load ()

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

Loads property values into eprop and connects.

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_supported ()

gboolean    glade_editor_property_supported (GParamSpec *pspec);

pspec : A GParamSpec
Returns : whether this pspec is supported by GladeEditorProperties.

glade_editor_property_new_from_widget ()

GladeEditorProperty* glade_editor_property_new_from_widget
                                            (GladeWidget *widget,
                                             const gchar *property,
                                             gboolean use_command);

This is a convenience function to create a GladeEditorProperty corresponding to property

widget : A GladeWidget
property : The widget's property
use_command : Whether the undo/redo stack applies here.
Returns : A newly created and connected GladeEditorProperty

glade_editor_property_hide_info ()

void        glade_editor_property_hide_info (GladeEditorProperty *eprop);

Hide the control widget to access help for eprop

eprop : A GladeEditorProperty

glade_editor_property_show_info ()

void        glade_editor_property_show_info (GladeEditorProperty *eprop);

Show the control widget to access help for eprop

eprop : A GladeEditorProperty

Properties

The "property-class" property

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

The GladePropertyClass this GladeEditorProperty was created for.


The "show-info" property

  "show-info"            gboolean              : Read / Write

Whether we should show an informational button.

Default value: FALSE


The "use-command" property

  "use-command"          gboolean              : Read / Write

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

Default value: FALSE

Signals

The "gtk-doc-search" signal

void        user_function                  (GladeEditorProperty *gladeeditor,
                                            gchar *arg1,
                                            gchar *arg2,
                                            gchar *arg3,
                                            gpointer user_data);

Emitted when the editor property requests that a doc-search be performed.

gladeeditor : the GladeEditorProperty which received the signal.
arg1 : the (gchar *) book to search or NULL
arg2 : the (gchar *) page to search or NULL
arg3 : the (gchar *) search string or NULL
user_data : user data set when the signal handler was connected.