Top |
Functions
Properties
|
audio-encoding | Read / Write |
|
audio-format | Read / Write |
|
encoding | Read / Write |
|
filename | Read / Write |
xml-doc | Read / Write |
Signals
open | ||
open-from-data | ||
read | ||
read-resolve | ||
read-start | ||
rw-open | ||
write | ||
write-concurrent | ||
write-resolve |
Types and Values
#define | AGS_FILE_DEFAULT_ENCODING |
#define | AGS_FILE_DEFAULT_DTD |
#define | AGS_FILE_CHECKSUM_LENGTH |
#define | AGS_FILE_DEFAULT_AUDIO_FORMAT |
#define | AGS_FILE_DEFAULT_AUDIO_ENCODING |
enum | AgsFileFlags |
#define | AGS_FILE_ERROR |
enum | AgsFileError |
Description
The AgsFile is an object to read or write files using XML. It is the persisting layer of Advanced Gtk+ Sequencer.
Functions
ags_file_set_filename ()
void ags_file_set_filename (AgsFile *file
,);
gchar *filename
Set filename
of file
.
Since:
ags_file_get_filename ()
gchar * ags_file_get_filename (AgsFile *file
);
Get filename of file
.
Since:
ags_file_set_encoding ()
void ags_file_set_encoding (AgsFile *file
,);
gchar *encoding
Set encoding
of file
.
Since:
ags_file_get_encoding ()
gchar * ags_file_get_encoding (AgsFile *file
);
Get encoding of file
.
Since:
ags_file_set_audio_format ()
void ags_file_set_audio_format (AgsFile *file
,);
gchar *audio_format
Set audio_format
of file
.
Since:
ags_file_get_audio_format ()
gchar * ags_file_get_audio_format (AgsFile *file
);
Get audio format of file
.
Since:
ags_file_set_audio_encoding ()
void ags_file_set_audio_encoding (AgsFile *file
,);
gchar *audio_encoding
Set audio_encoding
of file
.
Since:
ags_file_get_audio_encoding ()
gchar * ags_file_get_audio_encoding (AgsFile *file
);
Get audio encoding of file
.
Since:
ags_file_set_xml_doc ()
void ags_file_set_xml_doc (AgsFile *file
,);
xmlDoc *xml_doc
Set xml_doc
of file
.
Since:
ags_file_get_xml_doc ()
xmlDoc * ags_file_get_xml_doc (AgsFile *file
);
Get xml doc of file
.
Since:
ags_file_str2md5 ()
gchar * ags_file_str2md5 (,
gchar *content);
guint content_length
Compute MD5 sums of a buffer.
Since:
ags_file_add_id_ref ()
void ags_file_add_id_ref (AgsFile *file
,);
GObject *id_ref
Adds id_ref
to file
.
Since:
ags_file_find_id_ref_by_node ()
GObject * ags_file_find_id_ref_by_node (AgsFile *file
,);
xmlNode *node
Find a reference by its XML node.
Since:
ags_file_find_id_ref_by_xpath ()
GObject * ags_file_find_id_ref_by_xpath (AgsFile *file
,);
gchar *xpath
Lookup a reference by xpath
.
Since:
ags_file_find_id_ref_by_reference ()
GObject * ags_file_find_id_ref_by_reference (AgsFile *file
,);
gpointer ref
Find a reference matching ref
.
Since:
ags_file_add_lookup ()
void ags_file_add_lookup (AgsFile *file
,);
GObject *file_lookup
Add file_lookup
for later invoking.
Since:
ags_file_add_launch ()
void ags_file_add_launch (AgsFile *file
,);
GObject *file_launch
Add file_launch
for later invoking.
Since:
ags_file_open ()
void ags_file_open (AgsFile *file
,);
GError **error
Opens the file specified by :filename property.
Since:
ags_file_open_from_data ()
void ags_file_open_from_data (AgsFile *file
,,
gchar *data,
guint length);
GError **error
Opens the file provided by data
.
Parameters
file |
the AgsFile |
|
data |
a buffer containing the XML document |
|
length |
the buffer length |
|
error |
the return location for errors |
Since:
ags_file_rw_open ()
void ags_file_rw_open (AgsFile *file
,,
gboolean create);
GError **error
Opens the file specified by :filename property in read-write mode.
Parameters
file |
the AgsFile |
|
create |
if |
|
error |
the return location for errors |
Since:
ags_file_open_filename ()
void ags_file_open_filename (AgsFile *file
,);
gchar *filename
Opens the file specified by filename
property.
Since:
ags_file_write_resolve ()
void ags_file_write_resolve (AgsFile *file
);
Resolve references to XPath expressions.
Since:
ags_file_read_start ()
void ags_file_read_start (AgsFile *file
);
Update or start the application.
Since:
ags_file_read_config ()
void ags_file_read_config (AgsFile *file
,,
xmlNode *node);
GObject **ags_config
ags_file_write_config ()
void ags_file_write_config (AgsFile *file
,,
xmlNode *parent);
GObject *ags_config
ags_file_read_application_context ()
void ags_file_read_application_context (AgsFile *file
,,
xmlNode *node);
GObject **application_context
ags_file_write_application_context ()
void ags_file_write_application_context (AgsFile *file
,,
xmlNode *parent);
GObject *application_context
Types and Values
enum AgsFileFlags
Enum values to control the behavior or indicate internal state of AgsFile by enable/disable as flags.
Property Details
The “audio-encoding”
property
“audio-encoding”gchar *
The encoding to use for embedding audio data.
Owner: AgsFile
Flags: Read / Write
Default value: "base64"
Since:
The “audio-format”
property
“audio-format”gchar *
The format of embedded audio data.
Owner: AgsFile
Flags: Read / Write
Default value: "raw"
Since:
The “encoding”
property
“encoding”gchar *
The charset encoding to use.
Owner: AgsFile
Flags: Read / Write
Default value: NULL
Since:
The “filename”
property
“filename”gchar *
The assigned filename to open and read from.
Owner: AgsFile
Flags: Read / Write
Default value: NULL
Since:
Signal Details
The “open”
signal
void user_function (AgsFile *file,gpointer error,gpointer user_data)
Open file
with appropriate filename.
Parameters
file |
the AgsFile |
|
error |
a |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “open-from-data”
signal
void user_function (AgsFile *file,gchar *data,guint length,gpointer error,gpointer user_data)
Open file
from a buffer containing the file.
Parameters
file |
the AgsFile |
|
data |
the buffer containing the file |
|
length |
the buffer length |
|
error |
a |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “read”
signal
void user_function (AgsFile *file,gpointer user_data)
Read a XML document from disk with specified filename.
Flags:
Since:
The “read-resolve”
signal
void user_function (AgsFile *file,gpointer user_data)
Resolve XPath expressions to their counterpart the newly created instances refering to.
Flags:
Since:
The “read-start”
signal
void user_function (AgsFile *file,gpointer user_data)
Hook after reading XML document to update or start the application.
Flags:
Since:
The “rw-open”
signal
void user_function (AgsFile *agsfile,gboolean arg1,gpointer arg2,gpointer user_data)
Flags:
The “write”
signal
void user_function (AgsFile *file,gpointer user_data)
Write XML Document to disk.
Flags:
Since:
The “write-concurrent”
signal
void user_function (AgsFile *agsfile,gpointer user_data)
Flags: