]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtkwindow.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtkwindow.sgml
index 0ee26fbb5fa10aab57bcc404ceec47f36a2aea5d..07c39b05b85dda08833a471b1a45a64278406974 100644 (file)
@@ -8,12 +8,41 @@ Toplevel which can contain other widgets
 <para>
 
 </para>
+<refsect2 id="GtkWindow-BUILDER-UI">
+<title>GtkWindow as GtkBuildable</title>
+<para>
+The GtkWindow implementation of the GtkBuildable interface supports a 
+custom &lt;accel-groups&gt; element, which supports any number of &lt;group&gt;
+elements representing the GtkAccelGroup objects you want to add to your
+window (synonymous with gtk_window_add_accel_group().
+</para>
+<example>
+<title>A UI definition fragment with accel groups</title>
+<programlisting><![CDATA[
+<object class="GtkWindow">
+  <accel-groups>
+    <group name="accelgroup1"/>
+  </accel-groups>
+</object>
+
+...
+
+<object class="GtkAccelGroup" id="accelgroup1"/>
+]]></programlisting>
+</example>
+</refsect2>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### STRUCT GtkWindow ##### -->
 <para>
 
@@ -50,22 +79,19 @@ Toplevel which can contain other widgets
 
 @window: the object which received the signal.
 
-<!-- ##### SIGNAL GtkWindow::move-focus ##### -->
+<!-- ##### SIGNAL GtkWindow::set-focus ##### -->
 <para>
 
 </para>
 
 @window: the object which received the signal.
-@arg1
+@widget
 
-<!-- ##### SIGNAL GtkWindow::set-focus ##### -->
+<!-- ##### ARG GtkWindow:accept-focus ##### -->
 <para>
 
 </para>
 
-@window: the object which received the signal.
-@widget: 
-
 <!-- ##### ARG GtkWindow:allow-grow ##### -->
 <para>
 
@@ -91,11 +117,21 @@ Toplevel which can contain other widgets
 
 </para>
 
+<!-- ##### ARG GtkWindow:deletable ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:destroy-with-parent ##### -->
 <para>
 
 </para>
 
+<!-- ##### ARG GtkWindow:focus-on-map ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:gravity ##### -->
 <para>
 
@@ -111,16 +147,31 @@ Toplevel which can contain other widgets
 
 </para>
 
+<!-- ##### ARG GtkWindow:icon-name ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:is-active ##### -->
 <para>
 
 </para>
 
+<!-- ##### ARG GtkWindow:mnemonics-visible ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:modal ##### -->
 <para>
 
 </para>
 
+<!-- ##### ARG GtkWindow:opacity ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:resizable ##### -->
 <para>
 
@@ -146,11 +197,21 @@ Toplevel which can contain other widgets
 
 </para>
 
+<!-- ##### ARG GtkWindow:startup-id ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:title ##### -->
 <para>
 
 </para>
 
+<!-- ##### ARG GtkWindow:transient-for ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:type ##### -->
 <para>
 
@@ -161,6 +222,11 @@ Toplevel which can contain other widgets
 
 </para>
 
+<!-- ##### ARG GtkWindow:urgency-hint ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkWindow:window-position ##### -->
 <para>
 
@@ -194,86 +260,6 @@ Toplevel which can contain other widgets
 @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>
 
@@ -310,13 +296,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>
-
-
-
 <!-- ##### FUNCTION gtk_window_activate_focus ##### -->
 <para>
 
@@ -428,11 +407,30 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_is_active ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_has_toplevel_focus ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_window_list_toplevels ##### -->
 <para>
 
 </para>
 
+@void: 
 @Returns: 
 
 
@@ -467,6 +465,26 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_activate_key ##### -->
+<para>
+
+</para>
+
+@window: 
+@event: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_propagate_key_event ##### -->
+<para>
+
+</para>
+
+@window: 
+@event: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_window_get_focus ##### -->
 <para>
 
@@ -485,6 +503,15 @@ Deprecated alias for gtk_window_set_position().
 @focus: 
 
 
+<!-- ##### FUNCTION gtk_window_get_default_widget ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_window_set_default ##### -->
 <para>
 
@@ -502,6 +529,15 @@ Deprecated alias for gtk_window_set_position().
 @window: 
 
 
+<!-- ##### FUNCTION gtk_window_present_with_time ##### -->
+<para>
+
+</para>
+
+@window: 
+@timestamp: 
+
+
 <!-- ##### FUNCTION gtk_window_iconify ##### -->
 <para>
 
@@ -618,6 +654,15 @@ Deprecated alias for gtk_window_set_position().
 @setting: 
 
 
+<!-- ##### FUNCTION gtk_window_set_deletable ##### -->
+<para>
+
+</para>
+
+@window: 
+@setting: 
+
+
 <!-- ##### FUNCTION gtk_window_set_frame_dimensions ##### -->
 <para>
 
@@ -648,25 +693,25 @@ Deprecated alias for gtk_window_set_position().
 @modifier: 
 
 
-<!-- ##### FUNCTION gtk_window_set_role ##### -->
+<!-- ##### FUNCTION gtk_window_set_type_hint ##### -->
 <para>
 
 </para>
 
 @window: 
-@role
+@hint
 
 
-<!-- ##### FUNCTION gtk_window_set_type_hint ##### -->
+<!-- ##### FUNCTION gtk_window_set_skip_taskbar_hint ##### -->
 <para>
 
 </para>
 
 @window: 
-@hint
+@setting
 
 
-<!-- ##### FUNCTION gtk_window_set_skip_taskbar_hint ##### -->
+<!-- ##### FUNCTION gtk_window_set_skip_pager_hint ##### -->
 <para>
 
 </para>
@@ -675,7 +720,7 @@ Deprecated alias for gtk_window_set_position().
 @setting: 
 
 
-<!-- ##### FUNCTION gtk_window_set_skip_pager_hint ##### -->
+<!-- ##### FUNCTION gtk_window_set_urgency_hint ##### -->
 <para>
 
 </para>
@@ -684,6 +729,42 @@ Deprecated alias for gtk_window_set_position().
 @setting: 
 
 
+<!-- ##### FUNCTION gtk_window_set_accept_focus ##### -->
+<para>
+
+</para>
+
+@window: 
+@setting: 
+
+
+<!-- ##### FUNCTION gtk_window_set_focus_on_map ##### -->
+<para>
+
+</para>
+
+@window: 
+@setting: 
+
+
+<!-- ##### FUNCTION gtk_window_set_startup_id ##### -->
+<para>
+
+</para>
+
+@window: 
+@startup_id: 
+
+
+<!-- ##### FUNCTION gtk_window_set_role ##### -->
+<para>
+
+</para>
+
+@window: 
+@role: 
+
+
 <!-- ##### FUNCTION gtk_window_get_decorated ##### -->
 <para>
 
@@ -693,11 +774,30 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_get_deletable ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_window_get_default_icon_list ##### -->
 <para>
 
 </para>
 
+@void: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_get_default_icon_name ##### -->
+<para>
+
+</para>
+
+@void: 
 @Returns: 
 
 
@@ -759,6 +859,15 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_get_icon_name ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_window_get_mnemonic_modifier ##### -->
 <para>
 
@@ -785,9 +894,6 @@ Deprecated alias for gtk_window_set_position().
 @window: 
 @root_x: 
 @root_y: 
-<!-- # Unused Parameters # -->
-@x: 
-@y: 
 
 
 <!-- ##### FUNCTION gtk_window_get_role ##### -->
@@ -854,6 +960,51 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_get_urgency_hint ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_get_accept_focus ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_get_focus_on_map ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_get_group ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_window_get_window_type ##### -->
+<para>
+
+</para>
+
+@window: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_window_move ##### -->
 <para>
 
@@ -906,8 +1057,6 @@ Deprecated alias for gtk_window_set_position().
 </para>
 
 @icon: 
-<!-- # Unused Parameters # -->
-@pixbuf: 
 
 
 <!-- ##### FUNCTION gtk_window_set_default_icon_from_file ##### -->
@@ -920,6 +1069,14 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_set_default_icon_name ##### -->
+<para>
+
+</para>
+
+@name: 
+
+
 <!-- ##### FUNCTION gtk_window_set_icon ##### -->
 <para>
 
@@ -949,6 +1106,15 @@ Deprecated alias for gtk_window_set_position().
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_window_set_icon_name ##### -->
+<para>
+
+</para>
+
+@window: 
+@name: 
+
+
 <!-- ##### FUNCTION gtk_window_set_auto_startup_notification ##### -->
 <para>
 
@@ -957,40 +1123,39 @@ Deprecated alias for gtk_window_set_position().
 @setting: 
 
 
-<!-- ##### FUNCTION gtk_decorated_window_init ##### -->
+<!-- ##### FUNCTION gtk_window_get_opacity ##### -->
 <para>
 
 </para>
 
 @window: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gtk_decorated_window_calculate_frame_size ##### -->
+<!-- ##### FUNCTION gtk_window_set_opacity ##### -->
 <para>
 
 </para>
 
 @window: 
+@opacity: 
 
 
-<!-- ##### FUNCTION gtk_decorated_window_set_title ##### -->
+<!-- ##### FUNCTION gtk_window_get_mnemonics_visible ##### -->
 <para>
 
 </para>
 
 @window: 
-@title
+@Returns
 
 
-<!-- ##### FUNCTION gtk_decorated_window_move_resize_window ##### -->
+<!-- ##### FUNCTION gtk_window_set_mnemonics_visible ##### -->
 <para>
 
 </para>
 
 @window: 
-@x: 
-@y: 
-@width: 
-@height: 
+@setting: