hildon-file-system-info

hildon-file-system-info — API for querying info about files.

Synopsis

                    HildonFileSystemInfoHandle;
                    HildonFileSystemInfo;
void                (*HildonFileSystemInfoCallback)     (HildonFileSystemInfoHandle *handle,
                                                         HildonFileSystemInfo *info,
                                                         const GError *error,
                                                         gpointer data);
HildonFileSystemInfoHandle* hildon_file_system_info_async_new
                                                        (const gchar *uri,
                                                         HildonFileSystemInfoCallback callback,
                                                         gpointer data);
const gchar*        hildon_file_system_info_get_display_name
                                                        (HildonFileSystemInfo *info);
GdkPixbuf*          hildon_file_system_info_get_icon    (HildonFileSystemInfo *info,
                                                         GtkWidget *ref_widget);
GdkPixbuf*          hildon_file_system_info_get_icon_at_size
                                                        (HildonFileSystemInfo *info,
                                                         GtkWidget *ref_widget,
                                                         gint size);
void                hildon_file_system_info_async_cancel
                                                        (HildonFileSystemInfoHandle *handle);
HildonFileSystemInfo* hildon_file_system_info_new       (const gchar *uri,
                                                         GError **error);
void                hildon_file_system_info_free        (HildonFileSystemInfo *info);

Description

HildonFileSystemInfo provides a way to obtain information about a given location (URI), such as its localized name and icon.

Details

HildonFileSystemInfoHandle

typedef struct _HildonFileSystemInfoHandle HildonFileSystemInfoHandle;


HildonFileSystemInfo

typedef struct _HildonFileSystemInfo HildonFileSystemInfo;


HildonFileSystemInfoCallback ()

void                (*HildonFileSystemInfoCallback)     (HildonFileSystemInfoHandle *handle,
                                                         HildonFileSystemInfo *info,
                                                         const GError *error,
                                                         gpointer data);

Called after hildon_file_system_info_async_new() managed to acquire the information. The info structure is owned by the library and must not be freed.

handle : the handle returned by the initiating hildon_file_system_info_async_new() call
info : the filled HildonFileSystemInfo structure
error : set if an error happened
data : additional argument passed to the initiating call

hildon_file_system_info_async_new ()

HildonFileSystemInfoHandle* hildon_file_system_info_async_new
                                                        (const gchar *uri,
                                                         HildonFileSystemInfoCallback callback,
                                                         gpointer data);

This function is used to query file statistics (the same ones shown in the file selection widgets). Currently name and icon are supported.

The info structure is only valid while the callback is running. You must not free it yourself.

The handle is valid until the callback has returned or until hildon_file_system_info_async_cancel has been called on it. Once the callback has been entered, you can no longer call hildon_file_system_info_async_cancel.

uri : an URI string.
callback : a pointer to callback function to be invoked when file information is available.
data : User data for callback function.
Returns : a HildonFileSystemInfoHandle or NULL if an error was before setting up asyncronous operation.

hildon_file_system_info_get_display_name ()

const gchar*        hildon_file_system_info_get_display_name
                                                        (HildonFileSystemInfo *info);

Gets user visible name of the location. All special places are named using the current locale.

info : a HildonFileSystemInfo pointer.
Returns : Visible name of the location. The value is owned by HildonFileSystemInfo and there is no need to free it.

hildon_file_system_info_get_icon ()

GdkPixbuf*          hildon_file_system_info_get_icon    (HildonFileSystemInfo *info,
                                                         GtkWidget *ref_widget);

Gets icon for the location. All special places have their special icons. Note that this function is just a special case of hildon_file_system_info_get_icon_at_size().

info : a HildonFileSystemInfo pointer.
ref_widget : Any widget on the same screen as the new icon.
Returns : a GdkPixbuf. The value is owned by HildonFileSystemInfo and there is no need to free it.

hildon_file_system_info_get_icon_at_size ()

GdkPixbuf*          hildon_file_system_info_get_icon_at_size
                                                        (HildonFileSystemInfo *info,
                                                         GtkWidget *ref_widget,
                                                         gint size);

Gets icon for the location. All special places have their special icons.

info : a HildonFileSystemInfo pointer.
ref_widget : Any widget on the same screen as the new icon.
size : Desired size of the icon.
Returns : a GdkPixbuf. The value is owned by HildonFileSystemInfo and there is no need to free it.

hildon_file_system_info_async_cancel ()

void                hildon_file_system_info_async_cancel
                                                        (HildonFileSystemInfoHandle *handle);

Cancels the operation associated with handle.

handle : the handle returned by hildon_file_system_info_async_new()

hildon_file_system_info_new ()

HildonFileSystemInfo* hildon_file_system_info_new       (const gchar *uri,
                                                         GError **error);

Warning

hildon_file_system_info_new is deprecated and should not be used in newly-written code.

uri :
error :
Returns :

hildon_file_system_info_free ()

void                hildon_file_system_info_free        (HildonFileSystemInfo *info);

Warning

hildon_file_system_info_free is deprecated and should not be used in newly-written code.

info :