diff --git a/doc/ChangeLog b/doc/ChangeLog index 7c886a6fe..95cf0c63f 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,25 @@ +2004-08-28 Shane Landrum + + * en/Gtk/HSV.xml: Added docs for color selector. + * en/Gtk/ProximityInEventArgs.xml + * en/Gtk/ProximityOutEventArgs.xml + * en/Gtk/Widget.xml: Docs for proximity events and other events. + * en/Gtk/SizeAllocatedArgs.xml + * en/Gtk/SizeRequestedArgs.xml + * en/Gtk/Requisition.xml: Docs for widget size requests. + * en/Gdk/Rectangle.xml: Added docs. + * en/Gtk/CursorMoveArgs.xml + * en/Gtk/RemovedArgs.xml + * en/Gtk/SelectPageArgs.xml + * en/Gtk/SetBaseArgs.xml + * en/Gtk/ResponseArgs.xml + * en/Gtk/StyleSetArgs.xml: Event data. + * en/Gtk/Settings.xml: Added docs. + * en/Gtk/Table.xml: Added docs. + * en/Gtk/ThemeEngine.xml: Added docs. + * en/Gtk/StockManager.xml: Added docs, flagged some API that needs + review. + 2004-08-28 Shane Landrum * en/Gtk/Widget.xml: Added docs. diff --git a/doc/en/Gdk/Rectangle.xml b/doc/en/Gdk/Rectangle.xml index 3fbc82e3b..3431f0ee3 100644 --- a/doc/en/Gdk/Rectangle.xml +++ b/doc/en/Gdk/Rectangle.xml @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gdk.Rectangle' - To be added + Makes a new rectangle. + An , the underlying unmanaged C object. + A + Not for general developer use. @@ -64,7 +64,7 @@ Width of the rectangle. Height of the rectangle The initialized rectangle. - To be added + @@ -115,8 +115,8 @@ - To be added - To be added + The Y element of the rectangle. + @@ -180,4 +180,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/CursorMoveArgs.xml b/doc/en/Gtk/CursorMoveArgs.xml index 4acbb8903..ac12f62b5 100644 --- a/doc/en/Gtk/CursorMoveArgs.xml +++ b/doc/en/Gtk/CursorMoveArgs.xml @@ -57,4 +57,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HSV.xml b/doc/en/Gtk/HSV.xml index 97efb7aa5..99dc0c823 100644 --- a/doc/en/Gtk/HSV.xml +++ b/doc/en/Gtk/HSV.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 color selector based on hue, saturation, and value. + TODO: add an example. Gtk.Widget @@ -43,10 +43,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Set the basic size of the hue ring. + A + A + @@ -61,11 +61,11 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Sets the color displayed in the widget. + A , the hue + A , the saturation + A , the value + @@ -102,9 +102,9 @@ - To be added - To be added: an object of type 'Gtk.HSV' - To be added + Default constructor. + A + @@ -115,8 +115,8 @@ - To be added - To be added + Fired when the color of this widget changes. + @@ -127,8 +127,8 @@ - To be added - To be added + Fired when this widget is moved. + @@ -146,14 +146,14 @@ - To be added - a - a - a - a - a - a - To be added + Converts a HSV value to a RGB (red-green-blue) triplet. + a , the hue + a , the saturation + a , the value + a , red component + a , blue component + a , green component + @@ -168,11 +168,11 @@ - To be added + Gets the current color indicated by this widget. a a a - To be added + @@ -186,10 +186,10 @@ - To be added - a - a - To be added + Gets the current size of this widget. + a to fill with the hue ring size. + a to fill with the width of the hue ring. + @@ -200,9 +200,18 @@ - To be added + + An HSV color selector is "adjusting" if multiple rapid + changes are being made to its value, for example, when the user + is adjusting the value with the mouse. This property tells + whether the HSV color selector is being adjusted or not. + a - To be added + + Returns true if clients can ignore changes to the color value, since + they may be transitory, or false if they should consider the color + value status to be final. + @@ -260,4 +269,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/ProximityInEventArgs.xml b/doc/en/Gtk/ProximityInEventArgs.xml index 7939fb860..48cc8368c 100644 --- a/doc/en/Gtk/ProximityInEventArgs.xml +++ b/doc/en/Gtk/ProximityInEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventProximity - To be added - To be added: an object of type 'Gdk.EventProximity' - To be added + The proximity event that triggered this signal. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/ProximityOutEventArgs.xml b/doc/en/Gtk/ProximityOutEventArgs.xml index 0a7140285..72911fa8c 100644 --- a/doc/en/Gtk/ProximityOutEventArgs.xml +++ b/doc/en/Gtk/ProximityOutEventArgs.xml @@ -39,10 +39,10 @@ Gdk.EventProximity - To be added - To be added: an object of type 'Gdk.EventProximity' - To be added + The proximity event that triggered this signal. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/RemovedArgs.xml b/doc/en/Gtk/RemovedArgs.xml index 939895f83..90b6adc14 100644 --- a/doc/en/Gtk/RemovedArgs.xml +++ b/doc/en/Gtk/RemovedArgs.xml @@ -39,10 +39,10 @@ Gtk.Widget - To be added - To be added: an object of type 'Gtk.Widget' - To be added + The widget that was removed from this container. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/Requisition.xml b/doc/en/Gtk/Requisition.xml index 9290be41d..349a68b5b 100644 --- a/doc/en/Gtk/Requisition.xml +++ b/doc/en/Gtk/Requisition.xml @@ -32,8 +32,8 @@ The size requisition phase of the widget layout process operates top-down. It st - To be added - To be added + An empty object. + @@ -46,10 +46,10 @@ The size requisition phase of the widget layout process operates top-down. It st - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.Requisition' - To be added + Constructor. + A , the underlying C object. + A + Not for general developer use. @@ -60,8 +60,8 @@ The size requisition phase of the widget layout process operates top-down. It st - To be added - To be added + Frees the memory used by this requisition. + @@ -72,9 +72,9 @@ The size requisition phase of the widget layout process operates top-down. It st - To be added - To be added: an object of type 'Gtk.Requisition' - To be added + Duplicates this requisition object by value. + A + @@ -117,4 +117,4 @@ The size requisition phase of the widget layout process operates top-down. It st - \ No newline at end of file + diff --git a/doc/en/Gtk/ResponseArgs.xml b/doc/en/Gtk/ResponseArgs.xml index a17ff9b6f..3eef5bc9c 100644 --- a/doc/en/Gtk/ResponseArgs.xml +++ b/doc/en/Gtk/ResponseArgs.xml @@ -40,10 +40,10 @@ - To be added + The response type the user gave for this dialog. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/SelectPageArgs.xml b/doc/en/Gtk/SelectPageArgs.xml index d3413fa45..46e030ad2 100644 --- a/doc/en/Gtk/SelectPageArgs.xml +++ b/doc/en/Gtk/SelectPageArgs.xml @@ -39,10 +39,10 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether or not to move the focus to the selected page. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/SetBaseArgs.xml b/doc/en/Gtk/SetBaseArgs.xml index e3d8659c1..846c6eb8a 100644 --- a/doc/en/Gtk/SetBaseArgs.xml +++ b/doc/en/Gtk/SetBaseArgs.xml @@ -39,10 +39,10 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The base URL for this HTML widget. + A . + - \ No newline at end of file + diff --git a/doc/en/Gtk/Settings.xml b/doc/en/Gtk/Settings.xml index ca5e8a3ce..e4faefe91 100644 --- a/doc/en/Gtk/Settings.xml +++ b/doc/en/Gtk/Settings.xml @@ -53,8 +53,8 @@ - To be added - A + Installs a property. + A , pointer to an unmanaged C property object. @@ -70,7 +70,7 @@ - To be added + Sets a property whose content is a . A A A @@ -88,7 +88,7 @@ - To be added + Sets a property whose value is a . A A @@ -106,7 +106,7 @@ - To be added + Sets a property whose value is a . A A A @@ -125,7 +125,7 @@ - To be added + Sets a property whose value is a . A A A @@ -182,7 +182,7 @@ - To be added + Gets the settings for . a a @@ -249,7 +249,7 @@ - To be added + Number of pixels the cursor can move before dragging. a @@ -275,7 +275,7 @@ - To be added + A font name. a @@ -288,9 +288,9 @@ - To be added + A string representing possible sizes for icons for different UI components. a - + This may look something like "(gtk-menu=16,16;gtk-button=20,20 [...])". @@ -301,7 +301,7 @@ - To be added + The name of the key theme RC file to load. a @@ -314,9 +314,9 @@ - To be added + Keybinding to activate the menu bar. a - + Defaults to F10. @@ -327,7 +327,7 @@ - To be added + Whether two cursors should be displayed for mixed left-to-right and right-to-left text. a @@ -340,7 +340,7 @@ - To be added + Name of the theme RC file to load. a diff --git a/doc/en/Gtk/SizeAllocatedArgs.xml b/doc/en/Gtk/SizeAllocatedArgs.xml index 001c29d54..dadf28889 100644 --- a/doc/en/Gtk/SizeAllocatedArgs.xml +++ b/doc/en/Gtk/SizeAllocatedArgs.xml @@ -39,10 +39,10 @@ Gdk.Rectangle - To be added - To be added: an object of type 'Gdk.Rectangle' - To be added + The actual rectangle that was allocated for the widget. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/SizeRequestedArgs.xml b/doc/en/Gtk/SizeRequestedArgs.xml index 30a6ea1db..d2d9c3506 100644 --- a/doc/en/Gtk/SizeRequestedArgs.xml +++ b/doc/en/Gtk/SizeRequestedArgs.xml @@ -39,10 +39,10 @@ Gtk.Requisition - To be added - To be added: an object of type 'Gtk.Requisition' - To be added + The width and height this widget would like to have. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/StockManager.xml b/doc/en/Gtk/StockManager.xml index e5d02d03c..0a14a4c23 100644 --- a/doc/en/Gtk/StockManager.xml +++ b/doc/en/Gtk/StockManager.xml @@ -30,10 +30,18 @@ - To be added + Registers each of the stock items in . + If an item already exists with the same stock ID as one of the + , the old item gets replaced. The stock + items are copied, so GTK+ does not hold any pointer into + and can be + freed. Use if + is persistent and GTK# doesn't need to + copy the array. + a - a - To be added + a , the number of items in + (TODO: This API doesn't make sense for the underlying C API, because the C API has an option of adding multiple items. Needs clarification.) @@ -47,10 +55,12 @@ - To be added + Same as but doesn't copy + , so must persist + until application exit. a a - To be added + (TODO:Needs API review; see the Add method also.) @@ -83,4 +93,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Style.xml b/doc/en/Gtk/Style.xml index 53cfd2a53..4013b2857 100644 --- a/doc/en/Gtk/Style.xml +++ b/doc/en/Gtk/Style.xml @@ -742,7 +742,7 @@ color or pixmap specified by this style for . a a a - To be added + diff --git a/doc/en/Gtk/StyleSetArgs.xml b/doc/en/Gtk/StyleSetArgs.xml index cb67cd90a..369fe7d79 100644 --- a/doc/en/Gtk/StyleSetArgs.xml +++ b/doc/en/Gtk/StyleSetArgs.xml @@ -39,10 +39,10 @@ Gtk.Style - To be added - To be added: an object of type 'Gtk.Style' - To be added + The style that was in use before this style. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/Table.xml b/doc/en/Gtk/Table.xml index 81e8b1c58..1b2c5287d 100644 --- a/doc/en/Gtk/Table.xml +++ b/doc/en/Gtk/Table.xml @@ -234,9 +234,9 @@ public Widget MakeTableTester() System.UInt32 - To be added - To be added: an object of type 'uint' - To be added + The default number of pixels between columns. + A . + @@ -248,10 +248,10 @@ public Widget MakeTableTester() - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + The number of pixels between columns if it isn't the default value. + . + A . + @@ -295,10 +295,10 @@ public Widget MakeTableTester() - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + The space between table rows. + A . + . + @@ -344,4 +344,4 @@ public Widget MakeTableTester() - \ No newline at end of file + diff --git a/doc/en/Gtk/ThemeEngine.xml b/doc/en/Gtk/ThemeEngine.xml index 4a01c24f2..5a80eeeea 100644 --- a/doc/en/Gtk/ThemeEngine.xml +++ b/doc/en/Gtk/ThemeEngine.xml @@ -36,10 +36,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.ThemeEngine' - To be added + Gets the theme engine whose name is . + A + A + @@ -50,9 +50,9 @@ - To be added - To be added: an object of type 'Gtk.RcStyle' - To be added + Generates a out of this ThemeEngine. + A . + @@ -122,4 +122,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Widget.xml b/doc/en/Gtk/Widget.xml index f4adfa3a2..f650ba963 100644 --- a/doc/en/Gtk/Widget.xml +++ b/doc/en/Gtk/Widget.xml @@ -2137,8 +2137,8 @@ handle focus grabs. - To be added - + Fired when the user is using a stylus or touch screen and their pointer comes near the widget. + See for context. @@ -2149,8 +2149,8 @@ handle focus grabs. - To be added - + Fired when the user is using a stylus or touch screen and their pointer leaves the area near the widget. + See for context. @@ -2161,7 +2161,7 @@ handle focus grabs. - To be added + Fired when this widget is destroyed. @@ -2173,7 +2173,7 @@ handle focus grabs. - To be added + Fired when this widget is the destination of a received selection. @@ -3210,7 +3210,7 @@ handle focus grabs. - To be added + Fired when the closures for this widget's accelerator change.