From 6a0ba3d687a17acf3c9fcc2fd8be09a66e5a99a6 Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Sat, 15 Mar 2003 22:50:24 +0000 Subject: [PATCH] Update docs for Gtk. svn path=/trunk/gtk-sharp/; revision=12567 --- doc/en/Gtk/Alignment.xml | 36 +- doc/en/Gtk/Bin.xml | 12 +- doc/en/Gtk/Button.xml | 294 ++++++++++++++- doc/en/Gtk/ColorSelectionButton.xml | 63 ++++ doc/en/Gtk/Combo.xml | 15 - doc/en/Gtk/HScale.xml | 21 +- doc/en/Gtk/HandleBox.xml | 35 +- doc/en/Gtk/NotebookPage.xml | 9 +- doc/en/Gtk/PositionType.xml | 12 +- doc/en/Gtk/Range.xml | 36 +- doc/en/Gtk/Scale.xml | 27 +- doc/en/Gtk/Table.xml | 95 ++--- doc/en/Gtk/VScale.xml | 23 +- doc/en/Gtk/Widget.xml | 567 ++++++++++++++-------------- doc/en/Gtk/WidgetFlags.xml | 96 ++--- 15 files changed, 869 insertions(+), 472 deletions(-) create mode 100644 doc/en/Gtk/ColorSelectionButton.xml diff --git a/doc/en/Gtk/Alignment.xml b/doc/en/Gtk/Alignment.xml index cc4709b55..c0a035333 100644 --- a/doc/en/Gtk/Alignment.xml +++ b/doc/en/Gtk/Alignment.xml @@ -8,10 +8,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A container that controls the alignment and size of its child. - An Alignment widget controls the alignment and size of its child widget. It has four settings: , , , and . - The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space). - The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect. - To add a child to an Alignment, use the method from the class. + + An Alignment widget controls the alignment and size of its child widget. It has four settings: , , , and . + The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space). + The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect. + To add a child to an Alignment, use the method from the class. + Gtk.Bin @@ -50,7 +52,9 @@ The vertical alignment of the child widget, from 0 (top) to 1 (bottom). The amount that the child widget expands horizontally to fill up unused space, from 0 to 1. The amount that the child widget expands vertically to fill up unused space, from 0 to 1. - For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment. + + For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment. + @@ -98,7 +102,7 @@ The amount that the child widget expands horizontally to fill up unused space, from 0 to 1. The amount that the child widget expands vertically to fill up unused space, from 0 to 1. A new Alignment. - + @@ -108,8 +112,8 @@ Internal constructor - - + + @@ -137,7 +141,9 @@ Manage the vertical alignment of the child widget. A new vertical alignment for the child widget. The child widget's current vertical alignment. - This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container. + + This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container. + @@ -153,7 +159,9 @@ Manage the horizontal alignment of the child widget. A new horizontal alignment for the child widget. The child widget's current horizontal alignment. - This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size. + + This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size. + @@ -169,7 +177,9 @@ Manage the horizontal expansion of the child widget. The proportion that the child widget should expand horizontally. The current horizontal expansion of the child widget. - This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size. + + This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size. + @@ -185,7 +195,9 @@ Manage the vertical expansion of the child widget. The proportion that the child widget should expand vertically. The current vertical expansion of the child widget. - This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size. + + This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size. + diff --git a/doc/en/Gtk/Bin.xml b/doc/en/Gtk/Bin.xml index d8eac7728..48fd794d2 100644 --- a/doc/en/Gtk/Bin.xml +++ b/doc/en/Gtk/Bin.xml @@ -8,9 +8,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A container with just one child. - A Bin widget is a with just one child. It is used to create subclasses, since it provides common code needed for handling a single child . - Many GTK+ widgets are subclasses of Bin, including , , , , and . - To place a child widget inside this container, use the standard method. + + A Bin widget is a with just one child. It is used to create subclasses, since it provides common code needed for handling a single child . + Many GTK+ widgets are subclasses of Bin, including , , , , and . + To place a child widget inside this container, use the standard method. + Gtk.Container @@ -66,8 +68,8 @@ Internal constructor - - + + diff --git a/doc/en/Gtk/Button.xml b/doc/en/Gtk/Button.xml index b14b64f12..e2148fe5b 100644 --- a/doc/en/Gtk/Button.xml +++ b/doc/en/Gtk/Button.xml @@ -36,31 +36,309 @@ - - + + Property - Gtk.ColorSelectionDialog + System.UInt32 To be added - To be added: an object of type 'Gtk.ColorSelectionDialog' + To be added: an object of type 'uint' + To be added + + + + + Property + + System.Boolean + + + + + + To be added + To be added: an object of type 'bool' + To be added: an object of type 'bool' + To be added + + + + + Property + + System.Boolean + + + + + + To be added + To be added: an object of type 'bool' + To be added: an object of type 'bool' + To be added + + + + + Property + + Gtk.ReliefStyle + + + + + + To be added + To be added: an object of type 'Gtk.ReliefStyle' + To be added: an object of type 'Gtk.ReliefStyle' + To be added + + + + + Property + + System.String + + + + + + To be added + To be added: an object of type 'string' + To be added: an object of type 'string' + To be added + + + + + Event + + + + To be added + To be added + + + + + Event + + + + To be added + To be added + + + + + Event + + + + To be added + To be added + + + + + Event + + + + To be added + To be added + + + + + Event + + + + To be added + To be added + + + + + Event + + + + To be added + To be added + + + + + Method + + System.UInt32 + + + + To be added + To be added: an object of type 'uint' + To be added + + + + + Method + + Gtk.Button + + + + + + To be added + To be added: an object of type 'string' + To be added: an object of type 'Gtk.Button' + To be added + + + + + Method + + Gtk.Button + + + + + + To be added + To be added: an object of type 'string' + To be added: an object of type 'Gtk.Button' + To be added + + + + + Method + + System.Void + + + + To be added + To be added + + + + + Method + + System.Void + + + + To be added + To be added + + + + + Method + + System.Void + + + + To be added + To be added + + + + + Method + + System.Void + + + + To be added + To be added + + + + + Method + + System.Void + + + + To be added + To be added + + + + + Method + + System.Void + + + + To be added To be added - + + Constructor + + + + + + To be added + To be added: an object of type 'GLib.Type' + To be added: an object of type 'Gtk.Button' + To be added + + + + Constructor - To be added - To be added: an object of type 'Gtk.ColorSelectionDialog' To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.ColorSelectionDialog+Button' + To be added: an object of type 'Gtk.Button' + To be added + + + + + Constructor + + + + To be added + To be added: an object of type 'Gtk.Button' + To be added + + + + + Constructor + + + + + + To be added + To be added: an object of type 'string' + To be added: an object of type 'Gtk.Button' To be added diff --git a/doc/en/Gtk/ColorSelectionButton.xml b/doc/en/Gtk/ColorSelectionButton.xml new file mode 100644 index 000000000..1b177673e --- /dev/null +++ b/doc/en/Gtk/ColorSelectionButton.xml @@ -0,0 +1,63 @@ + + + + gtk-sharp + + 0.0.0.0 + neutral + + + Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details. + + To be added + To be added + + + Gtk.Button + + + + Atk.Implementor + + + GLib.IWrapper + + + GLib.IWrapper + + + System.IDisposable + + + + + + + Constructor + + + + + + + To be added + To be added: an object of type 'Gtk.ColorSelectionDialog' + To be added: an object of type 'IntPtr' + To be added: an object of type 'Gtk.ColorSelectionDialog+ColorSelectionButton' + To be added + + + + + Property + + Gtk.ColorSelectionDialog + + + To be added + To be added: an object of type 'Gtk.ColorSelectionDialog' + To be added + + + + \ No newline at end of file diff --git a/doc/en/Gtk/Combo.xml b/doc/en/Gtk/Combo.xml index 1a5924549..cee868eb9 100644 --- a/doc/en/Gtk/Combo.xml +++ b/doc/en/Gtk/Combo.xml @@ -276,21 +276,6 @@ To be added - - - Method - - System.Void - - - - - - To be added - To be added: an object of type 'string' - To be added - - Constructor diff --git a/doc/en/Gtk/HScale.xml b/doc/en/Gtk/HScale.xml index 9f7a730c0..91b3d4302 100644 --- a/doc/en/Gtk/HScale.xml +++ b/doc/en/Gtk/HScale.xml @@ -8,7 +8,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A horizontal slider widget for selecting a value from a range. - The HScale widget allows the user to select a value with a horizontal slider.This widget and its model is manipulated using methods and properties in its super classes, and . + + The HScale widget allows the user to select a value with a horizontal slider. + This widget and its model is manipulated using methods and properties in its super classes, and . + Gtk.Scale @@ -65,10 +68,12 @@ - Creates a new horizontal slider based on the data in . + Creates a new horizontal slider based on the data in . The model to use for this HScale A new HScale - To create a horizontal slider without explicit use of a , use the alternative constructor. + + To create a horizontal slider without explicit use of a , use the alternative constructor. + @@ -81,12 +86,14 @@ - Creates a new horizontal slider without the need for an object. + Creates a new horizontal slider without the need for an object. The minimum value that is accepted by this HScale. The maximum value that is accepted by this HScale. The value to adjust the HScale by when 'sliding'. A new HScale. - Creates a new horizontal slider that lets the user input a number between (and including) and . Each adjustment of the slider changes the value by , which must be non-zero. + + Creates a new horizontal slider that lets the user input a number between (and including) and . Each adjustment of the slider changes the value by , which must be non-zero. + @@ -96,8 +103,8 @@ Internal constructor - - + + diff --git a/doc/en/Gtk/HandleBox.xml b/doc/en/Gtk/HandleBox.xml index 1c62fc665..500792dc5 100644 --- a/doc/en/Gtk/HandleBox.xml +++ b/doc/en/Gtk/HandleBox.xml @@ -8,10 +8,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. 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 . + + 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 @@ -68,7 +70,9 @@ The main way to create a HandleBox. A new HandleBox. - Creates a new HandleBox, with the set to the . + + Creates a new HandleBox, with the set to the . + @@ -96,7 +100,9 @@ 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. + + 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. + @@ -109,10 +115,10 @@ - Manage the appearance of the surrounding the child widget. + 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. - + @@ -128,7 +134,10 @@ 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. + + 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. + @@ -141,10 +150,10 @@ - Manage the appearance of the surrounding the child widget. + 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. - + @@ -154,7 +163,7 @@ This event is fired when the contents of the HandleBox are reattached to the main window. - + @@ -164,7 +173,7 @@ This event is fired when the contents of the handlebox are detached from the main window. - + diff --git a/doc/en/Gtk/NotebookPage.xml b/doc/en/Gtk/NotebookPage.xml index 6a6345b2e..d536bf306 100644 --- a/doc/en/Gtk/NotebookPage.xml +++ b/doc/en/Gtk/NotebookPage.xml @@ -47,12 +47,12 @@ widget. -1 if the widget is not found in the Notebook. - + Returns the number of the NotebookPage containing a given widget in a given Notebook or -1 if the widget is not found. - + @@ -78,10 +78,9 @@ To be added - Creates a new instance of + Creates a new instance of - + This is a constructor used by derivative types of . This is not typically used by C# code. diff --git a/doc/en/Gtk/PositionType.xml b/doc/en/Gtk/PositionType.xml index cfa77a8dc..88987368a 100644 --- a/doc/en/Gtk/PositionType.xml +++ b/doc/en/Gtk/PositionType.xml @@ -8,7 +8,9 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. 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 . + + 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 @@ -35,7 +37,7 @@ The relevant item should be placed on the left. - + @@ -47,7 +49,7 @@ The relevant item should be placed on the right. - + @@ -59,7 +61,7 @@ The relevant item should be placed at the top. - + @@ -71,7 +73,7 @@ The relevant item should be placed at the bottom. - + diff --git a/doc/en/Gtk/Range.xml b/doc/en/Gtk/Range.xml index 080497d8a..5fd652586 100644 --- a/doc/en/Gtk/Range.xml +++ b/doc/en/Gtk/Range.xml @@ -7,8 +7,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Base class for widgets that visualize an . - This class provides helper methods and properties for manipulating concrete widgets like and . + Base class for widgets that visualize an . + + This class provides helper methods and properties for manipulating concrete widgets like and . + Gtk.Widget @@ -43,7 +45,9 @@ Sets the step and page sizes for this range. Value difference for step movements, (see below). Value difference for page movements, (see below). - The size is used when the user clicks the arrows or moves with arrow keys. The size is used for example when moving via Page Up or Page Down keys. + + The size is used when the user clicks the arrows or moves with arrow keys. The size is used for example when moving via Page Up or Page Down keys. + @@ -60,7 +64,7 @@ Sets the limits of this range. The minimum acceptable value for this range. The maximum acceptable value for this range. - + @@ -98,8 +102,8 @@ Internal constructor - - + + @@ -127,7 +131,7 @@ Manage the value of this range. The new value for this range. The current value of this range. - + @@ -141,9 +145,11 @@ Manage whether the control of this range is manipulated in the opposite direction. - Set to to invert the controls. + Set to to invert the controls. Whether visual control of the range is currently inverted. - Setting this to causes a widget to move from right to left, instead of left to right. + + Setting this to causes a widget to move from right to left, instead of left to right. + @@ -159,7 +165,7 @@ Manage how often the value label is updated. A new update policy. The current update policy. - + @@ -173,9 +179,9 @@ Manipulate the underlying model of this range. - Sets a new object to model this range. - The current underlying this range. - + Sets a new object to model this range. + The current underlying this range. + @@ -195,7 +201,9 @@ Fired when the value in this range changes. - Connect to this event with a standard to find out when the value changes. + + Connect to this event with a standard to find out when the value changes. + diff --git a/doc/en/Gtk/Scale.xml b/doc/en/Gtk/Scale.xml index 24496a211..3f71e1602 100644 --- a/doc/en/Gtk/Scale.xml +++ b/doc/en/Gtk/Scale.xml @@ -7,8 +7,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - A base class for the concrete slider widgets; and . - A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, . To set the value of a scale, you would normally use the property. To detect changes to the value, connect an event handler to the event. + A base class for the concrete slider widgets; and . + + A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, . To set the value of a scale, you would normally use the property. To detect changes to the value, connect an event handler to the event. + Gtk.Range @@ -64,8 +66,8 @@ Internal constructor - - + + @@ -93,7 +95,9 @@ Manage the position of the value, relative to the slider. The position to place the value Where the value is currently being drawn. - Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the property. + + Note: This property is only meaningful is a value is being drawn. To ensure a value is drawn, use the property. + @@ -107,9 +111,12 @@ Manage whether a label is displayed to show the current value. - to display the value, otherwise. + + to display the value, otherwise. Whether the value is currently being displayed. - Use the property to alter the position of displayed value. + + Use the property to alter the position of displayed value. + @@ -125,7 +132,7 @@ Manage the number of decimal places for this slider. The number of decimal places to display. The number of decimal places currently being displayed. - + @@ -135,7 +142,9 @@ Allows the format of the displayed value to be altered. - Note: The signature of this event handler is currently incorrect. + + Note: The signature of this event handler is currently incorrect. + diff --git a/doc/en/Gtk/Table.xml b/doc/en/Gtk/Table.xml index 222b3cb5d..5c6eb14de 100644 --- a/doc/en/Gtk/Table.xml +++ b/doc/en/Gtk/Table.xml @@ -8,11 +8,13 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. Pack widgets in grid/table patterns. - The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically. - Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the method. Widgets are packed into the table with methods. - The layout of a table can be altered by setting the spacing between rows and columns. This is done with the and properties, respectively. The spacing of individual cells can be adjusted with . - The following shows how to create a table with three widgets: - + + The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically. + Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the method. Widgets are packed into the table with methods. + The layout of a table can be altered by setting the spacing between rows and columns. This is done with the and properties, respectively. The spacing of individual cells can be adjusted with . + The following shows how to create a table with three widgets: + + public Widget MakeTableTester() { // Create a table with 2 rows and 1 column @@ -28,8 +30,8 @@ public Widget MakeTableTester() tableLayout.ShowAll(); return tableLayout; } - - + + @@ -64,8 +66,10 @@ public Widget MakeTableTester() Sets the spacing around a specified column. A zero-indexed column number to adjust the spacing of. - The number of pixels on each side of the . - To adjust the spacing between all columns, use the property. + The number of pixels on each side of the . + + To adjust the spacing between all columns, use the property. + @@ -80,8 +84,8 @@ public Widget MakeTableTester() The spacing currently set for a given column. A zero-indexed column number to retrieve spacing information from. - The number of pixels of spacing assigned to the specified . - + The number of pixels of spacing assigned to the specified . + @@ -95,10 +99,10 @@ public Widget MakeTableTester() - Resizes the table so that the specified number of and are available for widget packing. + Resizes the table so that the specified number of and are available for widget packing. The new number of rows this table should allow. The new number of columns this table should allow. - + @@ -120,17 +124,18 @@ public Widget MakeTableTester() Packs a widget into the table. - The to add. - The column number to attach the left side of to. - The column number to attach the right side of to. - The row number to attach the top of to. - The row number to attach the bottom of to. - The horizontal packing options for this . - The vertical packing options for this . - The number of pixels of padding to add to the left and right of . - The number of pixels of padding to add to the top and bottom of . - You can pack widgets into the Table using default packing and padding with the convenience method. - Child widgets can span as many table cells as they wish, allowing the programmer to create complex grids of Widgets. + The to add. + The column number to attach the left side of to. + The column number to attach the right side of to. + The row number to attach the top of to. + The row number to attach the bottom of to. + The horizontal packing options for this . + The vertical packing options for this . + The number of pixels of padding to add to the left and right of . + The number of pixels of padding to add to the top and bottom of . + + You can pack widgets into the Table using default packing and padding with the convenience method. + Child widgets can span as many table cells as they wish, allowing the programmer to create complex grids of Widgets. @@ -149,12 +154,14 @@ public Widget MakeTableTester() Packs a widget into the table with default packing options. - The to add. - The column number to attach the left side of to. - The column number to attach the right side of to. - The row number to attach the top of to. - The row number to attach the bottom of to. - To pack widgets into the table with more control over size and padding, use the alternative method. + The to add. + The column number to attach the left side of to. + The column number to attach the right side of to. + The row number to attach the top of to. + The row number to attach the bottom of to. + + To pack widgets into the table with more control over size and padding, use the alternative method. + @@ -200,7 +207,9 @@ public Widget MakeTableTester() The number of columns in this table. Whether all table cells are forced to be the same size. A new Table. - The size of the table can be altered after its creation using the method. + + The size of the table can be altered after its creation using the method. + @@ -210,8 +219,8 @@ public Widget MakeTableTester() Internal constructor - - + + @@ -236,10 +245,10 @@ public Widget MakeTableTester() - Sets the space between every column equal to . + Sets the space between every column equal to . The number of pixels to place between every column. - - + + @@ -251,7 +260,7 @@ public Widget MakeTableTester() Retrieve the spacing that gets placed between newly added rows by default. Spacing between rows that will be added, in pixels. - + @@ -311,7 +320,7 @@ public Widget MakeTableTester() Manage the number of columns in this Table. The number of columns that this table should have. The number of columns this table currently has. - + @@ -325,9 +334,11 @@ public Widget MakeTableTester() Manage whether all cells must be of equal size. - to set all cells to an equal size, otherwise. - if all cells are currently equally sized, otherwise. - + + to set all cells to an equal size, otherwise. + + if all cells are currently equally sized, otherwise. + @@ -359,7 +370,7 @@ public Widget MakeTableTester() Manage the number of rows in this Table. The number of rows that this table should have. The number of rows this table currently has. - + diff --git a/doc/en/Gtk/VScale.xml b/doc/en/Gtk/VScale.xml index b88e74358..37faab9ab 100644 --- a/doc/en/Gtk/VScale.xml +++ b/doc/en/Gtk/VScale.xml @@ -8,8 +8,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A vertical slider widget for selecting a value from a range. - The VScale widget allows the user to select a value with a vertical slider.This widget and its model is manipulated using methods and properties in its super classes, and . - + + The VScale widget allows the user to select a value with a vertical slider. + This widget and its model is manipulated using methods and properties in its super classes, and . + + Gtk.Scale @@ -65,10 +68,12 @@ - Creates a new vertical slider based on the data in . + Creates a new vertical slider based on the data in . The model to use for this VScale A new VScale - To create a vertical slider without explicit use of a , use the alternative constructor. + + To create a vertical slider without explicit use of a , use the alternative constructor. + @@ -81,12 +86,14 @@ - Creates a new vertical slider without the need for an object. + Creates a new vertical slider without the need for an object. The minimum value that is accepted by this VScale. The maximum value that is accepted by this VScale. The value to adjust the VScale by when 'sliding'. A new VScale. - Creates a new vertical slider that lets the user input a number between (and including) and . Each adjustment of the slider changes the value by , which must be non-zero. + + Creates a new vertical slider that lets the user input a number between (and including) and . Each adjustment of the slider changes the value by , which must be non-zero. + @@ -96,8 +103,8 @@ Internal constructor - - + + diff --git a/doc/en/Gtk/Widget.xml b/doc/en/Gtk/Widget.xml index fbec05133..c4c4ac3db 100644 --- a/doc/en/Gtk/Widget.xml +++ b/doc/en/Gtk/Widget.xml @@ -9,11 +9,11 @@ GtkWidget introduces style properties - these are basically object properties that are stored in the style object associated to the widget. - + Style properties are set in resource files. This mechanism is used for configuring such things as the location of the scrollbar arrows through the theme, giving theme authors more control over the look of applications without the need to write a theme engine in C. - - Use , or to obtain the value of a style property. + + Use , or to obtain the value of a style property. @@ -44,10 +44,10 @@ - Makes all newly-created as composite children until the corresponding call. + Makes all newly-created as composite children until the corresponding call. - - A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK (but see vs. ), but e.g. GUI builders might want to treat them in a different way. + + A composite child is a child that's an implementation detail of the container it's inside and should not be visible to people using the container. Composite children aren't treated differently by GTK (but see vs. ), but e.g. GUI builders might want to treat them in a different way. @@ -62,11 +62,11 @@ - Pushes onto a global stack of colormaps. - Colormap that is pushed by . + Pushes onto a global stack of colormaps. + Colormap that is pushed by . - - Pushes onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove with . There's little reason to use this function. + + Pushes onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove with . There's little reason to use this function. @@ -79,10 +79,10 @@ - Removes a colormap pushed with . + Removes a colormap pushed with . - - Removes a colormap pushed with . + + Removes a colormap pushed with . @@ -95,10 +95,10 @@ - Cancels the effect of a previous call to . + Cancels the effect of a previous call to . - - Cancels the effect of a previous call to . + + Cancels the effect of a previous call to . @@ -111,11 +111,11 @@ - Gets a reference to an object's implementation. - An . + Gets a reference to an object's implementation. + An . - - Gets a reference to an object's implementation. + + Gets a reference to an object's implementation. @@ -128,10 +128,10 @@ - Shows a . + Shows a . - - If the is an unmapped toplevel widget, a that has not yet been shown, enter the main loop and wait for the window to actually be mapped. Be careful, because the main loop is running, anything can happen during this function. + + If the is an unmapped toplevel widget, a that has not yet been shown, enter the main loop and wait for the window to actually be mapped. Be careful, because the main loop is running, anything can happen during this function. @@ -144,10 +144,10 @@ - Causes to become the default . + Causes to become the default . - - The default is activated when the user presses Enter in a window. Default widgets must be activatable, that is, should affect them. The must have the flag set; typically you have to set this flag yourself by calling . + + The default is activated when the user presses Enter in a window. Default widgets must be activatable, that is, should affect them. The must have the flag set; typically you have to set this flag yourself by calling . @@ -162,11 +162,11 @@ - Moves a from one to another, handling reference count issues to avoid destroying the widget. - A to move the widget into. + Moves a from one to another, handling reference count issues to avoid destroying the widget. + A to move the widget into. - - Moves a widget from one to another, handling reference count issues to avoid destroying the widget. + + Moves a widget from one to another, handling reference count issues to avoid destroying the widget. @@ -182,13 +182,14 @@ - Computes the intersection of a 's area and . + Computes the intersection of a 's area and . A rectangle. - A rectangle to store intersection of and . - if there was an intersection. + A rectangle to store intersection of and . + + if there was an intersection. - - Computes the intersection of a 's area and , storing the intersection in , and returns if there was an intersection. may be if you're only interested in whether there was an intersection. + + Computes the intersection of a 's area and , storing the intersection in , and returns if there was an intersection. may be if you're only interested in whether there was an intersection. @@ -203,18 +204,19 @@ - Move focus to particular . + Move focus to particular . Direction of focus movement. - if focus ended up inside widget. + + if focus ended up inside widget. - - This function is used by custom widget implementations; if you're writing an app, you'd use to move the focus to a particular widget, and to change the focus tab order. So you may want to investigate those functions instead. + + This function is used by custom widget implementations; if you're writing an app, you'd use to move the focus to a particular widget, and to change the focus tab order. So you may want to investigate those functions instead. - - is called by containers as the user moves around the window using keyboard shortcuts. indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). invokes the "focus" signal on ; widgets override the default handler for this signal in order to implement appropriate focus behavior. + + is called by containers as the user moves around the window using keyboard shortcuts. indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). invokes the "focus" signal on ; widgets override the default handler for this signal in order to implement appropriate focus behavior. - - The "focus" default handler for a widget should return if moving in direction left the focus on a focusable location inside that widget, and if moving in direction moved the focus outside the widget. If returning , widgets normally call to place the focus accordingly; if returning , they don't modify the current focus location. + + The "focus" default handler for a widget should return if moving in direction left the focus on a focusable location inside that widget, and if moving in direction moved the focus outside the widget. If returning , widgets normally call to place the focus accordingly; if returning , they don't modify the current focus location. @@ -227,9 +229,9 @@ - Should be called by implementations of the remove method on , to dissociate a child from the container. + Should be called by implementations of the remove method on , to dissociate a child from the container. - + This function is only for use in widget implementations. @@ -243,13 +245,13 @@ - Creates the GDK (windowing system) resources associated with a . + Creates the GDK (windowing system) resources associated with a . - - For example, ->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all the widget's parent widgets to be realized; calling realizes the widget's parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen. + + For example, ->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically. Realizing a widget requires all the widget's parent widgets to be realized; calling realizes the widget's parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen. - - This function is primarily used in widget implementations, and isn't very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as . Or simply to the realize signal. + + This function is primarily used in widget implementations, and isn't very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as . Or simply to the realize signal. @@ -267,19 +269,19 @@ - Invalidates the rectangular area of a . + Invalidates the rectangular area of a . y coordinate of upper-left corner of rectangle to redraw. x coordinate of upper-left corner of rectangle to redraw. Width of region to draw. Height of region to draw. - - Invalidates the rectangular area of widget defined by , , and by calling on the widget's window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive events for the union of all regions that have been invalidated. + + Invalidates the rectangular area of widget defined by , , and by calling on the widget's window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive events for the union of all regions that have been invalidated. - - Normally you would only use this function in widget implementations. You might also use it, or directly, to schedule a redraw of a or some portion thereof. Frequently you can just call or instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children. + + Normally you would only use this function in widget implementations. You might also use it, or directly, to schedule a redraw of a or some portion thereof. Frequently you can just call or instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children. - + The advantage of adding to the invalidated region compared to simply drawing immediately is efficiency; using an invalid region ensures that you only have to redraw one time. @@ -296,12 +298,12 @@ - Sets the foreground for a in a particular . + Sets the foreground for a in a particular . The state for which to set the background color. - The color to assign (does not need to be allocated), or to undo the effect of previous calls to of . + The color to assign (does not need to be allocated), or to undo the effect of previous calls to of . - - All other style values are left untouched. See also . + + All other style values are left untouched. See also . @@ -318,17 +320,17 @@ - A convenience function that uses the theme engine and RC file settings for to look up and render it to a . + A convenience function that uses the theme engine and RC file settings for to look up and render it to a . A stock ID. A stock size. Render detail to pass to theme engine. - A new , or if the wasn't known. + A new , or if the wasn't known. - - The should be a stock icon ID such as or . should be a size such as . should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code. + + The should be a stock icon ID such as or . should be a size such as . should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code. - - The pixels in the returned are shared with the rest of the application and should not be modified. The should be freed after use with . + + The pixels in the returned are shared with the rest of the application and should not be modified. The should be freed after use with . @@ -344,12 +346,12 @@ - Gets the of a style property of . + Gets the of a style property of . The name of a style property. Location to return the property value. - - Gets the of a style property of . + + Gets the of a style property of . @@ -365,12 +367,12 @@ - Gets the values of a multiple style properties of . + Gets the values of a multiple style properties of . The name of the first property to get. - A va_list of pairs of property names and locations to return the property values, starting with the location for . + A va_list of pairs of property names and locations to return the property values, starting with the location for . - - Gets the values of a multiple style properties of . Used primarily by language bindings. + + Gets the values of a multiple style properties of . Used primarily by language bindings. @@ -383,10 +385,10 @@ - Recursively shows a , and any child (if the widget is a container). + Recursively shows a , and any child (if the widget is a container). - - Recursively shows a , and any child (if the widget is a container). + + Recursively shows a , and any child (if the widget is a container). @@ -402,12 +404,12 @@ - Sets the text for a in a particular state. + Sets the text for a in a particular state. The state for which to set the text color. - The color to assign (does not need to be allocated), or to undo the effect of previous calls to of . + The color to assign (does not need to be allocated), or to undo the effect of previous calls to of . - - All other style values are left untouched. The text color is the foreground color used along with the base color (see ) for widgets such as and . See also . + + All other style values are left untouched. The text color is the foreground color used along with the base color (see ) for widgets such as and . See also . @@ -420,11 +422,11 @@ - Creates a new with the appropriate colormap, font description, and base direction for drawing text for . - The new . + Creates a new with the appropriate colormap, font description, and base direction for drawing text for . + The new . - - See also . + + See also . @@ -437,11 +439,11 @@ - Utility function; intended to be connected to the signal on a . - Returns . + Utility function; intended to be connected to the signal on a . + Returns . - - The function calls on its argument, then returns . If connected to , the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when is received. + + The function calls on its argument, then returns . If connected to , the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when is received. @@ -456,11 +458,11 @@ - Obtains ->. - A to be filled in. + Obtains ->. + A to be filled in. - - Obtains ->, unless someone has forced a particular geometry on the widget, in which case it returns that geometry instead of the widget's . This function differs from in that it retrieves the last size request value from ->, while the method computes the size request and fill in ->, and only then returns ->. + + Obtains ->, unless someone has forced a particular geometry on the widget, in which case it returns that geometry instead of the widget's . This function differs from in that it retrieves the last size request value from ->, while the method computes the size request and fill in ->, and only then returns ->. @@ -476,12 +478,12 @@ - Obtains the location of the mouse pointer in coordinates. - Return location for the X coordinate, or . - Return location for the Y coordinate, or . + Obtains the location of the mouse pointer in coordinates. + Return location for the X coordinate, or . + Return location for the Y coordinate, or . - - Widget coordinates are a bit odd; for historical reasons, they are defined as ->window coordinates for widgets that are not widgets, and are relative to ->allocation.x, ->allocation.y for widgets that are widgets. + + Widget coordinates are a bit odd; for historical reasons, they are defined as ->window coordinates for widgets that are not widgets, and are relative to ->allocation.x, ->allocation.y for widgets that are widgets. @@ -494,10 +496,10 @@ - Causes a to have the keyboard focus for the it's inside. + Causes a to have the keyboard focus for the it's inside. - - The must be a focusable widget, such as a ; something like won't work (More precisely, it must have the flag set). + + The must be a focusable widget, such as a ; something like won't work (More precisely, it must have the flag set). @@ -510,10 +512,10 @@ - Equivalent to calling for the entire area of a . + Equivalent to calling for the entire area of a . - - Equivalent to calling for the entire area of a . + + Equivalent to calling for the entire area of a . @@ -526,11 +528,12 @@ - Determines if the is the focus widget within its toplevel. - if the widget is the focus widget. + Determines if the is the focus widget within its toplevel. + + if the widget is the focus widget. - - This does not mean that the flag is necessarily set; will only be set if the toplevel widget additionally has the global input focus. + + This does not mean that the flag is necessarily set; will only be set if the toplevel widget additionally has the global input focus. @@ -546,15 +549,15 @@ - Given an accelerator group, , and an accelerator path, , sets up an accelerator in so whenever the key binding that is defined for is pressed, will be activated. + Given an accelerator group, , and an accelerator path, , sets up an accelerator in so whenever the key binding that is defined for is pressed, will be activated. Path used to look up the the accelerator. - A . + A . - - This removes any accelerators (for any accelerator group) installed by previous calls to . Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. + + This removes any accelerators (for any accelerator group) installed by previous calls to . Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. - - This function is a low level function that would most likely be used by a menu creation system like . If you use , setting up accelerator paths will be done automatically. + + This function is a low level function that would most likely be used by a menu creation system like . If you use , setting up accelerator paths will be done automatically. @@ -573,18 +576,18 @@ - Installs an accelerator for this in that causes to be emitted if the accelerator is activated. + Installs an accelerator for this in that causes to be emitted if the accelerator is activated. Widget signal to emit on accelerator activation. Accel group for this widget, added to its toplevel. GDK keyval of the accelerator. Modifier key combination of the accelerator. Flag accelerators. - - The needs to be added to the widget's toplevel via , and the signal must be of type G_RUN_ACTION. Accelerators added through this function are not user changeable during runtime. + + The needs to be added to the widget's toplevel via , and the signal must be of type G_RUN_ACTION. Accelerators added through this function are not user changeable during runtime. - - Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use instead. + + Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use instead. @@ -597,12 +600,12 @@ - Flags a to be displayed. + Flags a to be displayed. - - Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call on the container, instead of individually showing the widgets. + + Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call on the container, instead of individually showing the widgets. - + Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen. And that when a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped. @@ -619,13 +622,13 @@ - For that support scrolling, sets the scroll adjustments. - An adjustment for horizontal scrolling, or . - An adjustment for vertical scrolling, or . - Returns if the widget supports scrolling. + For that support scrolling, sets the scroll adjustments. + An adjustment for horizontal scrolling, or . + An adjustment for vertical scrolling, or . + Returns if the widget supports scrolling. - - For that don't support scrolling, does nothing and returns . that don't support scrolling can be scrolled by placing them in a , which does support scrolling. + + For that don't support scrolling, does nothing and returns . that don't support scrolling can be scrolled by placing them in a , which does support scrolling. @@ -640,12 +643,12 @@ - Creates a new with the appropriate colormap, font description, and base direction for drawing text for . - text to set on the layout (can be ). - The new . + Creates a new with the appropriate colormap, font description, and base direction for drawing text for . + text to set on the layout (can be ). + The new . - - If you keep a created in this way around, in order notify the layout of changes to the base direction or font of this widget, you must call in response to the and signals for the widget. + + If you keep a created in this way around, in order notify the layout of changes to the base direction or font of this widget, you must call in response to the and signals for the widget. @@ -658,9 +661,9 @@ - Reset the styles of and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings. + Reset the styles of and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings. - + This function is not useful for applications. @@ -676,14 +679,14 @@ - Obtains the preferred size of a . - A to be filled in. + Obtains the preferred size of a . + A to be filled in. - - The container uses this information to arrange its child widgets and decide what size allocations to give them with . You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind. + + The container uses this information to arrange its child widgets and decide what size allocations to give them with . You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind. - - This function is typically used when implementing a subclass. Also remember that the size request is not necessarily the size a widget will actually be allocated. + + This function is typically used when implementing a subclass. Also remember that the size request is not necessarily the size a widget will actually be allocated. @@ -702,15 +705,15 @@ - Translate coordinates relative to 's allocation to coordinates relative to 's allocations. - A . + Translate coordinates relative to 's allocation to coordinates relative to 's allocations. + A . X position relative to source widget. Y position relative to source widget. - Location to store X position relative to . - Location to store Y position relative to . - Returns if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in and . Otherwise . + Location to store X position relative to . + Location to store Y position relative to . + Returns if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in and . Otherwise . - + In order to perform this operation, both widgets must be realized, and must share a common toplevel. @@ -724,11 +727,11 @@ - For that can be "activated" (buttons, menu items, etc.) this function activates them. - Returns if the widget was activatable. + For that can be "activated" (buttons, menu items, etc.) this function activates them. + Returns if the widget was activatable. - - Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the isn't activatable, the function returns . + + Activation is what happens when you press Enter on a widget during key navigation; clicking a button, selecting a menu item, etc. If the isn't activatable, the function returns . @@ -744,12 +747,12 @@ - Sets the background color for a in a particular state. + Sets the background color for a in a particular state. The state for which to set the background color. - The color to assign (does not need to be allocated), or to undo the effect of previous calls of . + The color to assign (does not need to be allocated), or to undo the effect of previous calls of . - - All other style values are left untouched. See also . + + All other style values are left untouched. See also . @@ -764,12 +767,12 @@ - Rarely-used function. This function is used to emit the event signals on a . - A . - Return from the event signal emission ( if the event was handled) + Rarely-used function. This function is used to emit the event signals on a . + A . + Return from the event signal emission ( if the event was handled) - - If you want to synthesize an event though, don't use this function; instead, use to invalidate a region of the window. + + If you want to synthesize an event though, don't use this function; instead, use to invalidate a region of the window. @@ -782,10 +785,10 @@ - Reverses the effects of , causing the to be hidden (invisible to the user). + Reverses the effects of , causing the to be hidden (invisible to the user). - - Reverses the effects of , causing the widget to be hidden (invisible to the user). + + Reverses the effects of , causing the widget to be hidden (invisible to the user). @@ -801,12 +804,12 @@ - Sets the base color for a in a particular state. + Sets the base color for a in a particular state. The state for which to set the base color. - The color to assign (does not need to be allocated), or to undo the effect of previous calls to of . + The color to assign (does not need to be allocated), or to undo the effect of previous calls to of . - - All other style values are left untouched. The base color is the background color used along with the text color (see ) for widgets such as and . See also . + + All other style values are left untouched. The base color is the background color used along with the text color (see ) for widgets such as and . See also . @@ -821,12 +824,12 @@ - Gets the first ancestor of with type . + Gets the first ancestor of with type . Ancestor type. - The ancestor widget, or if not found + The ancestor widget, or if not found - - For example, (widget, GTK_TYPE_BOX) gets the first that's an ancestor of . No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel in the docs for . Note that unlike , considers to be an ancestor of itself. + + For example, (widget, GTK_TYPE_BOX) gets the first that's an ancestor of . No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel in the docs for . Note that unlike , considers to be an ancestor of itself. @@ -839,9 +842,9 @@ - Recursively resets the shape on and its descendants. + Recursively resets the shape on and its descendants. - + Recursively resets the shape on this widget and its descendants. @@ -857,14 +860,14 @@ - Modifies style values on the . - The holding the style modifications. + Modifies style values on the . + The holding the style modifications. - - Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a is explicitely set on the using . The structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged. + + Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a is explicitely set on the using . The structure is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged. - - Note that modifications made with this function are not cumulative with previous calls to or with such functions as . If you wish to retain previous values, you must first call , make your modifications to the returned , then call with that . On the other hand, if you first call , subsequent calls to such functions will have a cumulative effect with the initial modifications. + + Note that modifications made with this function are not cumulative with previous calls to or with such functions as . If you wish to retain previous values, you must first call , make your modifications to the returned , then call with that . On the other hand, if you first call , subsequent calls to such functions will have a cumulative effect with the initial modifications. @@ -880,14 +883,14 @@ - Sets the minimum size of a ; that is, the 's size request will be by . - Width should request, or -1 to unset. - Weight should request, or -1 to unset. + Sets the minimum size of a ; that is, the 's size request will be by . + Width should request, or -1 to unset. + Weight should request, or -1 to unset. - - You can use this function to force a widget to be either larger or smaller than it normally would be. In most cases, is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, can be a useful function as well. + + You can use this function to force a widget to be either larger or smaller than it normally would be. In most cases, is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, can be a useful function as well. - + Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct. The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested. @@ -920,12 +923,12 @@ - Gets the size request that was explicitly set for the using . - Return location for width, or . - Return location for height, or . + Gets the size request that was explicitly set for the using . + Return location for width, or . + Return location for height, or . - - A value of -1 stored in or indicates that that dimension has not been set explicitly and the natural requisition of the will be used intead. See . To get the size a will actually use, call instead of this function. + + A value of -1 stored in or indicates that that dimension has not been set explicitly and the natural requisition of the will be used intead. See . To get the size a will actually use, call instead of this function. @@ -942,14 +945,14 @@ - Removes an accelerator from , previously installed with . + Removes an accelerator from , previously installed with . Accel group for this widget. GDK keyval of the accelerator. Modifier key combination of the accelerator. Returns whether an accelerator was installed and could be removed. - - Removes an accelerator from , previously installed with . + + Removes an accelerator from , previously installed with . @@ -966,16 +969,16 @@ - Obtains the full path to . - Location to store length of the path, or . - Location to store allocated path string, or . - Location to store allocated reverse path string, or . + Obtains the full path to . + Location to store length of the path, or . + Location to store allocated path string, or . + Location to store allocated reverse path string, or . - - The path is simply the name of a and all its parents in the container hierarchy, separated by periods. The name of a comes from . Paths are used to apply styles to a in gtkrc configuration files. Widget names are the type of the by default (e.g. "") or can be set to an application-specific value with . + + The path is simply the name of a and all its parents in the container hierarchy, separated by periods. The name of a comes from . Paths are used to apply styles to a in gtkrc configuration files. Widget names are the type of the by default (e.g. "") or can be set to an application-specific value with . - - By setting the name of a , you allow users or theme authors to apply styles to that specific in their gtkrc file. fills in the path in reverse order, i.e. starting with 's name instead of starting with the name of 's outermost ancestor. + + By setting the name of a , you allow users or theme authors to apply styles to that specific in their gtkrc file. fills in the path in reverse order, i.e. starting with 's name instead of starting with the name of 's outermost ancestor. @@ -988,9 +991,9 @@ - Causes a to be unmapped if it's currently mapped. + Causes a to be unmapped if it's currently mapped. - + This function is only for use in widget implementations. @@ -1004,9 +1007,9 @@ - Causes a to be mapped if it isn't already. + Causes a to be mapped if it isn't already. - + This function is only for use in widget implementations. @@ -1022,12 +1025,12 @@ - Computes the intersection of a 's area and , returning the intersection. - A , in the same coordinate system as ->allocation. That is, relative to ->window for widgets; relative to the parent window of ->window for widgets with their own window. - A newly allocated region holding the intersection of and . The coordinates of the return value are relative to ->window for widgets, and relative to the parent window of ->window for widgets with their own window. + Computes the intersection of a 's area and , returning the intersection. + A , in the same coordinate system as ->allocation. That is, relative to ->window for widgets; relative to the parent window of ->window for widgets with their own window. + A newly allocated region holding the intersection of and . The coordinates of the return value are relative to ->window for widgets, and relative to the parent window of ->window for widgets with their own window. - - The result may be empty, use to check. + + The result may be empty, use to check. @@ -1040,10 +1043,10 @@ - Flags a to have its size renegotiated; should be called when a for some reason has a new . + Flags a to have its size renegotiated; should be called when a for some reason has a new . - - This function is only for use in widget implementations. One example, when you change the text in a , it queues a resize to ensure there's enough space for the new text. + + This function is only for use in widget implementations. One example, when you change the text in a , it queues a resize to ensure there's enough space for the new text. @@ -1058,11 +1061,11 @@ - Sets the font to use for a . - The font description to use, or to undo the effect of previous calls to . + Sets the font to use for a . + The font description to use, or to undo the effect of previous calls to . - - All other style values are left untouched. See also . + + All other style values are left untouched. See also . @@ -1077,12 +1080,12 @@ - Very rarely-used function. This function is used to emit an signals on a . - A . - Return from the event signal emission ( if the event was handled). + Very rarely-used function. This function is used to emit an signals on a . + A . + Return from the event signal emission ( if the event was handled). - - This function is not normally used directly. The only time it is used is when propagating an to a child widget, and that is normally done using . If you want to force an area of a window to be redrawn, use or . To cause the redraw to be done immediately, follow that call with a call to . + + This function is not normally used directly. The only time it is used is when propagating an to a child widget, and that is normally done using . If you want to force an area of a window to be redrawn, use or . To cause the redraw to be done immediately, follow that call with a call to . @@ -1095,9 +1098,9 @@ - Causes a to be unrealized (frees all GDK resources associated with the widget). + Causes a to be unrealized (frees all GDK resources associated with the widget). - + This function is only useful in widget implementations. @@ -1111,10 +1114,10 @@ - Ensures that has a style (->style). + Ensures that has a style (->style). - - Not a very useful function; most of the time, if you want the style, the is realized, and realized widgets are guaranteed to have a style already. + + Not a very useful function; most of the time, if you want the style, the is realized, and realized widgets are guaranteed to have a style already. @@ -1129,12 +1132,12 @@ - Determines whether is somewhere inside , possibly with intermediate containers. - Another . - Returns if ancestor contains widget as a child, grandchild, great grandchild, etc. + Determines whether is somewhere inside , possibly with intermediate containers. + Another . + Returns if ancestor contains widget as a child, grandchild, great grandchild, etc. - - Determines whether is somewhere inside , possibly with intermediate containers. + + Determines whether is somewhere inside , possibly with intermediate containers. @@ -1149,11 +1152,11 @@ - Adds the events in the bitfield to the event mask for . - + Adds the events in the bitfield to the event mask for . + - - Adds the events in the bitfield to the event mask for . See for details. + + Adds the events in the bitfield to the event mask for . See for details. @@ -1166,10 +1169,10 @@ - Recursively hides a and any child . + Recursively hides a and any child . - - Recursively hides a and any child . + + Recursively hides a and any child . @@ -1182,10 +1185,10 @@ - Reverts the effect of a previous call to . + Reverts the effect of a previous call to . - - Reverts the effect of a previous call to . This causes all queued signals on to be emitted. + + Reverts the effect of a previous call to . This causes all queued signals on to be emitted. @@ -1202,13 +1205,13 @@ - Sets a shape for this 's GDK window. This allows for transparent windows etc., see for more information. - Shape to be added, or to remove an existing shape. + Sets a shape for this 's GDK window. This allows for transparent windows etc., see for more information. + Shape to be added, or to remove an existing shape. X position of shape mask with respect to the window. Y position of shape mask with respect to the window. - - Sets a shape for this 's GDK window. This allows for transparent windows etc., see for more information. + + Sets a shape for this 's GDK window. This allows for transparent windows etc., see for more information. @@ -1223,11 +1226,11 @@ - Emits a signal for the child property on . + Emits a signal for the child property on . The name of a child property installed on the class of widget's parent. - - Emits a signal for the child property on . + + Emits a signal for the child property on . @@ -1244,13 +1247,13 @@ - Same as , but always uses the name of a 's type, never uses a custom name set with . - Location to store the length of the class path, or . - Location to store the class path as an allocated string, or . - Location to store the reverse class path as an allocated string, or . + Same as , but always uses the name of a 's type, never uses a custom name set with . + Location to store the length of the class path, or . + Location to store the class path as an allocated string, or . + Location to store the reverse class path as an allocated string, or . - - Same as , but always uses the name of a 's type, never uses a custom name set with . + + Same as , but always uses the name of a 's type, never uses a custom name set with . @@ -1263,13 +1266,13 @@ - Destroys a . + Destroys a . - - Equivalent to , except that you don't have to cast the to . When a is destroyed, it will break any references it holds to other objects. If the is inside a container, the will be removed from the container. If the widget is a toplevel (derived from ), it will be removed from the list of toplevels, and the reference GTK+ holds to it will be removed. + + Equivalent to , except that you don't have to cast the to . When a is destroyed, it will break any references it holds to other objects. If the is inside a container, the will be removed from the container. If the widget is a toplevel (derived from ), it will be removed from the list of toplevels, and the reference GTK+ holds to it will be removed. - - Removing a widget from its container or the list of toplevels results in the being finalized, unless you've added additional references to the with .In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well. + + Removing a widget from its container or the list of toplevels results in the being finalized, unless you've added additional references to the with .In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well. @@ -1282,10 +1285,10 @@ - Stops emission of signals on . + Stops emission of signals on . - - The signals are queued until is called on . + + The signals are queued until is called on . @@ -1300,11 +1303,11 @@ - This function is only used by subclasses, to assign a size and position to their child widgets. - A position and size to be allocated to . + This function is only used by subclasses, to assign a size and position to their child widgets. + A position and size to be allocated to . - - This fuction is only used by subclasses, to assign a size and position to their child widgets. + + This fuction is only used by subclasses, to assign a size and position to their child widgets. @@ -1344,7 +1347,7 @@ A coonstructor. - An instance of . + An instance of . @@ -1538,15 +1541,16 @@ - Sets whether a size allocation changes, the entire is queued for drawing. - the entire widget will be redrawn when it is allocated to a new size. only the new portion of the widget will be redrawn. - Returns because it is on by Default, but returns if you turn it off. + Sets whether a size allocation changes, the entire is queued for drawing. + + the entire widget will be redrawn when it is allocated to a new size. only the new portion of the widget will be redrawn. + Returns because it is on by Default, but returns if you turn it off. - - By default, this setting is and the entire is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance. + + By default, this setting is and the entire is redrawn on every size change. If your widget leaves the upper left are unchanged when made bigger, turning this setting on will improve performance. - - Note that for widgets setting this flag to turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a widget that does draw on ->window, you are responsible for invalidating both the old and new allocation of the when the widget is moved and responsible for invalidating regions newly when the increases size. + + Note that for widgets setting this flag to turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a widget that does draw on ->window, you are responsible for invalidating both the old and new allocation of the when the widget is moved and responsible for invalidating regions newly when the increases size. @@ -1562,13 +1566,14 @@ Use this function to turn off the double buffering. - is on by Default, if you want to turn off double buffering no use call for true because it is default - Returns because double buffering is on by Default, but returns if you turn it off. + + is on by Default, if you want to turn off double buffering no use call for true because it is default + Returns because double buffering is on by Default, but returns if you turn it off. - - Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that and are called automatically around events sent to the widget. diverts all drawing to a 's window to an offscreen buffer, and draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered. + + Widgets are double buffered by default, you can use this function to turn off the buffering. "Double buffered" simply means that and are called automatically around events sent to the widget. diverts all drawing to a 's window to an offscreen buffer, and draws the buffer to the screen. The result is that users see the window update in one smooth step, and don't see individual graphics primitives being rendered. - + In very simple terms, double buffered widgets don't flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing. @@ -2509,4 +2514,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/WidgetFlags.xml b/doc/en/Gtk/WidgetFlags.xml index ed568024d..2d4c22ea8 100644 --- a/doc/en/Gtk/WidgetFlags.xml +++ b/doc/en/Gtk/WidgetFlags.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Tells about certain properties of the . + Tells about certain properties of the . @@ -34,10 +34,10 @@ - Widgets without a real parent, as there are s and s have this flag set throughout their lifetime. + Widgets without a real parent, as there are s and s have this flag set throughout their lifetime. - - Toplevel widgets always contain their own . + + Toplevel widgets always contain their own . @@ -50,10 +50,10 @@ - Indicative for a that does not provide its own . + Indicative for a that does not provide its own . - - Visible action (e.g. drawing) is performed on the parent's . + + Visible action (e.g. drawing) is performed on the parent's . @@ -66,10 +66,10 @@ - Set by , unset by . + Set by , unset by . - - A realized has an associated . + + A realized has an associated . @@ -82,10 +82,10 @@ - Set by , unset by . + Set by , unset by . - - Only realized widgets can be mapped. It means that has been called on the widgets window(s). + + Only realized widgets can be mapped. It means that has been called on the widgets window(s). @@ -98,10 +98,10 @@ - Set by , unset by . Implies that a will be mapped as soon as its parent is mapped. + Set by , unset by . Implies that a will be mapped as soon as its parent is mapped. - - Implies that a will be mapped as soon as its parent is mapped. + + Implies that a will be mapped as soon as its parent is mapped. @@ -114,9 +114,9 @@ - Set and unset by . The sensitivity of a determines whether it will receive certain events (e.g. button or key presses). + Set and unset by . The sensitivity of a determines whether it will receive certain events (e.g. button or key presses). - + One premise for the widgets sensitivity is to have this flag set. @@ -130,10 +130,10 @@ - Set and unset by operations on the parents of the . + Set and unset by operations on the parents of the . - - This is the second premise for the widgets sensitivity. Once it has and set, its state is effectively sensitive. + + This is the second premise for the widgets sensitivity. Once it has and set, its state is effectively sensitive. @@ -146,10 +146,10 @@ - Determines whether a is able to handle focus grabs. + Determines whether a is able to handle focus grabs. - - Determines whether a is able to handle focus grabs. + + Determines whether a is able to handle focus grabs. @@ -162,9 +162,9 @@ - Set by for widgets that also have set. + Set by for widgets that also have set. - + The flag will be unset once another widget grabs the focus. @@ -178,10 +178,10 @@ - The is allowed to receive the default action via . + The is allowed to receive the default action via . - - The is allowed to receive the default action via . + + The is allowed to receive the default action via . @@ -194,10 +194,10 @@ - The currently is receiving the default action. + The currently is receiving the default action. - - The currently is receiving the default action. + + The currently is receiving the default action. @@ -210,9 +210,9 @@ - Set by gtk_grab_add(), unset by gtk_grab_remove(). + Set by gtk_grab_add(), unset by gtk_grab_remove(). - + It means that the widget is in the grab_widgets stack, and will be the preferred one for receiving events other than ones of cosmetic value. @@ -228,8 +228,8 @@ Indicates that the widgets style has been looked up through the rc mechanism. - - It does not imply that the actually had a style defined through the rc mechanism. + + It does not imply that the actually had a style defined through the rc mechanism. @@ -242,10 +242,10 @@ - Indicates that the is a composite child of its parent. + Indicates that the is a composite child of its parent. - - See , . + + See , . @@ -270,9 +270,9 @@ - Set and unset by . + Set and unset by . - + Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff. @@ -286,10 +286,10 @@ - The when focused will receive the default action and have set even if there is a different widget set as default. + The when focused will receive the default action and have set even if there is a different widget set as default. - - The when focused will receive the default action and have set even if there is a different widget set as default. + + The when focused will receive the default action and have set even if there is a different widget set as default. @@ -302,10 +302,10 @@ - Set and unset by . Indicates that exposes done on the should be double-buffered. + Set and unset by . Indicates that exposes done on the should be double-buffered. - - Indicates that exposes done on the should be double-buffered. + + Indicates that exposes done on the should be double-buffered. @@ -323,4 +323,4 @@ - + \ No newline at end of file