From b68831eb6ca8b3d3ea38ca357ac8ffa707bd2c88 Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Fri, 28 Feb 2003 19:26:53 +0000 Subject: [PATCH] Merge in documents from bug #38940 by Hector, and doc Frame.xml myself. svn path=/trunk/gtk-sharp/; revision=12068 --- doc/ChangeLog | 10 +++++ doc/en/Gtk/Frame.xml | 77 ++++++++++++++++++++------------------- doc/en/Gtk/GammaCurve.xml | 21 +++++++---- doc/en/Gtk/Invisible.xml | 18 +++++---- doc/en/Gtk/MenuItem.xml | 24 ++++++------ doc/en/Gtk/Separator.xml | 14 +++---- doc/en/Gtk/VSeparator.xml | 18 +++++---- 7 files changed, 104 insertions(+), 78 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index d8c9c5f50..983c99ff4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,13 @@ +2003-02-28 Lee Mallabone + + * en/Gtk/Invisible.xml: + * en/Gtk/Separator.xml: + * en/Gtk/VSeparator.xml: + * en/Gtk/GammaCurve: Hector's latest. + + * en/Gtk/Frame.xml: complete docs exluding dubious API calls. + * en/Gtk/MenuItem: document a couple of skeleton methods + 2003-02-27 Martin Willemoes Hansen * en/Gtk/TreeModel.xml: Fixed GetValue method signature diff --git a/doc/en/Gtk/Frame.xml b/doc/en/Gtk/Frame.xml index 7508f2c68..5092148bc 100644 --- a/doc/en/Gtk/Frame.xml +++ b/doc/en/Gtk/Frame.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A with a decorative frame and optional . + This widget draws a frame around whatever it contains, so is often used to visually group a set of widgets together. + If present, a label is drawn in a gap in the top side of the frame. The position of the label can be controlled with . Gtk.Bin @@ -57,10 +58,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Sets the alignment of the . + The horizontal alignment, between 0 and 1.0. + The vertical alignment, between 0 and 1.0. + Horizontal and vertical alignments can be adjusted individually using the and properties, respectively. @@ -115,10 +116,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Frame' - To be added + Create a new frame with a label in the top left corner. + The text to appear as this frame's label + A new Frame. + This creates a new frame with a widget in the top left corner, displaying the text passed in as . @@ -127,9 +128,9 @@ - To be added - To be added: an object of type 'Gtk.Frame' - To be added + Create a new frame with no label + A new Frame with a null . + @@ -154,10 +155,10 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + Manage the widget that acts as a frame's . + A widget to replace the existing label. + The current in use as this Frame's label. + Despite its name, this property does not have to set a widget as its label. Because of the way that Gtk containers work, you may add an arbitrary widget as the label for this frame. However, a genuine is recommended for consistency with other applications. @@ -170,10 +171,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Set the vertical alignment of the . + A new vertical alignment between 0 and 1.0 + The existing vertical alignment of this Frame's label + @@ -186,10 +187,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Set the horizontal alignment of the . + A new horizontal alignment between 0 and 1.0 + The existing horizontal alignment of this Frame's label + @@ -202,10 +203,10 @@ - To be added - To be added: an object of type 'Gtk.ShadowType' - To be added: an object of type 'Gtk.ShadowType' - To be added + Manage the appearance of this frame's border. + A new shadow type. + The current shadow style that this Frame is rendered with. + @@ -218,10 +219,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The string that is visible as the Frame's label + Sets the text of the label, if this Frame has one. + The text of a label if is a , null otherwise. + @@ -234,10 +235,10 @@ - To be added - To be added: an object of type 'Gtk.ShadowType' - To be added: an object of type 'Gtk.ShadowType' - To be added + Manage the appearance of this frame's border. + A new shadow type. + The current shadow style that this Frame is rendered with. + diff --git a/doc/en/Gtk/GammaCurve.xml b/doc/en/Gtk/GammaCurve.xml index dc87063dc..34bcbd21b 100644 --- a/doc/en/Gtk/GammaCurve.xml +++ b/doc/en/Gtk/GammaCurve.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 is a variant of specifically for editing gamma curves, which are used in graphics applications such as the Gimp. + + + The widget shows a curve which the user can edit with the mouse just like a widget. On the right of the curve it also displays 5 buttons, 3 of which change between the 3 curve modes (spline, linear and free), and the other 2 set the curve to a particular gamma value, or reset it to a straight line. + + + 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.VBox @@ -79,9 +86,9 @@ - To be added - To be added: an object of type 'Gtk.GammaCurve' - To be added + Constructor. + An instance of . + @@ -97,4 +104,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Invisible.xml b/doc/en/Gtk/Invisible.xml index 372aae005..598ecdd61 100644 --- a/doc/en/Gtk/Invisible.xml +++ b/doc/en/Gtk/Invisible.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The widget is used for reliable pointer grabs and selection handling in the code for drag-and-drop. + + + Used internally in GTK+, and is probably not useful for application developers. + + Gtk.Widget @@ -79,9 +83,9 @@ - To be added - To be added: an object of type 'Gtk.Invisible' - To be added + Constructor. + An instance of . + @@ -97,4 +101,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/MenuItem.xml b/doc/en/Gtk/MenuItem.xml index b7fb83a21..a25e7f146 100644 --- a/doc/en/Gtk/MenuItem.xml +++ b/doc/en/Gtk/MenuItem.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A widget used for items in menus + The MenuItem and derived widgets are the only valid children for menus. Their function is to correctly handle highlighting, alignment, events and submenus. Gtk.Item @@ -39,10 +39,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.MenuItem' - To be added + Creates a new MenuItem with a . + The text to appear on this menu item. + A new MenuItem + @@ -53,8 +53,8 @@ - To be added - To be added + Removes the MenuItem's submenu, if it has one. + @@ -65,8 +65,8 @@ - To be added - To be added + Fires the event. + @@ -77,8 +77,8 @@ - To be added - To be added + Fires the event. + diff --git a/doc/en/Gtk/Separator.xml b/doc/en/Gtk/Separator.xml index 823cc13f7..e3568de7e 100644 --- a/doc/en/Gtk/Separator.xml +++ b/doc/en/Gtk/Separator.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The widget is an abstract class, used only for deriving the subclasses and . + Gtk.Widget @@ -79,9 +79,9 @@ - To be added - To be added: an object of type 'Gtk.Separator' - To be added + Constructor. + A instance of . + @@ -97,4 +97,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/VSeparator.xml b/doc/en/Gtk/VSeparator.xml index 4af69c03f..9779e9799 100644 --- a/doc/en/Gtk/VSeparator.xml +++ b/doc/en/Gtk/VSeparator.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The is a vertical separator, used to group the widgets within a window. + + + The is a vertical separator, used to group the widgets within a window. It displays a vertical line with a shadow to make it appear sunken into the interface. + + Gtk.Separator @@ -79,9 +83,9 @@ - To be added - To be added: an object of type 'Gtk.VSeparator' - To be added + Constructor. + A vertical separator. + @@ -97,4 +101,4 @@ - \ No newline at end of file +