bonobo-property-bag-client: Libbonobo Reference Manual

bonobo-property-bag-client

Functions

gchar *	bonobo_pbclient_get_string ()
gchar *	bonobo_pbclient_get_default_string ()
gchar *	bonobo_pbclient_get_string_with_default ()
gint16	bonobo_pbclient_get_short ()
gint16	bonobo_pbclient_get_default_short ()
gint16	bonobo_pbclient_get_short_with_default ()
guint16	bonobo_pbclient_get_ushort ()
guint16	bonobo_pbclient_get_default_ushort ()
guint16	bonobo_pbclient_get_ushort_with_default ()
gint32	bonobo_pbclient_get_long ()
gint32	bonobo_pbclient_get_default_long ()
gint32	bonobo_pbclient_get_long_with_default ()
guint32	bonobo_pbclient_get_ulong ()
guint32	bonobo_pbclient_get_default_ulong ()
guint32	bonobo_pbclient_get_ulong_with_default ()
gfloat	bonobo_pbclient_get_float ()
gfloat	bonobo_pbclient_get_default_float ()
gfloat	bonobo_pbclient_get_float_with_default ()
gdouble	bonobo_pbclient_get_double ()
gdouble	bonobo_pbclient_get_default_double ()
gdouble	bonobo_pbclient_get_double_with_default ()
gboolean	bonobo_pbclient_get_boolean ()
gboolean	bonobo_pbclient_get_default_boolean ()
gboolean	bonobo_pbclient_get_boolean_with_default ()
gchar	bonobo_pbclient_get_char ()
gchar	bonobo_pbclient_get_default_char ()
gchar	bonobo_pbclient_get_char_with_default ()
CORBA_any *	bonobo_pbclient_get_value ()
CORBA_any *	bonobo_pbclient_get_default_value ()
void	bonobo_pbclient_set_string ()
void	bonobo_pbclient_set_short ()
void	bonobo_pbclient_set_ushort ()
void	bonobo_pbclient_set_long ()
void	bonobo_pbclient_set_ulong ()
void	bonobo_pbclient_set_float ()
void	bonobo_pbclient_set_double ()
void	bonobo_pbclient_set_boolean ()
void	bonobo_pbclient_set_char ()
void	bonobo_pbclient_set_value ()
void	bonobo_pbclient_set_value_async ()
char *	bonobo_pbclient_get_doc_title ()
char *	bonobo_pbclient_get_doc ()
GList *	bonobo_pbclient_get_keys ()
void	bonobo_pbclient_free_keys ()
Bonobo_PropertyFlags	bonobo_pbclient_get_flags ()
void	bonobo_pbclient_set ()
void	bonobo_pbclient_get ()
char *	bonobo_pbclient_setv ()
char *	bonobo_pbclient_getv ()
#define	bonobo_property_bag_client_get_value_any()
#define	bonobo_property_bag_client_get_default_any()

Types and Values

#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_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_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

Functions

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database, or zero on error.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag
key	key of the value to get
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the database.

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

Parameters

bag	a reference to the PropertyBag object
key	key of the value to get
opt_tc	the type of the value, optional
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the value contained in the PropertyBag, or zero on error.

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

Parameters

bag	a reference to the PropertyBag object
key	key of the value to get
opt_tc	the type of the value, optional
opt_ev	an optional CORBA_Environment to return failure codes

Returns

the default value contained in the PropertyBag, or zero on error.

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

bonobo_pbclient_set_value_async ()

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

Set a value on the PropertyBag asynchronously, discarding any possible roundtrip exceptions.

Parameters

bag	a reference to the PropertyBag
key	key of the value to set
value	the new value
opt_ev	an optional CORBA_Environment to return failure codes

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_arg,
                      va_list var_args);

This function provides the grunt implementation for other var-arg functions like bonobo_widget_set_property

Parameters

bag	the property bag
ev	optional CORBA exception environment or NULL
first_arg	first argument name
var_args	list of subsequent name / type / value triplets

Returns

an error string on error or NULL on success.

bonobo_pbclient_getv ()

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

This function provides the grunt implementation for other var-arg functions like bonobo_widget_get_property.

Parameters

bag	the property bag
ev	optional CORBA exception environment or NULL
first_arg	first argument name
var_args	list of subsequent name / type / value triplets

Returns

an error string on error or NULL on success.

bonobo_property_bag_client_get_value_any()

#define             bonobo_property_bag_client_get_value_any(pb, name, ev)

bonobo_property_bag_client_get_default_any()

#define             bonobo_property_bag_client_get_default_any(pb, name, ev)

Types and Values

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_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_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