bonobo-property-bag-client

Name

bonobo-property-bag-client -- simplified property bag client wrapper code

Synopsis



CORBA_TypeCode bonobo_pbclient_get_type     (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gchar*      bonobo_pbclient_get_string      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gchar*      bonobo_pbclient_get_default_string
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gchar*      bonobo_pbclient_get_string_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gchar *defval,
                                             gboolean *def);
gint16      bonobo_pbclient_get_short       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gint16      bonobo_pbclient_get_default_short
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gint16      bonobo_pbclient_get_short_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint16 defval,
                                             gboolean *def);
guint16     bonobo_pbclient_get_ushort      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
guint16     bonobo_pbclient_get_default_ushort
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
guint16     bonobo_pbclient_get_ushort_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint16 defval,
                                             gboolean *def);
gint32      bonobo_pbclient_get_long        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gint32      bonobo_pbclient_get_default_long
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gint32      bonobo_pbclient_get_long_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint32 defval,
                                             gboolean *def);
guint32     bonobo_pbclient_get_ulong       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
guint32     bonobo_pbclient_get_default_ulong
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
guint32     bonobo_pbclient_get_ulong_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint32 defval,
                                             gboolean *def);
gfloat      bonobo_pbclient_get_float       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gfloat      bonobo_pbclient_get_default_float
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gfloat      bonobo_pbclient_get_float_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gfloat defval,
                                             gboolean *def);
gdouble     bonobo_pbclient_get_double      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gdouble     bonobo_pbclient_get_default_double
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gdouble     bonobo_pbclient_get_double_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gdouble defval,
                                             gboolean *def);
gboolean    bonobo_pbclient_get_boolean     (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gboolean    bonobo_pbclient_get_default_boolean
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gboolean    bonobo_pbclient_get_boolean_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gboolean defval,
                                             gboolean *def);
gchar       bonobo_pbclient_get_char        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gchar       bonobo_pbclient_get_default_char
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
gchar       bonobo_pbclient_get_char_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gchar defval,
                                             gboolean *def);
CORBA_any*  bonobo_pbclient_get_value       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_TypeCode opt_tc,
                                             CORBA_Environment *opt_ev);
CORBA_any*  bonobo_pbclient_get_default_value
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_TypeCode opt_tc,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_string      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             const char *value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_short       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint16 value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_ushort      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint16 value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_long        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint32 value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_ulong       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint32 value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_float       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gfloat value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_double      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gdouble value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_boolean     (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gboolean value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_char        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gchar value,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set_value       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_any *value,
                                             CORBA_Environment *opt_ev);
