SFI Interface Reference

/opt/src/beast/sfi/sfiparams.h

SYNOPSIS

struct  SfiChoiceValue;
struct  SfiChoiceValues;
struct  SfiParamSpecBBlock;
struct  SfiParamSpecChoice;
struct  SfiParamSpecFBlock;
struct  SfiParamSpecNote;
struct  SfiParamSpecProxy;
struct  SfiParamSpecRec;
struct  SfiParamSpecSeq;
   
void  _sfi_init_params  ();
SfiRecFields  sfi_boxed_type_get_rec_fields  (boxed_type);
GParamSpec*  sfi_boxed_type_get_seq_element  (boxed_type);
void  sfi_boxed_type_set_rec_fields  (boxed_type, static_const_fields);
void  sfi_boxed_type_set_seq_element  (boxed_type, element);
SfiSCategory  sfi_categorize_pspec  (pspec);
SfiSCategory  sfi_categorize_type  (value_type);
GType  sfi_category_param_type  (pspec_cat);
GType  sfi_category_type  (pspec_cat);
void  sfi_enum_type_set_choice_value_getter  (gtype, cvgetter);
gboolean  sfi_pspec_allows_void_note  (pspec);
GParamSpec*  sfi_pspec_bblock  (name, nick, blurb, hints);
GParamSpec*  sfi_pspec_bool  (name, nick, blurb, default_value, hints);
GParamSpec*  sfi_pspec_choice  (name, nick, blurb, default_value, static_const_evalues, hints);
GParamSpec*  sfi_pspec_choice_from_enum  (enum_pspec);
GParamSpec*  sfi_pspec_fblock  (name, nick, blurb, hints);
GParamSpec*  sfi_pspec_from_rec  (prec);
SfiBool  sfi_pspec_get_bool_default  (pspec);
const gchar*  sfi_pspec_get_choice_default  (pspec);
guint64  sfi_pspec_get_choice_hash  (pspec);
SfiChoiceValues  sfi_pspec_get_choice_values  (pspec);
const gchar*  sfi_pspec_get_group  (pspec);
SfiInt  sfi_pspec_get_int_default  (pspec);
void  sfi_pspec_get_int_range  (pspec, minimum_value, maximum_value, stepping);
SfiNum  sfi_pspec_get_num_default  (pspec);
void  sfi_pspec_get_num_range  (pspec, minimum_value, maximum_value, stepping);
const gchar*  sfi_pspec_get_owner  (pspec);
SfiReal  sfi_pspec_get_real_default  (pspec);
void  sfi_pspec_get_real_range  (pspec, minimum_value, maximum_value, stepping);
GParamSpec*  sfi_pspec_get_rec_field  (pspec, field_name);
SfiRecFields  sfi_pspec_get_rec_fields  (pspec);
GParamSpec*  sfi_pspec_get_seq_element  (pspec);
const gchar*  sfi_pspec_get_string_default  (pspec);
GParamSpec*  sfi_pspec_int  (name, nick, blurb, default_value, minimum_value, maximum_value, stepping, hints);
GParamSpec*  sfi_pspec_log_scale  (name, nick, blurb, default_value, minimum_value, maximum_value, stepping, center, base, n_steps, hints);
GParamSpec*  sfi_pspec_note  (name, nick, blurb, default_value, min_note, max_note, allow_void, hints);
GParamSpec*  sfi_pspec_num  (name, nick, blurb, default_value, minimum_value, maximum_value, stepping, hints);
GParamSpec*  sfi_pspec_proxy  (name, nick, blurb, hints);
GParamSpec*  sfi_pspec_proxy_from_object  (object_pspec);
GParamSpec*  sfi_pspec_pspec  (name, nick, blurb, hints);
GParamSpec*  sfi_pspec_real  (name, nick, blurb, default_value, minimum_value, maximum_value, stepping, hints);
GParamSpec*  sfi_pspec_rec  (name, nick, blurb, static_const_fields, hints);
GParamSpec*  sfi_pspec_rec_generic  (name, nick, blurb, hints);
GParamSpec*  sfi_pspec_seq  (name, nick, blurb, element_spec, hints);
GParamSpec*  sfi_pspec_set_group  (pspec, group);
void  sfi_pspec_set_owner  (pspec, owner);
GParamSpec*  sfi_pspec_string  (name, nick, blurb, default_value, hints);
GParamSpec*  sfi_pspec_time  (name, nick, blurb, hints);
SfiRec*  sfi_pspec_to_rec  (pspec);
GParamSpec*  sfi_pspec_to_serializable  (pspec);

