diff --git a/ChangeLog b/ChangeLog index b62193d84..1a3bf3e08 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2003-03-08 Miguel de Icaza + + * glib/Idle.cs: Add private constructor. + +2003-03-05 Miguel de Icaza + + * gtk/Bin.cs: Add new property `Child' to GtkBin. + 2003-03-06 Mike Kestner * rsvg/Makefile.in : some -L -r magic diff --git a/doc/ChangeLog b/doc/ChangeLog index fc91cc360..7847bc78e 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2003-03-08 Miguel de Icaza + + * en/GLib/IdleHandler.xml: Documeted. + + * en/GLib/List.xml: Documented. + + * en/GLib/Idle.xml: Documented. + + 2003-03-08 Lee Mallabone * en/Gtk/Table.xml: First draft of table docs. Have left spacing diff --git a/doc/en/GLib/Idle.xml b/doc/en/GLib/Idle.xml index 555447d99..189d241b9 100644 --- a/doc/en/GLib/Idle.xml +++ b/doc/en/GLib/Idle.xml @@ -5,10 +5,15 @@ 0.0.0.0 - Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. + This function is thread safe. - To be added - To be added + Idle handlers for GLib-based main-loops + + GLib provides an implementation of a "main loop" (an event-based + main loop that dispatches requests). The Idle handler class is + used to register a routine to be called when the main loop is + idle. + System.Object @@ -26,21 +31,31 @@ - To be added - To be added: an object of type 'GLib.IdleHandler' - To be added: an object of type 'uint' - To be added - - - - - Constructor - - - - To be added - To be added: an object of type 'GLib.Idle' - To be added + Installs an idle handler for the main loop. + The delegate method that will be invoked. + The handler code assigned to this idle handler. + + + This function installs the as a + handler to be invoked when the GLib mainloop is idle. If + the handler returns the handler is + kept for another round of Idle execution, if is returned, the handler is removed. + + + This method can be invoked from a differen thread than the + one running the Gtk main loop. The delegate will be + invoked within the context of the Gtk main loop. + + + The thread-safety of this routine can be used to queue + work by a thread to be performed in the context of the + main Gtk thread. Gtk# is thread aware, but not thread + safe; See the Gtk# Thread + Programming for details. + + diff --git a/doc/en/GLib/IdleHandler.xml b/doc/en/GLib/IdleHandler.xml index 1855ad005..609ae5a99 100644 --- a/doc/en/GLib/IdleHandler.xml +++ b/doc/en/GLib/IdleHandler.xml @@ -7,8 +7,16 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate to invoke during idle time + + + The handler specified by the delegate will be invoked during + the GLib main loop execution. If the handler returns the handler is kept for another round of + Idle execution, if is returned, the + handler is removed. + + System.Delegate diff --git a/doc/en/GLib/List.xml b/doc/en/GLib/List.xml index c29f615ef..5ab6ca47b 100644 --- a/doc/en/GLib/List.xml +++ b/doc/en/GLib/List.xml @@ -1,5 +1,5 @@ - + glib-sharp 0.0.0.0 @@ -7,8 +7,38 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A list class used by GTK+ + + + GLib.List is managed wrapper for the underlying C list + implementation used by Gtk+. Various functions on the Gtk+ + API take lists or return lists in this form. + + + The list deals with IntPtr objects, these are pointers into + unmanaged resources. + + + + For example to create a list of widgets, you would use the + following sample: + + + GLib.List MakeList (Gtk.Widget a, Gtk.Widget b) + { + GLib.List l = new GLib.List ((IntPtr) 0, typeof (Gtk.Widget)); + l.Append (a.Handle); + l.Append (b.Handle); + } + + + The argument to the GLib.List + constructor, allows the list enumerator code to return + properly wrapped or demarshalled objects from the unmanaged + world into the managed world. + + + GLib.ListBase @@ -40,9 +70,14 @@ - To be added - To be added: an object of type 'object' - To be added + Duplicates the list, shallow copy. + The duplicated list + + + Makes a new copy of the list. The individual elements on + the list are not duplicated. + + @@ -53,11 +88,21 @@ - Internal constructor - Pointer to the C object. - An instance of List, wrapping the C object. + Constructs a List + A handle to a GLib.List. + A new insteace instance of List, wrapping the C list. - This is an internal constructor, and should not be used by user code. + + GLib.List objects are constructed by passing an unmanaged + reference to an existing GLib.List, or they can use + "(IntPtr) 0" as an initial value. + + + Using this constructor will not track the type information + of the classes or structures kept in the list. If you + plan on tracking the type information, use the method. + @@ -71,10 +116,20 @@ Internal constructor - Pointer to the C object. - An instance of List, wrapping the C object. + A handle to a GLib.list + A new instance of List, wrapping the C list. - This is an internal constructor, and should not be used by user code. + + GLib.List objects are constructed by passing an unmanaged + reference to an existing GLib.List, or they can use + "(IntPtr) 0" as an initial value. + + + Using this constructor will track the type information + of the classes or structures kept in the list. This + information is used by the List enumerator when returning + data. +