libgdamm Reference Documentation
Main Page   Namespaces   Book  

Gnome::Gda::Threader Class Reference

TODO. More...

Inheritance diagram for Gnome::Gda::Threader:

Inheritance graph
[legend]

List of all members.

Public Member Functions

void cancel (guint job_id)
const GdaThreader* gobj () const
 Provides access to the underlying C GObject.
GdaThreader* gobj ()
 Provides access to the underlying C GObject.
GdaThreader* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::SignalProxy2< void,
guint, gpointer > 
signal_cancelled ()
Glib::SignalProxy2< void,
guint, gpointer > 
signal_finished ()
guint start_thread (GThreadFunc func, gpointer func_arg, ThreaderFunc ok_callback, ThreaderFunc cancel_callback)
virtual ~Threader ()

Static Public Member Functions

static Glib::RefPtr<Threadercreate ()

Protected Member Functions

virtual void on_cancelled (guint arg1, gpointer arg2)
virtual void on_finished (guint arg1, gpointer arg2)
 Threader ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr
<Gnome::Gda::Threader
wrap (GdaThreader* object, bool take_copy=false)
 A Glib::wrap() method for this object.


Detailed Description

TODO.

See http://bugzilla.gnome.org/show_bug.cgi?id=561175


Constructor & Destructor Documentation

virtual Gnome::Gda::Threader::~Threader (  )  [virtual]

Gnome::Gda::Threader::Threader (  )  [protected]


Member Function Documentation

void Gnome::Gda::Threader::cancel ( guint  job_id  ) 

static Glib::RefPtr<Threader> Gnome::Gda::Threader::create (  )  [static]

const GdaThreader* Gnome::Gda::Threader::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GdaThreader* Gnome::Gda::Threader::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GdaThreader* Gnome::Gda::Threader::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

virtual void Gnome::Gda::Threader::on_cancelled ( guint  arg1,
gpointer  arg2 
) [protected, virtual]

virtual void Gnome::Gda::Threader::on_finished ( guint  arg1,
gpointer  arg2 
) [protected, virtual]

Glib::SignalProxy2< void,guint,gpointer > Gnome::Gda::Threader::signal_cancelled (  ) 

Prototype:
void on_my_cancelled(guint arg1, gpointer arg2)

Glib::SignalProxy2< void,guint,gpointer > Gnome::Gda::Threader::signal_finished (  ) 

Prototype:
void on_my_finished(guint arg1, gpointer arg2)

guint Gnome::Gda::Threader::start_thread ( GThreadFunc  func,
gpointer  func_arg,
ThreaderFunc  ok_callback,
ThreaderFunc  cancel_callback 
)

Parameters:
func The function to be called in the newly created thread.
func_arg func's argument.
ok_callback Callback called when func terminates.
cancel_callback Callback called when func terminates and the job has been cancelled.
Returns:
The id of the new job executed in another thread.


Friends And Related Function Documentation

Glib::RefPtr<Gnome::Gda::Threader> wrap ( GdaThreader *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated for libgdamm by Doxygen 1.5.6 © 1997-2001