char*       bonobo_pbclient_get_doc_title   (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
char*       bonobo_pbclient_get_doc         (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
GList*      bonobo_pbclient_get_keys        (Bonobo_PropertyBag bag,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_free_keys       (GList *key_list);
Bonobo_PropertyFlags bonobo_pbclient_get_flags
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);
void        bonobo_pbclient_set             (Bonobo_PropertyBag bag,
                                             CORBA_Environment *opt_ev,
                                             const char *first_prop,
                                             ...);
void        bonobo_pbclient_get             (Bonobo_PropertyBag bag,
                                             CORBA_Environment *opt_ev,
                                             const char *first_prop,
                                             ...);
char*       bonobo_pbclient_setv            (Bonobo_PropertyBag bag,
                                             CORBA_Environment *ev,
                                             const char *first_prop,
                                             va_list var_args);
char*       bonobo_pbclient_getv            (Bonobo_PropertyBag bag,
                                             CORBA_Environment *ev,
                                             const char *first_prop,
                                             va_list var_args);
#define     bonobo_property_bag_client_setv
#define     bonobo_property_bag_client_getv
#define     bonobo_property_bag_client_get_property_type
#define     bonobo_property_bag_client_get_value_gboolean
#define     bonobo_property_bag_client_get_value_gint
#define     bonobo_property_bag_client_get_value_glong
#define     bonobo_property_bag_client_get_value_gfloat
#define     bonobo_property_bag_client_get_value_gdouble
#define     bonobo_property_bag_client_get_value_string
#define     bonobo_property_bag_client_get_value_any(pb, name, ev)
#define     bonobo_property_bag_client_get_default_gboolean
#define     bonobo_property_bag_client_get_default_gint
#define     bonobo_property_bag_client_get_default_glong
#define     bonobo_property_bag_client_get_default_gfloat
#define     bonobo_property_bag_client_get_default_gdouble
#define     bonobo_property_bag_client_get_default_string
#define     bonobo_property_bag_client_get_default_any(pb, name, ev)
#define     bonobo_property_bag_client_set_value_gboolean
#define     bonobo_property_bag_client_set_value_gint
#define     bonobo_property_bag_client_set_value_glong
#define     bonobo_property_bag_client_set_value_gfloat
#define     bonobo_property_bag_client_set_value_gdouble
#define     bonobo_property_bag_client_set_value_string
#define     bonobo_property_bag_client_set_value_any
#define     bonobo_property_bag_client_get_docstring
#define     bonobo_property_bag_client_get_flags

Description

This code is designed to make the property bag interface slightly easier to use, by allowing optional CORBA environments, sensible return values on exceptions, and accessors for specific types of CORBA_Any. eg. bonobo_property_bag_client_get_value_glong.

With the property bag interface, as in all current remote Bonobo method invocations, translation issues are very dodgy. Assuming that the server process was activated in the correct locale, all should be well, however there is no guarantee that ( in a rapidly changing locale environment ) the string will be correctly translated. It is difficult to know how to solve this problem.

Details

bonobo_pbclient_get_type ()

CORBA_TypeCode bonobo_pbclient_get_type     (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_string ()

gchar*      bonobo_pbclient_get_string      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a string from the PropertyBag


bonobo_pbclient_get_default_string ()

gchar*      bonobo_pbclient_get_default_string
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_string_with_default ()

gchar*      bonobo_pbclient_get_string_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gchar *defval,
                                             gboolean *def);


bonobo_pbclient_get_short ()

gint16      bonobo_pbclient_get_short       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a 16 bit integer from the PropertyBag


bonobo_pbclient_get_default_short ()

gint16      bonobo_pbclient_get_default_short
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_short_with_default ()

gint16      bonobo_pbclient_get_short_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint16 defval,
                                             gboolean *def);


bonobo_pbclient_get_ushort ()

guint16     bonobo_pbclient_get_ushort      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a 16 bit unsigned integer from the PropertyBag


bonobo_pbclient_get_default_ushort ()

guint16     bonobo_pbclient_get_default_ushort
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_ushort_with_default ()

guint16     bonobo_pbclient_get_ushort_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint16 defval,
                                             gboolean *def);


bonobo_pbclient_get_long ()

gint32      bonobo_pbclient_get_long        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a 32 bit integer from the PropertyBag


bonobo_pbclient_get_default_long ()

gint32      bonobo_pbclient_get_default_long
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_long_with_default ()

gint32      bonobo_pbclient_get_long_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint32 defval,
                                             gboolean *def);


bonobo_pbclient_get_ulong ()

guint32     bonobo_pbclient_get_ulong       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a 32 bit unsigned integer from the PropertyBag


bonobo_pbclient_get_default_ulong ()

guint32     bonobo_pbclient_get_default_ulong
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_ulong_with_default ()

guint32     bonobo_pbclient_get_ulong_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint32 defval,
                                             gboolean *def);


bonobo_pbclient_get_float ()

gfloat      bonobo_pbclient_get_float       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a single precision floating point value from the PropertyBag


bonobo_pbclient_get_default_float ()

gfloat      bonobo_pbclient_get_default_float
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_float_with_default ()

gfloat      bonobo_pbclient_get_float_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gfloat defval,
                                             gboolean *def);


bonobo_pbclient_get_double ()

gdouble     bonobo_pbclient_get_double      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a double precision floating point value from the PropertyBag


bonobo_pbclient_get_default_double ()

gdouble     bonobo_pbclient_get_default_double
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_double_with_default ()

gdouble     bonobo_pbclient_get_double_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gdouble defval,
                                             gboolean *def);


bonobo_pbclient_get_boolean ()

gboolean    bonobo_pbclient_get_boolean     (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a boolean value from the PropertyBag


bonobo_pbclient_get_default_boolean ()

gboolean    bonobo_pbclient_get_default_boolean
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_boolean_with_default ()

gboolean    bonobo_pbclient_get_boolean_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gboolean defval,
                                             gboolean *def);


bonobo_pbclient_get_char ()

gchar       bonobo_pbclient_get_char        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);

Get a 8 bit character value from the PropertyBag


bonobo_pbclient_get_default_char ()

gchar       bonobo_pbclient_get_default_char
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_char_with_default ()

gchar       bonobo_pbclient_get_char_with_default
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gchar defval,
                                             gboolean *def);


bonobo_pbclient_get_value ()

CORBA_any*  bonobo_pbclient_get_value       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_TypeCode opt_tc,
                                             CORBA_Environment *opt_ev);

Get a value from the PropertyBag


bonobo_pbclient_get_default_value ()

CORBA_any*  bonobo_pbclient_get_default_value
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_TypeCode opt_tc,
                                             CORBA_Environment *opt_ev);

Get the default value from the PropertyBag


bonobo_pbclient_set_string ()

void        bonobo_pbclient_set_string      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             const char *value,
                                             CORBA_Environment *opt_ev);

Set a string value in the PropertyBag.


bonobo_pbclient_set_short ()

void        bonobo_pbclient_set_short       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint16 value,
                                             CORBA_Environment *opt_ev);

Set a 16 bit integer value in the PropertyBag.


bonobo_pbclient_set_ushort ()

void        bonobo_pbclient_set_ushort      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint16 value,
                                             CORBA_Environment *opt_ev);

Set a 16 bit unsigned integer value in the PropertyBag.


bonobo_pbclient_set_long ()

void        bonobo_pbclient_set_long        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gint32 value,
                                             CORBA_Environment *opt_ev);

Set a 32 bit integer value in the PropertyBag.


bonobo_pbclient_set_ulong ()

void        bonobo_pbclient_set_ulong       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             guint32 value,
                                             CORBA_Environment *opt_ev);

Set a 32 bit unsigned integer value in the PropertyBag.


bonobo_pbclient_set_float ()

void        bonobo_pbclient_set_float       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gfloat value,
                                             CORBA_Environment *opt_ev);

Set a single precision floating point value in the PropertyBag.


bonobo_pbclient_set_double ()

void        bonobo_pbclient_set_double      (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gdouble value,
                                             CORBA_Environment *opt_ev);

Set a double precision floating point value in the PropertyBag.


bonobo_pbclient_set_boolean ()

void        bonobo_pbclient_set_boolean     (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gboolean value,
                                             CORBA_Environment *opt_ev);

Set a boolean value in the PropertyBag.


bonobo_pbclient_set_char ()

void        bonobo_pbclient_set_char        (Bonobo_PropertyBag bag,
                                             const char *key,
                                             gchar value,
                                             CORBA_Environment *opt_ev);

Set a 8 bit characte value in the PropertyBag.


bonobo_pbclient_set_value ()

void        bonobo_pbclient_set_value       (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_any *value,
                                             CORBA_Environment *opt_ev);

Set a value in the PropertyBag.


bonobo_pbclient_get_doc_title ()

