GtkWindow as GtkBuildable

The GtkWindow implementation of the GtkBuildable interface supports a custom <accel-groups> element, which supports any number of <group> elements representing the GtkAccelGroup objects you want to add to your window (synonymous with gtk_window_add_accel_group().

1
2
3
4
5
6
7

<object class="GtkWindow">
  <accel-groups>
    <group name="accelgroup1"/>
  </accel-groups>
</object>
...
<object class="GtkAccelGroup" id="accelgroup1"/>

GtkWindow

typedef struct _GtkWindow GtkWindow;

gtk_window_new ()

GtkWidget*          gtk_window_new                      (GtkWindowType type);

Creates a new GtkWindow, which is a toplevel window that can contain other widgets. Nearly always, the type of the window should be GTK_WINDOW_TOPLEVEL. If you're implementing something like a popup menu from scratch (which is a bad idea, just use GtkMenu), you might use GTK_WINDOW_POPUP. GTK_WINDOW_POPUP is not for dialogs, though in some other toolkits dialogs are called "popups". In GTK+, GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the window manager.

If you simply want an undecorated window (no window borders), use gtk_window_set_decorated(), don't use GTK_WINDOW_POPUP.

gtk_window_set_title ()

void                gtk_window_set_title                (GtkWindow *window,
                                                         const gchar *title);

Sets the title of the GtkWindow. The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager, so exactly how the title appears to users may vary according to a user's exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.

gtk_window_set_wmclass ()

void                gtk_window_set_wmclass              (GtkWindow *window,
                                                         const gchar *wmclass_name,
                                                         const gchar *wmclass_class);

Don't use this function. It sets the X Window System "class" and "name" hints for a window. 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 gtk_window_set_role() 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.

gtk_window_set_policy ()

void                gtk_window_set_policy               (GtkWindow *window,
                                                         gint allow_shrink,
                                                         gint allow_grow,
                                                         gint auto_shrink);

Changes how a toplevel window deals with its size request and user resize attempts. There are really only two reasonable ways to call this function:

The first policy is the default, that is, by default windows are designed to be resized by users.

The basic ugly truth of this function is that it should be simply: void gtk_window_set_resizable (GtkWindow* window, gboolean setting); ...which is why GTK+ 2.0 introduces gtk_window_set_resizable(), which you should use instead of gtk_window_set_policy().

If set to TRUE, the allow_grow parameter allows the user to expand the window beyond the size request of its child widgets. If allow_grow is TRUE, be sure to check that your child widgets work properly as the window is resized.

A toplevel window will always change size to ensure its child widgets receive their requested size. This means that if you add child widgets, the toplevel window will expand to contain them. However, normally the toplevel will not shrink to fit the size request of its children if it's too large; the auto_shrink parameter causes the window to shrink when child widgets have too much space. auto_shrink is normally used with the second of the two window policies mentioned above. That is, set auto_shrink to TRUE if you want the window to have a fixed, always-optimal size determined by your program.

Note that auto_shrink doesn't do anything if allow_shrink and allow_grow are both set to FALSE.

Neither of the two suggested window policies set the allow_shrink parameter to TRUE. If allow_shrink is TRUE, the user can shrink the window so that its children do not receive their full size request; this is basically a bad thing, because most widgets will look wrong if this happens. Furthermore GTK+ has a tendency to re-expand the window if size is recalculated for any reason. The upshot is that allow_shrink should always be set to FALSE.

Sometimes when you think you want to use allow_shrink, the real problem is that some specific child widget is requesting too much space, so the user can't shrink the window sufficiently. Perhaps you are calling gtk_widget_set_size_request() on a child widget, and forcing its size request to be too large. Instead of setting the child's usize, consider using gtk_window_set_default_size() so that the child gets a larger allocation than it requests.

gtk_window_set_resizable ()

void                gtk_window_set_resizable            (GtkWindow *window,
                                                         gboolean resizable);

Sets whether the user can resize a window. Windows are user resizable by default.

gtk_window_get_resizable ()

gboolean            gtk_window_get_resizable            (GtkWindow *window);

Gets the value set by gtk_window_set_resizable().

gtk_window_add_accel_group ()

void                gtk_window_add_accel_group          (GtkWindow *window,
                                                         GtkAccelGroup *accel_group);

Associate accel_group with window, such that calling gtk_accel_groups_activate() on window will activate accelerators in accel_group.

gtk_window_remove_accel_group ()

void                gtk_window_remove_accel_group       (GtkWindow *window,
                                                         GtkAccelGroup *accel_group);

Reverses the effects of gtk_window_add_accel_group().

gtk_window_position

#define gtk_window_position			gtk_window_set_position

Deprecated alias for gtk_window_set_position().

gtk_window_activate_focus ()

gboolean            gtk_window_activate_focus           (GtkWindow *window);

Activates the current focused widget within the window.

gtk_window_activate_default ()

gboolean            gtk_window_activate_default         (GtkWindow *window);

Activates the default widget for the window, unless the current focused widget has been configured to receive the default action (see gtk_widget_set_receives_default()), in which case the focused widget is activated.

gtk_window_set_modal ()

void                gtk_window_set_modal                (GtkWindow *window,
                                                         gboolean modal);

Sets a window modal or non-modal. Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use gtk_window_set_transient_for() to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

gtk_window_set_default_size ()

void                gtk_window_set_default_size         (GtkWindow *window,
                                                         gint width,
                                                         gint height);

Sets the default size of a window. 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 (gtk_window_set_geometry_hints() can be used to set these explicitly), the default size will be clamped to the nearest permitted size.

Unlike gtk_widget_set_size_request(), 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).

For more control over a window's initial size and how resizing works, investigate gtk_window_set_geometry_hints().

For some uses, gtk_window_resize() is a more appropriate function. gtk_window_resize() changes the current size of the window, rather than the size to be used on initial display. gtk_window_resize() 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.

Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.

gtk_window_set_geometry_hints ()

void                gtk_window_set_geometry_hints       (GtkWindow *window,
                                                         GtkWidget *geometry_widget,
                                                         GdkGeometry *geometry,
                                                         GdkWindowHints geom_mask);

This function sets up hints about how a window can be resized by the user. 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 the GdkGeometry struct.

gtk_window_set_gravity ()

void                gtk_window_set_gravity              (GtkWindow *window,
                                                         GdkGravity gravity);

Window gravity defines the meaning of coordinates passed to gtk_window_move(). See gtk_window_move() and GdkGravity for more details.

The default window gravity is GDK_GRAVITY_NORTH_WEST which will typically "do what you mean."

gtk_window_get_gravity ()

GdkGravity          gtk_window_get_gravity              (GtkWindow *window);

Gets the value set by gtk_window_set_gravity().

gtk_window_set_position ()

void                gtk_window_set_position             (GtkWindow *window,
                                                         GtkWindowPosition position);

Sets a position constraint for this window. If the old or new constraint is GTK_WIN_POS_CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint.

gtk_window_set_transient_for ()

void                gtk_window_set_transient_for        (GtkWindow *window,
                                                         GtkWindow *parent);

Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. gtk_dialog_new_with_buttons() and other convenience functions in GTK+ will sometimes call gtk_window_set_transient_for() on your behalf.

Passing NULL for parent unsets the current transient window.

On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.

gtk_window_set_destroy_with_parent ()

void                gtk_window_set_destroy_with_parent  (GtkWindow *window,
                                                         gboolean setting);

If setting is TRUE, then destroying the transient parent of window will also destroy window itself. This is useful for dialogs that shouldn't persist beyond the lifetime of the main window they're associated with, for example.

gtk_window_set_screen ()

void                gtk_window_set_screen               (GtkWindow *window,
                                                         GdkScreen *screen);

Sets the GdkScreen where the window is displayed; if the window is already mapped, it will be unmapped, and then remapped on the new screen.

Since 2.2

gtk_window_get_screen ()

GdkScreen*          gtk_window_get_screen               (GtkWindow *window);

Returns the GdkScreen associated with window.

Since 2.2

gtk_window_is_active ()

gboolean            gtk_window_is_active                (GtkWindow *window);

Returns whether the window is part of the current active toplevel. (That is, the toplevel window receiving keystrokes.) The return value is TRUE if the window is active toplevel itself, but also if it is, say, a GtkPlug embedded in the active toplevel. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window. See gtk_window_has_toplevel_focus()

Since 2.4

gtk_window_has_toplevel_focus ()

gboolean            gtk_window_has_toplevel_focus       (GtkWindow *window);

Returns whether the input focus is within this GtkWindow. For real toplevel windows, this is identical to gtk_window_is_active(), but for embedded windows, like GtkPlug, the results will differ.

Since 2.4

gtk_window_list_toplevels ()

GList*              gtk_window_list_toplevels           (void);

Returns a list of all existing toplevel windows. 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, NULL) first, and then unref all the widgets afterwards.

gtk_window_add_mnemonic ()

void                gtk_window_add_mnemonic             (GtkWindow *window,
                                                         guint keyval,
                                                         GtkWidget *target);

Adds a mnemonic to this window.

gtk_window_remove_mnemonic ()

void                gtk_window_remove_mnemonic          (GtkWindow *window,
                                                         guint keyval,
                                                         GtkWidget *target);

Removes a mnemonic from this window.

gtk_window_mnemonic_activate ()

gboolean            gtk_window_mnemonic_activate        (GtkWindow *window,
                                                         guint keyval,
                                                         GdkModifierType modifier);

