From 94e4a805f8d1b2c635a6cbd919a63de88b0949a3 Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Wed, 26 Mar 2003 00:38:24 +0000 Subject: [PATCH] Update docs reflect latest updater changes. svn path=/trunk/gtk-sharp/; revision=12840 --- doc/en/AtkSharp/KeySnoopFuncNative.xml | 2 +- doc/en/AtkSharp/KeySnoopFuncWrapper.xml | 30 +- .../voidObjectPropertyValuesDelegate.xml | 2 +- doc/en/Gdk/Colormap.xml | 34 +- doc/en/Gdk/Pixbuf.xml | 5 +- doc/en/GdkSharp/SpanFuncNative.xml | 2 +- doc/en/GdkSharp/SpanFuncWrapper.xml | 30 +- doc/en/Gnome/CanvasRichText.xml | 38 +- .../GnomeSharp/UISignalConnectFuncNative.xml | 2 +- .../GnomeSharp/UISignalConnectFuncWrapper.xml | 30 +- .../voidObjectCanvasBufDelegate.xml | 2 +- doc/en/Gtk/Adjustment.xml | 76 ++-- doc/en/Gtk/Application.xml | 39 +- doc/en/Gtk/Calendar.xml | 348 +----------------- doc/en/Gtk/TreeModel.xml | 220 +++++------ .../voidObjectAffineSVPintDelegate.xml | 2 +- 16 files changed, 266 insertions(+), 596 deletions(-) diff --git a/doc/en/AtkSharp/KeySnoopFuncNative.xml b/doc/en/AtkSharp/KeySnoopFuncNative.xml index 2f3dfb32d..97e00acf9 100644 --- a/doc/en/AtkSharp/KeySnoopFuncNative.xml +++ b/doc/en/AtkSharp/KeySnoopFuncNative.xml @@ -1,5 +1,5 @@ - + atk-sharp 0.0.0.0 diff --git a/doc/en/AtkSharp/KeySnoopFuncWrapper.xml b/doc/en/AtkSharp/KeySnoopFuncWrapper.xml index e2ff365b0..0c34ac7d2 100644 --- a/doc/en/AtkSharp/KeySnoopFuncWrapper.xml +++ b/doc/en/AtkSharp/KeySnoopFuncWrapper.xml @@ -40,8 +40,22 @@ To be added + + + Constructor + + + + + + To be added + To be added: an object of type 'Atk.KeySnoopFunc' + To be added: an object of type 'AtkSharp.KeySnoopFuncWrapper' + To be added + + - + Method System.Int32 @@ -58,19 +72,5 @@ To be added - - - Constructor - - - - - - To be added - To be added: an object of type 'Atk.KeySnoopFunc' - To be added: an object of type 'AtkSharp.KeySnoopFuncWrapper' - To be added - - \ No newline at end of file diff --git a/doc/en/AtkSharp/voidObjectPropertyValuesDelegate.xml b/doc/en/AtkSharp/voidObjectPropertyValuesDelegate.xml index 82e5e39d6..1f47bfe34 100644 --- a/doc/en/AtkSharp/voidObjectPropertyValuesDelegate.xml +++ b/doc/en/AtkSharp/voidObjectPropertyValuesDelegate.xml @@ -1,5 +1,5 @@ - + atk-sharp 0.0.0.0 diff --git a/doc/en/Gdk/Colormap.xml b/doc/en/Gdk/Colormap.xml index afd97db06..8ab00693d 100644 --- a/doc/en/Gdk/Colormap.xml +++ b/doc/en/Gdk/Colormap.xml @@ -172,8 +172,24 @@ To be added + + + Constructor + + + + + + Internal constructor + GLib type for the type + Creates a new instance of Colormap, using the GLib-provided type + + This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. + + + - + Method System.Boolean @@ -192,21 +208,5 @@ To be added - - - Constructor - - - - - - Internal constructor - GLib type for the type - Creates a new instance of Colormap, using the GLib-provided type - - This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. - - - \ No newline at end of file diff --git a/doc/en/Gdk/Pixbuf.xml b/doc/en/Gdk/Pixbuf.xml index 43e494e55..35c37eecb 100644 --- a/doc/en/Gdk/Pixbuf.xml +++ b/doc/en/Gdk/Pixbuf.xml @@ -295,7 +295,7 @@ for details on the possible ways on which this function might fail. - + Transfers image data from a and @@ -360,7 +360,8 @@ and if it fails it returns ; so check the return value.) - + + diff --git a/doc/en/GdkSharp/SpanFuncNative.xml b/doc/en/GdkSharp/SpanFuncNative.xml index e50be26e9..82edc562f 100644 --- a/doc/en/GdkSharp/SpanFuncNative.xml +++ b/doc/en/GdkSharp/SpanFuncNative.xml @@ -1,5 +1,5 @@ - + gdk-sharp 0.0.0.0 diff --git a/doc/en/GdkSharp/SpanFuncWrapper.xml b/doc/en/GdkSharp/SpanFuncWrapper.xml index 04bb780fa..cb6682c8c 100644 --- a/doc/en/GdkSharp/SpanFuncWrapper.xml +++ b/doc/en/GdkSharp/SpanFuncWrapper.xml @@ -40,8 +40,22 @@ To be added + + + Constructor + + + + + + To be added + To be added: an object of type 'Gdk.SpanFunc' + To be added: an object of type 'GdkSharp.SpanFuncWrapper' + To be added + + - + Method System.Void @@ -57,19 +71,5 @@ To be added - - - Constructor - - - - - - To be added - To be added: an object of type 'Gdk.SpanFunc' - To be added: an object of type 'GdkSharp.SpanFuncWrapper' - To be added - - \ No newline at end of file diff --git a/doc/en/Gnome/CanvasRichText.xml b/doc/en/Gnome/CanvasRichText.xml index e73c9a497..ee5573d87 100644 --- a/doc/en/Gnome/CanvasRichText.xml +++ b/doc/en/Gnome/CanvasRichText.xml @@ -35,25 +35,6 @@ To be added - - - Method - - System.Void - - - - - - - - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added - - Method @@ -512,5 +493,24 @@ + + + Method + + System.Void + + + + + + + + To be added + To be added: an object of type 'Gtk.TextIter&' + To be added: an object of type 'int' + To be added: an object of type 'int' + To be added + + \ No newline at end of file diff --git a/doc/en/GnomeSharp/UISignalConnectFuncNative.xml b/doc/en/GnomeSharp/UISignalConnectFuncNative.xml index 852cbad12..6228a4558 100644 --- a/doc/en/GnomeSharp/UISignalConnectFuncNative.xml +++ b/doc/en/GnomeSharp/UISignalConnectFuncNative.xml @@ -1,5 +1,5 @@ - + gnome-sharp 0.0.0.0 diff --git a/doc/en/GnomeSharp/UISignalConnectFuncWrapper.xml b/doc/en/GnomeSharp/UISignalConnectFuncWrapper.xml index 684c2404d..434f11a6a 100644 --- a/doc/en/GnomeSharp/UISignalConnectFuncWrapper.xml +++ b/doc/en/GnomeSharp/UISignalConnectFuncWrapper.xml @@ -40,8 +40,22 @@ To be added + + + Constructor + + + + + + To be added + To be added: an object of type 'Gnome.UISignalConnectFunc' + To be added: an object of type 'GnomeSharp.UISignalConnectFuncWrapper' + To be added + + - + Method System.Void @@ -59,19 +73,5 @@ To be added - - - Constructor - - - - - - To be added - To be added: an object of type 'Gnome.UISignalConnectFunc' - To be added: an object of type 'GnomeSharp.UISignalConnectFuncWrapper' - To be added - - \ No newline at end of file diff --git a/doc/en/GnomeSharp/voidObjectCanvasBufDelegate.xml b/doc/en/GnomeSharp/voidObjectCanvasBufDelegate.xml index febf2f2c6..c9d9e96ea 100644 --- a/doc/en/GnomeSharp/voidObjectCanvasBufDelegate.xml +++ b/doc/en/GnomeSharp/voidObjectCanvasBufDelegate.xml @@ -1,5 +1,5 @@ - + gnome-sharp 0.0.0.0 diff --git a/doc/en/Gtk/Adjustment.xml b/doc/en/Gtk/Adjustment.xml index cf3ee497f..282363950 100644 --- a/doc/en/Gtk/Adjustment.xml +++ b/doc/en/Gtk/Adjustment.xml @@ -8,10 +8,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Encapsulates an adjustable bounded value. - The Adjustment object represents a value with an associated and bound, together with a , , and a . - The Adjustment object does not update the value itself. Instead it is left up to the owner of the Adjustment to control the value. The owner of the Adjustment typically calls the and methods after changing the value or its bounds, respectively. This results in the emission of the or events respectively. - An Adjustment is used within several widgets, including , , and (which is a base class for , , , and ). - + + The Adjustment object represents a value with an associated and bound, together with a , , and a . + The Adjustment object does not update the value itself. Instead it is left up to the owner of the Adjustment to control the value. The owner of the Adjustment typically calls the and methods after changing the value or its bounds, respectively. This results in the emission of the or events respectively. + An Adjustment is used within several widgets, including , , and (which is a base class for , , , and ). + Gtk.Object @@ -45,8 +46,10 @@ The maximum value. The increment to use to make minor changes to the value. The increment to use to make major changes to the value. - The page size. In a this is the size of the area that is currently visible. - When updating the values and properties of an Adjustment, remember to call the and/or methods to ensure the correct events are fired. + The page size. In a this is the size of the area that is currently visible. + + When updating the values and properties of an Adjustment, remember to call the and/or methods to ensure the correct events are fired. + @@ -57,8 +60,10 @@ - Fires the event. - This method should be called manually after changing properties to notify all listening objects that the Adjustment's has changed. + Fires the event. + + This method should be called manually after changing properties to notify all listening objects that the Adjustment's has changed. + @@ -69,8 +74,10 @@ - Fires the event. - This method should be called manually after changing properties to notify all listening objects that one or more of the Adjustment's bounds have changed. + Fires the event. + + This method should be called manually after changing properties to notify all listening objects that one or more of the Adjustment's bounds have changed. + @@ -84,10 +91,13 @@ - Updates the to ensure that the range between lower and upper is in the current page (i.e. between value and value + page_size). + Updates the to ensure that the range between lower and upper is in the current page (i.e. between value and value + page_size). To be added: an object of type 'double' To be added: an object of type 'double' - To be added: The docs for this function are very confusing, and not 100% in sync with the code of gtk+ 2.0.5.If the range is larger than the page size, then only the start of it will be in the current page. The event will be fired if the value changes as a result of this method. + + To be added: The docs for this function are very confusing, and not 100% in sync with the code of gtk+ 2.0.5. + If the range is larger than the page size, then only the start of it will be in the current page. The event will be fired if the value changes as a result of this method. + @@ -137,9 +147,9 @@ The maximum value. The increment to use to make minor changes to the value. The increment to use to make major changes to the value. - The page size. In a this is the size of the area that is currently visible. + The page size. In a this is the size of the area that is currently visible. A new Adjustment - + @@ -149,8 +159,8 @@ Internal constructor - - + + @@ -178,7 +188,9 @@ Manage the size of a 'page'. The new page size. The current size of pages in this Adjustment. - In a this is the size of the area which is currently visible. + + In a this is the size of the area which is currently visible. + @@ -194,7 +206,9 @@ Manage the increment used to make major changes to the value. A new value for the PageIncrement The current PageIncrement. - The usefulness of this value is entirely dependent upon the context in whic hthe Adjustment is used. + + The usefulness of this value is entirely dependent upon the context in whic hthe Adjustment is used. + @@ -206,7 +220,9 @@ The increment to use to make minor changes to the value. The current value used for step increments. - In a this increment is used when the mouse is clicked on the arrows at the top and bottom of the , to scroll by a small amount. + + In a this increment is used when the mouse is clicked on the arrows at the top and bottom of the , to scroll by a small amount. + @@ -218,7 +234,7 @@ Retrieve the upper bound of this Adjustment. The maximum possible value that is currently allowed. - + @@ -230,7 +246,7 @@ Retrieve the lower bound of this Adjustment. The minimum possible value that is currently allowed. - + @@ -243,10 +259,12 @@ - Manage the current . + Manage the current . A new value for this Adjustment. The current value of this adjustment. - If you set this property, you should manually call so that all listening objects are notified of the change. + + If you set this property, you should manually call so that all listening objects are notified of the change. + @@ -255,8 +273,10 @@ - This event is fired when is called. - This event can be handled to be notified of changes to the Adjustment's value. However, this relies on all objects that change the calling . + This event is fired when is called. + + This event can be handled to be notified of changes to the Adjustment's value. However, this relies on all objects that change the calling . + @@ -265,8 +285,10 @@ - This event is fired when is called. - If the Adjustment's properties change, (such as , etc.), it is up to whichever class changes the values to call to ensure this event is fired. + This event is fired when is called. + + If the Adjustment's properties change, (such as , etc.), it is up to whichever class changes the values to call to ensure this event is fired. + diff --git a/doc/en/Gtk/Application.xml b/doc/en/Gtk/Application.xml index f424cebd6..fdae486ea 100644 --- a/doc/en/Gtk/Application.xml +++ b/doc/en/Gtk/Application.xml @@ -59,29 +59,6 @@ - - - Method - - System.Void - - - - - - - A boolean value, whether the iteration should block or not - - - Runs a single iteration of the mainloop. If is true, then if no events are - waiting to be processed GTK+ will block until the next - event is noticed; If is false, - then it if no events are waiting to be processed Gtk+ the - routine will return immediately. - - - - Method @@ -238,5 +215,21 @@ To be added + + + Method + + System.Boolean + + + + + + To be added + To be added: an object of type 'bool' + To be added: an object of type 'bool' + To be added + + \ No newline at end of file diff --git a/doc/en/Gtk/Calendar.xml b/doc/en/Gtk/Calendar.xml index 842377efb..551b2d3bf 100644 --- a/doc/en/Gtk/Calendar.xml +++ b/doc/en/Gtk/Calendar.xml @@ -31,350 +31,4 @@ public Calendar CreateCalendar () // Typical event handler for capturing the selected date void DaySelected (object obj, EventArgs args) { - Calendar activatedCalendar = (Calendar) obj; - Console.WriteLine (activatedCalendar.GetDate ().ToString ("yyyy/MM/dd")); -} - - - - - - Gtk.Widget - - - - Atk.Implementor - - - GLib.IWrapper - - - GLib.IWrapper - - - System.IDisposable - - - - - - - Method - - System.Boolean - - - - - - Removes a visual marker from the specified . - A day number from 1 to 31. - - - - - Visual markers are added to the calendar with . - - - - - - Method - - System.Boolean - - - - - - Adds a visual marker to the specified . - A day number from 1 to 31. - - - - - - - - - Method - - System.Void - - - - - - Set the display options for this calendar. - One or more values from , combined using a bit-wise OR. - - This method allows fine control over which parts of the calendar, such as day names, are displayed. The describe the choices in more detail. - - - - - - Method - - System.Void - - - - - - Select a specified day on the displayed month. - A day number from 1 to 31. - - A value of 0 for the will unselect the currently selected day. - - - - - - Method - - System.Void - - - - Stops the calendar from visually updating. - - If used before a large number of graphical updates, (such as calls to ), this method may prevent flicker. Once a batch of updates has taken place, call to render them. - - - - - - Method - - System.Void - - - - - - - - Retrieve the selected date. - A variable to place the chosen year in. - A variable to place the chosen month in. - A variable to place the chosen day in. - - NOTE: That month number is ZERO based, (0-11), whereas the day is one based, (1-31). - - - - - - Method - - System.Void - - - - Removes the effects of calling . - - This draws all graphical updates to the calendar that have happened since a . - - - - - - Method - - System.Void - - - - Removes all visual marks that have been added to dates. - - - - - - Method - - System.Boolean - - - - - - - Shifts the calendar to display the specified month. - A zero-based month number. - The year the month is in. - - - - - - - - - Method - - System.Void - - - - Disposes the resources associated with the object. - - - - - - Constructor - - - - - - Internal constructor - Pointer to the C object. - An instance of Calendar, wrapping the C object. - - This is an internal constructor, and should not be used by user code. - - - - - - Constructor - - - - Creates a new calendar displaying the current month. - A new Calendar. - - - - - - Property - - System.UInt32 - - - The GLib Type for Gtk.Calendar - The GLib Type for the Gtk.Calendar class. - - - - - - Event - - - - To be added - To be added - - - - - Event - - - - To be added - To be added - - - - - Event - - - - To be added - To be added - - - - - Event - - - - To be added - To be added - - - - - Event - - - - To be added - To be added - - - - - Event - - - - To be added - To be added - - - - - Event - - - - To be added - To be added - - - - - Constructor - - - - - - Internal constructor - GLib type for the type - Creates a new instance of Calendar, using the GLib-provided type - - This is a constructor used by derivative types of that would have their own GLib type assigned to it. This is not typically used by C# code. - - - - - - Property - - Gtk.CalendarDisplayOptions - - - - - - To be added - To be added: an object of type 'Gtk.CalendarDisplayOptions' - To be added: an object of type 'Gtk.CalendarDisplayOptions' - To be added - - - - - Method - - System.DateTime - - - - To be added - To be added: an object of type 'DateTime' - To be added - - - - \ No newline at end of file + Ca \ No newline at end of file diff --git a/doc/en/Gtk/TreeModel.xml b/doc/en/Gtk/TreeModel.xml index dbd06f546..c46dbb2ce 100644 --- a/doc/en/Gtk/TreeModel.xml +++ b/doc/en/Gtk/TreeModel.xml @@ -18,24 +18,6 @@ - - - Method - - System.Boolean - - - - - - - To be added - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added - - Method @@ -165,26 +147,6 @@ To be added - - - Method - - System.Boolean - - - - - - - - To be added - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'Gtk.TreeIter' - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added - - Method @@ -220,24 +182,6 @@ To be added - - - Method - - System.Boolean - - - - - - - To be added - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added - - Method @@ -269,42 +213,6 @@ To be added - - - Method - - System.Boolean - - - - - - - To be added - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'Gtk.TreeIter' - To be added: an object of type 'bool' - To be added - - - - - Method - - System.Boolean - - - - - - - To be added - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'Gtk.TreePath' - To be added: an object of type 'bool' - To be added - - Method @@ -337,24 +245,6 @@ To be added - - - Method - - System.Boolean - - - - - - - To be added - To be added: an object of type 'Gtk.TreeIter&' - To be added: an object of type 'Gtk.TreeIter' - To be added: an object of type 'bool' - To be added - - Method @@ -493,5 +383,115 @@ To be added + + + Method + + System.Boolean + + + + + + + To be added + To be added: an object of type 'Gtk.TreeIter&' + To be added: an object of type 'int' + To be added: an object of type 'bool' + To be added + + + + + Method + + System.Boolean + + + + + + + + To be added + To be added: an object of type 'Gtk.TreeIter&' + To be added: an object of type 'Gtk.TreeIter' + To be added: an object of type 'int' + To be added: an object of type 'bool' + To be added + + + + + Method + + System.Boolean + + + + + + + To be added + To be added: an object of type 'Gtk.TreeIter&' + To be added: an object of type 'string' + To be added: an object of type 'bool' + To be added + + + + + Method + + System.Boolean + + + + + + + To be added + To be added: an object of type 'Gtk.TreeIter&' + To be added: an object of type 'Gtk.TreeIter' + To be added: an object of type 'bool' + To be added + + + + + Method + + System.Boolean + + + + + + + To be added + To be added: an object of type 'Gtk.TreeIter&' + To be added: an object of type 'Gtk.TreePath' + To be added: an object of type 'bool' + To be added + + + + + Method + + System.Boolean + + + + + + + To be added + To be added: an object of type 'Gtk.TreeIter&' + To be added: an object of type 'Gtk.TreeIter' + To be added: an object of type 'bool' + To be added + + \ No newline at end of file diff --git a/doc/en/GtkSharp/voidObjectAffineSVPintDelegate.xml b/doc/en/GtkSharp/voidObjectAffineSVPintDelegate.xml index 0b302090a..aac67bd33 100644 --- a/doc/en/GtkSharp/voidObjectAffineSVPintDelegate.xml +++ b/doc/en/GtkSharp/voidObjectAffineSVPintDelegate.xml @@ -1,5 +1,5 @@ - + gnome-sharp 0.0.0.0