AgsSimpleFile: Advanced Gtk+ Sequencer Application Reference Manual

AgsSimpleFile

Stability Level

Stable, unless otherwise indicated

Functions

gchar *	ags_simple_file_str2md5 ()
void	ags_simple_file_add_id_ref ()
GObject *	ags_simple_file_find_id_ref_by_node ()
GList *	ags_simple_file_find_id_ref_by_xpath ()
GList *	ags_simple_file_find_id_ref_by_reference ()
void	ags_simple_file_add_lookup ()
void	ags_simple_file_add_launch ()
void	ags_simple_file_open ()
void	ags_simple_file_open_from_data ()
void	ags_simple_file_rw_open ()
void	ags_simple_file_open_filename ()
void	ags_simple_file_close ()
void	ags_simple_file_write ()
void	ags_simple_file_write_resolve ()
void	ags_simple_file_read ()
void	ags_simple_file_read_resolve ()
void	ags_simple_file_read_start ()
void	ags_simple_file_read_config ()
AgsSimpleFile *	ags_simple_file_new ()
#define	AGS_IS_SIMPLE_FILE()
#define	AGS_IS_SIMPLE_FILE_CLASS()
#define	AGS_SIMPLE_FILE()
#define	AGS_SIMPLE_FILE_CLASS()
#define	AGS_SIMPLE_FILE_GET_CLASS()
GType	ags_simple_file_get_type ()

Properties

char *	audio-encoding	Read / Write
char *	audio-format	Read / Write
char *	encoding	Read / Write
char *	filename	Read / Write
gboolean	no-config	Read / Write
gpointer	xml-doc	Read / Write

Signals

void	open	Run Last
void	open-from-data	Run Last
void	read	Run Last
void	read-resolve	Run Last
void	read-start	Run Last
void	rw-open	Run Last
void	write	Run Last
void	write-resolve	Run Last

Types and Values

#define	AGS_SIMPLE_FILE_DEFAULT_ENCODING
#define	AGS_SIMPLE_FILE_DEFAULT_DTD
#define	AGS_SIMPLE_FILE_CHECKSUM_LENGTH
#define	AGS_SIMPLE_FILE_DEFAULT_AUDIO_FORMAT
#define	AGS_SIMPLE_FILE_DEFAULT_AUDIO_ENCODING
#define	AGS_SIMPLE_FILE_ID_PROP
#define	AGS_SIMPLE_FILE_NAME_PROP
#define	AGS_SIMPLE_FILE_TYPE_PROP
#define	AGS_SIMPLE_FILE_VERSION_PROP
#define	AGS_SIMPLE_FILE_BUILD_ID_PROP
#define	AGS_SIMPLE_FILE_TRUE
#define	AGS_SIMPLE_FILE_FALSE
enum	AgsSimpleFileFlags
#define	AGS_SIMPLE_FILE_ERROR
enum	AgsSimpleFileError
#define	AGS_TYPE_SIMPLE_FILE
struct	AgsSimpleFile
struct	AgsSimpleFileClass

Object Hierarchy

    GObject
    ╰── AgsSimpleFile

Description

Functions

ags_simple_file_str2md5 ()

gchar *
ags_simple_file_str2md5 (gchar *content,
                         guint content_length);

ags_simple_file_add_id_ref ()

void
ags_simple_file_add_id_ref (AgsSimpleFile *simple_file,
                            GObject *id_ref);

ags_simple_file_find_id_ref_by_node ()

GObject *
ags_simple_file_find_id_ref_by_node (AgsSimpleFile *simple_file,
                                     xmlNode *node);

ags_simple_file_find_id_ref_by_xpath ()

GList *
ags_simple_file_find_id_ref_by_xpath (AgsSimpleFile *simple_file,
                                      gchar *xpath);

ags_simple_file_find_id_ref_by_reference ()

GList *
ags_simple_file_find_id_ref_by_reference
                               (AgsSimpleFile *simple_file,
                                gpointer ref);

ags_simple_file_add_lookup ()

void
ags_simple_file_add_lookup (AgsSimpleFile *simple_file,
                            GObject *file_lookup);

ags_simple_file_add_launch ()

void
ags_simple_file_add_launch (AgsSimpleFile *simple_file,
                            GObject *file_launch);

ags_simple_file_open ()

void
ags_simple_file_open (AgsSimpleFile *simple_file,
                      GError **error);

ags_simple_file_open_from_data ()

void
ags_simple_file_open_from_data (AgsSimpleFile *simple_file,
                                gchar *data,
                                guint length,
                                GError **error);

ags_simple_file_rw_open ()

void
ags_simple_file_rw_open (AgsSimpleFile *simple_file,
                         gboolean create,
                         GError **error);

ags_simple_file_open_filename ()

void
ags_simple_file_open_filename (AgsSimpleFile *simple_file,
                               gchar *filename);

ags_simple_file_close ()

void
ags_simple_file_close (AgsSimpleFile *simple_file);

ags_simple_file_write ()

void
ags_simple_file_write (AgsSimpleFile *simple_file);

ags_simple_file_write_resolve ()

void
ags_simple_file_write_resolve (AgsSimpleFile *simple_file);

ags_simple_file_read ()

void
ags_simple_file_read (AgsSimpleFile *simple_file);

ags_simple_file_read_resolve ()

void
ags_simple_file_read_resolve (AgsSimpleFile *simple_file);

ags_simple_file_read_start ()

void
ags_simple_file_read_start (AgsSimpleFile *simple_file);

ags_simple_file_read_config ()

void
ags_simple_file_read_config (AgsSimpleFile *simple_file,
                             xmlNode *node,
                             AgsConfig **ags_config);

ags_simple_file_new ()

AgsSimpleFile *
ags_simple_file_new ();

AGS_IS_SIMPLE_FILE()

#define AGS_IS_SIMPLE_FILE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_SIMPLE_FILE))

AGS_IS_SIMPLE_FILE_CLASS()

#define AGS_IS_SIMPLE_FILE_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_SIMPLE_FILE))

AGS_SIMPLE_FILE()

#define AGS_SIMPLE_FILE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_SIMPLE_FILE, AgsSimpleFile))

AGS_SIMPLE_FILE_CLASS()

#define AGS_SIMPLE_FILE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_SIMPLE_FILE, AgsSimpleFileClass))

AGS_SIMPLE_FILE_GET_CLASS()

#define AGS_SIMPLE_FILE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_SIMPLE_FILE, AgsSimpleFileClass))

ags_simple_file_get_type ()

GType
ags_simple_file_get_type (void);

Types and Values

AGS_SIMPLE_FILE_DEFAULT_ENCODING

#define AGS_SIMPLE_FILE_DEFAULT_ENCODING "UTF-8"

AGS_SIMPLE_FILE_DEFAULT_DTD

#define AGS_SIMPLE_FILE_DEFAULT_DTD "ags_simple_file.dtd"

AGS_SIMPLE_FILE_CHECKSUM_LENGTH

#define AGS_SIMPLE_FILE_CHECKSUM_LENGTH (g_checksum_type_get_length(G_CHECKSUM_MD5))

AGS_SIMPLE_FILE_DEFAULT_AUDIO_FORMAT

#define AGS_SIMPLE_FILE_DEFAULT_AUDIO_FORMAT "raw"

AGS_SIMPLE_FILE_DEFAULT_AUDIO_ENCODING

#define AGS_SIMPLE_FILE_DEFAULT_AUDIO_ENCODING "base64"

AGS_SIMPLE_FILE_ID_PROP

#define AGS_SIMPLE_FILE_ID_PROP "id"

AGS_SIMPLE_FILE_NAME_PROP

#define AGS_SIMPLE_FILE_NAME_PROP "name"

AGS_SIMPLE_FILE_TYPE_PROP

#define AGS_SIMPLE_FILE_TYPE_PROP "type"

AGS_SIMPLE_FILE_VERSION_PROP

#define AGS_SIMPLE_FILE_VERSION_PROP "version"

AGS_SIMPLE_FILE_BUILD_ID_PROP

#define AGS_SIMPLE_FILE_BUILD_ID_PROP "build-id"

AGS_SIMPLE_FILE_TRUE

#define AGS_SIMPLE_FILE_TRUE "true"

AGS_SIMPLE_FILE_FALSE

#define AGS_SIMPLE_FILE_FALSE "false"

enum AgsSimpleFileFlags

Members

AGS_SIMPLE_FILE_READ_BASIC
AGS_SIMPLE_FILE_READ_AUDIO_SIGNAL
AGS_SIMPLE_FILE_READ_EMBEDDED_AUDIO
AGS_SIMPLE_FILE_WRITE_BASIC
AGS_SIMPLE_FILE_WRITE_AUDIO_SIGNAL
AGS_SIMPLE_FILE_WRITE_EMBEDDED_AUDIO

AGS_SIMPLE_FILE_ERROR

#define AGS_SIMPLE_FILE_ERROR (ags_simple_file_error_quark())

enum AgsSimpleFileError

Members

AGS_SIMPLE_FILE_ERROR_PARSER_FAILURE

AGS_TYPE_SIMPLE_FILE

#define AGS_TYPE_SIMPLE_FILE                (ags_simple_file_get_type())

struct AgsSimpleFile

struct AgsSimpleFile;

struct AgsSimpleFileClass

struct AgsSimpleFileClass {
  GObjectClass gobject;

  void (*open)(AgsSimpleFile *simple_file,
	       GError **error);
  void (*open_from_data)(AgsSimpleFile *simple_file,
			 gchar *data, guint length,
			 GError **error);
  void (*rw_open)(AgsSimpleFile *simple_file,
		  gboolean create,
		  GError **error);

  void (*write)(AgsSimpleFile *simple_file);
  void (*write_resolve)(AgsSimpleFile *simple_file);

  void (*read)(AgsSimpleFile *simple_file);
  void (*read_resolve)(AgsSimpleFile *simple_file);
  void (*read_start)(AgsSimpleFile *simple_file);
};

Property Details

The `“audio-encoding”` property

  “audio-encoding”           char *

The encoding to use for embedding audio data.

Owner: AgsSimpleFile

Flags: Read / Write

Default value: "base64"

Since: 3.0.0

The `“audio-format”` property

  “audio-format”             char *

The format of embedded audio data.

Owner: AgsSimpleFile

Flags: Read / Write

Default value: "raw"

Since: 3.0.0

The `“encoding”` property

  “encoding”                 char *

The charset encoding to use.

Owner: AgsSimpleFile

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“filename”` property

  “filename”                 char *

The assigned filename to open and read from.

Owner: AgsSimpleFile

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“no-config”` property

  “no-config”                gboolean

The no config option.

Owner: AgsSimpleFile

Flags: Read / Write

Default value: FALSE

Since: 3.16.9

The `“xml-doc”` property

  “xml-doc”                  gpointer

The assigned xml-doc.

Owner: AgsSimpleFile

Flags: Read / Write

Since: 3.0.0

Signal Details

The `“open”` signal

void
user_function (AgsSimpleFile *simple_file,
               gpointer       error,
               gpointer       user_data)

Open simple_file with appropriate filename.

Parameters

simple_file	the AgsSimpleFile
error	a GError pointer to return error
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“open-from-data”` signal

void
user_function (AgsSimpleFile *simple_file,
               char          *create,
               guint          error,
               gpointer       arg3,
               gpointer       user_data)

Open simple_file in read-write mode.

Parameters

simple_file	the AgsSimpleFile
create	if `TRUE` the file will be created if not exists
error	a GError pointer to return error
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“read”` signal

void
user_function (AgsSimpleFile *simple_file,
               gpointer       user_data)

Read a XML document from disk with specified simple_filename.

Parameters

simple_file	the AgsSimpleFile
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“read-resolve”` signal

void
user_function (AgsSimpleFile *simple_file,
               gpointer       user_data)

Resolve XPath expressions to their counterpart the newly created instances refering to.

Parameters

simple_file	the AgsSimpleFile
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“read-start”` signal

void
user_function (AgsSimpleFile *simple_file,
               gpointer       user_data)

Start assigning resources.

Parameters

simple_file	the AgsSimpleFile
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“rw-open”` signal

void
user_function (AgsSimpleFile *agssimplefile,
               gboolean       arg1,
               gpointer       arg2,
               gpointer       user_data)

Flags: Run Last

The `“write”` signal

void
user_function (AgsSimpleFile *simple_file,
               gpointer       user_data)

Write XML Document to disk.

Parameters

simple_file	the AgsSimpleFile
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“write-resolve”` signal

void
user_function (AgsSimpleFile *simple_file,
               gpointer       user_data)

Resolve references and generate thus XPath expressions just before writing to disk.

Parameters

simple_file	the AgsSimpleFile
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

AgsSimpleFile

Stability Level

Functions

Properties

Signals

Types and Values

Object Hierarchy

Description

Functions

ags_simple_file_str2md5 ()

ags_simple_file_add_id_ref ()

ags_simple_file_find_id_ref_by_node ()

ags_simple_file_find_id_ref_by_xpath ()

ags_simple_file_find_id_ref_by_reference ()

ags_simple_file_add_lookup ()

ags_simple_file_add_launch ()

ags_simple_file_open ()

ags_simple_file_open_from_data ()

ags_simple_file_rw_open ()

ags_simple_file_open_filename ()

ags_simple_file_close ()

ags_simple_file_write ()

ags_simple_file_write_resolve ()

ags_simple_file_read ()

ags_simple_file_read_resolve ()

ags_simple_file_read_start ()

ags_simple_file_read_config ()

ags_simple_file_new ()

AGS_IS_SIMPLE_FILE()

AGS_IS_SIMPLE_FILE_CLASS()

AGS_SIMPLE_FILE()

AGS_SIMPLE_FILE_CLASS()

AGS_SIMPLE_FILE_GET_CLASS()

ags_simple_file_get_type ()

Types and Values

AGS_SIMPLE_FILE_DEFAULT_ENCODING

AGS_SIMPLE_FILE_DEFAULT_DTD

AGS_SIMPLE_FILE_CHECKSUM_LENGTH

AGS_SIMPLE_FILE_DEFAULT_AUDIO_FORMAT

AGS_SIMPLE_FILE_DEFAULT_AUDIO_ENCODING

AGS_SIMPLE_FILE_ID_PROP

AGS_SIMPLE_FILE_NAME_PROP

AGS_SIMPLE_FILE_TYPE_PROP

AGS_SIMPLE_FILE_VERSION_PROP

AGS_SIMPLE_FILE_BUILD_ID_PROP

AGS_SIMPLE_FILE_TRUE

AGS_SIMPLE_FILE_FALSE

enum AgsSimpleFileFlags

Members

AGS_SIMPLE_FILE_ERROR

enum AgsSimpleFileError

Members

AGS_TYPE_SIMPLE_FILE

struct AgsSimpleFile

struct AgsSimpleFileClass

Property Details

The “audio-encoding” property

The “audio-format” property

The “encoding” property

The “filename” property

The “no-config” property

The “xml-doc” property

Signal Details

The “open” signal

Parameters

The “open-from-data” signal

Parameters

The “read” signal

Parameters

The “read-resolve” signal

Parameters

The “read-start” signal

Parameters

The “rw-open” signal

The “write” signal

Parameters

The “write-resolve” signal

Parameters

The `“audio-encoding”` property

The `“audio-format”` property

The `“encoding”` property

The `“filename”` property

The `“no-config”` property

The `“xml-doc”` property

The `“open”` signal

The `“open-from-data”` signal

The `“read”` signal

The `“read-resolve”` signal

The `“read-start”` signal

The `“rw-open”` signal

The `“write”` signal

The `“write-resolve”` signal