GXK Interface Reference

/opt/src/beast/beast-gtk/gxk/gxkradget.h

SYNOPSIS

struct  GxkRadgetType;
   
void  gxk_radget_add  (radget, area, widget);
GxkRadgetArgs*  gxk_radget_args  (name1, ...);
const gchar*  gxk_radget_args_get  (args, name);
GxkRadgetArgs*  gxk_radget_args_merge  (dest, source);
GxkRadgetArgs*  gxk_radget_args_set  (args, name, value);
GxkRadgetArgs*  gxk_radget_args_valist  (name1, var_args);
GxkRadget*  gxk_radget_complete  (radget, domain_name, name, var1, ...);
GxkRadgetArgs*  gxk_radget_const_args  ();
GxkRadget*  gxk_radget_create  (domain_name, name, var1, ...);
GxkRadget*  gxk_radget_creator  (radget, domain_name, name, parent, call_args, env_args);
GxkRadgetArgs*  gxk_radget_data_copy_call_args  (gdgdata);
gchar*  gxk_radget_data_dup_expand  (gdgdata, expression);
GxkRadget*  gxk_radget_data_get_scope_radget  (gdgdata);
void  gxk_radget_define_type  (type, ggtype);
void  gxk_radget_define_widget_type  (type);
gpointer  gxk_radget_find  (radget, name);
gpointer  gxk_radget_find_area  (radget, area);
void  gxk_radget_free_args  (args);
const gchar*  gxk_radget_get_domain  (radget);
void  gxk_radget_parse  (domain_name, file_name, i18n_domain, error);
void  gxk_radget_parse_text  (domain_name, text, text_len, i18n_domain, error);
void  gxk_radget_register_hook  (pspec, property_id, hook_func);
void  gxk_radget_sensitize  (radget, name, sensitive);
gboolean  gxk_radget_type_lookup  (type, ggtype);

DESCRIPTION

GxkRadgetType

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:87
struct GxkRadgetType
{
  GParamSpec* (*find_prop) (GTypeClass*klass, const gchar*construct_param_name);
  GxkRadget*  (*create)    (GType type, const gchar*name, guint n_construct_params, GParameter*construct_params, GxkRadgetData*gdgdata);
  void        (*set_prop)  (GxkRadget*radget, const gchar*prop_name, const GValue*value);
  gboolean    (*adopt)     (GxkRadget*radget, GxkRadget*parent, GxkRadgetData*gdgdata);
  GParamSpec* (*find_pack) (GxkRadget*radget, const gchar*pack_name);
  void        (*set_pack)  (GxkRadget*radget, const gchar*pack_name, const GValue*value);
};

gxk_radget_add

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:79
void  gxk_radget_add  
(GxkRadget   *radget,
 const gchar *area,
 gpointer     widget);
Add the unparanted widget widget to radget within area area.
radget: a valid radget
area: radget name
widget: valid GtkWidget

gxk_radget_args

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:33
GxkRadgetArgs*  gxk_radget_args  
(const gchar *name1,
 ...);

gxk_radget_args_get

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:41
const gchar*  gxk_radget_args_get  
(const GxkRadgetArgs *args,
 const gchar         *name);

gxk_radget_args_merge

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:43
GxkRadgetArgs*  gxk_radget_args_merge  
(GxkRadgetArgs       *dest,
 const GxkRadgetArgs *source);

gxk_radget_args_set

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:39
GxkRadgetArgs*  gxk_radget_args_set  
(GxkRadgetArgs *args,
 const gchar   *name,
 const gchar   *value);

gxk_radget_args_valist

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:35
GxkRadgetArgs*  gxk_radget_args_valist  
(const gchar *name1,
 va_list      var_args);

gxk_radget_complete

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:56
GxkRadget*  gxk_radget_complete  
(GxkRadget   *radget,
 const gchar *domain_name,
 const gchar *name,
 const gchar *var1,
 ...);
