GOFileOpenerOpenFunc ()

void
(*GOFileOpenerOpenFunc) (GOFileOpener const *fo,
                         GOIOContext *io_context,
                         GoView *view,
                         GsfInput *input);

GOFileOpenerOpenFuncWithEnc ()

void
(*GOFileOpenerOpenFuncWithEnc) (GOFileOpener const *fo,
                                gchar const *enc,
                                GOIOContext *io_context,
                                GoView *view,
                                GsfInput *input);

GOFileOpenerProbeFunc ()

gboolean
(*GOFileOpenerProbeFunc) (GOFileOpener const *fo,
                          GsfInput *input,
                          GOFileProbeLevel pl);

go_file_opener_can_probe ()

gboolean
go_file_opener_can_probe (GOFileOpener const *fo,
                          GOFileProbeLevel pl);

go_file_opener_for_id ()

GOFileOpener *
go_file_opener_for_id (char const *id);

Searches for file opener with given id , registered using go_file_opener_register

go_file_opener_get_description ()

char const *
go_file_opener_get_description (GOFileOpener const *fo);

go_file_opener_get_id ()

char const *
go_file_opener_get_id (GOFileOpener const *fo);

go_file_opener_get_mimes ()

GSList const *
go_file_opener_get_mimes (GOFileOpener const *fo);

go_file_opener_get_suffixes ()

GSList const *
go_file_opener_get_suffixes (GOFileOpener const *fo);

go_file_opener_is_encoding_dependent ()

gboolean
go_file_opener_is_encoding_dependent (GOFileOpener const *fo);

go_file_opener_new ()

GOFileOpener *
go_file_opener_new (char const *id,
                    char const *description,
                    GSList *suffixes,
                    GSList *mimes,
                    GOFileOpenerProbeFunc probe_func,
                    GOFileOpenerOpenFunc open_func);

Creates new GOFileOpener object. Optional id will be used after registering it with go_file_opener_register function.

go_file_opener_new_with_enc ()

GOFileOpener *
go_file_opener_new_with_enc (char const *id,
                             char const *description,
                             GSList *suffixes,
                             GSList *mimes,
                             GOFileOpenerProbeFunc probe_func,
                             GOFileOpenerOpenFuncWithEnc open_func);

Creates new GOFileOpener object. Optional id will be used after registering it with go_file_opener_register function.

go_file_opener_open ()

void
go_file_opener_open (GOFileOpener const *fo,
                     gchar const *opt_enc,
                     GOIOContext *io_context,
                     GoView *view,
                     GsfInput *input);

Reads content of file_name file into workbook wbv is attached to. Results are reported using io_context object, use go_io_error_occurred to find out if operation was successful. The state of wbv and its workbook is undefined if operation fails, you should destroy them in that case.

go_file_opener_probe ()

gboolean
go_file_opener_probe (GOFileOpener const *fo,
                      GsfInput *input,
                      GOFileProbeLevel pl);

Checks if a given file is supported by the opener.

go_file_opener_register ()

void
go_file_opener_register (GOFileOpener *fo,
                         gint priority);

Adds fo opener to the list of available file openers, making it available for Gnumeric i/o routines. The opener is registered with given priority . The priority is used to determine the order in which openers will be tried when reading a file. The higher the priority, the sooner it will be tried. Default XML-based Gnumeric file opener is registered at priority 50. Recommended range for priority is [0, 100]. Reference count for the opener is incremented inside the function, but you don't have to (and shouldn't) call g_object_unref on it if it's floating object (for example, when you pass object newly created with go_file_opener_new and not referenced anywhere).

go_file_opener_unregister ()

void
go_file_opener_unregister (GOFileOpener *fo);

Removes fo opener from list of available file openers. Reference count for the opener is decremented inside the function.

GOFileOpener

typedef struct _GOFileOpener GOFileOpener;

GOFileOpenerClass

typedef struct {
	GObjectClass parent_class;

	/* private */
	gboolean  (*can_probe) (GOFileOpener const *fo,
				GOFileProbeLevel pl);
	gboolean  (*probe) (GOFileOpener const *fo,
	                    GsfInput *input,
	                    GOFileProbeLevel pl);
	void      (*open)  (GOFileOpener const *fo,
			    gchar const *opt_enc,
	                    GOIOContext *io_context,
	                    GoView *view,
	                    GsfInput *input);
} GOFileOpenerClass;

File opener base class.

The “description” property

  “description”              gchar *

The description of the opener.

Flags: Read / Write

Default value: NULL

The “id” property

  “id”                       gchar *

The identifier of the opener.

Flags: Read

Default value: NULL

The “interactive-only” property

  “interactive-only”         gboolean

TRUE if this opener requires interaction.

Flags: Read / Write

Default value: FALSE