browser-eal/include/gwebtransferitem.h File Reference

#include <glib-object.h>
#include "gwebcommon.h"

Include dependency graph for gwebtransferitem.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_GWebTransferItemIface
Defines
#define	G_TYPE_WEB_TRANSFER_ITEM   (g_web_transfer_item_get_type ())
#define	G_WEB_TRANSFER_ITEM(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_WEB_TRANSFER_ITEM, GWebTransferItem))
#define	G_WEB_TRANSFER_ITEM_CLASS(vtable)   (G_TYPE_CHECK_CLASS_CAST ((vtable), G_TYPE_WEB_TRANSFER_ITEM, GWebTransferItemIface))
#define	G_IS_WEB_TRANSFER_ITEM(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_WEB_TRANSFER_ITEM))
#define	G_IS_WEB_TRANSFER_ITEM_CLASS(vtable)   (G_TYPE_CHECK_CLASS_TYPE ((vtable), G_TYPE_WEB_TRANSFER_ITEM))
#define	G_WEB_TRANSFER_ITEM_GET_CLASS(inst)   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_WEB_TRANSFER_ITEM, GWebTransferItemIface))
#define	G_WEB_TRANSFER_ITEM_SIGNAL_STARTED   "started"
#define	G_WEB_TRANSFER_ITEM_SIGNAL_COMPLETED   "completed"
#define	G_WEB_TRANSFER_ITEM_SIGNAL_ERROR   "error"
#define	G_WEB_TRANSFER_ITEM_SIGNAL_PROGRESS   "progress"
Typedefs
typedef _GWebTransferItem	GWebTransferItem
typedef _GWebTransferItemIface	GWebTransferItemIface
Functions
GType	g_web_transfer_item_get_type (void)
void	g_web_transfer_item_destroy (GWebTransferItem *self)
void	g_web_transfer_item_start (GWebTransferItem *self)
void	g_web_transfer_item_stop (GWebTransferItem *self)
GWebStatus	g_web_transfer_item_continue (GWebTransferItem *self)
void	g_web_transfer_item_cancel (GWebTransferItem *self)
void	g_web_transfer_item_reload (GWebTransferItem *self)
GObject *	g_web_transfer_item_get_web_item (GWebTransferItem *self)
const gchar *	g_web_transfer_item_get_url (GWebTransferItem *self)
const gchar *	g_web_transfer_item_get_filename (GWebTransferItem *self)
glong	g_web_transfer_item_get_total_size (GWebTransferItem *self)
glong	g_web_transfer_item_get_progress (GWebTransferItem *self)
void	g_web_transfer_item_signal_started (GWebTransferItem *item)
void	g_web_transfer_item_signal_completed (GWebTransferItem *item)
void	g_web_transfer_item_signal_error (GWebTransferItem *item)
void	g_web_transfer_item_signal_progress (GWebTransferItem *item, gulong downloaded_bytes, gulong total_bytes, gdouble kbps)

---

Define Documentation

#define G_IS_WEB_TRANSFER_ITEM

(

obj

)

(G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_WEB_TRANSFER_ITEM))

Definition at line 35 of file gwebtransferitem.h.

#define G_IS_WEB_TRANSFER_ITEM_CLASS

(

vtable

)

(G_TYPE_CHECK_CLASS_TYPE ((vtable), G_TYPE_WEB_TRANSFER_ITEM))

Definition at line 36 of file gwebtransferitem.h.

#define G_TYPE_WEB_TRANSFER_ITEM   (g_web_transfer_item_get_type ())

Definition at line 32 of file gwebtransferitem.h.

#define G_WEB_TRANSFER_ITEM

(

obj

)

(G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_WEB_TRANSFER_ITEM, GWebTransferItem))

Definition at line 33 of file gwebtransferitem.h.

#define G_WEB_TRANSFER_ITEM_CLASS

(

vtable

)

(G_TYPE_CHECK_CLASS_CAST ((vtable), G_TYPE_WEB_TRANSFER_ITEM, GWebTransferItemIface))

Definition at line 34 of file gwebtransferitem.h.

#define G_WEB_TRANSFER_ITEM_GET_CLASS

(

inst

)

(G_TYPE_INSTANCE_GET_INTERFACE ((inst), G_TYPE_WEB_TRANSFER_ITEM, GWebTransferItemIface))

Definition at line 37 of file gwebtransferitem.h.