Create the children/contents of the radget defined under name within domain as part of the container object passed in as radget, using the variable bindings as defined in the ... paired string list.
radget: toplevel ragdet container
domain_name: radget domain
name: radget definition name
...: NULL terminated list of variable (name, value) strings pairs

gxk_radget_const_args

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:36
GxkRadgetArgs*  gxk_radget_const_args  
();

gxk_radget_create

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:51
GxkRadget*  gxk_radget_create  
(const gchar *domain_name,
 const gchar *name,
 const gchar *var1,
 ...);
Create the radget (GtkWidget or GObject) defined as name within domain, using the variable bindings as defined in the ... paired string list.
domain_name: radget domain
name: radget definition name
...: NULL terminated list of variable (name, value) strings pairs

gxk_radget_creator

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:62
GxkRadget*  gxk_radget_creator  
(GxkRadget   *radget,
 const gchar *domain_name,
 const gchar *name,
 GxkRadget   *parent,
 GSList      *call_args,
 GSList      *env_args);

gxk_radget_data_copy_call_args

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:119
GxkRadgetArgs*  gxk_radget_data_copy_call_args  
(GxkRadgetData *gdgdata);

gxk_radget_data_dup_expand

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:122
gchar*  gxk_radget_data_dup_expand  
(GxkRadgetData *gdgdata,
 const gchar   *expression);

gxk_radget_data_get_scope_radget

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:120
GxkRadget*  gxk_radget_data_get_scope_radget  
(GxkRadgetData *gdgdata);

gxk_radget_define_type

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:109
void  gxk_radget_define_type  
(GType                type,
 const GxkRadgetType *ggtype);

gxk_radget_define_widget_type

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:107
void  gxk_radget_define_widget_type  
(GType type);

gxk_radget_find

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:74
gpointer  gxk_radget_find  
(GxkRadget   *radget,
 const gchar *name);
Recursively find the radget named name within the container radget radget. The name may consist of a list of parent radget names, seperated by a dot '.'.
radget: a valid radget
name: radget name
RETURNS: radget named name or NULL

gxk_radget_find_area

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:76
gpointer  gxk_radget_find_area  
(GxkRadget   *radget,
 const gchar *area);
Recursively find the radget named name within the container radget radget.
radget: a valid radget
area: radget name
RETURNS: radget named name or NULL

gxk_radget_free_args

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:44
void  gxk_radget_free_args  
(GxkRadgetArgs *args);

gxk_radget_get_domain

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:63
const gchar*  gxk_radget_get_domain  
(GxkRadget *radget);
Return the domain within which the definition was found radget was created from.
radget: a valid radget
RETURNS: radget domain

gxk_radget_parse

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:67
void  gxk_radget_parse  
(const gchar *domain_name,
 const gchar *file_name,
 const gchar *i18n_domain,
 GError     **error);
Parse radget definitions from file_name. See gxk_radget_create() and gxk_radget_complete() to make use of the definitions.
domain_name: radget domain name
file_name: file containing ragdet definitions
i18n_domain: i18n domain to translate labels
error: GError location

gxk_radget_parse_text

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:72
void  gxk_radget_parse_text  
(const gchar *domain_name,
 const gchar *text,
 gint         text_len,
 const gchar *i18n_domain,
 GError     **error);
Parse radget definitions from text. See gxk_radget_create() and gxk_radget_complete() to make use of the definitions.
domain_name: radget domain name
text: radget definition string
text_len: length of text or -1
i18n_domain: i18n domain to translate labels
error: GError location

gxk_radget_register_hook

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:118
void  gxk_radget_register_hook  
(GParamSpec   *pspec,
 guint         property_id,
 GxkRadgetHook hook_func);

gxk_radget_sensitize

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:82
void  gxk_radget_sensitize  
(GxkRadget   *radget,
 const gchar *name,
 gboolean     sensitive);

gxk_radget_type_lookup

 /opt/src/beast/beast-gtk/gxk/gxkradget.h:111
gboolean  gxk_radget_type_lookup  
(GType          type,
 GxkRadgetType *ggtype);