Remove remaining GtkWindow deprecated documentation

This completes commit 89e3ec8c3d766c333f6e67764ebd7633d61e21cd
This commit is contained in:
Javier Jardón 2009-10-10 20:27:57 +02:00 committed by Javier Jardón
parent 123830b133
commit e606a4ec2a
5 changed files with 2 additions and 92 deletions

View File

@ -257,86 +257,6 @@ window (synonymous with gtk_window_add_accel_group().
@wmclass_class:
<!-- ##### FUNCTION gtk_window_set_policy ##### -->
<para>
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:
<orderedlist>
<listitem>
<para>
<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>
means that the window's size is program-controlled, and should simply match
the current size request of the window's children.
</para>
</listitem>
</orderedlist>
The first policy is the default, that is, by default windows are designed to
be resized by users.
</para>
<para>
The basic ugly truth of this function is that it should be simply:
<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
check that your child widgets work properly as the window is resized.
</para>
<para>
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.
</para>
<para>
Note that @auto_shrink doesn't do anything if @allow_shrink and @allow_grow are
both set to %FALSE.
</para>
<para>
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.
</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_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.
</para>
@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
@Deprecated: Use gtk_window_set_resizable() instead.
<!-- ##### FUNCTION gtk_window_set_resizable ##### -->
<para>
@ -373,14 +293,6 @@ the child gets a larger allocation than it requests.
@accel_group:
<!-- ##### MACRO gtk_window_position ##### -->
<para>
Deprecated alias for gtk_window_set_position().
</para>
@Deprecated: Use gtk_window_set_position() instead.
<!-- ##### FUNCTION gtk_window_activate_focus ##### -->
<para>

View File

@ -6134,7 +6134,7 @@ gint main( gint argc,
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
gtk_window_set_title (GTK_WINDOW (window), "Color selection test");
gtk_window_set_policy (GTK_WINDOW (window), TRUE, TRUE, TRUE);
gtk_window_set_resizable ((GTK_WINDOW (window), TRUE);
/* Attach to the "delete" and "destroy" events so we can exit */

View File

@ -90,7 +90,7 @@ gint main( gint argc,
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
gtk_window_set_title (GTK_WINDOW (window), "Color selection test");
gtk_window_set_policy (GTK_WINDOW (window), TRUE, TRUE, TRUE);
gtk_window_set_resizable (GTK_WINDOW (window), TRUE);
/* Attach to the "delete" and "destroy" events so we can exit */

View File

@ -47,7 +47,6 @@ int main( int argc,
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
gtk_widget_set_size_request (window, 600, 500);
gtk_window_set_policy (GTK_WINDOW (window), TRUE, TRUE, FALSE);
g_signal_connect (G_OBJECT (window), "destroy",
G_CALLBACK (close_application),
NULL);

View File

@ -1666,7 +1666,6 @@ _create_window (void)
{
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
gtk_widget_set_name (window, "Ferret Window");
gtk_window_set_policy (GTK_WINDOW(window), TRUE, TRUE, FALSE);
g_signal_connect (GTK_OBJECT (window), "destroy",
G_CALLBACK (gtk_widget_destroyed),