DESCRIPTION

SfiChoiceValue

 /opt/src/beast/sfi/sfiparams.h:78
struct SfiChoiceValue
{
  const gchar *choice_ident;
  const gchar *choice_label;
  const gchar *choice_blurb;
};

SfiChoiceValues

 /opt/src/beast/sfi/sfiparams.h:83
struct SfiChoiceValues
{
  guint                 n_values;
  const SfiChoiceValue *values;
};

SfiParamSpecBBlock

 /opt/src/beast/sfi/sfiparams.h:91
struct SfiParamSpecBBlock
{
  GParamSpecBoxed pspec;
};

SfiParamSpecChoice

 /opt/src/beast/sfi/sfiparams.h:87
struct SfiParamSpecChoice
{
  GParamSpecString pspec;
  SfiChoiceValues  cvalues;
};

SfiParamSpecFBlock

 /opt/src/beast/sfi/sfiparams.h:94
struct SfiParamSpecFBlock
{
  GParamSpecBoxed pspec;
};

SfiParamSpecNote

 /opt/src/beast/sfi/sfiparams.h:108
struct SfiParamSpecNote
{
  GParamSpecInt pspec;
  gboolean      allow_void;
};

SfiParamSpecProxy

 /opt/src/beast/sfi/sfiparams.h:105
struct SfiParamSpecProxy
{
  GParamSpecPointer pspec;
};

SfiParamSpecRec

 /opt/src/beast/sfi/sfiparams.h:101
struct SfiParamSpecRec
{
  GParamSpecBoxed pspec;
  SfiRecFields    fields;
};

SfiParamSpecSeq

 /opt/src/beast/sfi/sfiparams.h:97
struct SfiParamSpecSeq
{
  GParamSpecBoxed pspec;
  GParamSpec     *element;
};

_sfi_init_params

 /opt/src/beast/sfi/sfiparams.h:324
void  _sfi_init_params  
();

sfi_boxed_type_get_rec_fields

 /opt/src/beast/sfi/sfiparams.h:220
SfiRecFields  sfi_boxed_type_get_rec_fields  
(GType boxed_type);

sfi_boxed_type_get_seq_element

 /opt/src/beast/sfi/sfiparams.h:223
GParamSpec*  sfi_boxed_type_get_seq_element  
(GType boxed_type);

sfi_boxed_type_set_rec_fields

 /opt/src/beast/sfi/sfiparams.h:219
void  sfi_boxed_type_set_rec_fields  
(GType              boxed_type,
 const SfiRecFields static_const_fields);

sfi_boxed_type_set_seq_element

 /opt/src/beast/sfi/sfiparams.h:222
void  sfi_boxed_type_set_seq_element  
(GType       boxed_type,
 GParamSpec *element);

sfi_categorize_pspec

 /opt/src/beast/sfi/sfiparams.h:259
SfiSCategory  sfi_categorize_pspec  
(GParamSpec *pspec);

sfi_categorize_type

 /opt/src/beast/sfi/sfiparams.h:258
SfiSCategory  sfi_categorize_type  
(GType value_type);

sfi_category_param_type

 /opt/src/beast/sfi/sfiparams.h:261
GType  sfi_category_param_type  
(SfiSCategory pspec_cat);

sfi_category_type

 /opt/src/beast/sfi/sfiparams.h:260
GType  sfi_category_type  
(SfiSCategory pspec_cat);

sfi_enum_type_set_choice_value_getter

 /opt/src/beast/sfi/sfiparams.h:217
void  sfi_enum_type_set_choice_value_getter  
(GType                gtype,
 SfiChoiceValueGetter cvgetter);

sfi_pspec_allows_void_note

 /opt/src/beast/sfi/sfiparams.h:298