Referenced by g_web_transfer_item_cancel(), g_web_transfer_item_continue(), g_web_transfer_item_destroy(), g_web_transfer_item_get_filename(), g_web_transfer_item_get_progress(), g_web_transfer_item_get_total_size(), g_web_transfer_item_get_url(), g_web_transfer_item_get_web_item(), g_web_transfer_item_reload(), g_web_transfer_item_start(), and g_web_transfer_item_stop().

#define G_WEB_TRANSFER_ITEM_SIGNAL_COMPLETED   "completed"

"completed" signal.

Definition at line 141 of file gwebtransferitem.h.

#define G_WEB_TRANSFER_ITEM_SIGNAL_ERROR   "error"

"error" signal.

Definition at line 151 of file gwebtransferitem.h.

#define G_WEB_TRANSFER_ITEM_SIGNAL_PROGRESS   "progress"

"progress" signal.

Definition at line 161 of file gwebtransferitem.h.

#define G_WEB_TRANSFER_ITEM_SIGNAL_STARTED   "started"

"started" signal.

Definition at line 131 of file gwebtransferitem.h.

---

Typedef Documentation

typedef struct _GWebTransferItem GWebTransferItem

Definition at line 39 of file gwebtransferitem.h.

typedef struct _GWebTransferItemIface GWebTransferItemIface

Definition at line 40 of file gwebtransferitem.h.

---

Function Documentation

void g_web_transfer_item_cancel

(

GWebTransferItem *

self

)

Cancel download.

Parameters:

self

Object pointer

Definition at line 83 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

GWebStatus g_web_transfer_item_continue

(

GWebTransferItem *

self

)

Continue download.

Parameters:

self

Object pointer

Returns:

G_WEB_STATUS_OK on success.

Definition at line 77 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

void g_web_transfer_item_destroy

(

GWebTransferItem *

self

)

Destroy object.

Parameters:

self

Object pointer

Definition at line 59 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

const gchar* g_web_transfer_item_get_filename

(

GWebTransferItem *

self

)

Get item file name.

Parameters:

self

Object pointer

Returns:

File name string

Definition at line 107 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

glong g_web_transfer_item_get_progress

(

GWebTransferItem *

self

)

Get transfer item progress.

Parameters:

self

Object pointer

Returns:

Progress

Definition at line 119 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

glong g_web_transfer_item_get_total_size

(

GWebTransferItem *

self

)

Get transfer item total size.

Parameters:

self

Object pointer

Returns:

Total size

Definition at line 113 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

GType g_web_transfer_item_get_type

(

void

)

Definition at line 38 of file gwebtransferitem.c.

References g_web_transfer_item_base_init().

Here is the call graph for this function:

const gchar* g_web_transfer_item_get_url

(

GWebTransferItem *

self

)

Get item URL.

Parameters:

self

Object pointer

Returns:

URL string

Definition at line 101 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

GObject* g_web_transfer_item_get_web_item

(

GWebTransferItem *

self

)

Get container object.

Parameters:

self

Object pointer

Returns:

Container object pointer

Definition at line 95 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

void g_web_transfer_item_reload

(

GWebTransferItem *

self

)

Reload item.

Parameters:

self

Object pointer

Definition at line 89 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

void g_web_transfer_item_signal_completed

(

GWebTransferItem *

item

)

Signalled when the download is completed

Parameters:

item

Object pointer

void g_web_transfer_item_signal_error

(

GWebTransferItem *

item

)

Signalled if an error occurs during transfer

Parameters:

item

Object pointer

void g_web_transfer_item_signal_progress	(	GWebTransferItem *	item,
		gulong	downloaded_bytes,
		gulong	total_bytes,
		gdouble	kbps
	)

Progress of the transfer

Parameters:

	item	Object pointer
	downloaded_bytes	The number of bytes downloaded this far
	total_bytes	Total bytes downloaded this far
	kbps	Average kbps for this download

void g_web_transfer_item_signal_started

(

GWebTransferItem *

item

)

Signalled when the download has started

Parameters:

item

Object pointer

void g_web_transfer_item_start

(

GWebTransferItem *

self

)

Start download.

Parameters:

self

Object pointer

Definition at line 65 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

void g_web_transfer_item_stop

(

GWebTransferItem *

self

)

Stop download.

Parameters:

self

Object pointer

Definition at line 71 of file gwebtransferitem.c.

References G_WEB_TRANSFER_ITEM_GET_CLASS.

---