GtkWindow
<!-- ##### SECTION Short_Description ##### -->
-
+Toplevel which can contain other widgets
<!-- ##### SECTION Long_Description ##### -->
<para>
<orderedlist>
<listitem>
<para>
-<literal>gtk_window_set_policy(GTK_WINDOW(window), FALSE, TRUE, FALSE)</literal>
+<literal>gtk_window_set_policy (GTK_WINDOW (window), FALSE, TRUE, FALSE)</literal>
means that the window is user-resizable.
</para>
</listitem>
<listitem>
<para>
-<literal>gtk_window_set_policy(GTK_WINDOW(window), FALSE, FALSE, TRUE)</literal>
+<literal>gtk_window_set_policy (GTK_WINDOW (window), FALSE, FALSE, TRUE)</literal>
means that the window's size is program-controlled, and should simply match
the current size request of the window's children.
</para>
<para>
The basic ugly truth of this function is that it should be simply:
-<programlisting>
- void gtk_window_set_user_resizeable(GtkWidget* window, gboolean setting);
-</programlisting>
-So, pretend it is like that, and only use the two policies mentioned above.
-GTK+ 1.4 may replace gtk_window_set_policy() with a nicer function like
-gtk_window_set_user_resizeable().
+<literal>
+ void gtk_window_set_resizable (GtkWindow* window, gboolean setting);
+</literal>
+...which is why GTK+ 2.0 introduces gtk_window_set_resizable(), which you
+should use instead of gtk_window_set_policy().
</para>
<para>
-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
+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.
</para>
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
+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.
</para>
<para>
Note that @auto_shrink doesn't do anything if @allow_shrink and @allow_grow are
-both set to FALSE.
+both set to %FALSE.
</para>
<para>
-Neither of the two suggested window policies set the @allow_shrink paramter to
-TRUE. If @allow_shrink is TRUE, the user can shrink the window so that its
+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.
+upshot is that @allow_shrink should always be set to %FALSE.
</para>
<para>
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_usize()
+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.
@window: the window
@allow_shrink: whether the user can shrink the window below its size request
@allow_grow: whether the user can grow the window larger than its size request
-@auto_shrink: whether the window automatically snaps back to its size request if
-it's larger
+@auto_shrink: whether the window automatically snaps back to its size request
+ if it's larger
+@Deprecated: Use gtk_window_set_resizable() instead.
+
+
+<!-- ##### FUNCTION gtk_window_set_resizable ##### -->
+<para>
+
+</para>
+
+@window:
+@resizable:
+
+
+<!-- ##### FUNCTION gtk_window_get_resizable ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
<!-- ##### FUNCTION gtk_window_add_accel_group ##### -->
<!-- ##### MACRO gtk_window_position ##### -->
<para>
-
+Deprecated alias for gtk_window_set_position().
</para>
@geom_mask:
+<!-- ##### FUNCTION gtk_window_set_gravity ##### -->
+<para>
+
+</para>
+
+@window:
+@gravity:
+
+
+<!-- ##### FUNCTION gtk_window_get_gravity ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
<!-- ##### FUNCTION gtk_window_set_position ##### -->
<para>
@setting:
+<!-- ##### FUNCTION gtk_window_set_screen ##### -->
+<para>
+
+</para>
+
+@window:
+@screen:
+
+
+<!-- ##### FUNCTION gtk_window_get_screen ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
<!-- ##### FUNCTION gtk_window_list_toplevels ##### -->
<para>
@target:
-<!-- ##### FUNCTION gtk_window_deiconify ##### -->
+<!-- ##### FUNCTION gtk_window_remove_mnemonic ##### -->
+<para>
+
+</para>
+
+@window:
+@keyval:
+@target:
+
+
+<!-- ##### FUNCTION gtk_window_mnemonic_activate ##### -->
+<para>
+
+</para>
+
+@window:
+@keyval:
+@modifier:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_focus ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_set_focus ##### -->
+<para>
+
+</para>
+
+@window:
+@focus:
+
+
+<!-- ##### FUNCTION gtk_window_set_default ##### -->
+<para>
+
+</para>
+
+@window:
+@default_widget:
+
+
+<!-- ##### FUNCTION gtk_window_present ##### -->
<para>
</para>
@window:
+<!-- ##### FUNCTION gtk_window_deiconify ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION gtk_window_stick ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION gtk_window_unstick ##### -->
+<para>
+
+</para>
+
+@window:
+
+
<!-- ##### FUNCTION gtk_window_maximize ##### -->
<para>
@window:
-<!-- ##### FUNCTION gtk_window_present ##### -->
+<!-- ##### FUNCTION gtk_window_unmaximize ##### -->
<para>
</para>
@window:
-<!-- ##### FUNCTION gtk_window_remove_mnemonic ##### -->
+<!-- ##### FUNCTION gtk_window_fullscreen ##### -->
<para>
</para>
@window:
-@keyval:
-@target:
-<!-- ##### FUNCTION gtk_window_set_decorated ##### -->
+<!-- ##### FUNCTION gtk_window_unfullscreen ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION gtk_window_set_keep_above ##### -->
<para>
</para>
@setting:
-<!-- ##### FUNCTION gtk_window_set_decorations_hint ##### -->
+<!-- ##### FUNCTION gtk_window_set_keep_below ##### -->
<para>
</para>
@window:
-@decorations:
+@setting:
-<!-- ##### FUNCTION gtk_window_set_frame_dimensions ##### -->
+<!-- ##### FUNCTION gtk_window_begin_resize_drag ##### -->
<para>
</para>
@window:
-@left:
-@top:
-@right:
-@bottom:
+@edge:
+@button:
+@root_x:
+@root_y:
+@timestamp:
+
+
+<!-- ##### FUNCTION gtk_window_begin_move_drag ##### -->
+<para>
+
+</para>
+
+@window:
+@button:
+@root_x:
+@root_y:
+@timestamp:
-<!-- ##### FUNCTION gtk_window_set_functions_hint ##### -->
+<!-- ##### FUNCTION gtk_window_set_decorated ##### -->
+<para>
+
+</para>
+
+@window:
+@setting:
+
+
+<!-- ##### FUNCTION gtk_window_set_frame_dimensions ##### -->
<para>
</para>
@window:
-@functions:
+@left:
+@top:
+@right:
+@bottom:
<!-- ##### FUNCTION gtk_window_set_has_frame ##### -->
</para>
@window:
+@setting:
<!-- ##### FUNCTION gtk_window_set_mnemonic_modifier ##### -->
@hint:
-<!-- ##### FUNCTION gtk_window_stick ##### -->
+<!-- ##### FUNCTION gtk_window_set_skip_taskbar_hint ##### -->
<para>
</para>
@window:
+@setting:
-<!-- ##### FUNCTION gtk_window_unmaximize ##### -->
+<!-- ##### FUNCTION gtk_window_set_skip_pager_hint ##### -->
<para>
</para>
@window:
+@setting:
-<!-- ##### FUNCTION gtk_window_unstick ##### -->
+<!-- ##### FUNCTION gtk_window_get_decorated ##### -->
<para>
</para>
@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_default_icon_list ##### -->
+<para>
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_default_size ##### -->
+<para>
+
+</para>
+
+@window:
+@width:
+@height:
+
+
+<!-- ##### FUNCTION gtk_window_get_destroy_with_parent ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_frame_dimensions ##### -->
+<para>
+
+</para>
+
+@window:
+@left:
+@top:
+@right:
+@bottom:
+
+
+<!-- ##### FUNCTION gtk_window_get_has_frame ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_icon ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_icon_list ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_mnemonic_modifier ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_modal ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_position ##### -->
+<para>
+
+</para>
+
+@window:
+@root_x:
+@root_y:
+<!-- # Unused Parameters # -->
+@x:
+@y:
+
+
+<!-- ##### FUNCTION gtk_window_get_role ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_size ##### -->
+<para>
+
+</para>
+
+@window:
+@width:
+@height:
+
+
+<!-- ##### FUNCTION gtk_window_get_title ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_transient_for ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_type_hint ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_skip_taskbar_hint ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_get_skip_pager_hint ##### -->
+<para>
+
+</para>
+
+@window:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_move ##### -->
+<para>
+
+</para>
+
+@window:
+@x:
+@y:
+
+
+<!-- ##### FUNCTION gtk_window_parse_geometry ##### -->
+<para>
+
+</para>
+
+@window:
+@geometry:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_reshow_with_initial_size ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION gtk_window_resize ##### -->
+<para>
+
+</para>
+
+@window:
+@width:
+@height:
+
+
+<!-- ##### FUNCTION gtk_window_set_default_icon_list ##### -->
+<para>
+
+</para>
+
+@list:
+
+
+<!-- ##### FUNCTION gtk_window_set_default_icon ##### -->
+<para>
+
+</para>
+
+@icon:
+<!-- # Unused Parameters # -->
+@pixbuf:
+
+
+<!-- ##### FUNCTION gtk_window_set_default_icon_from_file ##### -->
+<para>
+
+</para>
+
+@filename:
+@err:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_set_icon ##### -->
+<para>
+
+</para>
+
+@window:
+@icon:
+
+
+<!-- ##### FUNCTION gtk_window_set_icon_list ##### -->
+<para>
+
+</para>
+
+@window:
+@list:
+
+
+<!-- ##### FUNCTION gtk_window_set_icon_from_file ##### -->
+<para>
+
+</para>
+
+@window:
+@filename:
+@err:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_window_set_auto_startup_notification ##### -->
+<para>
+
+</para>
+
+@setting:
+
+
+<!-- ##### FUNCTION gtk_decorated_window_init ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION gtk_decorated_window_calculate_frame_size ##### -->
+<para>
+
+</para>
+
+@window:
+
+
+<!-- ##### FUNCTION gtk_decorated_window_set_title ##### -->
+<para>
+
+</para>
+
+@window:
+@title:
+
+
+<!-- ##### FUNCTION gtk_decorated_window_move_resize_window ##### -->
+<para>
+
+</para>
+
+@window:
+@x:
+@y:
+@width:
+@height:
+
+
+<!-- ##### SIGNAL GtkWindow::activate-default ##### -->
+<para>
+
+</para>
+
+@window: the object which received the signal.
+
+<!-- ##### SIGNAL GtkWindow::activate-focus ##### -->
+<para>
+
+</para>
+
+@window: the object which received the signal.
<!-- ##### SIGNAL GtkWindow::frame-event ##### -->
<para>
@event:
@Returns:
+<!-- ##### SIGNAL GtkWindow::keys-changed ##### -->
+<para>
+
+</para>
+
+@window: the object which received the signal.
+
+<!-- ##### SIGNAL GtkWindow::move-focus ##### -->
+<para>
+
+</para>
+
+@window: the object which received the signal.
+@arg1:
+
<!-- ##### SIGNAL GtkWindow::set-focus ##### -->
<para>
@window: the object which received the signal.
@widget:
-<!-- ##### ARG GtkWindow:type ##### -->
+<!-- ##### ARG GtkWindow:allow-grow ##### -->
<para>
-The type of the window.
+
</para>
-<!-- ##### ARG GtkWindow:title ##### -->
+<!-- ##### ARG GtkWindow:allow-shrink ##### -->
<para>
-The title of the window.
+
</para>
-<!-- ##### ARG GtkWindow:auto-shrink ##### -->
+<!-- ##### ARG GtkWindow:decorated ##### -->
<para>
-If the window shrinks automatically when widgets within it shrink.
+
</para>
-<!-- ##### ARG GtkWindow:allow-shrink ##### -->
+<!-- ##### ARG GtkWindow:default-height ##### -->
<para>
-If the window can be resized to a smaller size by the user.
+
</para>
-<!-- ##### ARG GtkWindow:allow-grow ##### -->
+<!-- ##### ARG GtkWindow:default-width ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:destroy-with-parent ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:gravity ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:has-toplevel-focus ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:icon ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:is-active ##### -->
<para>
-If the window can be resized to a larger size by the user.
+
</para>
<!-- ##### ARG GtkWindow:modal ##### -->
<para>
-If the window is modal, i.e. it grabs all GTK+ events.
+
</para>
-<!-- ##### ARG GtkWindow:window-position ##### -->
+<!-- ##### ARG GtkWindow:resizable ##### -->
<para>
-The position of the window.
+
</para>
-<!-- ##### ARG GtkWindow:default-width ##### -->
+<!-- ##### ARG GtkWindow:role ##### -->
<para>
</para>
-<!-- ##### ARG GtkWindow:default-height ##### -->
+<!-- ##### ARG GtkWindow:screen ##### -->
<para>
</para>
-<!-- ##### ARG GtkWindow:destroy-with-parent ##### -->
+<!-- ##### ARG GtkWindow:skip-pager-hint ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:skip-taskbar-hint ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:title ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:type ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:type-hint ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkWindow:window-position ##### -->
<para>
</para>
projects / ~andy / gtk / blobdiff