Activates the targets associated with the mnemonic.

gtk_window_activate_key ()

gboolean            gtk_window_activate_key             (GtkWindow *window,
                                                         GdkEventKey *event);

Activates mnemonics and accelerators for this GtkWindow. This is normally called by the default ::key_press_event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

Since 2.4

gtk_window_propagate_key_event ()

gboolean            gtk_window_propagate_key_event      (GtkWindow *window,
                                                         GdkEventKey *event);

Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles event. This is normally called by the default ::key_press_event and ::key_release_event handlers for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

Since 2.4

gtk_window_get_focus ()

GtkWidget *         gtk_window_get_focus                (GtkWindow *window);

Retrieves the current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be TRUE for the widget.

gtk_window_set_focus ()

void                gtk_window_set_focus                (GtkWindow *window,
                                                         GtkWidget *focus);

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is NULL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use gtk_widget_grab_focus() instead of this function.

gtk_window_get_default_widget ()

GtkWidget *         gtk_window_get_default_widget       (GtkWindow *window);

Returns the default widget for window. See gtk_window_set_default() for more details.

Since 2.14

gtk_window_set_default ()

void                gtk_window_set_default              (GtkWindow *window,
                                                         GtkWidget *default_widget);

The default widget is the widget that's activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget for a GtkWindow about. When setting (rather than unsetting) the default widget it's generally easier to call gtk_widget_grab_focus() on the widget. Before making a widget the default widget, you must set the GTK_CAN_DEFAULT flag on the widget you'd like to make the default using GTK_WIDGET_SET_FLAGS().

gtk_window_present ()

void                gtk_window_present                  (GtkWindow *window);

Presents a window 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 gtk_widget_show() 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 gtk_window_present() to move the already-open dialog where the user can see it.

If you are calling this function in response to a user interaction, it is preferable to use gtk_window_present_with_time().

gtk_window_present_with_time ()

void                gtk_window_present_with_time        (GtkWindow *window,
                                                         guint32 timestamp);

Presents a window to the user in response to a user interaction. If you need to present a window without a timestamp, use gtk_window_present(). See gtk_window_present() for details.

Since 2.8

gtk_window_iconify ()

void                gtk_window_iconify                  (GtkWindow *window);

Asks to iconify (i.e. minimize) the specified window. 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 don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.

You can track iconification via the "window-state-event" signal on GtkWidget.

gtk_window_deiconify ()

void                gtk_window_deiconify                (GtkWindow *window);

Asks to deiconify (i.e. unminimize) the specified window. 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 "window-state-event" signal on GtkWidget.

gtk_window_stick ()

void                gtk_window_stick                    (GtkWindow *window);

Asks to stick window, 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.

It's permitted to call this function before showing a window.

You can track stickiness via the "window-state-event" signal on GtkWidget.

gtk_window_unstick ()

void                gtk_window_unstick                  (GtkWindow *window);

Asks to unstick window, 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 don't write code that crashes if not.

You can track stickiness via the "window-state-event" signal on GtkWidget.

gtk_window_maximize ()

void                gtk_window_maximize                 (GtkWindow *window);

Asks to maximize window, 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.

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 "window-state-event" signal on GtkWidget.

gtk_window_unmaximize ()

void                gtk_window_unmaximize               (GtkWindow *window);

Asks to unmaximize window. 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 "window-state-event" signal on GtkWidget.

gtk_window_fullscreen ()

void                gtk_window_fullscreen               (GtkWindow *window);

Asks to place window 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 fullscreen. Just don't write code that crashes if not.

You can track the fullscreen state via the "window-state-event" signal on GtkWidget.

Since 2.2

gtk_window_unfullscreen ()

void                gtk_window_unfullscreen             (GtkWindow *window);

Asks to toggle off the fullscreen state for window. 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 "window-state-event" signal on GtkWidget.

Since 2.2

gtk_window_set_keep_above ()

void                gtk_window_set_keep_above           (GtkWindow *window,
                                                         gboolean setting);

Asks to keep window above, so that it stays on top. Note that you shouldn't assume the window is definitely above afterward, because other entities (e.g. the user or window manager) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.

You can track the above state via the "window-state-event" signal on GtkWidget.

Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

Since 2.4

gtk_window_set_keep_below ()

void                gtk_window_set_keep_below           (GtkWindow *window,
                                                         gboolean setting);

Asks to keep window below, so that it stays in bottom. Note that you shouldn't assume the window is definitely below afterward, because other entities (e.g. the user or window manager) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don't write code that crashes if not.

It's permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.

You can track the below state via the "window-state-event" signal on GtkWidget.

Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

Since 2.4

gtk_window_begin_resize_drag ()

