gtk2/docs/reference/gtk/tmpl/gtkwindow.sgml
Matthias Clasen 7447ef0fc2 Make 3.0 parallel-installable to 2.x
In particular, rename

  - libraries to lib*-3.0.so
  - pc files to *-3.0.pc
  - include paths to /usr/include/gtk-3.0/*
  - module paths to /usr/lib/gtk-3.0/*
  - rc files names to gtk-3.0/gtkrc
  - commandline utilities to *-3.0
  - adjust documentation

Also change the install location for unix-print headers to
/usr/include/gtk-3.0/unix-print/gtk.
2010-05-08 01:18:53 -04:00

1162 lines
13 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkWindow
<!-- ##### SECTION Short_Description ##### -->
Toplevel which can contain other widgets
<!-- ##### SECTION Long_Description ##### -->
<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>
</para>
<!-- ##### 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>
</para>
@window: the object which received the signal.
@event:
@Returns:
<!-- ##### SIGNAL GtkWindow::keys-changed ##### -->
<para>
</para>
@window: the object which received the signal.
<!-- ##### SIGNAL GtkWindow::set-focus ##### -->
<para>
</para>
@window: the object which received the signal.
@widget:
<!-- ##### ARG GtkWindow:accept-focus ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:allow-grow ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:allow-shrink ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:decorated ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:default-height ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:default-width ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:deletable ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:destroy-with-parent ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:focus-on-map ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:gravity ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:has-toplevel-focus ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:icon ##### -->
<para>
</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>
</para>
<!-- ##### ARG GtkWindow:role ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:screen ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:skip-pager-hint ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:skip-taskbar-hint ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:startup-id ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:title ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:transient-for ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:type ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:type-hint ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:urgency-hint ##### -->
<para>
</para>
<!-- ##### ARG GtkWindow:window-position ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_window_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gtk_window_set_title ##### -->
<para>
</para>
@window:
@title:
<!-- ##### FUNCTION gtk_window_set_wmclass ##### -->
<para>
</para>
@window:
@wmclass_name:
@wmclass_class:
<!-- ##### FUNCTION gtk_window_set_resizable ##### -->
<para>
</para>
@window:
@resizable:
<!-- ##### FUNCTION gtk_window_get_resizable ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_add_accel_group ##### -->
<para>
</para>
@window:
@accel_group:
<!-- ##### FUNCTION gtk_window_remove_accel_group ##### -->
<para>
</para>
@window:
@accel_group:
<!-- ##### FUNCTION gtk_window_activate_focus ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_activate_default ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_set_modal ##### -->
<para>
</para>
@window:
@modal:
<!-- ##### FUNCTION gtk_window_set_default_size ##### -->
<para>
</para>
@window:
@width:
@height:
<!-- ##### FUNCTION gtk_window_set_geometry_hints ##### -->
<para>
</para>
@window:
@geometry_widget:
@geometry:
@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>
</para>
@window:
@position:
<!-- ##### FUNCTION gtk_window_set_transient_for ##### -->
<para>
</para>
@window:
@parent:
<!-- ##### FUNCTION gtk_window_set_destroy_with_parent ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_screen ##### -->
<para>
</para>
@window:
@screen:
<!-- ##### FUNCTION gtk_window_get_screen ##### -->
<para>
</para>
@window:
@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:
<!-- ##### FUNCTION gtk_window_add_mnemonic ##### -->
<para>
</para>
@window:
@keyval:
@target:
<!-- ##### FUNCTION gtk_window_remove_mnemonic ##### -->
<para>
</para>
@window:
@keyval:
@target:
<!-- ##### FUNCTION gtk_window_mnemonic_activate ##### -->
<para>
</para>
@window:
@keyval:
@modifier:
@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>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_set_focus ##### -->
<para>
</para>
@window:
@focus:
<!-- ##### FUNCTION gtk_window_get_default_widget ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_set_default ##### -->
<para>
</para>
@window:
@default_widget:
<!-- ##### FUNCTION gtk_window_present ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gtk_window_present_with_time ##### -->
<para>
</para>
@window:
@timestamp:
<!-- ##### FUNCTION gtk_window_iconify ##### -->
<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>
</para>
@window:
<!-- ##### FUNCTION gtk_window_unmaximize ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gtk_window_fullscreen ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gtk_window_unfullscreen ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gtk_window_set_keep_above ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_keep_below ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_begin_resize_drag ##### -->
<para>
</para>
@window:
@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_decorated ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_deletable ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_frame_dimensions ##### -->
<para>
</para>
@window:
@left:
@top:
@right:
@bottom:
<!-- ##### FUNCTION gtk_window_set_has_frame ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_mnemonic_modifier ##### -->
<para>
</para>
@window:
@modifier:
<!-- ##### FUNCTION gtk_window_set_type_hint ##### -->
<para>
</para>
@window:
@hint:
<!-- ##### FUNCTION gtk_window_set_skip_taskbar_hint ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_skip_pager_hint ##### -->
<para>
</para>
@window:
@setting:
<!-- ##### FUNCTION gtk_window_set_urgency_hint ##### -->
<para>
</para>
@window:
@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>
</para>
@window:
@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:
<!-- ##### 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_icon_name ##### -->
<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:
<!-- ##### 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_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>
</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:
<!-- ##### FUNCTION gtk_window_set_default_icon_from_file ##### -->
<para>
</para>
@filename:
@err:
@Returns:
<!-- ##### FUNCTION gtk_window_set_default_icon_name ##### -->
<para>
</para>
@name:
<!-- ##### 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_icon_name ##### -->
<para>
</para>
@window:
@name:
<!-- ##### FUNCTION gtk_window_set_auto_startup_notification ##### -->
<para>
</para>
@setting:
<!-- ##### FUNCTION gtk_window_get_opacity ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_set_opacity ##### -->
<para>
</para>
@window:
@opacity:
<!-- ##### FUNCTION gtk_window_get_mnemonics_visible ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gtk_window_set_mnemonics_visible ##### -->
<para>
</para>
@window:
@setting: