diff options
author | Owen Taylor <otaylor@redhat.com> | 2002-04-30 18:07:51 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 2002-04-30 18:07:51 +0000 |
commit | c117408d9efaccd2db2441ae592de0e9ba84bb2c (patch) | |
tree | 3d3e7e0e06253073b5ebcee4164877e019eb1d69 /docs/reference/gdk | |
parent | 683de88115a7f85f89984315a9f48ba15119729d (diff) | |
download | gtk+-c117408d9efaccd2db2441ae592de0e9ba84bb2c.tar.gz |
Update for multihead.
Tue Apr 30 12:26:31 2002 Owen Taylor <otaylor@redhat.com>
* gdk-sections.txt: Update for multihead.
* multihead.sgml gtk-docs.sgml: Add overview of
multihead from multihead branch.
* tmpl/gdkdisplay.sgml tmpl/gdkscreen.sgml: New
sections from multihead branch.
Diffstat (limited to 'docs/reference/gdk')
22 files changed, 1190 insertions, 51 deletions
diff --git a/docs/reference/gdk/gdk-docs.sgml b/docs/reference/gdk/gdk-docs.sgml index 67321178a8..95d34006cf 100644 --- a/docs/reference/gdk/gdk-docs.sgml +++ b/docs/reference/gdk/gdk-docs.sgml @@ -26,6 +26,10 @@ <!entity gdk-Input SYSTEM "sgml/input.sgml"> <!entity gdk-Drag-and-Drop SYSTEM "sgml/dnd.sgml"> <!entity gdk-X-Window-System-Interaction SYSTEM "sgml/x_interaction.sgml"> +<!entity gdk-Screen SYSTEM "sgml/gdkscreen.sgml"> +<!entity gdk-Display SYSTEM "sgml/gdkdisplay.sgml"> + +<!entity gdk-Multihead SYSTEM "multihead.sgml"> ]> <book id="index"> @@ -37,6 +41,10 @@ <title>API Reference</title> &gdk-General; + &gdk-Multihead; + &gdk-Screen; + &gdk-Display; + &gdk-Points-Rectangles-and-Regions; &gdk-Graphics-Contexts; &gdk-Drawing-Primitives; diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index 0974d0f599..b60374442f 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -6,6 +6,8 @@ <FILE>general</FILE> gdk_init gdk_init_check +gdk_parse_args +gdk_get_display_arg_name gdk_set_locale gdk_set_sm_client_id gdk_exit @@ -111,6 +113,78 @@ gdk_wm_function_get_type </SECTION> <SECTION> +<FILE>gdkdisplay</FILE> +<TITLE>GdkDisplay</TITLE> +GdkDisplay +gdk_open_display +gdk_display_get_name +gdk_display_get_n_screens +gdk_display_get_screen +gdk_display_get_default_screen +gdk_display_pointer_ungrab +gdk_display_keyboard_ungrab +gdk_display_pointer_is_grabbed +gdk_display_beep +gdk_display_sync +gdk_display_close +gdk_display_list_devices +gdk_display_get_event +gdk_display_peek_event +gdk_display_put_event +gdk_display_add_client_message_filter +gdk_display_set_double_click_time +gdk_display_set_sm_client_id +gdk_set_default_display +gdk_get_default_display +<SUBSECTION Standard> +GDK_DISPLAY_OBJECT +GDK_IS_DISPLAY +GDK_TYPE_DISPLAY +gdk_display_get_type +GDK_DISPLAY_CLASS +GDK_IS_DISPLAY_CLASS +GDK_DISPLAY_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gdkscreen</FILE> +<TITLE>GdkScreen</TITLE> +gdk_screen_get_default_colormap +gdk_screen_set_default_colormap +gdk_screen_get_system_colormap +gdk_screen_get_system_visual +gdk_screen_get_rgb_colormap +gdk_screen_get_rgb_visual +gdk_screen_get_root_window +gdk_screen_get_display +gdk_screen_get_number +gdk_screen_get_window_at_pointer +gdk_screen_get_width +gdk_screen_get_height +gdk_screen_get_width_mm +gdk_screen_get_height_mm +gdk_screen_close +gdk_screen_list_visuals +gdk_screen_get_toplevel_windows +gdk_screen_use_virtual_screen +gdk_screen_get_n_monitors +gdk_screen_get_monitor_geometry +gdk_screen_get_monitor_at_point +gdk_screen_get_monitor_at_window +gdk_screen_broadcast_client_message +gdk_get_default_screen +gdk_screen_get_setting +<SUBSECTION Standard> +GDK_SCREEN +GDK_IS_SCREEN +GDK_TYPE_SCREEN +gdk_screen_get_type +GDK_SCREEN_CLASS +GDK_IS_SCREEN_CLASS +GDK_SCREEN_GET_CLASS +</SECTION> + +<SECTION> <TITLE>Bitmaps and Pixmaps</TITLE> <FILE>pixmaps</FILE> GdkPixmap @@ -274,8 +348,12 @@ gdk_color_get_type GdkFont GdkFontType gdk_font_load +gdk_font_load_for_display gdk_fontset_load +gdk_fontset_load_for_display gdk_font_from_description +gdk_font_from_description_for_display +gdk_font_get_display gdk_font_ref gdk_font_unref gdk_font_id @@ -322,6 +400,8 @@ gdk_drawable_ref gdk_drawable_unref gdk_drawable_set_data gdk_drawable_get_data +gdk_drawable_get_display +gdk_drawable_get_screen gdk_drawable_get_visual gdk_drawable_set_colormap gdk_drawable_get_colormap @@ -380,6 +460,7 @@ GdkFunction gdk_gc_new gdk_gc_new_with_values +gdk_gc_get_screen gdk_gc_ref gdk_gc_unref gdk_gc_destroy @@ -648,10 +729,13 @@ GDK_SELECTION_TYPE_PIXMAP GDK_SELECTION_TYPE_WINDOW GDK_SELECTION_TYPE_STRING gdk_selection_owner_set +gdk_selection_owner_set_for_display gdk_selection_owner_get +gdk_selection_owner_get_for_display gdk_selection_convert gdk_selection_property_get gdk_selection_send_notify +gdk_selection_send_notify_for_display </SECTION> <SECTION> @@ -662,12 +746,16 @@ GDK_ATOM_TO_POINTER GDK_POINTER_TO_ATOM GDK_NONE gdk_text_property_to_text_list +gdk_text_property_to_text_list_for_display gdk_free_text_list gdk_text_property_to_utf8_list +gdk_text_property_to_utf8_list_for_display gdk_string_to_compound_text +gdk_string_to_compound_text_for_display gdk_free_compound_text gdk_utf8_to_string_target gdk_utf8_to_compound_text +gdk_utf8_to_compound_text_for_display gdk_atom_intern gdk_atom_name gdk_property_get @@ -683,6 +771,7 @@ GDK_TYPE_PROP_MODE <TITLE>Pango Interaction</TITLE> <FILE>pango_interaction</FILE> gdk_pango_context_get +gdk_pango_context_get_for_screen gdk_pango_context_set_colormap GdkPangoAttrEmbossed GdkPangoAttrStipple @@ -759,6 +848,7 @@ gdk_threads_mutex GdkKeymap GdkKeymapKey gdk_keymap_get_default +gdk_keymap_get_for_display gdk_keymap_lookup_key gdk_keymap_translate_keyboard_state gdk_keymap_get_entries_for_keyval @@ -868,6 +958,7 @@ GdkEventFunc <SUBSECTION> gdk_event_send_client_message +gdk_event_send_client_message_for_display gdk_event_send_clientmessage_toall gdk_add_client_message_filter @@ -939,6 +1030,8 @@ GdkCursor GdkCursorType gdk_cursor_new gdk_cursor_new_from_pixmap +gdk_cursor_new_for_screen +gdk_cursor_get_screen gdk_cursor_ref gdk_cursor_unref gdk_cursor_destroy @@ -979,6 +1072,7 @@ gdk_drag_begin gdk_drag_motion gdk_drop_finish gdk_drag_get_protocol +gdk_drag_get_protocol_for_display GdkDragProtocol gdk_drag_context_unref GdkDragContext @@ -1010,6 +1104,7 @@ GDK_WINDOW_XDISPLAY GDK_WINDOW_XID GDK_PIXMAP_XDISPLAY GDK_PIXMAP_XID +GDK_DISPLAY_XDISPLAY GDK_DRAWABLE_XDISPLAY GDK_DRAWABLE_XID GDK_IMAGE_XDISPLAY @@ -1017,6 +1112,9 @@ GDK_IMAGE_XIMAGE GDK_GC_XDISPLAY GDK_COLORMAP_XDISPLAY GDK_COLORMAP_XCOLORMAP +GDK_SCREEN_XDISPLAY +GDK_SCREEN_XNUMBER +GDK_SCREEN_XSCREEN GDK_VISUAL_XVISUAL GDK_FONT_XDISPLAY GDK_FONT_XFONT @@ -1026,19 +1124,29 @@ GDK_GC_XGC GDK_GC_GET_XGC GDK_WINDOW_XWINDOW gdkx_visual_get +gdkx_visual_get_for_screen gdkx_colormap_get gdk_pixmap_foreign_new +gdk_pixmap_foreign_new_for_display gdk_window_foreign_new +gdk_window_foreign_new_for_display gdk_xid_table_lookup +gdk_xid_table_lookup_for_display gdk_window_lookup +gdk_window_lookup_for_display gdk_pixmap_lookup +gdk_pixmap_lookup_for_display gdk_font_lookup +gdk_font_lookup_for_display +gdk_x11_lookup_xdisplay gdk_x11_get_server_time gdk_net_wm_supports +gdk_x11_screen_supports_net_wm_hint gdk_x11_colormap_get_xcolormap gdk_x11_colormap_get_xdisplay gdk_x11_cursor_get_xcursor gdk_x11_cursor_get_xdisplay +gdk_x11_display_get_xdisplay gdk_x11_drawable_get_xdisplay gdk_x11_drawable_get_xid gdk_x11_font_get_name @@ -1052,12 +1160,18 @@ gdk_x11_get_default_xdisplay gdk_x11_grab_server gdk_x11_image_get_xdisplay gdk_x11_image_get_ximage +gdk_x11_screen_get_screen_number +gdk_x11_screen_get_xscreen gdk_x11_ungrab_server gdk_x11_visual_get_xvisual gdk_x11_atom_to_xatom +gdk_x11_atom_to_xatom_for_display gdk_x11_xatom_to_atom +gdk_x11_xatom_to_atom_for_display gdk_x11_get_xatom_by_name +gdk_x11_get_xatom_by_name_for_display gdk_x11_get_xatom_name +gdk_x11_get_xatom_name_for_display <SUBSECTION Private> gdk_display diff --git a/docs/reference/gdk/multihead.sgml b/docs/reference/gdk/multihead.sgml new file mode 100644 index 0000000000..bcedf2bfb5 --- /dev/null +++ b/docs/reference/gdk/multihead.sgml @@ -0,0 +1,124 @@ +<refentry id="multihead" revision="20 Mar 2002"> + <refmeta> + <refentrytitle>Multi-head Support Overview</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>GDK Library</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>Multi-head Support Overview</refname> + <refpurpose>Overview of <link + linkend="GdkDisplay">GdkDisplay</link> and <link + linkend="GdkScreen">GdkScreen</link></refpurpose> + </refnamediv> + + <refsect1> + <title>Overview</title> + <para> + Multihead support is based around two main object types: + <itemizedlist> + <listitem><para>#GdkDisplayManager</para></listitem> + <listitem><para>#GdkDisplay</para></listitem> + </itemizedlist> + </para> + + <para> + #GdkDisplay objects are the Gdk representation of the X Display which can be + described as <emphasis>"a workstation consisting of a keyboard a pointing + device (such as a mouse) and one or more screens"</emphasis>. + It is used to open and keep track of various #GdkScreen objects currently + intanciated by the application. It is also used to grab and release the keyboard + and the mouse pointer. + </para> + <para> + #GdkScreen objects are the Gdk representation of a physical screen. It is used + throughout Gdk and Gtk+ to specify which screen the top level windows (GtkWindow) + are to be displayed on. + It is also used to query the screen specification and default settings such as + the default colormap (gdk_screen_get_default_colormap()), + the screen width (gdk_screen_get_width()), etc. + </para> + <para> + the following code samples demonstrate common usage of the objects described above + </para> + + <example> + <title>Testing the number of screen on the current display</title> + <programlisting><!-- +-->gint num_screen = 0; +gchar *displayname = NULL; +GdkScreen **screen_list; +GdkDisplay *display; + +gtk_init (&argc, &argv); + +display = gdk_get_default_display (); +num_screen = gdk_display_get_n_screens (display); +displayname = gdk_display_get_name (display); +if (num_screen <= 1) + { + printf ("This Xserver (%s) manages only one screen. exiting...\n", + displayname); + exit (1); + } +else + { + printf ("This Xserver (%s) manages %d screens.\n", displayname, + num_screen); + }<!-- + +--> </programlisting> + </example> + <example> + <title>Opening a second display</title> + <programlisting><!-- +-->gchar *second_screen_name; +dkDisplay *second_display; +dkScreen *second_screen; +tkWidget *window; + +tk_init (&argc, &argv); + +* screen2_name needs to be initialized before calling +* gdk_display_new() */ +second_display = gdk_display_new (&argc, &argv, second_screen_name); +if (second_display) + second_screen = gdk_display_get_default_screen (second_display); +else + { + g_print ("Can't open display :\n\t%s\n\n", + second_screen_name); + exit (1); + } +/* now GdkScreen can be assigned to GtkWindows */ + +window = gtk_window_new (GTK_WINDOW_TOPLEVEL); +gtk_window_set_screen (window, second_screen);<!-- + --></programlisting> + </example> + </refsect1> + <refsect1> + <title>See Also</title> + <para> + <variablelist> + <varlistentry> + <term>#GdkDisplay</term> + <listitem><para>the Gdk Object used to represent and manipulate display + related data</para></listitem> + </varlistentry> + <varlistentry> + <term>#GdkScreen</term> + <listitem><para>the Gdk Object used to represent and query screen related + data</para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + </refentry> + +<!-- +Local variables: +mode: sgml +sgml-parent-document: ("gdk-docs.sgml" "book" "refentry" "") +End: +-->
\ No newline at end of file diff --git a/docs/reference/gdk/tmpl/colors.sgml b/docs/reference/gdk/tmpl/colors.sgml index dc6e087133..28b9af0a39 100644 --- a/docs/reference/gdk/tmpl/colors.sgml +++ b/docs/reference/gdk/tmpl/colors.sgml @@ -103,7 +103,7 @@ Creates a new colormap for the given visual. <para> </para> -@Returns: +@Returns: <!-- ##### FUNCTION gdk_colormap_get_system_size ##### --> diff --git a/docs/reference/gdk/tmpl/cursors.sgml b/docs/reference/gdk/tmpl/cursors.sgml index a441471b25..f811ea9b9f 100644 --- a/docs/reference/gdk/tmpl/cursors.sgml +++ b/docs/reference/gdk/tmpl/cursors.sgml @@ -171,6 +171,25 @@ The color does not have to be allocated first. @Returns: a new #GdkCursor. +<!-- ##### FUNCTION gdk_cursor_new_for_screen ##### --> +<para> + +</para> + +@screen: +@cursor_type: +@Returns: + + +<!-- ##### FUNCTION gdk_cursor_get_screen ##### --> +<para> + +</para> + +@cursor: +@Returns: + + <!-- ##### FUNCTION gdk_cursor_ref ##### --> <para> diff --git a/docs/reference/gdk/tmpl/dnd.sgml b/docs/reference/gdk/tmpl/dnd.sgml index d9caae1325..3d372c68b0 100644 --- a/docs/reference/gdk/tmpl/dnd.sgml +++ b/docs/reference/gdk/tmpl/dnd.sgml @@ -162,6 +162,17 @@ Finds out the DND protocol supported by a window. support Drag and Drop. +<!-- ##### FUNCTION gdk_drag_get_protocol_for_display ##### --> +<para> + +</para> + +@display: +@xid: +@protocol: +@Returns: + + <!-- ##### ENUM GdkDragProtocol ##### --> <para> Used in #GdkDragContext to indicate the protocol according to diff --git a/docs/reference/gdk/tmpl/drawing.sgml b/docs/reference/gdk/tmpl/drawing.sgml index 57a39f179d..7717f7f7fb 100644 --- a/docs/reference/gdk/tmpl/drawing.sgml +++ b/docs/reference/gdk/tmpl/drawing.sgml @@ -72,6 +72,24 @@ or a #GdkWindow. @Returns: +<!-- ##### FUNCTION gdk_drawable_get_display ##### --> +<para> + +</para> + +@drawable: +@Returns: + + +<!-- ##### FUNCTION gdk_drawable_get_screen ##### --> +<para> + +</para> + +@drawable: +@Returns: + + <!-- ##### FUNCTION gdk_drawable_get_visual ##### --> <para> diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml index 64fdbbd713..592be2f672 100644 --- a/docs/reference/gdk/tmpl/events.sgml +++ b/docs/reference/gdk/tmpl/events.sgml @@ -151,43 +151,44 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>. <para> </para> -@Returns: +@Returns: <!-- ##### FUNCTION gdk_event_peek ##### --> <para> </para> -@Returns: +@Returns: + <!-- ##### FUNCTION gdk_event_get ##### --> <para> </para> -@Returns: +@Returns: <!-- ##### FUNCTION gdk_event_get_graphics_expose ##### --> <para> </para> -@window: -@Returns: +@window: +@Returns: <!-- ##### FUNCTION gdk_event_put ##### --> <para> </para> -@event: +@event: <!-- ##### FUNCTION gdk_event_copy ##### --> <para> </para> -@event: -@Returns: +@event: +@Returns: <!-- ##### FUNCTION gdk_event_free ##### --> @@ -201,8 +202,8 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>. <para> </para> -@event: -@Returns: +@event: +@Returns: <!-- ##### FUNCTION gdk_event_get_state ##### --> @@ -252,9 +253,9 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>. <para> </para> -@func: -@data: -@notify: +@func: +@data: +@notify: <!-- ##### USER_FUNCTION GdkEventFunc ##### --> @@ -272,16 +273,27 @@ gdk_event_handler_set(). <para> </para> -@event: -@xid: -@Returns: +@event: +@xid: +@Returns: + + +<!-- ##### FUNCTION gdk_event_send_client_message_for_display ##### --> +<para> + +</para> + +@display: +@event: +@xid: +@Returns: <!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### --> <para> </para> -@event: +@event: <!-- ##### FUNCTION gdk_add_client_message_filter ##### --> @@ -289,30 +301,30 @@ gdk_event_handler_set(). </para> @message_type: -@func: -@data: +@func: +@data: <!-- ##### FUNCTION gdk_get_show_events ##### --> <para> </para> -@Returns: +@Returns: <!-- ##### FUNCTION gdk_set_show_events ##### --> <para> </para> -@show_events: +@show_events: <!-- ##### FUNCTION gdk_setting_get ##### --> <para> </para> -@name: -@value: -@Returns: +@name: +@value: +@Returns: diff --git a/docs/reference/gdk/tmpl/fonts.sgml b/docs/reference/gdk/tmpl/fonts.sgml index 5a86237782..9604889a00 100644 --- a/docs/reference/gdk/tmpl/fonts.sgml +++ b/docs/reference/gdk/tmpl/fonts.sgml @@ -299,6 +299,16 @@ You should make no assumptions about the initial reference count. @Returns: a #GdkFont, or %NULL if the font could not be loaded. +<!-- ##### FUNCTION gdk_font_load_for_display ##### --> +<para> + +</para> + +@display: +@font_name: +@Returns: + + <!-- ##### FUNCTION gdk_fontset_load ##### --> <para> Loads a fontset. @@ -313,6 +323,16 @@ You should make no assumptions about the initial reference count. @Returns: a #GdkFont, or %NULL if the fontset could not be loaded. +<!-- ##### FUNCTION gdk_fontset_load_for_display ##### --> +<para> + +</para> + +@display: +@fontset_name: +@Returns: + + <!-- ##### FUNCTION gdk_font_from_description ##### --> <para> @@ -322,6 +342,25 @@ You should make no assumptions about the initial reference count. @Returns: +<!-- ##### FUNCTION gdk_font_from_description_for_display ##### --> +<para> + +</para> + +@display: +@font_desc: +@Returns: + + +<!-- ##### FUNCTION gdk_font_get_display ##### --> +<para> + +</para> + +@font: +@Returns: + + <!-- ##### FUNCTION gdk_font_ref ##### --> <para> Increases the reference count of a font by one. diff --git a/docs/reference/gdk/tmpl/gcs.sgml b/docs/reference/gdk/tmpl/gcs.sgml index 4d8c8780a2..0e3b6d86f8 100644 --- a/docs/reference/gdk/tmpl/gcs.sgml +++ b/docs/reference/gdk/tmpl/gcs.sgml @@ -144,6 +144,15 @@ Create a new GC with the given initial values. @Returns: the new graphics context. +<!-- ##### FUNCTION gdk_gc_get_screen ##### --> +<para> + +</para> + +@gc: +@Returns: + + <!-- ##### FUNCTION gdk_gc_ref ##### --> <para> diff --git a/docs/reference/gdk/tmpl/gdkdisplay.sgml b/docs/reference/gdk/tmpl/gdkdisplay.sgml new file mode 100644 index 0000000000..72e0640768 --- /dev/null +++ b/docs/reference/gdk/tmpl/gdkdisplay.sgml @@ -0,0 +1,215 @@ +<!-- ##### SECTION Title ##### --> +GdkDisplay + +<!-- ##### SECTION Short_Description ##### --> +controls the keyboard/mouse pointer grabs and a set of #GdkScreen + +<!-- ##### SECTION Long_Description ##### --> +<para> +#GdkDisplay objects purpose are two fold : +<itemizedlist> +<listitem><para>To grab/ungrab keyboard focus and mouse pointer</para></listitem> +<listitem><para>To manage and provide information about the #GdkScreen(s) + available for this #GdkDisplay + </para></listitem> +</itemizedlist> +</para> +<para> + #GdkDisplay objects are the Gdk representation of the X Display which can be + described as <emphasis>"a workstation consisting of a keyboard a pointing + device (such as a mouse) and one or more screens"</emphasis>. + It is used to open and keep track of various #GdkScreen objects currently + intanciated by the application. It is also used to grab and release the keyboard + and the mouse pointer. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT GdkDisplay ##### --> +<para> + +</para> + +@parent_instance: + +<!-- ##### FUNCTION gdk_open_display ##### --> +<para> + +</para> + +@display_name: +@Returns: + + +<!-- ##### FUNCTION gdk_display_get_name ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_get_n_screens ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_get_screen ##### --> +<para> + +</para> + +@display: +@screen_num: +@Returns: + + +<!-- ##### FUNCTION gdk_display_get_default_screen ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_pointer_ungrab ##### --> +<para> + +</para> + +@display: +@time: + + +<!-- ##### FUNCTION gdk_display_keyboard_ungrab ##### --> +<para> + +</para> + +@display: +@time: + + +<!-- ##### FUNCTION gdk_display_pointer_is_grabbed ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_beep ##### --> +<para> + +</para> + +@display: + + +<!-- ##### FUNCTION gdk_display_sync ##### --> +<para> + +</para> + +@display: + + +<!-- ##### FUNCTION gdk_display_close ##### --> +<para> + +</para> + +@display: + + +<!-- ##### FUNCTION gdk_display_list_devices ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_get_event ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_peek_event ##### --> +<para> + +</para> + +@display: +@Returns: + + +<!-- ##### FUNCTION gdk_display_put_event ##### --> +<para> + +</para> + +@display: +@event: + + +<!-- ##### FUNCTION gdk_display_add_client_message_filter ##### --> +<para> + +</para> + +@display: +@message_type: +@func: +@data: + + +<!-- ##### FUNCTION gdk_display_set_double_click_time ##### --> +<para> + +</para> + +@display: +@msec: + + +<!-- ##### FUNCTION gdk_display_set_sm_client_id ##### --> +<para> + +</para> + +@display: +@sm_client_id: + + +<!-- ##### FUNCTION gdk_set_default_display ##### --> +<para> + +</para> + +@display: + + +<!-- ##### FUNCTION gdk_get_default_display ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/gdk/tmpl/gdkscreen.sgml b/docs/reference/gdk/tmpl/gdkscreen.sgml new file mode 100644 index 0000000000..87bdd7b056 --- /dev/null +++ b/docs/reference/gdk/tmpl/gdkscreen.sgml @@ -0,0 +1,252 @@ +<!-- ##### SECTION Title ##### --> +GdkScreen + +<!-- ##### SECTION Short_Description ##### --> +object representing a physical screen + +<!-- ##### SECTION Long_Description ##### --> +<para> + #GdkScreen objects are the Gdk representation of a physical screen. It is used + throughout Gdk and Gtk+ to specify which screen the top level windows (GtkWindow) + are to be displayed on. + It is also used to query the screen specification and default settings such as + the default colormap (gdk_screen_get_default_colormap()), + the screen width (gdk_screen_get_width()), etc. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION gdk_screen_get_default_colormap ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_set_default_colormap ##### --> +<para> + +</para> + +@screen: +@colormap: + + +<!-- ##### FUNCTION gdk_screen_get_system_colormap ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_system_visual ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_rgb_colormap ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_rgb_visual ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_root_window ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_display ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_number ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_window_at_pointer ##### --> +<para> + +</para> + +@screen: +@win_x: +@win_y: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_width ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_height ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_width_mm ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_height_mm ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_close ##### --> +<para> + +</para> + +@screen: + + +<!-- ##### FUNCTION gdk_screen_list_visuals ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_toplevel_windows ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_use_virtual_screen ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_n_monitors ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_monitor_geometry ##### --> +<para> + +</para> + +@screen: +@monitor_num: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_monitor_at_point ##### --> +<para> + +</para> + +@screen: +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_monitor_at_window ##### --> +<para> + +</para> + +@screen: +@anid: +@Returns: + + +<!-- ##### FUNCTION gdk_screen_broadcast_client_message ##### --> +<para> + +</para> + +@screen: +@event: + + +<!-- ##### FUNCTION gdk_get_default_screen ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gdk_screen_get_setting ##### --> +<para> + +</para> + +@screen: +@name: +@value: +@Returns: + + diff --git a/docs/reference/gdk/tmpl/general.sgml b/docs/reference/gdk/tmpl/general.sgml index c3b24d4977..00b7d9fb79 100644 --- a/docs/reference/gdk/tmpl/general.sgml +++ b/docs/reference/gdk/tmpl/general.sgml @@ -53,6 +53,23 @@ by GTK+ applications. @Returns: %TRUE if initialization succeeded. +<!-- ##### FUNCTION gdk_parse_args ##### --> +<para> + +</para> + +@argc: +@argv: + + +<!-- ##### FUNCTION gdk_get_display_arg_name ##### --> +<para> + +</para> + +@Returns: + + <!-- ##### FUNCTION gdk_set_locale ##### --> <para> Initializes the support for internationalization by calling the <function>setlocale()</function> @@ -81,7 +98,7 @@ locale. <para> </para> -@sm_client_id: +@sm_client_id: <!-- ##### FUNCTION gdk_exit ##### --> @@ -139,37 +156,37 @@ trapping X errors with gdk_error_trap_push() and gdk_error_trap_pop(). <!-- ##### FUNCTION gdk_screen_width ##### --> <para> -Returns the width of the screen in pixels. +Returns the width of the default screen in pixels. </para> -@Returns: the width of the screen in pixels. +@Returns: the width of the default screen in pixels. <!-- ##### FUNCTION gdk_screen_height ##### --> <para> -Returns the height of the screen in pixels. +Returns the height of the default screen in pixels. </para> -@Returns: the height of the screen in pixels. +@Returns: the height of the default screen in pixels. <!-- ##### FUNCTION gdk_screen_width_mm ##### --> <para> -Returns the width of the screen in millimeters. +Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct. </para> -@Returns: the width of the screen in millimeters, though it is not always +@Returns: the width of the default screen in millimeters, though it is not always correct. <!-- ##### FUNCTION gdk_screen_height_mm ##### --> <para> -Returns the height of the screen in millimeters. +Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct. </para> -@Returns: the height of the screen in millimeters, though it is not always +@Returns: the height of the default screen in millimeters, though it is not always correct. diff --git a/docs/reference/gdk/tmpl/images.sgml b/docs/reference/gdk/tmpl/images.sgml index c4fb7c5d9c..98cb586a63 100644 --- a/docs/reference/gdk/tmpl/images.sgml +++ b/docs/reference/gdk/tmpl/images.sgml @@ -123,11 +123,12 @@ image is freed.</para></warning> </para> @drawable: -@x: -@y: -@width: -@height: -@Returns: +@x: +@y: +@width: +@height: +@Returns: + <!-- ##### FUNCTION gdk_image_ref ##### --> <para> diff --git a/docs/reference/gdk/tmpl/input_devices.sgml b/docs/reference/gdk/tmpl/input_devices.sgml index bd84e6bd5e..16ffab7f0d 100644 --- a/docs/reference/gdk/tmpl/input_devices.sgml +++ b/docs/reference/gdk/tmpl/input_devices.sgml @@ -176,7 +176,7 @@ types that GTK+ understands. <para> </para> -@Returns: +@Returns: <!-- ##### FUNCTION gdk_device_set_source ##### --> diff --git a/docs/reference/gdk/tmpl/keys.sgml b/docs/reference/gdk/tmpl/keys.sgml index a711ac2118..b21093c191 100644 --- a/docs/reference/gdk/tmpl/keys.sgml +++ b/docs/reference/gdk/tmpl/keys.sgml @@ -118,6 +118,15 @@ be mapped to a keyval. @Returns: +<!-- ##### FUNCTION gdk_keymap_get_for_display ##### --> +<para> + +</para> + +@display: +@Returns: + + <!-- ##### FUNCTION gdk_keymap_lookup_key ##### --> <para> diff --git a/docs/reference/gdk/tmpl/pango_interaction.sgml b/docs/reference/gdk/tmpl/pango_interaction.sgml index 641972b659..9c3b2935da 100644 --- a/docs/reference/gdk/tmpl/pango_interaction.sgml +++ b/docs/reference/gdk/tmpl/pango_interaction.sgml @@ -22,6 +22,15 @@ Pango Interaction @Returns: +<!-- ##### FUNCTION gdk_pango_context_get_for_screen ##### --> +<para> + +</para> + +@screen: +@Returns: + + <!-- ##### FUNCTION gdk_pango_context_set_colormap ##### --> <para> diff --git a/docs/reference/gdk/tmpl/properties.sgml b/docs/reference/gdk/tmpl/properties.sgml index 3c4c8d3fd9..e3c0d2693f 100644 --- a/docs/reference/gdk/tmpl/properties.sgml +++ b/docs/reference/gdk/tmpl/properties.sgml @@ -96,6 +96,20 @@ the nul-separated elements of the original text string.) if the conversion failed. +<!-- ##### FUNCTION gdk_text_property_to_text_list_for_display ##### --> +<para> + +</para> + +@display: +@encoding: +@format: +@text: +@length: +@list: +@Returns: + + <!-- ##### FUNCTION gdk_free_text_list ##### --> <para> Frees the array of strings created by @@ -119,6 +133,20 @@ gdk_text_property_to_text_list(). @Returns: +<!-- ##### FUNCTION gdk_text_property_to_utf8_list_for_display ##### --> +<para> + +</para> + +@display: +@encoding: +@format: +@text: +@length: +@list: +@Returns: + + <!-- ##### FUNCTION gdk_string_to_compound_text ##### --> <para> Converts a string from the encoding of the current locale @@ -133,6 +161,20 @@ into a form suitable for storing in a window property. @Returns: 0 upon sucess, non-zero upon failure. +<!-- ##### FUNCTION gdk_string_to_compound_text_for_display ##### --> +<para> + +</para> + +@display: +@str: +@encoding: +@format: +@ctext: +@length: +@Returns: + + <!-- ##### FUNCTION gdk_free_compound_text ##### --> <para> Frees the data returned from gdk_string_to_compound_text(). @@ -163,6 +205,20 @@ Frees the data returned from gdk_string_to_compound_text(). @Returns: +<!-- ##### FUNCTION gdk_utf8_to_compound_text_for_display ##### --> +<para> + +</para> + +@display: +@str: +@encoding: +@format: +@ctext: +@length: +@Returns: + + <!-- ##### FUNCTION gdk_atom_intern ##### --> <para> Finds or creates an atom corresponding to a given string. diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml index 4aedc3d6ea..a204e58ae4 100644 --- a/docs/reference/gdk/tmpl/regions.sgml +++ b/docs/reference/gdk/tmpl/regions.sgml @@ -236,16 +236,16 @@ Positive values shrink the region. Negative values expand it. </para> -@region: -@rect: +@region: +@rect: <!-- ##### FUNCTION gdk_region_intersect ##### --> <para> </para> -@source1: -@source2: +@source1: +@source2: <!-- ##### FUNCTION gdk_region_union ##### --> @@ -253,24 +253,24 @@ Positive values shrink the region. Negative values expand it. </para> -@source1: -@source2: +@source1: +@source2: <!-- ##### FUNCTION gdk_region_subtract ##### --> <para> </para> -@source1: -@source2: +@source1: +@source2: <!-- ##### FUNCTION gdk_region_xor ##### --> <para> </para> -@source1: -@source2: +@source1: +@source2: <!-- ##### STRUCT GdkSpan ##### --> diff --git a/docs/reference/gdk/tmpl/rgb.sgml b/docs/reference/gdk/tmpl/rgb.sgml index 2c8f066a9c..ed9dc697e4 100644 --- a/docs/reference/gdk/tmpl/rgb.sgml +++ b/docs/reference/gdk/tmpl/rgb.sgml @@ -409,7 +409,7 @@ private colormap. <para> </para> -@Returns: +@Returns: <!-- ##### FUNCTION gdk_rgb_get_colormap ##### --> diff --git a/docs/reference/gdk/tmpl/selections.sgml b/docs/reference/gdk/tmpl/selections.sgml index 118fe8971f..11652afcbd 100644 --- a/docs/reference/gdk/tmpl/selections.sgml +++ b/docs/reference/gdk/tmpl/selections.sgml @@ -208,6 +208,19 @@ Sets the owner of the given selection. changed to @owner, otherwise %FALSE. +<!-- ##### FUNCTION gdk_selection_owner_set_for_display ##### --> +<para> + +</para> + +@display: +@owner: +@selection: +@time: +@send_event: +@Returns: + + <!-- ##### FUNCTION gdk_selection_owner_get ##### --> <para> Determines the owner of the given selection. @@ -224,6 +237,16 @@ Determines the owner of the given selection. this call. +<!-- ##### FUNCTION gdk_selection_owner_get_for_display ##### --> +<para> + +</para> + +@display: +@selection: +@Returns: + + <!-- ##### FUNCTION gdk_selection_convert ##### --> <para> Retrieves the contents of a selection in a given @@ -273,3 +296,16 @@ Sends a response to SelectionRequest event. @time: timestamp. +<!-- ##### FUNCTION gdk_selection_send_notify_for_display ##### --> +<para> + +</para> + +@display: +@requestor: +@selection: +@target: +@property: +@time: + + diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml index a41b673d51..4174cb4af4 100644 --- a/docs/reference/gdk/tmpl/x_interaction.sgml +++ b/docs/reference/gdk/tmpl/x_interaction.sgml @@ -76,6 +76,14 @@ Returns the X pixmap belonging to a #GdkPixmap. @win: a #GdkPixmap. +<!-- ##### MACRO GDK_DISPLAY_XDISPLAY ##### --> +<para> + +</para> + +@display: + + <!-- ##### MACRO GDK_DRAWABLE_XDISPLAY ##### --> <para> Returns the display of a #GdkDrawable. @@ -139,6 +147,30 @@ Returns the X colormap belonging to a #GdkColormap. @Returns: an Xlib <type>Colormap</type>. +<!-- ##### MACRO GDK_SCREEN_XDISPLAY ##### --> +<para> + +</para> + +@screen: + + +<!-- ##### MACRO GDK_SCREEN_XNUMBER ##### --> +<para> + +</para> + +@screen: + + +<!-- ##### MACRO GDK_SCREEN_XSCREEN ##### --> +<para> + +</para> + +@screen: + + <!-- ##### MACRO GDK_VISUAL_XVISUAL ##### --> <para> Returns the X visual belonging to a #GdkVisual. @@ -223,6 +255,16 @@ Returns a #GdkVisual corresponding to a X visual. @Returns: the #GdkVisual. +<!-- ##### FUNCTION gdkx_visual_get_for_screen ##### --> +<para> + +</para> + +@screen: +@xvisualid: +@Returns: + + <!-- ##### FUNCTION gdkx_colormap_get ##### --> <para> Returns a #GdkColormap corresponding to a X colormap. @@ -241,6 +283,16 @@ Returns a #GdkColormap corresponding to a X colormap. @Returns: +<!-- ##### FUNCTION gdk_pixmap_foreign_new_for_display ##### --> +<para> + +</para> + +@display: +@anid: +@Returns: + + <!-- ##### FUNCTION gdk_window_foreign_new ##### --> <para> @@ -250,6 +302,16 @@ Returns a #GdkColormap corresponding to a X colormap. @Returns: +<!-- ##### FUNCTION gdk_window_foreign_new_for_display ##### --> +<para> + +</para> + +@display: +@anid: +@Returns: + + <!-- ##### FUNCTION gdk_xid_table_lookup ##### --> <para> Returns the Gdk object associated with the given X id. @@ -260,6 +322,16 @@ Returns the Gdk object associated with the given X id. a #GdkWindow or a #GdkFont. +<!-- ##### FUNCTION gdk_xid_table_lookup_for_display ##### --> +<para> + +</para> + +@display: +@xid: +@Returns: + + <!-- ##### FUNCTION gdk_window_lookup ##### --> <para> </para> @@ -267,6 +339,17 @@ a #GdkWindow or a #GdkFont. @anid: @Returns: + +<!-- ##### FUNCTION gdk_window_lookup_for_display ##### --> +<para> + +</para> + +@display: +@anid: +@Returns: + + <!-- ##### FUNCTION gdk_pixmap_lookup ##### --> <para> </para> @@ -275,6 +358,16 @@ a #GdkWindow or a #GdkFont. @Returns: +<!-- ##### FUNCTION gdk_pixmap_lookup_for_display ##### --> +<para> + +</para> + +@display: +@anid: +@Returns: + + <!-- ##### MACRO gdk_font_lookup ##### --> <para> Obtains the #GdkFont for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has @@ -284,6 +377,24 @@ been created for @xid. @xid: +<!-- ##### MACRO gdk_font_lookup_for_display ##### --> +<para> + +</para> + +@display: +@xid: + + +<!-- ##### FUNCTION gdk_x11_lookup_xdisplay ##### --> +<para> + +</para> + +@xdisplay: +@Returns: + + <!-- ##### FUNCTION gdk_x11_get_server_time ##### --> <para> @@ -302,6 +413,16 @@ been created for @xid. @Returns: +<!-- ##### FUNCTION gdk_x11_screen_supports_net_wm_hint ##### --> +<para> + +</para> + +@screen: +@property: +@Returns: + + <!-- ##### FUNCTION gdk_x11_colormap_get_xcolormap ##### --> <para> Returns the X colormap belonging to a #GdkColormap. @@ -340,6 +461,15 @@ Returns the display of a #GdkCursor. @Returns: an Xlib <type>Display*</type>. +<!-- ##### FUNCTION gdk_x11_display_get_xdisplay ##### --> +<para> + +</para> + +@display: +@Returns: + + <!-- ##### FUNCTION gdk_x11_drawable_get_xdisplay ##### --> <para> Returns the display of a #GdkDrawable. @@ -461,6 +591,24 @@ Returns the X image belonging to a #GdkImage. @Returns: an <type>XImage*</type>. +<!-- ##### FUNCTION gdk_x11_screen_get_screen_number ##### --> +<para> + +</para> + +@screen: +@Returns: + + +<!-- ##### FUNCTION gdk_x11_screen_get_xscreen ##### --> +<para> + +</para> + +@screen: +@Returns: + + <!-- ##### FUNCTION gdk_x11_ungrab_server ##### --> <para> Ungrab the default display after it has been grabbed with @@ -487,6 +635,18 @@ Returns the X visual belonging to a #GdkVisual. @Returns: +<!-- ##### FUNCTION gdk_x11_atom_to_xatom_for_display ##### --> +<para> + +</para> + +@display: +@atom: +@Returns: +<!-- # Unused Parameters # --> +@virtual_atom: + + <!-- ##### FUNCTION gdk_x11_xatom_to_atom ##### --> <para> @@ -496,6 +656,16 @@ Returns the X visual belonging to a #GdkVisual. @Returns: +<!-- ##### FUNCTION gdk_x11_xatom_to_atom_for_display ##### --> +<para> + +</para> + +@display: +@xatom: +@Returns: + + <!-- ##### FUNCTION gdk_x11_get_xatom_by_name ##### --> <para> @@ -505,6 +675,16 @@ Returns the X visual belonging to a #GdkVisual. @Returns: +<!-- ##### FUNCTION gdk_x11_get_xatom_by_name_for_display ##### --> +<para> + +</para> + +@display: +@atom_name: +@Returns: + + <!-- ##### FUNCTION gdk_x11_get_xatom_name ##### --> <para> @@ -514,3 +694,13 @@ Returns the X visual belonging to a #GdkVisual. @Returns: +<!-- ##### FUNCTION gdk_x11_get_xatom_name_for_display ##### --> +<para> + +</para> + +@display: +@xatom: +@Returns: + + |