SwamiObjectPropBag

typedef struct {
  SwamiRoot *root;		/* parent swami root object */
  char *name;			/* Swami object property name */
  guint8 rank;			/* Swami object rank property */
  guint8 flags;			/* Swami object flags property */
  guint16 reserved;
} SwamiObjectPropBag;

enum SwamiRank

typedef enum
{
  SWAMI_RANK_INVALID = 0,
  SWAMI_RANK_LOWEST  = 10,
  SWAMI_RANK_LOW     = 25,
  SWAMI_RANK_NORMAL  = 50, /* NORMAL default value */
  SWAMI_RANK_DEFAULT = 60, /* value to elect default objects */
  SWAMI_RANK_HIGH    = 75,
  SWAMI_RANK_HIGHEST = 90
} SwamiRank;

enum SwamiObjectFlags

typedef enum /*< flags >*/
{
  SWAMI_OBJECT_SAVE = 1 << 0, /* flags if object state should be saved */
  SWAMI_OBJECT_USER = 1 << 1 /* user visable object (in tree view, etc) */
} SwamiObjectFlags;

swami_object_propbag_quark

extern GQuark swami_object_propbag_quark;

swami_type_set_rank ()

void                swami_type_set_rank                 (GType type,
                                                         GType group_type,
                                                         int rank);

Sets the ranking of instance GTypes derived from an ancestor group_type. This is useful to set a default instance type or to define order to types. An example of use would be to set a higher rank on a plugin wavetable type to cause it to be used when creating a default wavetable instance.

swami_type_get_rank ()

int                 swami_type_get_rank                 (GType type,
                                                         GType group_type);

Gets the instance rank of the given type derived from a group_type. See swami_type_set_rank() for more info.

swami_type_get_children ()

GType *             swami_type_get_children             (GType group_type);

Gets an array of types that are derived from group_type, sorted by rank. For types that have not had their rank explicitly set SWAMI_RANK_NORMAL will be assumed.

swami_type_get_default ()

GType               swami_type_get_default              (GType group_type);

Gets the default (highest ranked) type derived from a group_type. Like swami_type_get_children() but returns first type instead of an array.

swami_object_set_default ()

void                swami_object_set_default            (GObject *object,
                                                         GType type);

Set an object as default amongst its peers of the same type. Uses the Swami rank system (see "rank" Swami property) to elect a default object. All other object's registered to the same SwamiRoot and of the same type (or derived thereof) are set to SWAMI_RANK_NORMAL and the object's rank is set higher.

swami_object_get_by_name ()

GObject *           swami_object_get_by_name            (GObject *object,
                                                         const char *name);

Finds an object by its Swami name property, searches recursively through object tree. The object can be either a SwamiRoot or, as an added convenience, an object registered to one.

swami_object_find_by_type ()

IpatchList *        swami_object_find_by_type           (GObject *object,
                                                         const char *type_name);

Lookup all objects by type_name or derived from type_name recursively. The object can be either a SwamiRoot or, as an added convenience, an object registered to one. The returned iterator list is sorted by Swami rank (see "rank" Swami property).

swami_object_get_by_type ()

GObject *           swami_object_get_by_type            (GObject *object,
                                                         const char *type_name);

Lookup the highest ranking (see "rank" Swami property) object of the given type_name or derived from it. The returned object's reference count is incremented and the caller is responsible for removing it with g_object_unref when finished with it.

swami_object_get_valist ()

void                swami_object_get_valist             (GObject *object,
                                                         const char *first_property_name,
                                                         va_list var_args);

Get Swami properties from an object.

swami_object_get_property ()

void                swami_object_get_property           (GObject *object,
                                                         const char *property_name,
                                                         GValue *value);

Get a Swami property from an object.

swami_object_get ()

void                swami_object_get                    (gpointer object,
                                                         const char *first_prop_name,
                                                         ...);

Get multiple Swami properties from an object.

swami_object_set_valist ()

void                swami_object_set_valist             (GObject *object,
                                                         const char *first_property_name,
                                                         va_list var_args);

Set Swami properties of an object.

swami_object_set_property ()

void                swami_object_set_property           (GObject *object,
                                                         const char *property_name,
                                                         const GValue *value);

Set a Swami property of an object.

swami_object_set ()

void                swami_object_set                    (gpointer object,
                                                         const char *first_prop_name,
                                                         ...);

Set multiple Swami properties on an object.

swami_find_object_property ()

GParamSpec *        swami_find_object_property          (const char *property_name);

Find a Swami property.

swami_list_object_properties ()

GParamSpec **       swami_list_object_properties        (guint *n_properties);

Get the list of Swami properties.

swami_object_get_flags ()

guint               swami_object_get_flags              (GObject *object);

Get Swami flags from an object (see SwamiObjectFlags).

swami_object_set_flags ()

void                swami_object_set_flags              (GObject *object,
                                                         guint flags);

Sets Swami flags in an object. Flag bits are only set, not cleared.

swami_object_clear_flags ()

void                swami_object_clear_flags            (GObject *object,
                                                         guint flags);

Clears Swami flags in an object. Flag bits are only cleared, not set.

swami_object_set_origin ()

void                swami_object_set_origin             (GObject *obj,
                                                         GObject *origin);

This is used for associating an origin object to another object. Currently this is only used for GtkList item selections. The current active item selection is assigned to the swamigui_root object. In order to determine what GUI widget is the source, this function can be used to associate the widget object with the GtkList selection (for example the SwamiguiTree or SwamiguiSplits widgets). In this way, only the selection needs to be assigned to the root object and the source widget can be determined.

swami_object_get_origin ()

GObject *           swami_object_get_origin             (GObject *obj);

See swamigui_object_set_origin() for more details.