diff --git a/doc/ChangeLog b/doc/ChangeLog index 8291fb6c8..64a1d0637 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2004-01-12 Hector E. Gomez Morales + + * en/Gtk/Ctree.xml + * en/Gtk/Style.xml + * en/Gtk/Tree.xml: First draft. + * en/Gtk/TODO: updated. + * en/Gtk/Widget.xml: Documented the remaining methods and properties. + * en/Gtk/Window.xml: Documented all methods excepts the overloads and all the properties. + 2004-01-08 John Luke * en/Gtk/RadioButton.xml: diff --git a/doc/en/Gtk/Ctree.xml b/doc/en/Gtk/Ctree.xml index 8cb4d76e5..b85a0185e 100644 --- a/doc/en/Gtk/Ctree.xml +++ b/doc/en/Gtk/Ctree.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -10,8 +10,18 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A displaying a hierarchical tree. + + + The widget is used for showing a hierarchical tree to the user, for example a directory tree. The tree is internally represented as a set of nodes. + + + Positions in the tree are often indicated by two arguments, a parent and a sibling, both node pointers. If the parent is , the position is at the root of the tree and if the sibling is , it will be the last child of parent, otherwise it wil be inserted just before the sibling. + + + Warning: is deprecated and should not be used in newly-written code. + + System.Object @@ -83,4 +93,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Style.xml b/doc/en/Gtk/Style.xml index 09c579ea5..ce43097e2 100644 --- a/doc/en/Gtk/Style.xml +++ b/doc/en/Gtk/Style.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Methods for drawing widget parts. + GLib.Object @@ -52,10 +52,10 @@ - To be added - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gdk.Color' - To be added + Sets the background of to the background color or pixmap specified by style for the state. + A state. + A color to be used for the background. + @@ -1197,4 +1197,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TODO b/doc/en/Gtk/TODO index 6583b80b3..56bcf4bb9 100644 --- a/doc/en/Gtk/TODO +++ b/doc/en/Gtk/TODO @@ -1,6 +1,6 @@ TODO doc for Gtk namespace. -There are in total 324 xml to document in Gtk. Right now there are 164 xml not documented in any proportion. +There are in total 324 xml to document in Gtk. Right now there are 160 xml not documented in any proportion. The idea is to have a easy way to know what documentation is missing, if you want to help or are helping please take out the xml that you commit from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email next to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs mailing list). @@ -24,7 +24,6 @@ ClipboardTestReceivedFunc.xml ColorSelectionButton.xml ColorSelectionChangePaletteFunc.xml ColorSelectionChangePaletteWithScreenFunc.xml -Ctree.xml DebugFlag.xml Decorated.xml DestroyNotify.xml @@ -91,7 +90,6 @@ RBNodeColor.xml RBTree.xml RBTreeTraverseFunc.xml RBTreeView.xml -RadioButton.xml RadioMenuItem.xml Rc.xml RcFlags.xml @@ -111,7 +109,6 @@ SettingsPropertyValue.xml SettingsValue.xml SignalFunc.xml StockManager.xml -Style.xml Submenu.xml TargetEntry.xml TargetFlags.xml @@ -147,7 +144,6 @@ TextWindowType.xml ThemeEngine.xml ThreadNotify.xml TranslateFunc.xml -Tree.xml TreeCellDataFunc.xml TreeDataList.xml TreeDestroyCountFunc.xml diff --git a/doc/en/Gtk/Tree.xml b/doc/en/Gtk/Tree.xml index 36efd9e12..fa5b5ae2f 100644 --- a/doc/en/Gtk/Tree.xml +++ b/doc/en/Gtk/Tree.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -10,8 +10,15 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A tree . + + + is deprecated and unsupported. It is known to be buggy. To use it, you must define the symbol prior to includng the Gtk# header files. Use instead. + + + The widget is a container that shows users a list of items, in a tree format complete withbranches and leafnodes. Branches can be expanded to show their child items, or collapsed to hide them. + + System.Object @@ -71,4 +78,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Widget.xml b/doc/en/Gtk/Widget.xml index b55439169..c83cf49e5 100644 --- a/doc/en/Gtk/Widget.xml +++ b/doc/en/Gtk/Widget.xml @@ -50,7 +50,7 @@ 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. @@ -190,7 +190,7 @@ if focus ended up inside . - 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. + This method is used by custom 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 event on ; override the default handler for this event in order to implement appropriate focus behavior. @@ -256,7 +256,7 @@ Height of region to draw. - 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. + Invalidates the rectangular area of defined by , , and by calling on the '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 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. @@ -726,10 +726,10 @@ - To be added + Activates the targets associated with the mnemonic. To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + if the activation is done. + @@ -949,8 +949,8 @@ 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. + + See for details. @@ -1488,10 +1488,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the is visible. + If the widget is set to be visible. + if the widget is meant to be visible. + @@ -1503,10 +1503,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Override for the width request for the . + The width to be set for the . + The width of the . + Or -1 if natural request should be used. @@ -1518,10 +1518,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the responds to input. + If the is set to respond to input. + if the responds to input. + @@ -1533,10 +1533,23 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Obtains or sets the event mask for the (a bitfield containing flags from ). + Event mask. + Event mask for . + + + The event mask determines which events a will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a 's fuctionalit, so be careful. + + + This property must be called while a is unrealized. Consider for widgets that are already realized, or if you want to preserve the existing event mask. + + + This property can't be used with widgets; to get events on those events, place them inside a and receive events on the event box. + + + These are the events that the will receive. + + @@ -1548,10 +1561,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether to make the receive the default action when it is focused. + If the will receive the default action when is focused. + if the will receive the default action when is focused. + @@ -1563,10 +1576,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the has the input focus. + If the has the input focus. + if the has the input focus. + @@ -1578,10 +1591,10 @@ - To be added - To be added: an object of type 'Gdk.ExtensionMode' - To be added: an object of type 'Gdk.ExtensionMode' - To be added + The mask that decides what kind of extension events the gets. + A Gdk.ExtensionMode. + A Gdk.ExtensionMode. + @@ -1593,10 +1606,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the is the default . + If the is the default . + if the is the default . + @@ -1606,9 +1619,9 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether the is part of a composite widget. + if the is part of a composite widget. + @@ -1620,10 +1633,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the can be the default widget. + If the can be the default widget. + if the can be the default widget. + @@ -1635,10 +1648,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the can accept the input focus. + If the can accept the input focus. + if the can accept the input focus. + @@ -1650,10 +1663,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Override for the height request for the . + The height to be set for the . + The height of the . + Or -1 if natural request should be used. @@ -1665,10 +1678,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the application will paint directly on the . + If the application will paint directly on the . + if the application will paint directly on the . + @@ -1680,10 +1693,10 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' - To be added + The parent widget of this . + The parent widget. + The parent widget. + Must be a Container , @@ -1695,10 +1708,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The name of the . + The name to be set for the . + The name of the . + @@ -1710,10 +1723,10 @@ - To be added - To be added: an object of type 'Gtk.Style' - To be added: an object of type 'Gtk.Style' - To be added + The style of the . + A style. + A style. + Which contains information about how it will look (colors etc). @@ -2422,9 +2435,16 @@ Gdk.Display - To be added - a - To be added + Obtains the for the toplevel window associated with this . + The for the toplevel for this . + + + This method can only be called after the has been added to a widget hierarchy with a at the top. + + + In general, you should only create display specific resources when a has been realized, and you should free those resources when the is unrealized. + + @@ -2434,9 +2454,16 @@ Gdk.Screen - To be added - a - To be added + Obtains the from the toplevel window associated with this . + The for the toplevel for this . + + + This method can only be called after the has been added to a widget hierarchy with a at the top. + + + In general, you should only create screen specific resources when a has been realized, and you should free those resources when the is unrealized. + + @@ -2504,11 +2531,11 @@ 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. + A which identifies the clipboard to use. gives the default clipboard, another common value is , 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. + must have a associated with it, so must be attached to a toplevel window. @@ -2629,9 +2656,19 @@ - To be added - a - To be added + Obtains the preferred size of a . + A . + + + The container uses this information to arrange its child widgets 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 requieres the to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind. + + + Also remember that the size request is not necessarily the size a will actually be allocated. + + @@ -2645,10 +2682,10 @@ - To be added - a - a - To be added + Obtains the value of a style property of . + The name of a style property. + Location to return the property value. + @@ -4472,10 +4509,14 @@ - To be added - a - a - To be added + Obtains the first ancestor of . + Ancestor type. + The ancesor , or see if not found. + + + For example sending gets the first that's an ancstor of . No reference will be added to the retured ; 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. + + diff --git a/doc/en/Gtk/Window.xml b/doc/en/Gtk/Window.xml index 32a726fd2..63bb6fcfd 100644 --- a/doc/en/Gtk/Window.xml +++ b/doc/en/Gtk/Window.xml @@ -43,7 +43,7 @@ Returns a list of all existing toplevel windows. List of toplevel widgets. - + The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, ) first, and then unref all the widgets afterwards. @@ -68,7 +68,7 @@ Y position where the user clicked to initiate the drag. Timestamp from the click event that initiated the drag. - + This method is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system. @@ -93,10 +93,10 @@ Location to store the width of the frame at the returns, or . Location to store the height of the frame at the bottom, or . - + 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 method intended for the framebuffer port; see . @@ -112,10 +112,10 @@ Asks to iconify (i.e. minimize) the specified . - - 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. + + Note that you shouldn't assume the 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 will end up iconified. Just do not write code that crashes if not. - + You can track iconification via the event on . @@ -131,10 +131,10 @@ 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. + + Note that you shouldn't assume the is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the will end up stuck. Just do not write code that crashes if not. - + You can track stickiness via the event on . @@ -150,11 +150,12 @@ Asks to unmaximize . - - 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. + + Note that you shouldn't assume the 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 will end up unmaximized. Just don't write code that crashes if not. + + + You can track maximization via the event on - - You can track maximization via the event on @@ -173,11 +174,11 @@ Return location for width, or . Return location for height, or . - - 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. + + If 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 gets updated. - - 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. + + Note 1: Nearly any use of this method creates a race condition, because the size of the 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 and adjust your size-dependent state to match the size delivered in the GdkEventConfigure. @@ -197,8 +198,8 @@ Location to store the default width, or . Location to store the default height, or . - - A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the window will be used. + + A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the will be used. @@ -215,16 +216,16 @@ 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. + Width in pixels to resize the to. + Height in pixels to resize the to. - - The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call to set the window's request to a smaller value. + + The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call to set the 's request to a smaller value. - - If is called before showing a window for the first time, it overrides any default size set with . Windows may not be resized smaller than 1 by 1 pixels. + + If is called before showing a for the first time, it overrides any default size set with . Windows may not be resized smaller than 1 by 1 pixels. - + @@ -236,8 +237,7 @@ Activates the current focused within the . - - if a got activated. + if a got activated. @@ -257,19 +257,19 @@ if string was parsed successfully. - - does work on all GTK# ports including Win32 but is primarily intended for an X environment. + + does work on all GTK# ports including Win32 but is primarily intended for an X environment. - - If either a size or a position can be extracted from the geometry string, returns and calls and/or to resize/move the window. + + If either a size or a position can be extracted from the geometry string, returns and calls and/or to resize/move the . - - If returns , it will also set the GDK_HINT_USER_POS and/or GDK_HINT_USER_SIZE hints indicating to the window manager that the size/position of the window was user-specified. This causes most window managers to honor the geometry. + + If returns , it will also set the and/or hints indicating to the window manager that the size/position of the was user-specified. This causes most window managers to honor the geometry. - - Note that for to work as expected, it has to be called when the window has its "final" size, i.e. after calling on the contents and on the window. + + Note that for to work as expected, it has to be called when the has its "final" size, i.e. after calling on the contents and on the . - + @@ -297,13 +297,13 @@ Asks to stick , which means that it will appear on all user desktops. - - 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. + + Note that you shouldn't assume the 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 will end up stuck. Just don't write code that crashes if not. - - You can track stickiness via the event on GtkWidget. It's permitted to call this method before showing a window. + + You can track stickiness via the event on GtkWidget. It's permitted to call this method before showing a . - + @@ -325,10 +325,10 @@ The width of the right border. The height of the bottom border. - + 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. - + @@ -369,10 +369,10 @@ Y position where the user clicked to initiate the drag Timestamp from the click event that initiated the drag. - + 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. - + @@ -390,22 +390,22 @@ Return location for X coordinate of gravity-determined reference point. Return location for Y coordinate of gravity-determined reference point. - - If you haven't changed the window gravity, its gravity will be GDK_GRAVITY_NORTH_WEST. This means that gets the position of the top-left corner of the window manager frame for the window. sets the position of this same top-left corner. + + If you haven't changed the window gravity, its gravity will be . This means that gets the position of the top-left corner of the window manager frame for the . sets the position of this same top-left corner. - - is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a window by the window manager. Thus GTK# is using a "best guess" that works with most window managers. + + is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a by the window manager. Thus GTK# is using a "best guess" that works with most window managers. - - Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a window to its current position as returned by tends to result in moving the window slightly. Window managers are slowly getting better over time. + + Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a to its current position as returned by tends to result in moving the slightly. Window managers are slowly getting better over time. - - If a window has gravity GDK_GRAVITY_STATIC the window manager frame is not relevant, and thus will always produce accurate results. However you can't use static gravity to do things like place a window in a corner of the screen, because static gravity ignores the window manager decorations. + + If a has gravity the window manager frame is not relevant, and thus will always produce accurate results. However you can't use static gravity to do things like place a in a corner of the screen, because static gravity ignores the window manager decorations. - - If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your window sizes and positions. + + If you are saving and restoring your application's positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your sizes and positions. - + @@ -418,13 +418,13 @@ Asks to deiconify (i.e. unminimizw) the specified . - - 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. + + Note that you shouldn't assume the 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 event on GtkWidget. - + @@ -441,8 +441,7 @@ Activates the targets associated with the mnemonic. The mnemonic. The modifiers. - - if the activation is done. + if the activation is done. @@ -455,13 +454,12 @@ Activates the default for the . - - if a is activated. + if a 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. - + @@ -474,13 +472,13 @@ Asks to maximize , so that it becomes full-screen. - - 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. + + Note that you shouldn't assume the 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 will end up maximized. Just don't write code that crashes if not. - - 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. + + You can track maximization via the event on . It's permitted to call this method before showing a , in which case the will be maximized when it appears onscreen initially. - + @@ -530,10 +528,10 @@ 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 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. + + 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 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. - + @@ -566,20 +564,20 @@ Width in pixels, or -1 to unset the default width. Height in pixels, or -1 to unset the default height. - - 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. + + If the '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 ( 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 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). + + Unlike which sets a size request for a and thus would keep users from shrinking the , this method only sets the initial size, just as if the user had resized the themselves. Users can still shrink the again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the ). - - For more control over a window's initial size and how resizing works, investigate . + + For more control over a 's initial size and how resizing works, investigate . - - 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. + + For some uses, is a more appropriate method. changes the current size of the , rather than the size to be used on initial display. always affects the 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. + + The default size of a only affects the first time a is shown; if a is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size. @@ -594,13 +592,13 @@ 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 method calls as well. + + This may mean raising the 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 is hidden, this method calls as well. - - 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. + + This method should be used when the user tries to open a 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. - + @@ -613,10 +611,10 @@ Hides , then reshows it, resetting the default size and position of the . - + Used by GUI builders only. - + @@ -631,22 +629,22 @@ Asks the window manager to move to the given position. - X coordinate to move window to. - Y coordinate to move window to. + X coordinate to move to. + Y coordinate to move to. - - Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown. + + Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the has already been shown. - - Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point. + + Note: the position is the position of the gravity-determined reference point for the . The gravity determines two things: first, the location of the reference point in root coordinates; and second, which point on the is positioned at the reference point. - - By default the gravity is GDK_GRAVITY_NORTH_WEST, so the reference point is simply the x, y supplied to . The top-left corner of the window decorations (aka window frame or border) will be placed at , . Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is GDK_GRAVITY_NORTH_WEST) and move the window to 0,0. + + By default the gravity is so the reference point is simply the x, y supplied to . The top-left corner of the decorations (aka window frame or border) will be placed at , . Therefore, to position a at the top left of the screen, you want to use the default gravity (which is ) and move the to 0,0. - - To position a window at the bottom right corner of the screen, you would set GDK_GRAVITY_SOUTH_EAST, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point. + + To position a at the bottom right corner of the screen, you would set , which means that the reference point is at x + the width and y + the height, and the bottom-right corner of the window border will be placed at that reference point. - + @@ -662,8 +660,8 @@ Sets the position constraint for a . A position constraint. - - Is is used for placing the window in some area, depending on the constraint. + + Is is used for placing the in some area, depending on the constraint. @@ -681,10 +679,10 @@ Associate with . A . - + Such that calling on will activate accelerators in . - + @@ -704,10 +702,10 @@ Struct containing geometry information. Mask indicating which struct fields should be paid attention to. - + You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See . - + @@ -730,11 +728,11 @@ - Internal constructor + Internal constructor. Pointer to the C object. An instance of Window, wrapping the C object. - This is an internal constructor, and should not be used by user code. + This is an internal constructor, and should not be used by user code. @@ -750,7 +748,7 @@ A . A . - + Creates a new Window object, wich can be of type TopLevel ( most of the cases ) or PopUp. Take care with the use of PopUp type, since it is not controlled by the window manager. @@ -762,8 +760,8 @@ - Internal constructor - an object of type + Internal constructor. + An object of type . This is an internal constructor, and should not be used by user code. @@ -779,7 +777,7 @@ A string. A . - + Creates a new TopLevel Window object, using as the title. You get the same if you use the public Window ( Gtk.WindowType type ) constructor and later set the string Title property. @@ -798,10 +796,10 @@ 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. - + @@ -817,10 +815,10 @@ 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. - + @@ -832,18 +830,17 @@ - If this function is called on a window with setting of , before it is realized or showed, it will have a "frame" window around widget->window, accessible in window->frame. Or it access the "frame" window exterior to widget->window. + If this function is called on a with setting of , before it is realized or showed, it will have a "frame" around widget->window, accessible in window->frame. Or it access the "frame" exterior to widget->window. A . - - if a frame has been added to the window via . + if a frame has been added to the via . - + Using the event you can receive all events targeted at the frame. This method is used by the linux-fb port to implement managed windows, but it could concievably be used by X-programs that want to do their own window decorations. - + Note: This is a special-purpose method for the framebuffer port, this caues to GTK# to draw its own window border. For most applications you want instead, which tells the window manager whether to draw the window border. - + @@ -859,10 +856,10 @@ A window gravity. A window gravity. - + The default window gravity is which is typically "do what you mean". See and . - + @@ -876,7 +873,7 @@ Sets or obtains the mnemonic modifier for this . The modfier mask. - The modifier mask used to activate mnemonics on this window. + The modifier mask used to activate mnemonics on this . @@ -891,12 +888,12 @@ Sets or obtains the type hint for . The window type. - The ttype hint for . + The type hint for . - - By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application. This property should be called before the window becomes visible. + + By setting the type hint for the , you allow the window manager to decorate and handle the in a way which is suitable to the function of the in your application. This property should be called before the becomes visible. - + @@ -909,17 +906,17 @@ Sets ot obtains the transient parent. - Parent window. + Parent . - - Dialog windows should be transient for the main window they were spawned from, this allows windows managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. + + Dialog windows should be transient for the main they were spawned from, this allows windows managers to e.g. keep the dialog on top of the main , or center the dialog over the main . - - On Windows(tm), this function will and put the child window on top of the parent, much as the window would have done in X. + + On Windows(tm), this function will and put the child on top of the parent, much as the would have done in X. - + @@ -931,18 +928,17 @@ - Sets a to be the focus widget for the window if it is not the current focus widget, and its focusable, or retrieves the current focused within the window. - - to be the new focus widget, or to unset any focus widget for the toplevel window. + Sets a to be the focus widget for the if it is not the current focus widget, and its focusable, or retrieves the current focused within the . + to be the new focus widget, or to unset any focus widget for the toplevel window. The currently focused , or if there is none. - + To set the focus to a particular in the toplevel, it is usually more convenient to use . - - Note: when retrieving the current focused is the that would have the focus if the toplevel focused; if the toplevel window is not focused then will not be for the . + + Note: when retrieving the current focused is the that would have the focus if the toplevel focused; if the toplevel is not focused then will not be for the . - + @@ -958,22 +954,24 @@ A list of . Copy of window's icon list. - - The icon is used when window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window framw, or display it in other contexts. + + The icon is used when is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. + + - - allows you to pass the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK#. Scaling is postponed unitl the last minute, when the desired final size is known, to allow best quality. By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling. + + allows you to pass the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK#. Scaling is postponed unitl the last minute, when the desired final size is known, to allow best quality. By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling. - + Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them). - - Note that transient windows (those who have been set transient for another window using will inherit their icon from their transient parent. So there's no need to explicity set the icon on transient windows. + + Note that transient windows (those who have been set transient for another using will inherit their icon from their transient parent. So there's no need to explicity set the icon on transient windows. - + When retrieving the list is copied, but the reference count on each won't be incremented. - + @@ -985,17 +983,18 @@ - Sets or obtains the role of the window. - Unique identifier for the window to be used when restoring a session. - The role of the window if set, or . The returned is owned by the widget and must not be modified or freed. + Sets or obtains the role of the . + Unique identifier for the to be used when restoring a session. + The role of the if set, or . The returned is owned by the widget and must not be modified or freed. - + This property is only useful on X11, not with other GTK# targets. - In combination with the window title, the window role allows a window manager to identify "the same" window when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox window, so that when the user restarts their session, the session manager can put the toolbox back in the same place. + In combination with the title, the role allows a window manager to identify "the same" when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox , so that when the user restarts their session, the session manager can put the toolbox back in the same place. - If a window already has a unique title, you don't need to set the role, since the WM can use the title to identigy the window when restoring the session. - + If a already has a unique title, you don't need to set the role, since the WM can use the title to identigy the when restoring the session. + + @@ -1007,17 +1006,15 @@ - Sets or obtains whether the window has been set to have decorations. - - to decorate the window. - - if the window has been set to have decorations. + Sets or obtains whether the has been set to have decorations. + to decorate the . + if the has been set to have decorations. - - With this property you control if a window will be decorated or not. + + With this property you control if a will be decorated or not. - - By default, windows are decorated with a title bar and resize controls. Some window managers allow to disable these decorations, creating a borderless Window. If you set this property as false, Gtk# will try to convince the window manager not to decorate the window. + + By default, windows are decorated with a title bar and resize controls. Some window managers allow to disable these decorations, creating a borderless Window. If you set this property as false, Gtk# will try to convince the window manager not to decorate the . @@ -1031,14 +1028,12 @@ - Sets or obtains whether a window will be resizable by the user or not. - - if the user can resize this window. - - if the user can resize the window. + Sets or obtains whether a will be resizable by the user or not. + if the user can resize this . + if the user can resize the . - - By default, windows are resizable, so you can change the size of them. But if you set this property to false, the user won't be able to change the size of them. + + By default, the are resizable, so you can change the size of them. But if you set this property to false, the user won't be able to change the size of them. @@ -1052,12 +1047,12 @@ - Property used for setting/getting the window position. - An object of type . - An object of type . + Property used for setting/getting the position. + A position. See also . + The position. See also . - - This property will alow you to define where a Window must be displayed on the screen. It work with the Gtk.WindowPosition enum, so maybe you should check it before use it. + + This property will alow you to define where a must be displayed on the screen. It work with the enum, so maybe you should check it before use it. @@ -1071,12 +1066,12 @@ - Property used for defining the default height of a window. - An object of type . - An object of type . + Property used for setting or obtaining the default height of a . + A height. + The default height of the . - - This property will allow you to define the default height for your Window. It only define the default one, so if the Window is resized, it won't be able to do anything. + + This property will allow you to define the default height for your . It only define the default one, so if the is resized, it won't be able to do anything. @@ -1094,10 +1089,10 @@ an object of type an object of type - - This is useful for dialogs that shouldn't persist beyond the livefime of the main window they're associated with, for example. + + This is useful for dialogs that shouldn't persist beyond the livefime of the main they're associated with, for example. - + @@ -1110,17 +1105,16 @@ Sets or obtains the modal status of . - Whether the window is modal. - - if the window is set to be modal and establishes a grab when shown. + Whether the is modal. + if the is set to be modal and establishes a grab when shown. - + Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent. - + There are two status: modal () and non-modal (). - + @@ -1133,9 +1127,8 @@ Sets or obtains if the can be resized to a larger size by the user. - if the can be resized. - - if the can be resized. + If the can be resized. + if the can be resized. @@ -1148,12 +1141,12 @@ - Property used for setting the window title. + Property used for setting the title. Title of the . The title of the , or if none has been set explicitely. The returned string is owned by the and must not be modified or freed. - - This property will allow you to set the window title. The title of a will be displayed in its title bar. Since the title bar is rendered by the window managers on X Window System, the way it appears will depend on the user preferences. This title should help the users to distinguish a window from others opened. A good title will have the application name an the actual document, for example. + + This property will allow you to set the title. The title of a will be displayed in its title bar. Since the title bar is rendered by the window managers on X Window System, the way it appears will depend on the user preferences. This title should help the users to distinguish a from others opened. A good title will have the application name an the actual document, for example. @@ -1165,9 +1158,13 @@ Gtk.WindowType - To be added - an object of type - To be added + The type of . + The type. + + + See also . + + @@ -1179,10 +1176,14 @@ - To be added - an object of type - an object of type - To be added + Property used for setting or obtaining the default width of a . + A . + The default width of the . + + + This property will allow you to define the default width for . It only define the default one, so if the is resized, it won't be able to do anything. + + @@ -1194,10 +1195,10 @@ - To be added - an object of type - an object of type - To be added + Property used for setting the icon for a . + An icon. + The default icon for . + @@ -1209,10 +1210,14 @@ - To be added - an object of type - an object of type - To be added + Sets or obtains if the has no mininum size. + If the has no minimum size. + if the has no minimum size. + + + Setting this to is 99% of the time a bad idea. + + @@ -1296,10 +1301,17 @@ - To be added - a - a - To be added + Property used for setting the automatic startup notification. + If automatically do startup notification. + if set to automatically do startup notification. + + + By default, after showing the first for each , GTK# calls . Use this property to disable the automatic startup notification. + + + You might do this if your first is a splash screen, and you want to delay notification until after your real main has been shown, for example. In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main would automatically result in notification. + + @@ -1309,9 +1321,13 @@ System.Drawing.Size - To be added - a - To be added + Property that obtains the current size of . + The width and height of , a . + + + If is not onscreen, it returns the size GTK# will suggest to the window manager for the initial 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, rather than querying the X server for the size. As a result, if you call then immediately call , the size won't 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 gets updated. + + @@ -1321,9 +1337,28 @@ System.Drawing.Size - To be added + Property that obtains the position you need to pass to to keep in its current position. a - To be added + + + This means that the meaning of the returned value varies with window gravity. See for more details. + + + If you haven't changed the window gravity, its gravity will be . This means that gets the position of the top-left corner of the window manager frame for the . sets the position of this same top-left corner. + + + This property is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a by the window manager. Thus GTK# is using a "best guess" that works with most window managers. + + + Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a to its current position as returned by tends to result in moving the slightly. Window managers are slowly getting better over time. + + + If a has gravity the window manager frame is not relevant, and thus will always produce accurate results. However you can't use static gravity to do things like place a in a corner of the screen, because static gravity ignores the window manager decorations. + + + If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your window sizes and positions. + + @@ -1335,10 +1370,32 @@ - To be added + Sets or obtains the default size of . a a - To be added + + + A value of -1 for the size indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the will be used. + + + If the '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 ( 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 and thus would keep users from shrinking the , this method only sets the initial size, just as if the user had resized the themselves. Users can still shrink the again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the ). + + + For more control over a 's initial size and how resizing works, read . + + + For some uses, is a more appropriate method. changes the current size of the , rather than the size to be used on initial display. always affects the itself, not the geometry widget. + + + The default size of a only affects the first time a is shown; if a is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size. + + + Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 is OK, resulting in a 1x1 default size. + + @@ -1350,10 +1407,14 @@ - To be added - a - a - To be added + Sets or obtains the where the is displayed. + A . + A . + + + If the is already mapped, it will be unmapped, and then remapped on the new screen. + + @@ -1363,9 +1424,9 @@ System.Boolean - To be added - a - To be added + Whether the toplevel is the current active . + if the is the toplevel. + @@ -1375,9 +1436,9 @@ System.Boolean - To be added - a - To be added + Whether the input focus is within this . + if the has the input focus. + @@ -1389,10 +1450,10 @@ - To be added - a - a - To be added + Whether the should not be in the pager. + If then the will not be in the pager. + if the should not be in the pager. + @@ -1404,10 +1465,10 @@ - To be added - a - a - To be added + Whether the should not be in the taskbar. + If then the will not be in the taskbar. + if the should not be in the taskbar. + @@ -1422,8 +1483,7 @@ 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. + if setting the icon succeded. @@ -1437,13 +1497,13 @@ 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. + + Note that you shouldn't assume the 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 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 . - + @@ -1458,13 +1518,12 @@ Sets the icon for . Location of icon file. - - if setting the icon succeded. + if setting the icon succeded. - + This method is equivalent to calling with pixbuf created by loading the image from . - + @@ -1477,10 +1536,10 @@ Asks to toggle off the fullscreen state for . - - 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. + + Note that you shouldn't assume the 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 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 . @@ -1699,4 +1758,4 @@ - \ No newline at end of file +