From 43ffab4a20e91ec9abeeea4d98d371597565c42d Mon Sep 17 00:00:00 2001 From: "Hector E. Gomez Morales" Date: Thu, 25 Sep 2003 05:34:26 +0000 Subject: [PATCH] en/Gtk/Accessible.xml: Full doc. en/Gtk/CellEditable.xml: Full doc. en/Gtk/Drag.xml: Full doc. en/Gtk/Widget.xml: Fixes and some updates. en/Gtk/WidgetFlags.xml: Full doc. svn path=/trunk/gtk-sharp/; revision=18289 --- doc/ChangeLog | 9 ++ doc/en/Gtk/Accessible.xml | 20 +-- doc/en/Gtk/CellEditable.xml | 42 ++++-- doc/en/Gtk/Drag.xml | 292 +++++++++++++++++++++--------------- doc/en/Gtk/Widget.xml | 284 ++++++++++++++++++----------------- doc/en/Gtk/WidgetFlags.xml | 152 +++++++++++++------ doc/en/Gtk/Window.xml | 120 +++++++++------ 7 files changed, 545 insertions(+), 374 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 869e2da05..6953a3ff7 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2003-09-25 Hector E. Gomez Morales + + * en/Gtk/Accessible.xml + * en/Gtk/CellEditable.xml + * en/Gtk/Drag.xml: Full docs. + * en/Gtk/Widget.xml: Fixes and some updates. + * en/Gtk/WidgetFlags.xml: Full doc. + * en/Gtk/Window.xml: Fixes and some updates, still missing to document the properties. + 2003-09-23 John Luke * en/Art.xml: diff --git a/doc/en/Gtk/Accessible.xml b/doc/en/Gtk/Accessible.xml index 79f0c3870..02f0d5760 100644 --- a/doc/en/Gtk/Accessible.xml +++ b/doc/en/Gtk/Accessible.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + This class requests instances for the UI components that provide useful information to the user. + Atk.Object @@ -31,8 +31,8 @@ - To be added - To be added + This method specifies the callback function to be called when the corresponding to a is destroyed. + @@ -69,9 +69,11 @@ - To be added - To be added: an object of type 'Gtk.Accessible' - To be added + Internal constructor. + An instance of . + + This is an internal constructor, and should not be used by user code. + @@ -103,4 +105,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/CellEditable.xml b/doc/en/Gtk/CellEditable.xml index bd2f89a98..50ef43440 100644 --- a/doc/en/Gtk/CellEditable.xml +++ b/doc/en/Gtk/CellEditable.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An object for editing a single cell. + @@ -28,9 +28,13 @@ - To be added - To be added: an object of type 'Gdk.Event' - To be added + Begins editing on a cell editable. + A , or . + + + is the that began the editing process. It may be , in the instance that editing was initiated through programatic means. + + @@ -41,8 +45,12 @@ - To be added - To be added + Emits the event. + + + This event is a sign for the cell renderer to update its value from the cell. + + @@ -53,8 +61,12 @@ - To be added - To be added + Emits the event. + + + This event is meant to indicate that the cell is finished editing, and the may now be destroyed. + + @@ -65,8 +77,8 @@ - To be added - To be added + Event that indicates that the cell is finished editing, and the may now be destroyed. + @@ -77,9 +89,9 @@ - To be added - To be added + Event that indicates to the cell renderer to update its value from the cell. + - \ No newline at end of file + diff --git a/doc/en/Gtk/Drag.xml b/doc/en/Gtk/Drag.xml index 0b80bbf46..fe25a0803 100644 --- a/doc/en/Gtk/Drag.xml +++ b/doc/en/Gtk/Drag.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Methods for controlling drag and drop handling. + + + GTK+ has a rich set of methods for doing inter-process communication via the drag-and-drop metaphor. GTK+ can do drag-and-drop (DND) via multiple protocols. The currently supported protocols are the Xdnd and Motif protocols. As well as the methods listed here, applications may need to use some facilities provided for . Also, the Drag and Drop API makes use of events in the class. + + System.Object @@ -28,9 +32,13 @@ - To be added - a - To be added + Clears information about a drop destinantion set with . + A . + + + The will no longer receive notification of drags. + + @@ -43,10 +51,10 @@ - To be added - a - a - To be added + Determines the source for a drag. + A (destination side) drag context. + If the drag is occurring within a single application, a pointer to the source . Otherwise, . + @@ -62,12 +70,12 @@ - To be added - a - a - a - a - To be added + Sets this as a proxy for drops to another window. + A . + The window to which to foward drag events. + The drag protocol which the accepts (You can use to determine this). + If , send the same coordinates to the destination, because it is an embedded subwindow. + @@ -83,12 +91,12 @@ - To be added - a - a - a - a - To be added + Informs the drag sourcre that the drop is finished, and that the data of the drag will no longer be repaired. + The drag context. + A flag indicating whether the drop was successful. + A flag indicating whether the source should delete the original data (this should be for a move). + The timestamp from the event. + @@ -102,10 +110,14 @@ - To be added - a - a - To be added + Sets the target types that this can accept from drag and drop. + A that's a drag destination. + List of droppable targets, or for none. + + + The must first be made into a drag destination with . + + @@ -122,13 +134,17 @@ - To be added - a - a - a - a - a - To be added + Sets up a so that GTK+ will start a drag operation when the user clicks and drags on the . + A . + The bitmask of buttons that can start the drag. + The table of targets that the drag will support. + The number of items in . + the bitmask of possible actions for a drag from this . + + + The must have a window. + + @@ -143,12 +159,16 @@ - To be added - a - a - a - a - To be added + Looks for a match between ->targets and the , returning the first matching target, otherwise returning GDK_NONE. + Drag destination . + Drag context. + List of droppable targets, or to use . + First target that the source offers and the dest can accept. or GDK_NONE. + + + should usually be the return value from but some widgets may have different valid targets for different parts of the ; in that case, they will have to implement a drag_motion handler that passes the correct target list to this method. + + @@ -165,14 +185,14 @@ - To be added - a - a - a - a - a - a - To be added + Checks to see if a mouse drag starting at (, ) and ending at (, ) has passed the GTK+ drag threshold, and this should trigger the beginning of a drag-and-drog operation. + A . + X coordinate of a start of drag. + Y coordinate of a start of drag. + Current X coordinate. + Current Y coordinate. + if the drag threshold has been passed. + @@ -186,10 +206,10 @@ - To be added - a - a - To be added + Sets the icon that will be used for drags from a particular source to a stock icon. + A . + The ID of the stock icon to use. + @@ -202,9 +222,9 @@ - To be added - a - To be added + Removes a highlight set by from a . + A . + @@ -217,9 +237,13 @@ - To be added - a - To be added + Draws a highlight around a . + A to highlight. + + + This will attach handlers to and , so the highlight will continue to be displayed until is called. + + @@ -233,10 +257,14 @@ - To be added - a - a - To be added + Sets the icon that will be used for drags from a particular from a . + A . + The for the drag icon. + + + GTK+ retains a reference for and will release it when it is no longer needed. + + @@ -253,14 +281,18 @@ - To be added - a - a - a - a - a - a - To be added + Initates a drag on the source side. + The source . + The targets (data formats) in which the source can provide the data. + A bitmask of the allowed drag actions for this drag. + The button the user clicked to start the drag. + The event that triggered the start of the drag. + The context fot this drag. + + + The method only needs to be used when the application is starting drags itself, and is not needed when is used. + + @@ -276,12 +308,12 @@ - To be added - a - a - a - a - To be added + Sets the icon for a given drag from a stock ID. + The context of the drag (this must be called with a context for the source side of a drag). + The ID of the stock icon to use for the drag. + The X offset within the icon of the hotspot. + The Y offset within the icon of the hotspot. + @@ -297,12 +329,16 @@ - To be added - a - a - a - a - To be added + Obtains the data associated with a drag. + The that will receive the event. + The drag context. + The target (form of the data) to retrieve. + A timestamp for retrieving the data. This will generally be the time received in a or event. + + + When the data is received or the retrieval fails, GTK+ will emit a event. Failure of the retrieval is indicated by the length field of the signal parameter being negative. However, when is called implicitely because the was set, then the will not receive notification of failed drops. + + @@ -320,14 +356,18 @@ - To be added - a - a - a - a - a - a - To be added + Sets as the icon for a given drag. + The context for a drag (this must be called with a context for the source side of a drag). + The colormap of the icon. + The image data for the icon. + The transparency mask for the icon. + The X offset with of the hotspot. + The Y offset with of the hotspot. + + + GTK+ retains references for the arguments, and will release them when they are no longer needed. In general, will be more convenient to use. + + @@ -343,12 +383,12 @@ - To be added - a - a - a - a - To be added + Sets as the icon for a given drag. + The context for a drag (this must be called with a context for the source side of a drag). + The to use as the drag icon. + The X offset within of the hotspot. + The Y offset within of the hotspot. + @@ -361,10 +401,10 @@ - To be added - a - a - To be added + Returns the list of targets this can accept from drag-and-drop. + A . + The , or if none. + @@ -377,9 +417,9 @@ - To be added - a - To be added + Undoes the effects of . + A . + @@ -395,12 +435,16 @@ - To be added - a - a - a - a - To be added + Sets the icon that will be used for drags from a particular from a pixmap/mask. + A . + The colormap of the icon. + The image data for the icon. + The transparency mask for an image. + + + GTK+ retains references for the arguments, and will release them when they are no longer needed. Use instead. + + @@ -416,12 +460,16 @@ - To be added - a - a - a - a - To be added + Changes the icon for a to a given . + The context for a drag (this must be called with a context for the source side of a drag. + A toplevel window to use as an icon. + The X offset within of the hotspot. + The Y offset within of the hotspot. + + + GTK+ will not destroy the icon, so if you don't want it to persist, you should connect to the event and destroy it yourself. + + @@ -430,9 +478,9 @@ - To be added - a - To be added + A constructor. + Creates a new instance of . + @@ -443,11 +491,11 @@ - To be added - a - a - To be added + Sets the icon for a particular drag to the default icon. + The context for a drag (this must be called with a context for the source side of a drag). + if the icon has been made the default. + - \ No newline at end of file + diff --git a/doc/en/Gtk/Widget.xml b/doc/en/Gtk/Widget.xml index 070395676..66936326b 100644 --- a/doc/en/Gtk/Widget.xml +++ b/doc/en/Gtk/Widget.xml @@ -7,7 +7,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - GtkWidget introduces style properties - these are basically object properties that are stored in the style object associated to the widget. + GtkWidget introduces style properties - these are basically object properties that are stored in the style object associated to the . 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. @@ -66,7 +66,7 @@ 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 . Remove with . There's little reason to use this method. @@ -131,7 +131,7 @@ 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 , 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 method. @@ -147,7 +147,7 @@ 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 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 . + A to move the into. - Moves a widget from one to another, handling reference count issues to avoid destroying the widget. + Moves a from one to another, handling reference count issues to avoid destroying the . @@ -184,16 +184,16 @@ Move focus to particular . Direction of focus movement. - if focus ended up inside widget. + if focus ended up inside . - 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 method is used by custom widget implementations; if you're writing an app, you'd use to move the focus to a particular , and to change the focus tab order. So you may want to investigate those methods 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 event on ; override the default handler for this event 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 should return if moving in direction left the focus on a focusable location inside that , and if moving in direction moved the focus outside the . If returning , normally call to place the focus accordingly; if returning , they don't modify the current focus location. @@ -209,7 +209,7 @@ 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. + This method is only for use in widget implementations. @@ -225,10 +225,10 @@ 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 is realized. Normally realization happens implicitly; if you show a and all its parent containers, then it will be realized and mapped automatically. Realizing a requires all the widget's parent widgets to be realized; calling realizes the widget's parents in addition to itself. If a 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 method 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 event that will be called after the is realized automatically, such as . Or simply to the realize event. @@ -253,10 +253,10 @@ 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 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 method 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 method. Those methods will invalidate only a single window, instead of the 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. @@ -297,14 +297,14 @@ - A convenience function that uses the theme engine and RC file settings for to look up and render it to a . + A convenience method 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. - 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 or code doing the rendering, so that theme engines can special-case rendering for that 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 . @@ -365,7 +365,7 @@ 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 such as and . See also . @@ -395,11 +395,11 @@ - Utility function; intended to be connected to the signal on a . + Utility method; intended to be connected to the event 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 method 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. @@ -418,7 +418,7 @@ 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, in which case it returns that geometry instead of the widget's . This method 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 ->. @@ -434,7 +434,7 @@ 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 , such as a ; something like won't work (More precisely, it must have the flag set). @@ -474,7 +474,7 @@ 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 is a low level method that would most likely be used by a menu creation system like . If you use , setting up accelerator paths will be done automatically. @@ -495,16 +495,16 @@ 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. + Accel group for this , 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 method 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 method are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use instead. @@ -520,10 +520,10 @@ 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 that isn't shown will not appear on the screen. If you want to show all the in a container, it's easier to call on the container, instead of individually showing the . - 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. + Remember that you have to show the containers containing a , in addition to the itself, before it will appear onscreen. And that when a toplevel container is shown, it is immediately realized and mapped; other shown are realized and mapped when their toplevel container is realized and mapped. @@ -542,7 +542,7 @@ 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. + Returns if the 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. @@ -565,7 +565,7 @@ 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 , you must call in response to the and events for the . @@ -581,7 +581,7 @@ 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. + This method is not useful for applications. @@ -594,11 +594,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 method activates them. + Returns if the 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 method returns . @@ -634,12 +634,12 @@ - Rarely-used function. This function is used to emit the event signals on a . + Rarely-used method. This method is used to emit the events on a . A . - Return from the event signal emission ( if the event was handled) + Return from the event 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 method; instead, use to invalidate a region of the window. @@ -655,7 +655,7 @@ 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 to be hidden (invisible to the user). @@ -676,7 +676,7 @@ 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 such as and . See also . @@ -693,10 +693,10 @@ Gets the first ancestor of with type . Ancestor type. - The ancestor widget, or if not found + The ancestor , 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 ; 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. @@ -712,7 +712,7 @@ Recursively resets the shape on and its descendants. - Recursively resets the shape on this widget and its descendants. + Recursively resets the shape on this and its descendants. @@ -731,10 +731,10 @@ 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 method, 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 method are not cumulative with previous calls to or with such methods 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 methods will have a cumulative effect with the initial modifications. @@ -755,10 +755,10 @@ 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 method to force a to be either larger or smaller than it normally would be. In most cases, is a better choice for toplevel windows than this method; 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 method 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. + 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 . So, it's basically impossible to hardcode a size that will always be correct. The size request of a is the smallest size a can accept while still methoding well and drawing itself correctly. However in some strange cases a may be allocated less than its requested size, and in many cases a may be allocated more space than it requested. @@ -795,7 +795,7 @@ 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 method. @@ -813,7 +813,7 @@ Removes an accelerator from , previously installed with . - Accel group for this widget. + Accel group for this . GDK keyval of the accelerator. Modifier key combination of the accelerator. Returns whether an accelerator was installed and could be removed. @@ -835,7 +835,7 @@ Causes a to be unmapped if it's currently mapped. - This function is only for use in widget implementations. + This method is only for use in widget implementations. @@ -851,7 +851,7 @@ Causes a to be mapped if it isn't already. - This function is only for use in widget implementations. + This method is only for use in widget implementations. @@ -867,8 +867,8 @@ 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. + A , in the same coordinate system as ->allocation. That is, relative to ->window for ; 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 , and relative to the parent window of ->window for widgets with their own window. The result may be empty, use to check. @@ -887,7 +887,7 @@ 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 method 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. @@ -921,12 +921,12 @@ - Very rarely-used function. This function is used to emit an signals on a . + Very rarely-used method. This method is used to emit an events on a . A . - Return from the event signal emission ( if the event was handled). + Return from the event 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 method is not normally used directly. The only time it is used is when propagating an to a child , 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 . @@ -942,7 +942,7 @@ Causes a to be unrealized (frees all GDK resources associated with the widget). - This function is only useful in widget implementations. + This method is only useful in widget implementations. @@ -958,7 +958,7 @@ 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 method; most of the time, if you want the style, the is realized, and realized are guaranteed to have a style already. @@ -975,7 +975,7 @@ Determines whether is somewhere inside , possibly with intermediate containers. Another . - Returns if ancestor contains widget as a child, grandchild, great grandchild, etc. + Returns if ancestor contains as a child, grandchild, great grandchild, etc. Determines whether is somewhere inside , possibly with intermediate containers. @@ -1029,7 +1029,7 @@ 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 events on to be emitted. @@ -1067,11 +1067,11 @@ - Emits a signal for the child property on . + Emits a event 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 event for the child property on . @@ -1087,10 +1087,10 @@ 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 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 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. @@ -1103,10 +1103,10 @@ - Stops emission of signals on . + Stops emission of events on . - The signals are queued until is called on . + The events are queued until is called on . @@ -1121,11 +1121,11 @@ - This function is only used by subclasses, to assign a size and position to their child widgets. + This method is only used by subclasses, to assign a size and position to their child . 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 . @@ -1164,9 +1164,11 @@ - A constructor. + Internal constructor. An instance of . - + + This is an internal constructor, and should not be used by user code. + @@ -1192,11 +1194,11 @@ Gtk.Style - Obtains the default style used by all widgets initially. + Obtains the default style used by all initially. Returns the default style. This object is owned by GTK+ and should not be modified or freed. - Returns the default style used by all widgets initially. + Returns the default style used by all initially. @@ -1209,12 +1211,12 @@ - Sets or obtains the default colormap to use when creating widgets. + Sets or obtains the default colormap to use when creating . A colormap (see ). A . - is a better function to use if you only want to affect a few widgets, rather than all widgets. + is a better method to use if you only want to affect a few widgets, rather than all widgets. @@ -1227,7 +1229,7 @@ - Sets or obtains the default reading direction for widgets. + Sets or obtains the default reading direction for . A . A . @@ -1280,9 +1282,9 @@ Atk.Object - Obtains the default reading direction for widgets. + Obtains the default reading direction for . A . - Obtains the default reading direction for widgets. + Obtains the default reading direction for . @@ -1295,10 +1297,10 @@ Sets or obtains the reading direction on a particular . A . - The reading direction for the widget. + The reading direction for the . - This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification). If the direction is set none, then the value set by will be used. + This direction controls the primary direction for containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitely visual rather than logical (such as buttons for text justification). If the direction is set none, then the value set by will be used. @@ -1331,13 +1333,13 @@ Sets or obtains whether should be mapped along with its when its parent is mapped and has been shown with . If , should be mapped along with its parent. - Returns if the widget is mapped with the parent. + Returns if the is mapped with the parent. - The child visibility can be set for widget before it is added to a container with , to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of when the widget is removed from a container. + The child visibility can be set for before it is added to a container with , to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of when the is removed from a container. - Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself. This function is only useful for container implementations and never should be called by an application. + Note that changing the child visibility of a does not queue a resize on the . Most of the time, the size of a is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself. This property is only useful for container implementations and never should be called by an application. @@ -1355,7 +1357,7 @@ The composite name of , or if is not a composite child. The string should not be freed when it is no longer needed. - The widget must be a composite child of its parent; see . + The must be a composite child of its parent; see . @@ -1367,11 +1369,11 @@ Gtk.Widget - Obtains the topmost widget in the container hierarchy is a part of. + Obtains the topmost in the container hierarchy is a part of. The topmost ancestor of , or itself if there's no ancestor. - Note the difference in behavior against , would return if wasn't inside a toplevel window, and if the window was inside a GtkWindow-derived widget which was in turn inside the toplevel . While the second case may seem unlikely, it actually happens when a is embedded inside a within the same application. To reliably find the toplevel , use and check if the flag is set on the result. + Note the difference in behavior against , would return if wasn't inside a toplevel window, and if the window was inside a GtkWindow-derived which was in turn inside the toplevel . While the second case may seem unlikely, it actually happens when a is embedded inside a within the same application. To reliably find the toplevel , use and check if the flag is set on the result. @@ -1386,14 +1388,14 @@ 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. + the entire will be redrawn when it is allocated to a new size. only the new portion of the 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 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 setting this flag to turns off all allocation on resizing: the 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 that does draw on ->window, you are responsible for invalidating both the old and new allocation of the when the is moved and responsible for invalidating regions newly when the increases size. @@ -1406,16 +1408,16 @@ - Use this function to turn off the double buffering. + Use this property 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. - 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 property to turn off the buffering. "Double buffered" simply means that and are called automatically around events sent to the . 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. + In very simple terms, double buffered don't flicker, so you would only use this property to turn off double buffering if you had special needs and really knew what you were doing. @@ -1431,7 +1433,7 @@ The relevant object. - Note that this function can only be called when the is attached to a toplevel, since the settings object is specific to a particular . + Note that this property can only be called when the is attached to a toplevel, since the settings object is specific to a particular . @@ -1465,10 +1467,10 @@ - Unlike the context returned by , this context is owned by the (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the 's attributes. + Unlike the context returned by , this context is owned by the (it can be used until the screen for the changes or the is removed from its toplevel), and will be updated to match any changes to the 's attributes. - If you create and keep a using this context, you must deal with changes to the context by calling on the layout in response to the and signals for the . + If you create and keep a using this context, you must deal with changes to the context by calling on the layout in response to the and events for the . @@ -1486,7 +1488,7 @@ The of the . - Usually you should set the state using wrapper functions such as . This function is for use in widget implementations. + Usually you should set the state using wrapper fuctions such as . This property is for use in widget implementations. @@ -1514,11 +1516,11 @@ Gtk.RcStyle - Obtains the current modifier style for the widget.(As set by ) - The modifier style for the widget. This rc style is owned by the widget. + Obtains the current modifier style for the .(As set by ) + The modifier style for the . This rc style is owned by the . - If no style has previously set, a new will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call , passing in the returned rc style, to make sure that your changes take effect. + If no style has previously set, a new will be created with all values unset, and set as the modifier style for the . If you make changes to this rc style, you must call , passing in the returned rc style, to make sure that your changes take effect. Caution: passing the style back to will normally end up destroying it, because copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive. @@ -2508,10 +2510,10 @@ Determines if the is the focus widget within its toplevel. - if the widget is the focus widget. + if the 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 additionally has the global input focus. @@ -2566,9 +2568,9 @@ 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 . + @@ -2582,10 +2584,14 @@ - To be added - a - a - To be added + Returns the clipboard object for the given selection to be used with . + A which identifies the clipboard to use. GDK_SELECTION_CLIPBOARD gives the default clipboard, another common value is GDK_SELECTION_PRIMARY, which gives the primary X selection. + The appropiate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time. + + + must have a associated with it, so must be attached to a toplevel window. + + @@ -2603,9 +2609,9 @@ 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 , and are relative to ->allocation.x, ->allocation.y for widgets that are . + @@ -2625,15 +2631,15 @@ 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. + X position relative to source . + Y position relative to source . 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 . + Returns if either 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. - + + In order to perform this operation, both widgets must be realized, and must share a common toplevel. + @@ -2654,12 +2660,12 @@ 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 . - - - 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. - + + 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. + @@ -2671,9 +2677,13 @@ - To be added - a - To be added + Checks whether there is a is associated with this , + if there is a associated with the . + + + All toplevel have an associated screen, and all added into a heirarchy with a toplevel window at the top. + + @@ -2688,11 +2698,11 @@ - To be added - a - a - a - To be added + 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 . + @@ -2708,12 +2718,12 @@ 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. - - - 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. - + + The container uses this information to arrange its child and decide what size allocations to give them with . You can also call this method from an application, with some caveats. Most notably, getting a size request requires the to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind. + + + This method is typically used when implementing a subclass. Also remember that the size request is not necessarily the size a will actually be allocated. + diff --git a/doc/en/Gtk/WidgetFlags.xml b/doc/en/Gtk/WidgetFlags.xml index 732ed4508..9bfe94122 100644 --- a/doc/en/Gtk/WidgetFlags.xml +++ b/doc/en/Gtk/WidgetFlags.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Tells about certain properties of the . + System.Enum @@ -40,8 +40,12 @@ - To be added - To be added + Widgets without a real parent, as there are s and s have this flag set throughout their lifetime. + + + Toplevel widgets always contain their own . + + @@ -52,8 +56,12 @@ - To be added - To be added + Indicative for a that does not provide its own . + + + Visible action (e.g. drawing) is performed on the parent's . + + @@ -64,8 +72,12 @@ - To be added - To be added + Set by , unset by . + + + A realized has an associated . + + @@ -76,8 +88,12 @@ - To be added - To be added + Set by , unset by . + + + Only realized widgets can be mapped. It means that has been called on the widgets window(s). + + @@ -88,8 +104,12 @@ - To be added - To be added + 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. + + @@ -100,8 +120,12 @@ - To be added - To be added + 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. + + @@ -112,8 +136,12 @@ - To be added - To be added + 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. + + @@ -124,8 +152,12 @@ - To be added - To be added + Determines whether a is able to handle focus grabs. + + + Determines whether a is able to handle focus grabs. + + @@ -136,8 +168,12 @@ - To be added - To be added + Set by for widgets that also have set. + + + The flag will be unset once another widget grabs the focus. + + @@ -148,8 +184,12 @@ - To be added - To be added + The is allowed to receive the default action via . + + + The is allowed to receive the default action via . + + @@ -160,8 +200,12 @@ - To be added - To be added + The currently is receiving the default action. + + + The currently is receiving the default action. + + @@ -172,8 +216,12 @@ - To be added - To be added + 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. + + @@ -184,8 +232,12 @@ - To be added - To be added + 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. + + @@ -196,8 +248,12 @@ - To be added - To be added + Indicates that the is a composite child of its parent. + + + See , . + + @@ -208,8 +264,8 @@ - To be added - To be added + Unused since before GTK+ 1.2, will be removed in a future version. + @@ -220,8 +276,12 @@ - To be added - To be added + 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. + + @@ -232,8 +292,12 @@ - To be added - To be added + 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. + + @@ -244,8 +308,12 @@ - To be added - To be added + Set and unset by . Indicates that exposes done on the should be double-buffered. + + + Indicates that exposes done on the should be double-buffered. + + @@ -256,9 +324,9 @@ - To be added - To be added + To be added. + To be added. - \ No newline at end of file + diff --git a/doc/en/Gtk/Window.xml b/doc/en/Gtk/Window.xml index adf5d76ff..24fe7ffd1 100644 --- a/doc/en/Gtk/Window.xml +++ b/doc/en/Gtk/Window.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Toplevel widget which can contain other widgets. - Toplevel widget which can contain other widgets. + Toplevel which can contain other widgets. + Toplevel which can contain other widgets. Gtk.Bin @@ -59,7 +59,7 @@ - Starts moving a window. + Starts moving a . Mouse button that initiated the drag. X position where the user clicked to initiate the drag, in root window coordinates. Y position where the user clicked to initiate the drag. @@ -94,7 +94,7 @@ It will not return the size of the window border drawn by the window manager, which is the normal case when using a windowing system. See to get the standard window border extents.) See also , . - Note: this is a special-purpose function intended for the framebuffer port; see . + Note: this is a special-purpose method intended for the framebuffer port; see . @@ -113,7 +113,7 @@ Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the window will end up iconified. Just do not write code that crashes if not. - You can track iconification via the signal on . + You can track iconification via the event on . @@ -126,13 +126,13 @@ - Asks to unstick window, which means that it will appear on only one of the user's desktops. + Asks to unstick , which means that it will appear on only one of the user's desktops. Note that you shouldn't assume the window is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the window will end up stuck. Just do not write code that crashes if not. - You can track stickiness via the signal on . + You can track stickiness via the event on . @@ -151,7 +151,7 @@ Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don't write code that crashes if not. - You can track maximization via the signal on + You can track maximization via the event on @@ -175,7 +175,7 @@ If window is not onscreen, it returns the size GTK+ will suggest to the window manager for the initial window size (but this is not reliably the same as the size the window manager will actually select). The size obtained by is the last size received in a GdkEventConfigure, that is, GTK+ uses its locally-stored size, rather than querying the X server for the size. As a result, if you call then immediately call , the size would not have taken effect yet. After the window manager processes the resize request, GTK+ receives notification that the size has changed via a configure event, and the size of the window gets updated. - Note 1: Nearly any use of this function creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to on the window and adjust your size-dependent state to match the size delivered in the GdkEventConfigure. + Note 1: Nearly any use of this method creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to on the window and adjust your size-dependent state to match the size delivered in the GdkEventConfigure. @@ -191,7 +191,7 @@ - Gets the default size of the window. + Gets the default size of the . Location to store the default width, or . Location to store the default height, or . @@ -212,7 +212,7 @@ - Resizes the window as if the user had done so, obeying geometry constraints. + Resizes the as if the user had done so, obeying geometry constraints. Width in pixels to resize the window to. Height in pixels to resize the window to. @@ -233,8 +233,8 @@ - Activates the current focused widget within the window. - if a widget got activated. + Activates the current focused within the . + if a got activated. @@ -296,7 +296,7 @@ Note that you shouldn't assume the window is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not. - You can track stickiness via the signal on GtkWidget. It's permitted to call this function before showing a window. + You can track stickiness via the event on GtkWidget. It's permitted to call this method before showing a window. @@ -314,14 +314,14 @@ - For windows with frames (see ) this function can be used to change the size of the frame border. + For windows with frames (see ) this method can be used to change the size of the frame border. The width of the left border. The height of the top border. The width of the right border. The height of the bottom border. - Note: this is a special-purpose function intended for the framebuffer port; see . It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system. + Note: this is a special-purpose method intended for the framebuffer port; see . It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system. @@ -339,7 +339,7 @@ Adds a mnemonic to this . The mnemonic. - The widget that gets activated by the mnemonic. + The that gets activated by the mnemonic. @@ -365,7 +365,7 @@ Timestamp from the click event that initiated the drag. - This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system. + This method is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system. @@ -381,7 +381,7 @@ - This function returns the position you need to pass to to keep in its current position. + This method returns the position you need to pass to to keep in its current position. Return location for X coordinate of gravity-determined reference point. Return location for Y coordinate of gravity-determined reference point. @@ -417,7 +417,7 @@ Note that you shouldn't assume the window is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run. - You can track iconification via the signal on GtkWidget. + You can track iconification via the event on GtkWidget. @@ -449,10 +449,10 @@ Activates the default for the . - if a widget is activated. + if a is activated. - That is unless the current focused widget has been configured to receive the default (see ) action in which case the case the focused widget is activated. + That is unless the current focused has been configured to receive the default (see ) action in which case the case the focused is activated. @@ -471,7 +471,7 @@ Note that you shouldn't assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don't write code that crashes if not. - You can track maximization via the signal on GtkWidget. It's permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially. + You can track maximization via the event on GtkWidget. It's permitted to call this method before showing a window, in which case the window will be maximized when it appears onscreen initially. @@ -489,7 +489,7 @@ Removes a mnemonic from this . The mnemonic. - The widget that gets activated by the mnemonic. + The that gets activated by the mnemonic. @@ -519,12 +519,12 @@ - It sets the X Window System "class" and "name" hints for a . (Don't use this function.) + It sets the X Window System "class" and "name" hints for a . (Don't use this method.) Window name hint. Window class hint. - According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this function is sort of pointless. However, you may want to call on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session. + According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this method is sort of pointless. However, you may want to call on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session. @@ -563,13 +563,13 @@ If the window's "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window ( can be used to set these explicitly), the default size will be clamped to the nearest permitted size. - Unlike which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window). + Unlike which sets a size request for a and thus would keep users from shrinking the window, this method only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window). For more control over a window's initial size and how resizing works, investigate . - For some uses, is a more appropriate function. changes the current size of the window, rather than the size to be used on initial display. always affects the window itself, not the geometry widget. + For some uses, is a more appropriate method. changes the current size of the window, rather than the size to be used on initial display. always affects the window itself, not the geometry widget. The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size. @@ -588,10 +588,10 @@ Presents a to the user. - This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences. If window is hidden, this function calls as well. + This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences. If window is hidden, this method calls as well. - This function should be used when the user tries to open a window that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use to move the already-open dialog where the user can see it. + This method should be used when the user tries to open a window that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use to move the already-open dialog where the user can see it. @@ -604,7 +604,7 @@ - Hides , then reshows it, resetting the default size and position of the window. + Hides , then reshows it, resetting the default size and position of the . Used by GUI builders only. @@ -786,10 +786,14 @@ - To be added - an object of type - an object of type - To be added + Sets or obtains the icon list to be used as fallback for windows that haven't had called on them to set up a window-specific icon list. + A list of . + A copy of default icon list. + + + This method allows you to set up the icon for all windows in your app at once. + + @@ -812,10 +816,14 @@ - To be added - an object of type - an object of type - To be added + Sets or unsets the default for a about. + Widget to be the default, or to unset the default for the toplevel. + A . + + + The default is the widget that's activated when the user presses Enter in a dialog (for example). When setting (rather than unsetting) the default it's generally easier to call on the . Before making a default , you must set the flag on the you'd like to make the default. + + @@ -1337,10 +1345,10 @@ - To be added - a - a - To be added + Sets an icon to be used as fallback for windows that haven't had called on them from a file on disk. + Location of icon file. + if setting the icon succeded. + @@ -1351,8 +1359,15 @@ - To be added - To be added + Asks to place in the fullscreen state. + + + Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not. + + + You can track the fullscreen state via the event on . + + @@ -1365,10 +1380,14 @@ - To be added - a - a - To be added + Sets the icon for . + Location of icon file. + if setting the icon succeded. + + + This method is equivalent to calling with pixbuf created by loading the image from . + + @@ -1384,6 +1403,9 @@ Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not. + + You can track the fullscreen state via the event on . +