From 9d2b95bcc6cfb21492f5cc45ebbba5762de4bb38 Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Wed, 5 Mar 2003 07:39:20 +0000 Subject: [PATCH] 2003-03-05 Duncan Mak * en/Gtk/Curve.xml * en/Gtk/DrawingArea.xml: More from Hector. svn path=/trunk/gtk-sharp/; revision=12210 --- doc/ChangeLog | 5 ++ doc/en/Gtk/Curve.xml | 133 +++++++++++++++++++++++-------------- doc/en/Gtk/DrawingArea.xml | 25 +++++-- 3 files changed, 107 insertions(+), 56 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 1fecd192d..7f7649803 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-03-05 Duncan Mak + + * en/Gtk/Curve.xml + * en/Gtk/DrawingArea.xml: More from Hector. + 2003-03-04 Lee Mallabone * en/Gtk/*Paned.xml: First draft at Paned docs. diff --git a/doc/en/Gtk/Curve.xml b/doc/en/Gtk/Curve.xml index d38a1a8d7..c747f3bb2 100644 --- a/doc/en/Gtk/Curve.xml +++ b/doc/en/Gtk/Curve.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,15 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The widget allows the user to edit a curve covering a range of values. + + + The widget allows the user to edit a curve covering a range of values. It is typically used to fine-tune color balances in graphics applications like the Gimp. The widget has 3 modes of operation - spline, linear and free. In spline mode the user places points on the curve which are automatically connected together into a smooth curve. In linear mode the user places points on the curve which are connected by straight lines. In free mode the user can draw the points of the curve freely, and they are not connected at all. + + + NOTE: this widget is considered too specialized/little-used for GTK+, and will in the future be moved to some other package. If your application needs this widget, feel free to use it, as the widget does work and is useful in some applications; it's just not of general interest. However, we are not accepting new features for the widget, and it will eventually move out of the GTK+ distribution. + + Gtk.DrawingArea @@ -50,8 +57,12 @@ - To be added - To be added + Resets the curve to a straight line from the minimum x and y values to the maximum x and y values (i.e. from the bottom-left to the top-right corners). + + + Resets the curve to a straight line from the minimum x and y values to the maximum x and y values (i.e. from the bottom-left to the top-right corners). The curve type is not changed. + + @@ -67,12 +78,16 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Sets the minimum and maximum x and y values of the curve. + The minimum x value. + The maximum x value. + The minimum y value. + The maximum y value. + + + Sets the minimum and maximum x and y values of the curve. The curve is also reset with a call to . + + @@ -86,10 +101,14 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'float[]' - To be added + Sets the vector of points on the curve. + The number of points. + The points on the curve. + + + Sets the vector of points on the curve. The curve type is set to . + + @@ -103,10 +122,14 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'float[]' - To be added + Returns a vector of points representing the curve. + The number of points to calculate. + Returns the points. + + + Returns a vector of points representing the curve. + + @@ -159,9 +182,9 @@ - To be added - To be added: an object of type 'Gtk.Curve' - To be added + Constructor. + An instance of . + @@ -186,10 +209,14 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Recomputes the entire curve using the given gamma value. + A gamma value. + A gamma value. + + + A gamma value of 1 results in a straight line. Values greater than 1 result in a curve above the straight line. Values less than 1 result in a curve below the straight. + + @@ -202,10 +229,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The maximum y value of the gamma curve. + A max y value. + A max y value. + @@ -218,10 +245,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The maximum x value of the gamma curve. + A max x value. + A max x value. + @@ -234,10 +261,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The minimum y value of the gamma curve. + A min y value. + A min y value. + @@ -250,10 +277,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The minimum x value of the gamma curve. + A min x value. + A min x value. + @@ -266,10 +293,14 @@ - To be added - To be added: an object of type 'Gtk.CurveType' - To be added: an object of type 'Gtk.CurveType' - To be added + Sets the type of the curve. + The type of the curve. + A . + + + The curve will remain unchanged except when changing from a free curve to a linear or spline curve, in which case the curve will be changed as little as possible. + + @@ -278,9 +309,13 @@ - To be added - To be added + Emitted when the curve type has been changed. + + + The curve type can be changed explicitly with a call to . It is also changed as a side-effect of calling or . + + - \ No newline at end of file + diff --git a/doc/en/Gtk/DrawingArea.xml b/doc/en/Gtk/DrawingArea.xml index bc9cc4d52..880e1eb5b 100644 --- a/doc/en/Gtk/DrawingArea.xml +++ b/doc/en/Gtk/DrawingArea.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,19 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The GtkDrawingArea widget is used for creating custom user interface elements. + + + The widget is used for creating custom user interface elements. It's essentially a blank widget; you can draw on ->window. After creating a drawing area, the application may want to connect to: + 1) Mouse and button press signals to respond to input from the user. (Use to enable events you wish to receive). + 2) The signal to take any necessary actions when the widget is instantiated on a particular display. (Create GDK resources in response to this signal.) + 3) The signal to take any necessary actions when the widget changes size. + 4) The signal to handle redrawing the contents of the widget. + + + Expose events are normally delivered when a drawing area first comes onscreen, or when it's covered by another window and then uncovered (exposed). You can also force an expose event by adding to the "damage region" of the drawing area's window; and are equally good ways to do this. You'll then get an expose event for the invalid region. See also for drawing a . + + Gtk.Widget @@ -79,9 +90,9 @@ - To be added - To be added: an object of type 'Gtk.DrawingArea' - To be added + Constructor. + An instance of . + @@ -97,4 +108,4 @@ - \ No newline at end of file +