diff --git a/doc/ChangeLog b/doc/ChangeLog index 57eefaed1..19bc46bd1 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-03-12 Lee Mallabone + + * en/Gtk/PositionType.xml: + * en/Gtk/HandleBox.xml: First draft docs. + 2003-03-11 Lee Mallabone * en/Gtk/Range.xml: First draft. diff --git a/doc/en/Gtk/HandleBox.xml b/doc/en/Gtk/HandleBox.xml index 6ecc0f81c..1c62fc665 100644 --- a/doc/en/Gtk/HandleBox.xml +++ b/doc/en/Gtk/HandleBox.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A container with a handle and a detachable child widget. + The HandleBox widget allows a portion of a window to be "torn off". It is a widget that displays its child with a handle that the user can drag to create a separate floating window containing the child widget and the 'handle'. + A thin ghost is drawn in the original location of the HandleBox. By dragging the separate window back to its original location, it can be reattached. When reattaching, the ghost and float window, must be aligned along one of the edges, the . This can either be specified by the application programmer explicitly, otherwise a reasonable default will be used, based on the . + To make detaching and reattaching the HandleBox as minimally confusing as possible to the user, it is important to set the snap edge so that it does not move when the HandleBox is deattached. For instance, if the HandleBox is packed at the bottom of a , then when the HandleBox is detached, the bottom edge of the HandleBox's allocation will remain fixed as the height of the HandleBox shrinks, so the snap edge should be set to . + The child of this widget is set using the method in . Gtk.Bin @@ -63,9 +66,9 @@ - To be added - To be added: an object of type 'Gtk.HandleBox' - To be added + The main way to create a HandleBox. + A new HandleBox. + Creates a new HandleBox, with the set to the . @@ -90,10 +93,10 @@ - To be added - To be added: an object of type 'Gtk.PositionType' - To be added: an object of type 'Gtk.PositionType' - To be added + Manage which edge a detached HandleBox must reattach to. + The new edge + The current edge that snapping works with. + To ensure good usability, this edge should be set to a side of the HandleBox whose position or size will not be altered when the child is detached. @@ -106,10 +109,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 the surrounding the child widget. + The new style of shadow to use for this HandleBox. + The current style of shadow in use. + @@ -122,10 +125,10 @@ - To be added - To be added: an object of type 'Gtk.PositionType' - To be added: an object of type 'Gtk.PositionType' - To be added + Manage where the handle of this container is placed. + A new position for the handle. + The current position of the handle. + Note: In western cultures, anything other than a handle for horizontal HandleBoxes, or a handle for vertical HandleBoxes, may seem strange to users.The reverse is likely to be true for cultures with languages that are written from right to left. @@ -138,10 +141,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 the surrounding the child widget. + The new style of shadow to use for this HandleBox. + The current style of shadow in use. + @@ -150,8 +153,8 @@ - To be added - To be added + This event is fired when the contents of the HandleBox are reattached to the main window. + @@ -160,8 +163,8 @@ - To be added - To be added + This event is fired when the contents of the handlebox are detached from the main window. + diff --git a/doc/en/Gtk/PositionType.xml b/doc/en/Gtk/PositionType.xml index cb0c512bc..cfa77a8dc 100644 --- a/doc/en/Gtk/PositionType.xml +++ b/doc/en/Gtk/PositionType.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 + Indicates a position for placement or layout. + A PositionType is used to place widgets, usually relative to other widgets or other parts of the same widget. For example, the position of a handle in a , or the position of tabs in a . System.Enum @@ -34,8 +34,8 @@ - To be added - To be added + The relevant item should be placed on the left. + @@ -46,8 +46,8 @@ - To be added - To be added + The relevant item should be placed on the right. + @@ -58,8 +58,8 @@ - To be added - To be added + The relevant item should be placed at the top. + @@ -70,8 +70,8 @@ - To be added - To be added + The relevant item should be placed at the bottom. +