diff --git a/doc/ChangeLog b/doc/ChangeLog index 33b2beb49..8934ef8df 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,19 @@ +2004-08-27 Shane Landrum + + * en/Gtk/WindowKeysForeachFunc.xml + * en/Gtk/Accessibility.xml + * en/Gtk/CallbackMarshal.xml + * en/Gtk/ColorSelectionChangePaletteFunc.xml + * en/Gtk/ColorSelectionDialog.xml + * en/Gtk/Container.xml + * en/Gtk/DestroyNotify.xml + * en/Gtk/IconSet.xml + * en/Gtk/ScrollAdjustmentsSetArgs.xml + * en/Gtk/ScrollType.xml + * en/Gtk/MoveFocusArgs.xml : Miscellaneous docs. + * en/Gtk/RB*.xml : Internal classes. Do not use. + * en/Gtk/Style*.xml : Began documenting style-related classes. + 2004-08-27 Shane Landrum * en/Gtk/TagAddedArgs.xml diff --git a/doc/en/Gtk/Accessible.xml b/doc/en/Gtk/Accessible.xml index f3320fe3b..7639c4eb6 100644 --- a/doc/en/Gtk/Accessible.xml +++ b/doc/en/Gtk/Accessible.xml @@ -99,10 +99,10 @@ - To be added + Protected constructor. a - To be added + Chain to this constructor if you have not registered a native value for your subclass. - \ No newline at end of file + diff --git a/doc/en/Gtk/CallbackMarshal.xml b/doc/en/Gtk/CallbackMarshal.xml index f92c6784e..145e9f84a 100644 --- a/doc/en/Gtk/CallbackMarshal.xml +++ b/doc/en/Gtk/CallbackMarshal.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 + Delegate for specifying a function signature for marshalling callbacks. + FIXME: provide an example here System.Delegate @@ -32,4 +32,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/ColorSelectionChangePaletteFunc.xml b/doc/en/Gtk/ColorSelectionChangePaletteFunc.xml index f3ac4a2f4..01556211f 100644 --- a/doc/en/Gtk/ColorSelectionChangePaletteFunc.xml +++ b/doc/en/Gtk/ColorSelectionChangePaletteFunc.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 + Delegate to specify function signature for methods that change the color palette in a . + System.Delegate @@ -30,4 +30,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/ColorSelectionDialog.xml b/doc/en/Gtk/ColorSelectionDialog.xml index 867dc20b5..2a05d19ee 100644 --- a/doc/en/Gtk/ColorSelectionDialog.xml +++ b/doc/en/Gtk/ColorSelectionDialog.xml @@ -85,7 +85,7 @@ A button for providing help with this dialog A standard . - To be added + @@ -154,4 +154,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Container.xml b/doc/en/Gtk/Container.xml index 6c5743991..e41556885 100644 --- a/doc/en/Gtk/Container.xml +++ b/doc/en/Gtk/Container.xml @@ -561,9 +561,9 @@ - To be added + Protected constructor for chaining by descendant classes. a - To be added + @@ -597,4 +597,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/DestroyNotify.xml b/doc/en/Gtk/DestroyNotify.xml index bc4b88d74..e2747a3b6 100644 --- a/doc/en/Gtk/DestroyNotify.xml +++ b/doc/en/Gtk/DestroyNotify.xml @@ -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 delegate specifying a function signature. + See for where this +gets used. System.Delegate @@ -28,4 +29,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/IconSet.xml b/doc/en/Gtk/IconSet.xml index 42ecf1528..cbd65256d 100644 --- a/doc/en/Gtk/IconSet.xml +++ b/doc/en/Gtk/IconSet.xml @@ -16,7 +16,7 @@ A represents a single icon in various sizes and widget states. It can provide a for a given size and state on request, - and automatically caches some of the rendered GdkPixbuf objects. + and automatically caches some of the rendered objects. @@ -236,4 +236,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Menu.xml b/doc/en/Gtk/Menu.xml index b23ff1698..0580a0173 100644 --- a/doc/en/Gtk/Menu.xml +++ b/doc/en/Gtk/Menu.xml @@ -336,7 +336,7 @@ class PopupSample Sets an accelerator path for this menu from which accelerator paths for its immediate children, its menu items, can be constructed. A valid accelerator path. - To be added: an object of type 'string' + void The main purpose of this function is to spare the programmer the inconvenience of having to call on each menu item that should support runtime user changable accelerators. Instead, by just calling on their parent, each menu item of this menu, that contains a label describing its purpose, automatically gets an accel path assigned. diff --git a/doc/en/Gtk/MoveFocusArgs.xml b/doc/en/Gtk/MoveFocusArgs.xml index b84f651ce..8c1955411 100644 --- a/doc/en/Gtk/MoveFocusArgs.xml +++ b/doc/en/Gtk/MoveFocusArgs.xml @@ -53,10 +53,10 @@ Gtk.DirectionType - To be added - To be added: an object of type 'Gtk.DirectionType' + The direction to move the focus. + a To be added - \ No newline at end of file + diff --git a/doc/en/Gtk/RBNode.xml b/doc/en/Gtk/RBNode.xml index 7a89ca75f..0a3a18ca5 100644 --- a/doc/en/Gtk/RBNode.xml +++ b/doc/en/Gtk/RBNode.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + A node of a red-black data tree. Do not use. To be added @@ -135,4 +135,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/RBTree.xml b/doc/en/Gtk/RBTree.xml index dc3d5b24e..55820ff4b 100644 --- a/doc/en/Gtk/RBTree.xml +++ b/doc/en/Gtk/RBTree.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A red-black data tree. Do not use. + For internal use only? System.ValueType @@ -96,4 +96,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/RBTreeTraverseFunc.xml b/doc/en/Gtk/RBTreeTraverseFunc.xml index 3dde0ec4f..bc60ce997 100644 --- a/doc/en/Gtk/RBTreeTraverseFunc.xml +++ b/doc/en/Gtk/RBTreeTraverseFunc.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + A delegate class for traversing a red-black tree. To be added @@ -30,4 +30,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/ScrollAdjustmentsSetArgs.xml b/doc/en/Gtk/ScrollAdjustmentsSetArgs.xml index 88407ec11..6ae06a0ca 100644 --- a/doc/en/Gtk/ScrollAdjustmentsSetArgs.xml +++ b/doc/en/Gtk/ScrollAdjustmentsSetArgs.xml @@ -63,9 +63,9 @@ Gtk.Adjustment - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added + The vertical adjustment for the scrolling event. + a + @@ -75,10 +75,10 @@ Gtk.Adjustment - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added + The horizontal adjustment for the scrolling event. + a + - \ No newline at end of file + diff --git a/doc/en/Gtk/ScrollType.xml b/doc/en/Gtk/ScrollType.xml index 44bc6f69b..e03e80c47 100644 --- a/doc/en/Gtk/ScrollType.xml +++ b/doc/en/Gtk/ScrollType.xml @@ -137,7 +137,7 @@ - To be added + Move the scroller a step up. @@ -150,7 +150,7 @@ - To be added + Move the scroller a step down. @@ -163,7 +163,7 @@ - To be added + Move the slider a page up. @@ -176,7 +176,7 @@ - To be added + Move the slider a page down. @@ -291,4 +291,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Selection.xml b/doc/en/Gtk/Selection.xml index fefc8301f..702e3d49e 100644 --- a/doc/en/Gtk/Selection.xml +++ b/doc/en/Gtk/Selection.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Object to represent a selection. + System.Object @@ -187,4 +187,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Style.xml b/doc/en/Gtk/Style.xml index be971c189..30f946006 100644 --- a/doc/en/Gtk/Style.xml +++ b/doc/en/Gtk/Style.xml @@ -1,6 +1,6 @@ - + : gtk-sharp @@ -38,9 +38,9 @@ Gets the foreground color for a particular state - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gdk.Color' - To be added + A , the state being considered + A + @@ -54,7 +54,7 @@ Sets the background of to the background color or pixmap specified by style for the state. - A state. + A , the state being considered A color to be used for the background. @@ -70,10 +70,10 @@ - To be added - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gdk.GC' - To be added + Gets the graphics context for the background of . + a + a , the graphics context + @@ -86,10 +86,10 @@ - To be added - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gdk.GC' - To be added + Gets the graphics context for the foreground of . + a + a , the graphics context + @@ -109,16 +109,16 @@ - To be added - To be added: an object of type 'Gdk.Window' - To be added: an object of type 'bool' - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gdk.Rectangle' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Sets the default background. + A + A (TODO: explain) + A + A + A , X coordinate of the upper left corner + A , Y coordinate of the upper left corner + A , width of the area + A , height of the area + TODO: explain this, as the underlying GTK+ isn't very well-commented either @@ -132,10 +132,11 @@ - To be added - To be added: an object of type 'Gdk.Window' - To be added: an object of type 'Gtk.StateType' - To be added + Set the background of to the +color or pixmap specified by this style for . + A + A + @@ -146,8 +147,8 @@ - To be added - To be added + Detaches this style from the window it's attached to. + @@ -165,15 +166,15 @@ - To be added - To be added: an object of type 'Gtk.IconSource' - To be added: an object of type 'Gtk.TextDirection' - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gtk.IconSize' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Pixbuf' - To be added + Renders the icon specified by at the given according to the given parameters and returns the result in a pixbuf. + A + A + A + A + A + A + A + TODO: needs an example. @@ -199,10 +200,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.IconSet' - To be added + Gets the icon set for the given . + A + A + @@ -282,10 +283,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The Y thickness, which is used for vertical padding. + A + A + @@ -311,8 +312,8 @@ The foreground colors - To be added: an object of type 'Gdk.Color []' - To be added + A + @@ -322,9 +323,9 @@ Gdk.Color [] - To be added - To be added: an object of type 'Gdk.Color []' - To be added + The background colors. + A + @@ -334,9 +335,9 @@ Gdk.Color - To be added - To be added: an object of type 'Gdk.Color' - To be added + Black. + A + @@ -346,9 +347,9 @@ Gdk.Color - To be added - To be added: an object of type 'Gdk.Color' - To be added + White. + A + @@ -359,7 +360,7 @@ To be added - To be added: an object of type 'Gdk.GC []' + A To be added @@ -371,7 +372,7 @@ To be added - To be added: an object of type 'Gdk.GC []' + A To be added @@ -383,7 +384,7 @@ To be added - To be added: an object of type 'Gdk.GC' + A To be added @@ -395,7 +396,7 @@ To be added - To be added: an object of type 'Gdk.GC' + A To be added diff --git a/doc/en/Gtk/StyleChangedArgs.xml b/doc/en/Gtk/StyleChangedArgs.xml index cd91cf968..201de3101 100644 --- a/doc/en/Gtk/StyleChangedArgs.xml +++ b/doc/en/Gtk/StyleChangedArgs.xml @@ -39,10 +39,10 @@ Gtk.ToolbarStyle - To be added - To be added: an object of type 'Gtk.ToolbarStyle' - To be added + The style that the toolbar was changed to use. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/WindowKeysForeachFunc.xml b/doc/en/Gtk/WindowKeysForeachFunc.xml index 8aa6de343..c7bf7cdbc 100644 --- a/doc/en/Gtk/WindowKeysForeachFunc.xml +++ b/doc/en/Gtk/WindowKeysForeachFunc.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added + Delegate for use by To be added @@ -32,4 +32,4 @@ System.Void - \ No newline at end of file +