AgsConfig

AgsConfig — Config Advanced Gtk+ Sequencer

Functions

Properties

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── AgsConfig

Implemented Interfaces

AgsConfig implements AgsConnectable.

Includes

#include <ags/object/ags_config.h>

Description

AgsConfig provides configuration to Advanced Gtk+ Sequencer.

Functions

ags_config_load_defaults ()

void
ags_config_load_defaults (AgsConfig *config);

Load configuration from default values.

Parameters

config

the AgsConfig

 

Since: 1.0.0


ags_config_load_from_file ()

void
ags_config_load_from_file (AgsConfig *config,
                           gchar *filename);

Load configuration from filename .

Parameters

config

the AgsConfig

 

filename

the configuration file

 

Since: 1.0.0


ags_config_load_from_data ()

void
ags_config_load_from_data (AgsConfig *config,
                           char *buffer,
                           gsize buffer_length);

Read configuration in memory.

Parameters

config

the AgsConfig

 

buffer

the data buffer

 

buffer_length

the size of the buffer

 

Since: 1.0.0


ags_config_set_value ()

void
ags_config_set_value (AgsConfig *config,
                      gchar *group,
                      gchar *key,
                      gchar *value);

Set config by group and key , applying value .

Parameters

config

the AgsConfig

 

group

the config group identifier

 

key

the key of the property

 

value

the value to set

 

Since: 1.0.0


ags_config_get_value ()

gchar *
ags_config_get_value (AgsConfig *config,
                      gchar *group,
                      gchar *key);

Retrieve config by group and key .

Parameters

config

the AgsConfig

 

group

the config group identifier

 

key

the key of the property

 

Returns

the property's value

Since: 1.0.0


ags_config_to_data ()

void
ags_config_to_data (AgsConfig *config,
                    char **buffer,
                    gsize *buffer_length);

Save configuration.

Parameters

config

the AgsConfig

 

buffer

the data buffer

 

buffer_length

the size of the buffer

 

Since: 1.0.0


ags_config_save ()

void
ags_config_save (AgsConfig *config);

Save configuration.

Parameters

config

the AgsConfig

 

Since: 1.0.0


ags_config_clear ()

void
ags_config_clear (AgsConfig *config);

Clears configuration.

Parameters

config

the AgsConfig

 

Since: 1.0.0


ags_config_get_instance ()

AgsConfig *
ags_config_get_instance ();

Get config instance.

Returns

the config instance

Since: 1.0.0


ags_config_new ()

AgsConfig *
ags_config_new (GObject *application_context);

Creates an AgsConfig.

Parameters

application_context

the AgsApplicationContext

 

Returns

a new AgsConfig.

Since: 1.0.0


AGS_CONFIG()

#define AGS_CONFIG(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_CONFIG, AgsConfig))

AGS_CONFIG_CLASS()

#define AGS_CONFIG_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_CONFIG, AgsConfigClass))

AGS_CONFIG_GET_CLASS()

#define AGS_CONFIG_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_CONFIG, AgsConfigClass))

AGS_IS_CONFIG()

#define AGS_IS_CONFIG(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_CONFIG))

ags_config_get_type ()

GType
ags_config_get_type ();

Types and Values

AGS_CONFIG_DEFAULT_VERSION

#define AGS_CONFIG_DEFAULT_VERSION "0.7.0\0"

AGS_CONFIG_DEFAULT_BUILD_ID

#define AGS_CONFIG_DEFAULT_BUILD_ID "CEST 13-10-2015 01:19\0"

AGS_CONFIG_GENERIC

#define AGS_CONFIG_GENERIC "generic\0"

AGS_CONFIG_THREAD

#define AGS_CONFIG_THREAD "thread\0"

AGS_CONFIG_SOUNDCARD

#define AGS_CONFIG_SOUNDCARD "soundcard\0"

AGS_CONFIG_SOUNDCARD_0

#define AGS_CONFIG_SOUNDCARD_0 "soundcard-0\0"

AGS_CONFIG_SEQUENCER

#define AGS_CONFIG_SEQUENCER "sequencer\0"

AGS_CONFIG_SEQUENCER_0

#define AGS_CONFIG_SEQUENCER_0 "sequencer-0\0"

AGS_CONFIG_RECALL

#define AGS_CONFIG_RECALL "recall\0"

enum AgsConfigFlags

Enum values to control the behavior or indicate internal state of AgsConfig by enable/disable as flags.

Members

AGS_CONFIG_CONNECTED

the config was connected by calling AgsConnectable::connect()

 

AGS_TYPE_CONFIG

#define AGS_TYPE_CONFIG                (ags_config_get_type ())

struct AgsConfig

struct AgsConfig;

struct AgsConfigClass

struct AgsConfigClass {
  GObjectClass object;

  void (*load_defaults)(AgsConfig *config);

  void (*set_value)(AgsConfig *config, gchar *group, gchar *key, gchar *value);
  gchar* (*get_value)(AgsConfig *config, gchar *group, gchar *key);
};

Property Details

The “application-context” property

  “application-context”      AgsApplicationContext *

The assigned application context.

Flags: Read / Write

Since: 1.0.0

Signal Details

The “get-value” signal

gchar*
user_function (AgsConfig *config,
               gchar     *group,
               gchar     *key,
               gpointer   user_data)

The ::get-value signal notifies about value been getting.

Parameters

config

the object to resolve

 

group

the group to retrieve from

 

key

the key to get

 

user_data

user data set when the signal handler was connected.

 

Returns

the value

Flags: Run Last

Since: 1.0.0


The “load-defaults” signal

void
user_function (AgsConfig *config,
               gpointer   user_data)

The ::load-defaults signal notifies about loading defaults

Parameters

config

the object to resolve

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0


The “set-value” signal

void
user_function (AgsConfig *config,
               gchar     *group,
               gchar     *key,
               gchar     *value,
               gpointer   user_data)

The ::set-value signal notifies about value been setting.

Parameters

config

the object to resolve

 

group

the group to apply to

 

key

the key to set

 

value

the value to apply

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0