gtk2/docs/reference/gdk/tmpl/windows.sgml

1041 lines
11 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
Windows
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkWindowAttr ##### -->
<para>
</para>
@title:
@event_mask:
@x:
@y:
@width:
@height:
@wclass:
@visual:
@colormap:
@window_type:
@cursor:
@wmclass_name:
@wmclass_class:
@override_redirect:
<!-- ##### STRUCT GdkWindow ##### -->
<para>
</para>
@user_data:
<!-- ##### ENUM GdkWindowType ##### -->
<para>
</para>
@GDK_WINDOW_ROOT:
@GDK_WINDOW_TOPLEVEL:
@GDK_WINDOW_CHILD:
@GDK_WINDOW_DIALOG:
@GDK_WINDOW_TEMP:
@GDK_WINDOW_FOREIGN:
<!-- ##### ENUM GdkWindowClass ##### -->
<para>
</para>
@GDK_INPUT_OUTPUT:
@GDK_INPUT_ONLY:
<!-- ##### ENUM GdkWindowAttributesType ##### -->
<para>
</para>
@GDK_WA_TITLE:
@GDK_WA_X:
@GDK_WA_Y:
@GDK_WA_CURSOR:
@GDK_WA_COLORMAP:
@GDK_WA_VISUAL:
@GDK_WA_WMCLASS:
@GDK_WA_NOREDIR:
<!-- ##### ENUM GdkWindowHints ##### -->
<para>
</para>
@GDK_HINT_POS:
@GDK_HINT_MIN_SIZE:
@GDK_HINT_MAX_SIZE:
@GDK_HINT_BASE_SIZE:
@GDK_HINT_ASPECT:
@GDK_HINT_RESIZE_INC:
contrib subdir 2000-10-06 Havoc Pennington <hp@redhat.com> * Makefile.am (SRC_SUBDIRS): contrib subdir * gdk/gdkpixbuf.h: Move GdkPixbufAlphaMode to gdk-pixbuf library, so it can be used in Xlib version * demos/testpixbuf.c (update_timeout): error checking from 1.0 tree * gtk/gdk-pixbuf-loader.c (gdk_pixbuf_loader_get_pixbuf): Sync change from 1.0 tree that returns first frame of animation if the loaded file is an animation. * contrib: add new directory to hold stuff that comes with GTK+ but isn't really part of GTK+ (for now, gdk-pixbuf-xlib) * configure.in: add contrib/* 2000-10-06 Havoc Pennington <hp@redhat.com> * gdk-pixbuf.h: add GdkPixbufAlphaMode 2000-10-06 Havoc Pennington <hp@redhat.com> This entry is a summary of the merged-in changes from 1.0. Relevant original ChangeLog entries are spliced in after this entry; the files they refer to are from the 1.0 gdk-pixbuf sources. * pixops/pixops.c (pixops_composite_nearest): sync a small fix from 1.0 * io-xpm.c (xpm_seek_string): add fscanf error check from 1.0 Add progressive loader from 1.0 * io-tiff.c (gdk_pixbuf__tiff_image_begin_load): mem leak fixes from 1.0 tree * io-pnm.c: new version from 1.0 tree * io-jpeg.c (gdk_pixbuf__jpeg_image_load): sync from 1.0, use malloc not g_malloc * io-gif.c (lzw_read_byte): sync from 1.0, change a g_error to g_warning (gif_get_next_step): return 0 here, sync from 1.0 * gdk-pixbuf-util.c: sync email address change for Cody Russell 2000-09-11 Jeffrey Stedfast <fejj@helixcode.com> * gdk-pixbuf/io-pnm.c: Pretty much totally rewrote again because last nights code was still "broken". Should now properly handle all error conditions gracefully. 2000-09-10 Jeffrey Stedfast <fejj@helixcode.com> * gdk-pixbuf/io-pnm.c: Rewrote. 2000-09-09 Federico Mena Quintero <federico@helixcode.com> * gdk-pixbuf/pixops/pixops.c (pixops_composite_nearest): Compute the correct dest offset. 2000-08-25 Federico Mena Quintero <federico@helixcode.com> * gdk-pixbuf/io-xpm.c: #include <unistd.h> 2000-08-05 Larry Ewing <lewing@helixcode.com> * gdk-pixbuf/io-tiff.c: stop leaking context->tempname. * gdk-pixbuf/io-xpm.c: same as above. 2000-07-26 Michael Meeks <michael@helixcode.com> * gdk-pixbuf/io-jpeg.c (gdk_pixbuf__jpeg_image_load): make g_malloc a malloc. 2000-07-21 Larry Ewing <lewing@helixcode.com> * gdk-pixbuf/io-xpm.c: add a fake progressive loader so that xpm at least supports the progressive interface like the one in io-tiff.c. This should be reimplemented as an actual progressive loader. 2000-07-19 Jonathan Blandford <jrb@redhat.com> * demo/pixbuf-demo.c (update_timeout): changed scaling level to make it look better. * gdk-pixbuf/testpixbuf.c (update_timeout): Patch from michael meeks to handle errors better.
2000-10-09 17:22:20 +00:00
@GDK_HINT_WIN_GRAVITY:
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GdkGeometry ##### -->
<para>
</para>
@min_width:
@min_height:
@max_width:
@max_height:
@base_width:
@base_height:
@width_inc:
@height_inc:
@min_aspect:
@max_aspect:
contrib subdir 2000-10-06 Havoc Pennington <hp@redhat.com> * Makefile.am (SRC_SUBDIRS): contrib subdir * gdk/gdkpixbuf.h: Move GdkPixbufAlphaMode to gdk-pixbuf library, so it can be used in Xlib version * demos/testpixbuf.c (update_timeout): error checking from 1.0 tree * gtk/gdk-pixbuf-loader.c (gdk_pixbuf_loader_get_pixbuf): Sync change from 1.0 tree that returns first frame of animation if the loaded file is an animation. * contrib: add new directory to hold stuff that comes with GTK+ but isn't really part of GTK+ (for now, gdk-pixbuf-xlib) * configure.in: add contrib/* 2000-10-06 Havoc Pennington <hp@redhat.com> * gdk-pixbuf.h: add GdkPixbufAlphaMode 2000-10-06 Havoc Pennington <hp@redhat.com> This entry is a summary of the merged-in changes from 1.0. Relevant original ChangeLog entries are spliced in after this entry; the files they refer to are from the 1.0 gdk-pixbuf sources. * pixops/pixops.c (pixops_composite_nearest): sync a small fix from 1.0 * io-xpm.c (xpm_seek_string): add fscanf error check from 1.0 Add progressive loader from 1.0 * io-tiff.c (gdk_pixbuf__tiff_image_begin_load): mem leak fixes from 1.0 tree * io-pnm.c: new version from 1.0 tree * io-jpeg.c (gdk_pixbuf__jpeg_image_load): sync from 1.0, use malloc not g_malloc * io-gif.c (lzw_read_byte): sync from 1.0, change a g_error to g_warning (gif_get_next_step): return 0 here, sync from 1.0 * gdk-pixbuf-util.c: sync email address change for Cody Russell 2000-09-11 Jeffrey Stedfast <fejj@helixcode.com> * gdk-pixbuf/io-pnm.c: Pretty much totally rewrote again because last nights code was still "broken". Should now properly handle all error conditions gracefully. 2000-09-10 Jeffrey Stedfast <fejj@helixcode.com> * gdk-pixbuf/io-pnm.c: Rewrote. 2000-09-09 Federico Mena Quintero <federico@helixcode.com> * gdk-pixbuf/pixops/pixops.c (pixops_composite_nearest): Compute the correct dest offset. 2000-08-25 Federico Mena Quintero <federico@helixcode.com> * gdk-pixbuf/io-xpm.c: #include <unistd.h> 2000-08-05 Larry Ewing <lewing@helixcode.com> * gdk-pixbuf/io-tiff.c: stop leaking context->tempname. * gdk-pixbuf/io-xpm.c: same as above. 2000-07-26 Michael Meeks <michael@helixcode.com> * gdk-pixbuf/io-jpeg.c (gdk_pixbuf__jpeg_image_load): make g_malloc a malloc. 2000-07-21 Larry Ewing <lewing@helixcode.com> * gdk-pixbuf/io-xpm.c: add a fake progressive loader so that xpm at least supports the progressive interface like the one in io-tiff.c. This should be reimplemented as an actual progressive loader. 2000-07-19 Jonathan Blandford <jrb@redhat.com> * demo/pixbuf-demo.c (update_timeout): changed scaling level to make it look better. * gdk-pixbuf/testpixbuf.c (update_timeout): Patch from michael meeks to handle errors better.
2000-10-09 17:22:20 +00:00
@win_gravity:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GdkGravity ##### -->
<para>
</para>
@GDK_GRAVITY_NORTH_WEST:
@GDK_GRAVITY_NORTH:
@GDK_GRAVITY_NORTH_EAST:
@GDK_GRAVITY_WEST:
@GDK_GRAVITY_CENTER:
@GDK_GRAVITY_EAST:
@GDK_GRAVITY_SOUTH_WEST:
@GDK_GRAVITY_SOUTH:
@GDK_GRAVITY_SOUTH_EAST:
@GDK_GRAVITY_STATIC:
<!-- ##### ENUM GdkWindowTypeHint ##### -->
<para>
</para>
@GDK_WINDOW_TYPE_HINT_NORMAL:
@GDK_WINDOW_TYPE_HINT_DIALOG:
@GDK_WINDOW_TYPE_HINT_MENU:
@GDK_WINDOW_TYPE_HINT_TOOLBAR:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_new ##### -->
<para>
</para>
@parent:
@attributes:
@attributes_mask:
@Returns:
<!-- ##### FUNCTION gdk_window_destroy ##### -->
<para>
</para>
@window:
<!-- ##### MACRO gdk_window_ref ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- # Unused Parameters # -->
@window:
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO gdk_window_unref ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- # Unused Parameters # -->
1999-08-16 18:51:52 +00:00
@window:
<!-- ##### FUNCTION gdk_window_get_window_type ##### -->
<para>
</para>
@window:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_at_pointer ##### -->
<para>
</para>
@win_x:
@win_y:
@Returns:
<!-- ##### FUNCTION gdk_window_show ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_hide ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_is_visible ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_is_viewable ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_get_state ##### -->
<para>
</para>
@window:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_withdraw ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_iconify ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_deiconify ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_stick ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_unstick ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_maximize ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_unmaximize ##### -->
<para>
</para>
@window:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_move ##### -->
<para>
</para>
@window:
@x:
@y:
<!-- ##### FUNCTION gdk_window_resize ##### -->
<para>
</para>
@window:
@width:
@height:
<!-- ##### FUNCTION gdk_window_move_resize ##### -->
<para>
</para>
@window:
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gdk_window_scroll ##### -->
<para>
</para>
@window:
@dx:
@dy:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_reparent ##### -->
<para>
</para>
@window:
@new_parent:
@x:
@y:
<!-- ##### FUNCTION gdk_window_clear ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_clear_area ##### -->
<para>
</para>
@window:
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
<para>
</para>
@window:
@x:
@y:
@width:
@height:
<!-- ##### MACRO gdk_window_copy_area ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@drawable:
1999-08-16 18:51:52 +00:00
@gc:
@x:
@y:
@source_drawable:
1999-08-16 18:51:52 +00:00
@source_x:
@source_y:
@width:
@height:
<!-- # Unused Parameters # -->
@window:
@source_window:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_raise ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_lower ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_focus ##### -->
<para>
</para>
@window:
@timestamp:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_register_dnd ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_begin_paint_rect ##### -->
<para>
</para>
@window:
@rectangle:
<!-- ##### FUNCTION gdk_window_begin_paint_region ##### -->
<para>
</para>
@window:
@region:
<!-- ##### FUNCTION gdk_window_end_paint ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_invalidate_rect ##### -->
<para>
</para>
@window:
@rect:
@invalidate_children:
<!-- ##### FUNCTION gdk_window_invalidate_region ##### -->
<para>
</para>
@window:
@region:
@invalidate_children:
<!-- ##### FUNCTION gdk_window_get_update_area ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_freeze_updates ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_thaw_updates ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_process_all_updates ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_window_process_updates ##### -->
<para>
</para>
@window:
@update_children:
<!-- ##### FUNCTION gdk_window_set_debug_updates ##### -->
<para>
</para>
@setting:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_set_user_data ##### -->
<para>
</para>
@window:
@user_data:
<!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
<para>
</para>
@window:
@override_redirect:
<!-- ##### FUNCTION gdk_window_add_filter ##### -->
<para>
</para>
@window:
@function:
@data:
<!-- ##### FUNCTION gdk_window_remove_filter ##### -->
<para>
</para>
@window:
@function:
@data:
<!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
<para>
</para>
@xevent:
@event:
@data:
@Returns:
<!-- ##### ENUM GdkFilterReturn ##### -->
<para>
</para>
@GDK_FILTER_CONTINUE:
@GDK_FILTER_TRANSLATE:
@GDK_FILTER_REMOVE:
<!-- ##### TYPEDEF GdkXEvent ##### -->
<para>
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
<para>
</para>
@window:
@shape_mask:
@offset_x:
@offset_y:
<!-- ##### FUNCTION gdk_window_shape_combine_region ##### -->
<para>
</para>
@window:
@shape_region:
@offset_x:
@offset_y:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
<para>
</para>
@window:
<!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
<para>
</para>
@window:
@use_static:
@Returns:
<!-- ##### FUNCTION gdk_window_set_hints ##### -->
<para>
</para>
@window:
@x:
@y:
@min_width:
@min_height:
@max_width:
@max_height:
@flags:
<!-- ##### FUNCTION gdk_window_set_title ##### -->
<para>
</para>
@window:
@title:
<!-- ##### FUNCTION gdk_window_set_background ##### -->
<para>
</para>
@window:
@color:
<!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
<para>
</para>
@window:
@pixmap:
@parent_relative:
<!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_window_set_cursor ##### -->
<para>
</para>
@window:
@cursor:
<!-- ##### MACRO gdk_window_set_colormap ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- # Unused Parameters # -->
1999-08-16 18:51:52 +00:00
@window:
@colormap:
<!-- ##### FUNCTION gdk_window_get_user_data ##### -->
<para>
</para>
@window:
@data:
<!-- ##### FUNCTION gdk_window_get_geometry ##### -->
<para>
</para>
@window:
@x:
@y:
@width:
@height:
@depth:
<!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
<para>
</para>
@window:
@geometry:
@flags:
<!-- ##### FUNCTION gdk_window_set_icon_list ##### -->
<para>
</para>
@window:
@pixbufs:
@Returns:
<!-- ##### FUNCTION gdk_window_set_modal_hint ##### -->
<para>
</para>
@window:
@modal:
<!-- ##### FUNCTION gdk_window_set_type_hint ##### -->
<para>
</para>
@window:
@hint:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_get_position ##### -->
<para>
</para>
@window:
@x:
@y:
<!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
<para>
</para>
@window:
@x:
@y:
<!-- ##### MACRO gdk_window_get_size ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
<!-- # Unused Parameters # -->
1999-08-16 18:51:52 +00:00
@window:
@width:
@height:
<!-- ##### MACRO gdk_window_get_visual ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- # Unused Parameters # -->
@window:
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO gdk_window_get_colormap ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- # Unused Parameters # -->
@window:
1999-08-16 18:51:52 +00:00
<!-- ##### MACRO gdk_window_get_type ##### -->
1999-08-16 18:51:52 +00:00
<para>
</para>
@Returns:
<!-- # Unused Parameters # -->
@window:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_get_origin ##### -->
<para>
</para>
@window:
@x:
@y:
@Returns:
<!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
<para>
</para>
@window:
@x:
@y:
@Returns:
<!-- ##### FUNCTION gdk_window_get_pointer ##### -->
<para>
</para>
@window:
@x:
@y:
@mask:
@Returns:
<!-- ##### ENUM GdkModifierType ##### -->
<para>
</para>
@GDK_SHIFT_MASK:
@GDK_LOCK_MASK:
@GDK_CONTROL_MASK:
@GDK_MOD1_MASK:
@GDK_MOD2_MASK:
@GDK_MOD3_MASK:
@GDK_MOD4_MASK:
@GDK_MOD5_MASK:
@GDK_BUTTON1_MASK:
@GDK_BUTTON2_MASK:
@GDK_BUTTON3_MASK:
@GDK_BUTTON4_MASK:
@GDK_BUTTON5_MASK:
@GDK_RELEASE_MASK:
@GDK_MODIFIER_MASK:
<!-- ##### FUNCTION gdk_window_get_parent ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_get_children ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_peek_children ##### -->
<para>
</para>
@window:
@Returns:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gdk_window_get_events ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_window_set_events ##### -->
<para>
</para>
@window:
@event_mask:
<!-- ##### FUNCTION gdk_window_set_icon ##### -->
<para>
</para>
@window:
@icon_window:
@pixmap:
@mask:
<!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
<para>
</para>
@window:
@name:
<!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
<para>
</para>
@window:
@leader:
<!-- ##### FUNCTION gdk_window_set_role ##### -->
<para>
</para>
@window:
@role:
<!-- ##### FUNCTION gdk_window_set_group ##### -->
<para>
</para>
@window:
@leader:
<!-- ##### FUNCTION gdk_window_set_decorations ##### -->
<para>
</para>
@window:
@decorations:
<!-- ##### FUNCTION gdk_window_get_decorations ##### -->
<para>
</para>
@window: The window to get the decorations from
@decorations: The window decorations will be written here
@Returns: TRUE if the window has decorations set, FALSE otherwise.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GdkWMDecoration ##### -->
<para>
</para>
@GDK_DECOR_ALL:
@GDK_DECOR_BORDER:
@GDK_DECOR_RESIZEH:
@GDK_DECOR_TITLE:
@GDK_DECOR_MENU:
@GDK_DECOR_MINIMIZE:
@GDK_DECOR_MAXIMIZE:
<!-- ##### FUNCTION gdk_window_set_functions ##### -->
<para>
</para>
@window:
@functions:
<!-- ##### ENUM GdkWMFunction ##### -->
<para>
</para>
@GDK_FUNC_ALL:
@GDK_FUNC_RESIZE:
@GDK_FUNC_MOVE:
@GDK_FUNC_MINIMIZE:
@GDK_FUNC_MAXIMIZE:
@GDK_FUNC_CLOSE:
<!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
<para>
</para>
@Returns: