---

mlview-file-descriptor.h File Reference

#include <gnome.h>

Go to the source code of this file.

Data Structures
struct	_MlViewFileDescriptor
Typedefs
typedef _MlViewFileDescriptor	MlViewFileDescriptor
typedef _MlViewFileDescriptorPrivate	MlViewFileDescriptorPrivate
Functions
MlViewFileDescriptor *	mlview_file_descriptor_new (const gchar *a_file_path)
void	mlview_file_descriptor_destroy (MlViewFileDescriptor *a_file_desc)
gchar *	mlview_file_descriptor_get_file_path (const MlViewFileDescriptor *a_file_desc)
void	mlview_file_descriptor_set_file_path (MlViewFileDescriptor *a_file_desc, gchar *file_path)
guint	mlview_file_descriptor_get_lmd (const MlViewFileDescriptor *a_file_desc)
void	mlview_file_descriptor_set_lmd (MlViewFileDescriptor *a_file_desc, guint a_last_modified_time)
	Sets the last modified date to a_last_modif time.
void	mlview_file_descriptor_update_modified_time (MlViewFileDescriptor *a_file_desc)
	Sets the last modified time of the current instance of file descriptor to the current time.
gint	mlview_file_descriptor_is_modified (const MlViewFileDescriptor *a_file_desc, gboolean *a_is_modified)
gint	mlview_file_descriptor_is_readable (const MlViewFileDescriptor *a_file_desc, gboolean *a_is_readable)
gint	mlview_file_descriptor_is_writeable (const MlViewFileDescriptor *a_file_desc, gboolean *a_is_writeable)
gint	mlview_file_descriptor_is_dir (const MlViewFileDescriptor *a_file_desc, gboolean *a_is_dir)
gint	mlview_file_descriptor_is_regular_file (const MlViewFileDescriptor *a_file_desc, gboolean *a_is_reg)
gint	mlview_file_descriptor_create_directory (MlViewFileDescriptor *a_file_desc, guint a_mode)
gint	mlview_file_descriptor_create_file (MlViewFileDescriptor *a_file_desc, guint a_mode)
gint	mlview_file_descriptor_is_local (MlViewFileDescriptor *a_file_desc, gboolean *a_is_local)

---

Typedef Documentation

typedef struct _MlViewFileDescriptor MlViewFileDescriptor

Definition at line 24 of file mlview-file-descriptor.h.

typedef struct _MlViewFileDescriptorPrivate MlViewFileDescriptorPrivate

Definition at line 25 of file mlview-file-descriptor.h.

---

Function Documentation

gint mlview_file_descriptor_create_directory (  MlViewFileDescriptor *    a_file_desc, guint    a_mode )

Definition at line 386 of file mlview-file-descriptor.c. References PRIVATE.

gint mlview_file_descriptor_create_file (  MlViewFileDescriptor *    a_file_desc, guint    a_mode )

Parameters: a_mode  the file mode a_file_desc  creates a file descriptor. Definition at line 405 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_settings_manager_create_personal_settings_file().

void mlview_file_descriptor_destroy (  MlViewFileDescriptor *    a_file_desc )

Parameters: a_file_desc  Definition at line 103 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_app_context_get_xpm(), mlview_settings_manager_create_personal_settings_file(), and mlview_settings_manager_personal_settings_file_exists().

gchar* mlview_file_descriptor_get_file_path (  const MlViewFileDescriptor *    a_file_desc )

Parameters: a_file_desc  The current instance of file descriptor. Returns: NULL. The file path can also be NULL. Definition at line 257 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_editor_add_xml_document_view(), mlview_editor_remove_xml_document_view(), mlview_xml_document_clone(), mlview_xml_document_get_file_path(), and mlview_xml_document_save().

guint mlview_file_descriptor_get_lmd (  const MlViewFileDescriptor *    a_file_desc )

Parameters: a_file_desc  the current instance of MlViewFileDescriptor Returns: the last modif date of the file pointed by file desc. Definition at line 302 of file mlview-file-descriptor.c. References PRIVATE.

gint mlview_file_descriptor_is_dir (  const MlViewFileDescriptor *    a_file_desc, gboolean *    a_is_dir )

Parameters: a_is_dir  response. Equals TRUE if the file descriptor points to a directory and false if not. a_file_desc  the current file descriptor Definition at line 337 of file mlview-file-descriptor.c. References PRIVATE.

gint mlview_file_descriptor_is_local (  MlViewFileDescriptor *    a_file_desc, gboolean *    a_is_local )

Definition at line 429 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_file_descriptor_fetch_file().

gint mlview_file_descriptor_is_modified (  const MlViewFileDescriptor *    a_file_desc, gboolean *    a_is_modified )

Parameters: a_file_desc  the current instance of MlViewFileDescriptor. Returns: FALSE also if the a_file_desc pointer is not safe (is null, or contains unexpected null pointer fields). Definition at line 153 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_xml_document_needs_saving().

gint mlview_file_descriptor_is_readable (  const MlViewFileDescriptor *    a_file_desc, gboolean *    a_is_readable )

Parameters: a_file_desc  the current instance of MlViewFileDescriptor Definition at line 184 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_app_context_get_xpm().

gint mlview_file_descriptor_is_regular_file (  const MlViewFileDescriptor *    a_file_desc, gboolean *    a_is_reg )

Definition at line 361 of file mlview-file-descriptor.c. References PRIVATE.

gint mlview_file_descriptor_is_writeable (  const MlViewFileDescriptor *    a_file_desc, gboolean *    a_is_writeable )

Parameters: a_file_desc  the current instance of MlViewFileDescriptor Definition at line 219 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_settings_manager_personal_settings_file_exists().

MlViewFileDescriptor* mlview_file_descriptor_new (  const gchar *    a_file_uri )

Parameters: param  a_file_path The file path to associate to the file descriptor. This null terminated char is duplicated by thisfunction. This file path can be a URI. You can use the mlview_file_descriptor_is_a_uri() method to know. Returns: NULL. Definition at line 64 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_app_context_get_xpm(), mlview_settings_manager_create_personal_settings_file(), mlview_settings_manager_personal_settings_file_exists(), and mlview_xml_document_set_file_path().

void mlview_file_descriptor_set_file_path (  MlViewFileDescriptor *    a_file_desc, gchar *    a_file_path )

Parameters: a_file_path  the file path to set. a_file_desc  the current instance of MlViewFileDescriptor. Definition at line 274 of file mlview-file-descriptor.c. References PRIVATE. Referenced by mlview_xml_document_set_file_path().

void mlview_file_descriptor_set_lmd (  MlViewFileDescriptor *    a_file_desc, guint    a_last_modif_time )

Sets the last modified date to a_last_modif time. Parameters: a_file_desc  the current instance of MlViewFileDescriptor. a_last_modif_time  the new modif time. Definition at line 320 of file mlview-file-descriptor.c. References PRIVATE.

void mlview_file_descriptor_update_modified_time (  MlViewFileDescriptor *    a_file_desc )

Sets the last modified time of the current instance of file descriptor to the current time. Parameters: a_file_desc  the current instance of MlViewFileDescriptor. Definition at line 135 of file mlview-file-descriptor.c. References PRIVATE.

---