gboolean  sfi_pspec_allows_void_note  
(GParamSpec *pspec);

sfi_pspec_bblock

 /opt/src/beast/sfi/sfiparams.h:169
GParamSpec*  sfi_pspec_bblock  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *hints);

sfi_pspec_bool

 /opt/src/beast/sfi/sfiparams.h:119
GParamSpec*  sfi_pspec_bool  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiBool      default_value,
 const gchar *hints);

sfi_pspec_choice

 /opt/src/beast/sfi/sfiparams.h:165
GParamSpec*  sfi_pspec_choice  
(const gchar    *name,
 const gchar    *nick,
 const gchar    *blurb,
 const gchar    *default_value,
 SfiChoiceValues static_const_evalues,
 const gchar    *hints);

sfi_pspec_choice_from_enum

 /opt/src/beast/sfi/sfiparams.h:214
GParamSpec*  sfi_pspec_choice_from_enum  
(GParamSpec *enum_pspec);

sfi_pspec_fblock

 /opt/src/beast/sfi/sfiparams.h:173
GParamSpec*  sfi_pspec_fblock  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *hints);

sfi_pspec_from_rec

 /opt/src/beast/sfi/sfiparams.h:327
GParamSpec*  sfi_pspec_from_rec  
(SfiRec *prec);

sfi_pspec_get_bool_default

 /opt/src/beast/sfi/sfiparams.h:292
SfiBool  sfi_pspec_get_bool_default  
(GParamSpec *pspec);

sfi_pspec_get_choice_default

 /opt/src/beast/sfi/sfiparams.h:314
const gchar*  sfi_pspec_get_choice_default  
(GParamSpec *pspec);

sfi_pspec_get_choice_hash

 /opt/src/beast/sfi/sfiparams.h:316
guint64  sfi_pspec_get_choice_hash  
(GParamSpec *pspec);

sfi_pspec_get_choice_values

 /opt/src/beast/sfi/sfiparams.h:315
SfiChoiceValues  sfi_pspec_get_choice_values  
(GParamSpec *pspec);

sfi_pspec_get_group

 /opt/src/beast/sfi/sfiparams.h:283
const gchar*  sfi_pspec_get_group  
(GParamSpec *pspec);

sfi_pspec_get_int_default

 /opt/src/beast/sfi/sfiparams.h:293
SfiInt  sfi_pspec_get_int_default  
(GParamSpec *pspec);

sfi_pspec_get_int_range

 /opt/src/beast/sfi/sfiparams.h:297
void  sfi_pspec_get_int_range  
(GParamSpec *pspec,
 SfiInt     *minimum_value,
 SfiInt     *maximum_value,
 SfiInt     *stepping);

sfi_pspec_get_num_default

 /opt/src/beast/sfi/sfiparams.h:301
SfiNum  sfi_pspec_get_num_default  
(GParamSpec *pspec);

sfi_pspec_get_num_range

 /opt/src/beast/sfi/sfiparams.h:305
void  sfi_pspec_get_num_range  
(GParamSpec *pspec,
 SfiNum     *minimum_value,
 SfiNum     *maximum_value,
 SfiNum     *stepping);

sfi_pspec_get_owner

 /opt/src/beast/sfi/sfiparams.h:286
const gchar*  sfi_pspec_get_owner  
(GParamSpec *pspec);

sfi_pspec_get_real_default

 /opt/src/beast/sfi/sfiparams.h:306
SfiReal  sfi_pspec_get_real_default  
(GParamSpec *pspec);

sfi_pspec_get_real_range

 /opt/src/beast/sfi/sfiparams.h:310
void  sfi_pspec_get_real_range  
(GParamSpec *pspec,
 SfiReal    *minimum_value,
 SfiReal    *maximum_value,
 SfiReal    *stepping);

sfi_pspec_get_rec_field

 /opt/src/beast/sfi/sfiparams.h:320
GParamSpec*  sfi_pspec_get_rec_field  
(GParamSpec  *pspec,
 const gchar *field_name);

sfi_pspec_get_rec_fields

 /opt/src/beast/sfi/sfiparams.h:318
SfiRecFields  sfi_pspec_get_rec_fields  
(GParamSpec *pspec);

sfi_pspec_get_seq_element

 /opt/src/beast/sfi/sfiparams.h:317
GParamSpec*  sfi_pspec_get_seq_element  
(GParamSpec *pspec);

sfi_pspec_get_string_default

 /opt/src/beast/sfi/sfiparams.h:313
const gchar*  sfi_pspec_get_string_default  
(GParamSpec *pspec);

sfi_pspec_int

 /opt/src/beast/sfi/sfiparams.h:127
GParamSpec*  sfi_pspec_int  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiInt       default_value,
 SfiInt       minimum_value,
 SfiInt       maximum_value,
 SfiInt       stepping,
 const gchar *hints);

sfi_pspec_log_scale

 /opt/src/beast/sfi/sfiparams.h:154
GParamSpec*  sfi_pspec_log_scale  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiReal      default_value,
 SfiReal      minimum_value,
 SfiReal      maximum_value,
 SfiReal      stepping,
 SfiReal      center,
 SfiReal      base,
 SfiReal      n_steps,
 const gchar *hints);

sfi_pspec_note

 /opt/src/beast/sfi/sfiparams.h:272
GParamSpec*  sfi_pspec_note  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiInt       default_value,
 SfiInt       min_note,
 SfiInt       max_note,
 gboolean     allow_void,
 const gchar *hints);

sfi_pspec_num

 /opt/src/beast/sfi/sfiparams.h:135
GParamSpec*  sfi_pspec_num  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiNum       default_value,
 SfiNum       minimum_value,
 SfiNum       maximum_value,
 SfiNum       stepping,
 const gchar *hints);

sfi_pspec_proxy

 /opt/src/beast/sfi/sfiparams.h:195
GParamSpec*  sfi_pspec_proxy  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *hints);

sfi_pspec_proxy_from_object

 /opt/src/beast/sfi/sfiparams.h:215
GParamSpec*  sfi_pspec_proxy_from_object  
(GParamSpec *object_pspec);

sfi_pspec_pspec

 /opt/src/beast/sfi/sfiparams.h:177
GParamSpec*  sfi_pspec_pspec  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *hints);

sfi_pspec_real

 /opt/src/beast/sfi/sfiparams.h:143
GParamSpec*  sfi_pspec_real  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiReal      default_value,
 SfiReal      minimum_value,
 SfiReal      maximum_value,
 SfiReal      stepping,
 const gchar *hints);

sfi_pspec_rec

 /opt/src/beast/sfi/sfiparams.h:187
GParamSpec*  sfi_pspec_rec  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 SfiRecFields static_const_fields,
 const gchar *hints);

sfi_pspec_rec_generic

 /opt/src/beast/sfi/sfiparams.h:191
GParamSpec*  sfi_pspec_rec_generic  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *hints);

sfi_pspec_seq

 /opt/src/beast/sfi/sfiparams.h:182
GParamSpec*  sfi_pspec_seq  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 GParamSpec  *element_spec,
 const gchar *hints);

sfi_pspec_set_group

 /opt/src/beast/sfi/sfiparams.h:282
GParamSpec*  sfi_pspec_set_group  
(GParamSpec  *pspec,
 const gchar *group);

sfi_pspec_set_owner

 /opt/src/beast/sfi/sfiparams.h:285
void  sfi_pspec_set_owner  
(GParamSpec  *pspec,
 const gchar *owner);

sfi_pspec_string

 /opt/src/beast/sfi/sfiparams.h:159
GParamSpec*  sfi_pspec_string  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *default_value,
 const gchar *hints);

sfi_pspec_time

 /opt/src/beast/sfi/sfiparams.h:277
GParamSpec*  sfi_pspec_time  
(const gchar *name,
 const gchar *nick,
 const gchar *blurb,
 const gchar *hints);

sfi_pspec_to_rec

 /opt/src/beast/sfi/sfiparams.h:326
SfiRec*  sfi_pspec_to_rec  
(GParamSpec *pspec);

sfi_pspec_to_serializable

 /opt/src/beast/sfi/sfiparams.h:213
GParamSpec*  sfi_pspec_to_serializable  
(GParamSpec *pspec);