GelIOScanner

GelIOScanner

Synopsis

                    GelIOScanner;
                    GelIOScannerClass;
GList *             gel_io_scanner_flatten_result       (GList *forest);
GelIOScanner *      gel_io_scanner_new                  (void);
GelIOScanner *      gel_io_scanner_new_full             (GList *uris,
                                                         const gchar *attributes,
                                                         gboolean recurse);
void                gel_io_scanner_scan                 (GelIOScanner *self,
                                                         GList *uris,
                                                         const gchar *attributes,
                                                         gboolean recurse);

Object Hierarchy

  GObject
   +----GelIOScanner

Signals

  "cancel"                                         : Run Last
  "error"                                          : Run Last
  "finish"                                         : Run Last

Description

Details

GelIOScanner

typedef struct _GelIOScanner GelIOScanner;

GelIOScannerClass

typedef struct {
	GObjectClass parent_class;
	void (*finish) (GelIOScanner *self, GList *forest);
	void (*error)  (GelIOScanner *self, GFile *source, GError *error);
	void (*cancel) (GelIOScanner *self);
} GelIOScannerClass;

gel_io_scanner_flatten_result ()

GList *             gel_io_scanner_flatten_result       (GList *forest);

Flatens a forest (a list of trees) of results

forest :

A GList of GNode to flat. [transfer none]

Returns :

The forest in a 'flatten' state. Data from forest is reutilized in the returned GList. [transfer container]

gel_io_scanner_new ()

GelIOScanner *      gel_io_scanner_new                  (void);

Creates a new GelIOScanner

Returns :

The scanner. [transfer full]

gel_io_scanner_new_full ()

GelIOScanner *      gel_io_scanner_new_full             (GList *uris,
                                                         const gchar *attributes,
                                                         gboolean recurse);

uris: (element-type utf8) (transfer none): URIs to scan (gchar*) attributes: Attributes to retrieve from URIs, see GFileInfo attributes recurse: Recurse deep into the uris

Scans URIs from uris, retrieving the requested attributes

Returns :

A new GelIOScanner in progress. [transfer full]

gel_io_scanner_scan ()

void                gel_io_scanner_scan                 (GelIOScanner *self,
                                                         GList *uris,
                                                         const gchar *attributes,
                                                         gboolean recurse);

self: A existing GelIOScanner uris: (element-type utf8) (transfer none): A GList of URIs (gchar*) to * scan attributes: Attributes to retrieve from URIs, see GFileInfo attributes recurse: Recurse deep into the uri

Scans URIs on a existing GelIOScanner. Fails if self it is already on scan

Signal Details

The "cancel" signal

void                user_function                      (GelIOScanner *scanner,
                                                        gpointer      user_data)      : Run Last

Emitted if the scan if canceled

scanner :

The GelIOScanner

user_data :

user data set when the signal handler was connected.

The "error" signal

void                user_function                      (GelIOScanner *scanner,
                                                        GObject      *error,
                                                        gpointer      arg2,
                                                        gpointer      user_data)      : Run Last

Emitted if an error is encountered

scanner :

The GelIOScanner

error :

A GError

user_data :

user data set when the signal handler was connected.

The "finish" signal

void                user_function                      (GelIOScanner *scanner,
                                                        gpointer      results,
                                                        gpointer      user_data)      : Run Last

Emitted after scan completion

scanner :

The GelIOScanner

results :

Results of the operation

user_data :

user data set when the signal handler was connected.