Class

AgsFile

[−]

Description

class Ags.File : GObject.Object
{
  flags: guint,
  obj_mutex: GRecMutex,
  app_encoding: gchar*,
  out: FILE*,
  buffer: xmlChar*,
  filename: gchar*,
  encoding: gchar*,
  dtd: gchar*,
  audio_format: gchar*,
  audio_encoding: gchar*,
  read_charset_converter: GCharsetConverter*,
  write_charset_converter: GCharsetConverter*,
  doc: xmlDoc*,
  root_node: xmlNode*,
  id_refs: GList*,
  lookup: GList*,
  launch: GList*,
  clipboard: GObject*,
  property: GList*,
  script: GList*,
  cluster: GObject*,
  client: GObject*,
  server: GObject*,
  history: GObject*,
  embedded_audio: GList*,
  file_link: GList*
}

No description available.

[−]

Ancestors

GObject

[−]

Constructors

ags_file_new

Creates an AgsFile.

since: 3.0.0

[−]

Functions

ags_file_str2md5

Compute MD5 sums of a buffer.

since: 3.0.0

[−]

Instance methods

ags_file_add_id_ref

Adds id_ref to file.

since: 3.0.0

ags_file_add_launch

Add file_launch for later invoking.

since: 3.0.0

ags_file_add_lookup

Add file_lookup for later invoking.

since: 3.0.0

ags_file_close

Closes file.

since: 3.0.0

ags_file_find_id_ref_by_node

Find a reference by its XML node.

since: 3.0.0

ags_file_find_id_ref_by_reference

Find a reference matching ref.

since: 3.0.0

ags_file_find_id_ref_by_xpath

Lookup a reference by xpath.

since: 3.0.0

ags_file_get_audio_encoding

Get audio encoding of file.

since: 3.6.17

ags_file_get_audio_format

Get audio format of file.

since: 3.6.17

ags_file_get_encoding

Get encoding of file.

since: 3.6.17

ags_file_get_filename

Get filename of file.

since: 3.6.17

ags_file_get_xml_doc

Get xml doc of file.

since: 3.6.17

ags_file_open

Opens the file specified by :filename property.

since: 3.0.0

ags_file_open_filename

Opens the file specified by filename property.

since: 3.0.0

ags_file_open_from_data

Opens the file provided by data.

since: 3.0.0

ags_file_read

Read XML document from disk.

since: 3.0.0

ags_file_read_application_context

No description available.

ags_file_read_config

No description available.

ags_file_read_resolve

No description available.

ags_file_read_start

Update or start the application.

since: 3.0.0

ags_file_rw_open

Opens the file specified by :filename property in read-write mode.

since: 3.0.0

ags_file_set_audio_encoding

Set audio_encoding of file.

since: 3.6.17

ags_file_set_audio_format

Set audio_format of file.

since: 3.6.17

ags_file_set_encoding

Set encoding of file.

since: 3.6.17

ags_file_set_filename

Set filename of file.

since: 3.6.17

ags_file_set_xml_doc

Set xml_doc of file.

since: 3.6.17

ags_file_write

Write the XML document to disk.

since: 3.0.0

ags_file_write_application_context

No description available.

ags_file_write_concurrent

No description available.

ags_file_write_config

No description available.

ags_file_write_resolve

Resolve references to XPath expressions.

since: 3.0.0

ags_file_xml_add_child

Set root element root_node of doc.

since: 4.0.0

ags_file_xml_get_content

Get content of node.

since: 4.0.0

ags_file_xml_get_node_children

No description available.

ags_file_xml_get_node_name

Get node name of node.

since: 4.0.0

ags_file_xml_get_node_next

No description available.

ags_file_xml_get_node_parent

No description available.

ags_file_xml_get_prop

Get property of node.

since: 4.0.0

ags_file_xml_get_root_element

Get root element of doc.

since: 4.0.0

ags_file_xml_new_doc

Create #xmlDoc-struct.

since: 4.0.0

ags_file_xml_new_node

Create #xmlNode-struct.

since: 4.0.0

ags_file_xml_set_content

Set content of node.

since: 4.0.0

ags_file_xml_set_prop

Set property of node.

since: 4.0.0

ags_file_xml_set_root_element

Set root element root_node of doc.

since: 4.0.0

[+]

Methods inherited from GObject (43)

[−]

Properties

Ags.File:audio-encoding

The encoding to use for embedding audio data.

since: 3.0.0

Ags.File:audio-format

The format of embedded audio data.

since: 3.0.0

Ags.File:encoding

The charset encoding to use.

since: 3.0.0

Ags.File:filename

The assigned filename to open and read from.

since: 3.0.0

Ags.File:xml-doc

The assigned xml-doc.

since: 3.0.0

[−]

Signals

Ags.File::open

Open file with appropriate filename.

since: 3.0.0

Ags.File::open-from-data

Open file from a buffer containing the file.

since: 3.0.0

Ags.File::read

Read a XML document from disk with specified filename.

since: 3.0.0

Ags.File::read-resolve

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

since: 3.0.0

Ags.File::read-start

Hook after reading XML document to update or start the application.

since: 3.0.0

Ags.File::rw-open

No description available.

Ags.File::write

Write XML Document to disk.

since: 3.0.0

Ags.File::write-concurrent

No description available.

Ags.File::write-resolve

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

since: 3.0.0

[+]

Signals inherited from GObject (1)

[+]

Class structure

struct AgsFileClass {
  GObjectClass gobject;
  void (* open) (
    AgsFile* file,
    GError** error
  );
  void (* open_from_data) (
    AgsFile* file,
    gchar* data,
    guint length,
    GError** error
  );
  void (* rw_open) (
    AgsFile* file,
    gboolean create,
    GError** error
  );
  void (* write) (
    AgsFile* file
  );
  void (* write_concurrent) (
    AgsFile* file
  );
  void (* write_resolve) (
    AgsFile* file
  );
  void (* read) (
    AgsFile* file
  );
  void (* read_resolve) (
    AgsFile* file
  );
  void (* read_start) (
    AgsFile* file
  );
  
}