void                gtk_window_begin_resize_drag        (GtkWindow *window,
                                                         GdkWindowEdge edge,
                                                         gint button,
                                                         gint root_x,
                                                         gint root_y,
                                                         guint32 timestamp);

Starts resizing a window. 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.

gtk_window_begin_move_drag ()

void                gtk_window_begin_move_drag          (GtkWindow *window,
                                                         gint button,
                                                         gint root_x,
                                                         gint root_y,
                                                         guint32 timestamp);

Starts moving a window. This function 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.

gtk_window_set_decorated ()

void                gtk_window_set_decorated            (GtkWindow *window,
                                                         gboolean setting);

By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK+ to disable these decorations, creating a borderless window. If you set the decorated property to FALSE using this function, GTK+ will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling gtk_window_show().

On Windows, this function always works, since there's no window manager policy involved.

gtk_window_set_deletable ()

void                gtk_window_set_deletable            (GtkWindow *window,
                                                         gboolean setting);

By default, windows have a close button in the window frame. Some window managers allow GTK+ to disable this button. If you set the deletable property to FALSE using this function, GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling gtk_window_show().

On Windows, this function always works, since there's no window manager policy involved.

Since 2.10

gtk_window_set_frame_dimensions ()

void                gtk_window_set_frame_dimensions     (GtkWindow *window,
                                                         gint left,
                                                         gint top,
                                                         gint right,
                                                         gint bottom);

(Note: this is a special-purpose function intended for the framebuffer port; see gtk_window_set_has_frame(). 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.)

For windows with frames (see gtk_window_set_has_frame()) this function can be used to change the size of the frame border.

gtk_window_set_has_frame ()

void                gtk_window_set_has_frame            (GtkWindow *window,
                                                         gboolean setting);

(Note: this is a special-purpose function for the framebuffer port, that causes GTK+ to draw its own window border. For most applications, you want gtk_window_set_decorated() instead, which tells the window manager whether to draw the window border.)

If this function is called on a window with setting of TRUE, before it is realized or showed, it will have a "frame" window around window->window, accessible in window->frame. Using the signal frame_event you can receive all events targeted at the frame.

This function is used by the linux-fb port to implement managed windows, but it could conceivably be used by X-programs that want to do their own window decorations.

gtk_window_set_mnemonic_modifier ()

void                gtk_window_set_mnemonic_modifier    (GtkWindow *window,
                                                         GdkModifierType modifier);

Sets the mnemonic modifier for this window.

gtk_window_set_type_hint ()

void                gtk_window_set_type_hint            (GtkWindow *window,
                                                         GdkWindowTypeHint hint);

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 function should be called before the window becomes visible.

gtk_dialog_new_with_buttons() and other convenience functions in GTK+ will sometimes call gtk_window_set_type_hint() on your behalf.

gtk_window_set_skip_taskbar_hint ()

void                gtk_window_set_skip_taskbar_hint    (GtkWindow *window,
                                                         gboolean setting);

Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint.

Since 2.2

gtk_window_set_skip_pager_hint ()

void                gtk_window_set_skip_pager_hint      (GtkWindow *window,
                                                         gboolean setting);

Windows may set a hint asking the desktop environment not to display the window in the pager. This function sets this hint. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.)

Since 2.2

gtk_window_set_urgency_hint ()

void                gtk_window_set_urgency_hint         (GtkWindow *window,
                                                         gboolean setting);

Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint.

Since 2.8

gtk_window_set_accept_focus ()

void                gtk_window_set_accept_focus         (GtkWindow *window,
                                                         gboolean setting);

Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint.

Since 2.4

gtk_window_set_focus_on_map ()

void                gtk_window_set_focus_on_map         (GtkWindow *window,
                                                         gboolean setting);

Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. This function sets this hint.

Since 2.6

gtk_window_set_startup_id ()

void                gtk_window_set_startup_id           (GtkWindow *window,
                                                         const gchar *startup_id);

Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GdkWindow. Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling gtk_window_present() or any equivalent function generating a window map event.

This function is only useful on X11, not with other GTK+ targets.

Since 2.12

gtk_window_set_role ()

void                gtk_window_set_role                 (GtkWindow *window,
                                                         const gchar *role);

This function 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 window 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 identify the window when restoring the session.

gtk_window_get_decorated ()

gboolean            gtk_window_get_decorated            (GtkWindow *window);

Returns whether the window has been set to have decorations such as a title bar via gtk_window_set_decorated().

gtk_window_get_deletable ()

gboolean            gtk_window_get_deletable            (GtkWindow *window);

Returns whether the window has been set to have a close button via gtk_window_set_deletable().

Since 2.10

gtk_window_get_default_icon_list ()

GList*              gtk_window_get_default_icon_list    (void);

Gets the value set by gtk_window_set_default_icon_list(). The list is a copy and should be freed with g_list_free(), but the pixbufs in the list have not had their reference count incremented.

gtk_window_get_default_icon_name ()

gchar *             gtk_window_get_default_icon_name    (void);

Returns the fallback icon name for windows that has been set with gtk_window_set_default_icon_name(). The returned string is owned by GTK+ and should not be modified. It is only valid until the next call to gtk_window_set_default_icon_name().

Since 2.16

gtk_window_get_default_size ()

void                gtk_window_get_default_size         (GtkWindow *window,
                                                         gint *width,
                                                         gint *height);

Gets the default size of the window. 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.

gtk_window_get_destroy_with_parent ()

gboolean            gtk_window_get_destroy_with_parent  (GtkWindow *window);

Returns whether the window will be destroyed with its transient parent. See gtk_window_set_destroy_with_parent().

gtk_window_get_frame_dimensions ()

void                gtk_window_get_frame_dimensions     (GtkWindow *window,
                                                         gint *left,
                                                         gint *top,
                                                         gint *right,
                                                         gint *bottom);

(Note: this is a special-purpose function intended for the framebuffer port; see gtk_window_set_has_frame(). 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 gdk_window_get_frame_extents() to get the standard window border extents.)

Retrieves the dimensions of the frame window for this toplevel. See gtk_window_set_has_frame(), gtk_window_set_frame_dimensions().

gtk_window_get_has_frame ()

gboolean            gtk_window_get_has_frame            (GtkWindow *window);

Accessor for whether the window has a frame window exterior to window->window. Gets the value set by gtk_window_set_has_frame().

gtk_window_get_icon ()

GdkPixbuf*          gtk_window_get_icon                 (GtkWindow *window);

Gets the value set by gtk_window_set_icon() (or if you've called gtk_window_set_icon_list(), gets the first icon in the icon list).

gtk_window_get_icon_list ()

GList*              gtk_window_get_icon_list            (GtkWindow *window);

Retrieves the list of icons set by gtk_window_set_icon_list(). The list is copied, but the reference count on each member won't be incremented.

gtk_window_get_icon_name ()

gchar *             gtk_window_get_icon_name            (GtkWindow *window);

Returns the name of the themed icon for the window, see gtk_window_set_icon_name().

Since 2.6

gtk_window_get_mnemonic_modifier ()

GdkModifierType     gtk_window_get_mnemonic_modifier    (GtkWindow *window);

Returns the mnemonic modifier for this window. See gtk_window_set_mnemonic_modifier().

gtk_window_get_modal ()

gboolean            gtk_window_get_modal                (GtkWindow *window);

Returns whether the window is modal. See gtk_window_set_modal().

gtk_window_get_position ()

void                gtk_window_get_position             (GtkWindow *window,
                                                         gint *root_x,
                                                         gint *root_y);

This function returns the position you need to pass to gtk_window_move() to keep window in its current position. This means that the meaning of the returned value varies with window gravity. See gtk_window_move() for more details.

If you haven't changed the window gravity, its gravity will be GDK_GRAVITY_NORTH_WEST. This means that gtk_window_get_position() gets the position of the top-left corner of the window manager frame for the window. gtk_window_move() sets the position of this same top-left corner.

gtk_window_get_position() 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.

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 gtk_window_get_position() tends to result in moving the window 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 gtk_window_get_position() 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 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.

gtk_window_get_role ()

const gchar *       gtk_window_get_role                 (GtkWindow *window);

Returns the role of the window. See gtk_window_set_role() for further explanation.

gtk_window_get_size ()

void                gtk_window_get_size                 (GtkWindow *window,
                                                         gint *width,
                                                         gint *height);

Obtains the current size of window. 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 gtk_window_get_size() 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 gtk_window_resize() then immediately call gtk_window_get_size(), 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 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 "configure-event" on the window and adjust your size-dependent state to match the size delivered in the GdkEventConfigure.

Note 2: The returned size does not include the size of the window manager decorations (aka the window frame or border). Those are not drawn by GTK+ and GTK+ has no reliable method of determining their size.

Note 3: If you are getting a window size in order to position the window onscreen, there may be a better way. The preferred way is to simply set the window's semantic type with gtk_window_set_type_hint(), which allows the window manager to e.g. center dialogs. Also, if you set the transient parent of dialogs with gtk_window_set_transient_for() window managers will often center the dialog over its parent window. It's much preferred to let the window manager handle these things rather than doing it yourself, because all apps will behave consistently and according to user prefs if the window manager handles it. Also, the window manager can take the size of the window decorations/border into account, while your application cannot.

In any case, if you insist on application-specified window positioning, there's still a better way than doing it yourself - gtk_window_set_position() will frequently handle the details for you.

gtk_window_get_title ()

const gchar *       gtk_window_get_title                (GtkWindow *window);

Retrieves the title of the window. See gtk_window_set_title().

gtk_window_get_transient_for ()

GtkWindow *         gtk_window_get_transient_for        (GtkWindow *window);

Fetches the transient parent for this window. See gtk_window_set_transient_for().

gtk_window_get_type_hint ()

GdkWindowTypeHint   gtk_window_get_type_hint            (GtkWindow *window);

Gets the type hint for this window. See gtk_window_set_type_hint().

gtk_window_get_skip_taskbar_hint ()

gboolean            gtk_window_get_skip_taskbar_hint    (GtkWindow *window);

Gets the value set by gtk_window_set_skip_taskbar_hint()

Since 2.2

gtk_window_get_skip_pager_hint ()

gboolean            gtk_window_get_skip_pager_hint      (GtkWindow *window);

Gets the value set by gtk_window_set_skip_pager_hint().

Since 2.2

gtk_window_get_urgency_hint ()

gboolean            gtk_window_get_urgency_hint         (GtkWindow *window);

Gets the value set by gtk_window_set_urgency_hint()

Since 2.8

gtk_window_get_accept_focus ()

gboolean            gtk_window_get_accept_focus         (GtkWindow *window);

Gets the value set by gtk_window_set_accept_focus().

Since 2.4

gtk_window_get_focus_on_map ()

gboolean            gtk_window_get_focus_on_map         (GtkWindow *window);

Gets the value set by gtk_window_set_focus_on_map().

Since 2.6

gtk_window_get_group ()

GtkWindowGroup *    gtk_window_get_group                (GtkWindow *window);

Returns the group for window or the default group, if window is NULL or if window does not have an explicit window group.

Since 2.10

gtk_window_get_window_type ()

GtkWindowType       gtk_window_get_window_type          (GtkWindow *window);

Gets the type of the window. See GtkWindowType.

Since 2.20

gtk_window_move ()

void                gtk_window_move                     (GtkWindow *window,
                                                         gint x,
                                                         gint y);

Asks the window manager to move window to the given position. 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.

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.

By default the gravity is GDK_GRAVITY_NORTH_WEST, so the reference point is simply the x, y supplied to gtk_window_move(). The top-left corner of the window decorations (aka window frame or border) will be placed at x, y. 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.

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. So, to place a window in the bottom right corner you would first set gravity to south east, then write: gtk_window_move (window, gdk_screen_width() - window_width, gdk_screen_height() - window_height) (note that this example does not take multi-head scenarios into account).

The Extended Window Manager Hints specification at http://www.freedesktop.org/Standards/wm-spec has a nice table of gravities in the "implementation notes" section.

The gtk_window_get_position() documentation may also be relevant.

gtk_window_parse_geometry ()

gboolean            gtk_window_parse_geometry           (GtkWindow *window,
                                                         const gchar *geometry);

Parses a standard X Window System geometry string - see the manual page for X (type 'man X') for details on this. gtk_window_parse_geometry() 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, gtk_window_parse_geometry() returns TRUE and calls gtk_window_set_default_size() and/or gtk_window_move() to resize/move the window.

If gtk_window_parse_geometry() returns TRUE, 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.

Note that for gtk_window_parse_geometry() to work as expected, it has to be called when the window has its "final" size, i.e. after calling gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints() on the window.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

#include <gtk/gtk.h>
   
static void
fill_with_content (GtkWidget *vbox)
{
  /* fill with content... */
}
   
int
main (int argc, char *argv[])
{
  GtkWidget *window, *vbox;
  GdkGeometry size_hints = {
    100, 50, 0, 0, 100, 50, 10, 10, 0.0, 0.0, GDK_GRAVITY_NORTH_WEST  
  };
   
  gtk_init (&argc, &argv);
  
  window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  vbox = gtk_vbox_new (FALSE, 0);
  
  gtk_container_add (GTK_CONTAINER (window), vbox);
  fill_with_content (vbox);
  gtk_widget_show_all (vbox);
  
  gtk_window_set_geometry_hints (GTK_WINDOW (window),
	  			    window,
				    &size_hints,
				    GDK_HINT_MIN_SIZE | 
				    GDK_HINT_BASE_SIZE | 
				    GDK_HINT_RESIZE_INC);
  
  if (argc > 1)
    {
      if (!gtk_window_parse_geometry (GTK_WINDOW (window), argv[1]))
        fprintf (stderr, "Failed to parse '%s'\n", argv[1]);
    }
   
  gtk_widget_show_all (window);
  gtk_main ();
   
  return 0;
}

gtk_window_reshow_with_initial_size ()

void                gtk_window_reshow_with_initial_size (GtkWindow *window);

Hides window, then reshows it, resetting the default size and position of the window. Used by GUI builders only.

gtk_window_resize ()

void                gtk_window_resize                   (GtkWindow *window,
                                                         gint width,
                                                         gint height);

Resizes the window as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call gtk_widget_set_size_request() to set the window's request to a smaller value.

If gtk_window_resize() is called before showing a window for the first time, it overrides any default size set with gtk_window_set_default_size().

Windows may not be resized smaller than 1 by 1 pixels.

gtk_window_set_default_icon_list ()

void                gtk_window_set_default_icon_list    (GList *list);

Sets an icon list to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.

See gtk_window_set_icon_list() for more details.

gtk_window_set_default_icon ()

void                gtk_window_set_default_icon         (GdkPixbuf *icon);

Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon() called on them from a pixbuf.

Since 2.4

gtk_window_set_default_icon_from_file ()

gboolean            gtk_window_set_default_icon_from_file
                                                        (const gchar *filename,
                                                         GError **err);

Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them from a file on disk. Warns on failure if err is NULL.

Since 2.2

gtk_window_set_default_icon_name ()

void                gtk_window_set_default_icon_name    (const gchar *name);

Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them from a named themed icon, see gtk_window_set_icon_name().

Since 2.6

gtk_window_set_icon ()

void                gtk_window_set_icon                 (GtkWindow *window,
                                                         GdkPixbuf *icon);

Sets up the icon representing a GtkWindow. This icon is used when the window 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.

The icon should be provided in whatever size it was naturally drawn; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

If you have your icon hand-drawn in multiple sizes, use gtk_window_set_icon_list(). Then the best size will be used.

This function is equivalent to calling gtk_window_set_icon_list() with a 1-element list.

See also gtk_window_set_default_icon_list() to set the icon for all windows in your application in one go.

gtk_window_set_icon_list ()

void                gtk_window_set_icon_list            (GtkWindow *window,
                                                         GList *list);

Sets up the icon representing a GtkWindow. The icon is used when the window 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.

gtk_window_set_icon_list() allows you to pass in 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 until 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.

See also gtk_window_set_default_icon_list() to set the icon for all windows in your application in one go.

Note that transient windows (those who have been set transient for another window using gtk_window_set_transient_for()) will inherit their icon from their transient parent. So there's no need to explicitly set the icon on transient windows.

gtk_window_set_icon_from_file ()

gboolean            gtk_window_set_icon_from_file       (GtkWindow *window,
                                                         const gchar *filename,
                                                         GError **err);

Sets the icon for window. Warns on failure if err is NULL.

This function is equivalent to calling gtk_window_set_icon() with a pixbuf created by loading the image from filename.

Since 2.2

gtk_window_set_icon_name ()

void                gtk_window_set_icon_name            (GtkWindow *window,
                                                         const gchar *name);

Sets the icon for the window from a named themed icon. See the docs for GtkIconTheme for more details.

Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.

Since 2.6

gtk_window_set_auto_startup_notification ()

void                gtk_window_set_auto_startup_notification
                                                        (gboolean setting);

By default, after showing the first GtkWindow, GTK+ calls gdk_notify_startup_complete(). Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window 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 window would automatically result in notification.

Since 2.2

gtk_window_get_opacity ()

gdouble             gtk_window_get_opacity              (GtkWindow *window);

Fetches the requested opacity for this window. See gtk_window_set_opacity().

Since 2.12

gtk_window_set_opacity ()

void                gtk_window_set_opacity              (GtkWindow *window,
                                                         gdouble opacity);

Request the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See gtk_widget_is_composited(). On Windows it should work always.

Note that setting a window's opacity after the window has been shown causes it to flicker once on Windows.

Since 2.12

gtk_window_get_mnemonics_visible ()

gboolean            gtk_window_get_mnemonics_visible    (GtkWindow *window);

gtk_window_set_mnemonics_visible ()

void                gtk_window_set_mnemonics_visible    (GtkWindow *window,
                                                         gboolean setting);

Sets the "mnemonics-visible" property.

Since 2.20

The "accept-focus" property

  "accept-focus"             gboolean              : Read / Write

Whether the window should receive the input focus.

Default value: TRUE

Since 2.4

The "allow-grow" property

  "allow-grow"               gboolean              : Read / Write

If TRUE, users can expand the window beyond its minimum size.

Default value: TRUE

The "allow-shrink" property

  "allow-shrink"             gboolean              : Read / Write

If TRUE, the window has no mimimum size. Setting this to TRUE is 99% of the time a bad idea.

Default value: FALSE

The "decorated" property

  "decorated"                gboolean              : Read / Write

Whether the window should be decorated by the window manager.

Default value: TRUE

Since 2.4

The "default-height" property

  "default-height"           gint                  : Read / Write

The default height of the window, used when initially showing the window.

Allowed values: >= G_MAXULONG

Default value: -1

The "default-width" property

  "default-width"            gint                  : Read / Write

The default width of the window, used when initially showing the window.

Allowed values: >= G_MAXULONG

Default value: -1

The "deletable" property

  "deletable"                gboolean              : Read / Write

Whether the window frame should have a close button.

Default value: TRUE

Since 2.10

The "destroy-with-parent" property

  "destroy-with-parent"      gboolean              : Read / Write

If this window should be destroyed when the parent is destroyed.

Default value: FALSE

The "focus-on-map" property

  "focus-on-map"             gboolean              : Read / Write

Whether the window should receive the input focus when mapped.

Default value: TRUE

Since 2.6

The "gravity" property

  "gravity"                  GdkGravity            : Read / Write

The window gravity of the window. See gtk_window_move() and GdkGravity for more details about window gravity.

Default value: GDK_GRAVITY_NORTH_WEST

Since 2.4

The "has-toplevel-focus" property

  "has-toplevel-focus"       gboolean              : Read

Whether the input focus is within this GtkWindow.

Default value: FALSE

The "icon" property

  "icon"                     GdkPixbuf*            : Read / Write

Icon for this window.

The "icon-name" property

  "icon-name"                gchar*                : Read / Write

The :icon-name property specifies the name of the themed icon to use as the window icon. See GtkIconTheme for more details.

Default value: NULL

Since 2.6

The "is-active" property

  "is-active"                gboolean              : Read

Whether the toplevel is the current active window.

Default value: FALSE

The "mnemonics-visible" property

  "mnemonics-visible"        gboolean              : Read / Write

Whether mnemonics are currently visible in this window.

Default value: TRUE

The "modal" property

  "modal"                    gboolean              : Read / Write

If TRUE, the window is modal (other windows are not usable while this one is up).

Default value: FALSE

The "opacity" property

  "opacity"                  gdouble               : Read / Write

The requested opacity of the window. See gtk_window_set_opacity() for more details about window opacity.

Allowed values: [0,1]

Default value: 1

Since 2.12

The "resizable" property

  "resizable"                gboolean              : Read / Write

If TRUE, users can resize the window.

Default value: TRUE

The "role" property

  "role"                     gchar*                : Read / Write

Unique identifier for the window to be used when restoring a session.

Default value: NULL

The "screen" property

  "screen"                   GdkScreen*            : Read / Write

The screen where this window will be displayed.

The "skip-pager-hint" property

  "skip-pager-hint"          gboolean              : Read / Write

TRUE if the window should not be in the pager.

Default value: FALSE

The "skip-taskbar-hint" property

  "skip-taskbar-hint"        gboolean              : Read / Write

TRUE if the window should not be in the task bar.

Default value: FALSE

The "startup-id" property

  "startup-id"               gchar*                : Write

The :startup-id is a write-only property for setting window's startup notification identifier. See gtk_window_set_startup_id() for more details.

Default value: NULL

Since 2.12

The "title" property

  "title"                    gchar*                : Read / Write

The title of the window.

Default value: NULL

The "transient-for" property

  "transient-for"            GtkWindow*            : Read / Write / Construct

The transient parent of the window. See gtk_window_set_transient_for() for more details about transient windows.

Since 2.10

The "type" property

  "type"                     GtkWindowType         : Read / Write / Construct Only

The type of the window.

Default value: GTK_WINDOW_TOPLEVEL

The "type-hint" property

  "type-hint"                GdkWindowTypeHint     : Read / Write

Hint to help the desktop environment understand what kind of window this is and how to treat it.

Default value: GDK_WINDOW_TYPE_HINT_NORMAL

The "urgency-hint" property

  "urgency-hint"             gboolean              : Read / Write

TRUE if the window should be brought to the user's attention.

Default value: FALSE

The "window-position" property

  "window-position"          GtkWindowPosition     : Read / Write

The initial position of the window.

Default value: GTK_WIN_POS_NONE

The "activate-default" signal

void                user_function                      (GtkWindow *window,
                                                        gpointer   user_data)      : Run Last / Action

The ::activate-default signal is a keybinding signal which gets emitted when the user activates the default widget of window.

The "activate-focus" signal

void                user_function                      (GtkWindow *window,
                                                        gpointer   user_data)      : Run Last / Action

The ::activate-default signal is a keybinding signal which gets emitted when the user activates the currently focused widget of window.

The "frame-event" signal

gboolean            user_function                      (GtkWindow *window,
                                                        GdkEvent  *event,
                                                        gpointer   user_data)      : Run Last

The "keys-changed" signal

void                user_function                      (GtkWindow *window,
                                                        gpointer   user_data)      : Run First

The ::keys-changed signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.

The "set-focus" signal

void                user_function                      (GtkWindow *window,
                                                        GtkWidget *widget,
                                                        gpointer   user_data)      : Run Last