char*       bonobo_pbclient_get_doc_title   (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_doc ()

char*       bonobo_pbclient_get_doc         (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_get_keys ()

GList*      bonobo_pbclient_get_keys        (Bonobo_PropertyBag bag,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_free_keys ()

void        bonobo_pbclient_free_keys       (GList *key_list);


bonobo_pbclient_get_flags ()

Bonobo_PropertyFlags bonobo_pbclient_get_flags
                                            (Bonobo_PropertyBag bag,
                                             const char *key,
                                             CORBA_Environment *opt_ev);


bonobo_pbclient_set ()

void        bonobo_pbclient_set             (Bonobo_PropertyBag bag,
                                             CORBA_Environment *opt_ev,
                                             const char *first_prop,
                                             ...);


bonobo_pbclient_get ()

void        bonobo_pbclient_get             (Bonobo_PropertyBag bag,
                                             CORBA_Environment *opt_ev,
                                             const char *first_prop,
                                             ...);


bonobo_pbclient_setv ()

char*       bonobo_pbclient_setv            (Bonobo_PropertyBag bag,
                                             CORBA_Environment *ev,
                                             const char *first_prop,
                                             va_list var_args);

This function uses the TypeCode data extracted from the pb to determine how it walks its stack. This function provides the grunt implementation for other var-arg functions like bonobo_widget_set_property


bonobo_pbclient_getv ()

char*       bonobo_pbclient_getv            (Bonobo_PropertyBag bag,
                                             CORBA_Environment *ev,
                                             const char *first_prop,
                                             va_list var_args);

This function uses the TypeCode data extracted from the pb to determine how it walks its stack. This function provides the grunt implementation for other var-arg functions like bonobo_widget_get_property.


bonobo_property_bag_client_setv

#define     bonobo_property_bag_client_setv


bonobo_property_bag_client_getv

#define     bonobo_property_bag_client_getv


bonobo_property_bag_client_get_property_type

#define     bonobo_property_bag_client_get_property_type


bonobo_property_bag_client_get_value_gboolean

#define     bonobo_property_bag_client_get_value_gboolean


bonobo_property_bag_client_get_value_gint

#define     bonobo_property_bag_client_get_value_gint


bonobo_property_bag_client_get_value_glong

#define     bonobo_property_bag_client_get_value_glong


bonobo_property_bag_client_get_value_gfloat

#define     bonobo_property_bag_client_get_value_gfloat


bonobo_property_bag_client_get_value_gdouble

#define     bonobo_property_bag_client_get_value_gdouble


bonobo_property_bag_client_get_value_string

#define     bonobo_property_bag_client_get_value_string


bonobo_property_bag_client_get_value_any()

#define     bonobo_property_bag_client_get_value_any(pb, name, ev)


bonobo_property_bag_client_get_default_gboolean

#define     bonobo_property_bag_client_get_default_gboolean


bonobo_property_bag_client_get_default_gint

#define     bonobo_property_bag_client_get_default_gint


bonobo_property_bag_client_get_default_glong

#define     bonobo_property_bag_client_get_default_glong


bonobo_property_bag_client_get_default_gfloat

#define     bonobo_property_bag_client_get_default_gfloat


bonobo_property_bag_client_get_default_gdouble

#define     bonobo_property_bag_client_get_default_gdouble


bonobo_property_bag_client_get_default_string

#define     bonobo_property_bag_client_get_default_string


bonobo_property_bag_client_get_default_any()

#define     bonobo_property_bag_client_get_default_any(pb, name, ev)


bonobo_property_bag_client_set_value_gboolean

#define     bonobo_property_bag_client_set_value_gboolean


bonobo_property_bag_client_set_value_gint

#define     bonobo_property_bag_client_set_value_gint


bonobo_property_bag_client_set_value_glong

#define     bonobo_property_bag_client_set_value_glong


bonobo_property_bag_client_set_value_gfloat

#define     bonobo_property_bag_client_set_value_gfloat


bonobo_property_bag_client_set_value_gdouble

#define     bonobo_property_bag_client_set_value_gdouble


bonobo_property_bag_client_set_value_string

#define     bonobo_property_bag_client_set_value_string


bonobo_property_bag_client_set_value_any

#define     bonobo_property_bag_client_set_value_any


bonobo_property_bag_client_get_docstring

#define     bonobo_property_bag_client_get_docstring


bonobo_property_bag_client_get_flags

#define     bonobo_property_bag_client_get_flags

See Also

BonoboPropertyBag, BonoboProperty, BonoboPropertyControl