Commit 7788a6a7 authored by Matthias Clasen's avatar Matthias Clasen

Document GdkScreen.

	* gdk/tmpl/windows.sgml: Document GdkScreen.

	* gtk/gtk-sections.txt: Move a few Class structs to Standard sections.

	* gtk/tmpl/gtktreemodel.sgml, gtk/tmpl/gtkprogress.sgml,
	gtk/tmpl/gtksignal.sgml, gtk/tmpl/gtkimage.sgml: Generate proper
	markup for format strings in examples, also fix an oversight in
	the GtkTreeModel example.  (#74213)
parent 57c31b50
2002-03-12 Matthias Clasen <maclas@gmx.de>
* gdk/tmpl/windows.sgml: Document GdkScreen.
* gtk/gtk-sections.txt: Move a few Class structs to Standard sections.
2002-03-11 Matthias Clasen <maclas@gmx.de> 2002-03-11 Matthias Clasen <maclas@gmx.de>
* gtk/tmpl/gtktreemodel.sgml, gtk/tmpl/gtkprogress.sgml,
gtk/tmpl/gtksignal.sgml, gtk/tmpl/gtkimage.sgml: Generate proper
markup for format strings in examples, also fix an oversight in
the GtkTreeModel example. (#74213)
* gtk/gtk.types: Add interfaces to get docs on their signals. * gtk/gtk.types: Add interfaces to get docs on their signals.
Sat Mar 9 13:00:38 2002 Jonathan Blandford <jrb@redhat.com> Sat Mar 9 13:00:38 2002 Jonathan Blandford <jrb@redhat.com>
......
...@@ -240,7 +240,9 @@ corresponding flag in #GdkWindowAttributesType. ...@@ -240,7 +240,9 @@ corresponding flag in #GdkWindowAttributesType.
<!-- ##### STRUCT GdkScreen ##### --> <!-- ##### STRUCT GdkScreen ##### -->
<para> <para>
This is a currently just a placeholder typedef for the first argument of
the @window_at_pointer function in #GdkPointerHooks. It will be used
when GDK gets multihead support.
</para> </para>
......
...@@ -1169,7 +1169,6 @@ GtkImageAnimationData ...@@ -1169,7 +1169,6 @@ GtkImageAnimationData
<FILE>gtkimagemenuitem</FILE> <FILE>gtkimagemenuitem</FILE>
<TITLE>GtkImageMenuItem</TITLE> <TITLE>GtkImageMenuItem</TITLE>
GtkImageMenuItem GtkImageMenuItem
GtkImageMenuItemClass
gtk_image_menu_item_set_image gtk_image_menu_item_set_image
gtk_image_menu_item_get_image gtk_image_menu_item_get_image
gtk_image_menu_item_new gtk_image_menu_item_new
...@@ -1177,6 +1176,7 @@ gtk_image_menu_item_new_from_stock ...@@ -1177,6 +1176,7 @@ gtk_image_menu_item_new_from_stock
gtk_image_menu_item_new_with_label gtk_image_menu_item_new_with_label
gtk_image_menu_item_new_with_mnemonic gtk_image_menu_item_new_with_mnemonic
<SUBSECTION Standard> <SUBSECTION Standard>
GtkImageMenuItemClass
GTK_IMAGE_MENU_ITEM GTK_IMAGE_MENU_ITEM
GTK_IMAGE_MENU_ITEM_CLASS GTK_IMAGE_MENU_ITEM_CLASS
GTK_IMAGE_MENU_ITEM_GET_CLASS GTK_IMAGE_MENU_ITEM_GET_CLASS
...@@ -2101,7 +2101,6 @@ gtk_separator_menu_item_get_type ...@@ -2101,7 +2101,6 @@ gtk_separator_menu_item_get_type
<FILE>gtksettings</FILE> <FILE>gtksettings</FILE>
<TITLE>GtkSettings</TITLE> <TITLE>GtkSettings</TITLE>
GtkSettings GtkSettings
GtkSettingsClass
GtkSettingsValue GtkSettingsValue
gtk_settings_get_default gtk_settings_get_default
gtk_settings_install_property gtk_settings_install_property
...@@ -2116,6 +2115,7 @@ gtk_settings_set_string_property ...@@ -2116,6 +2115,7 @@ gtk_settings_set_string_property
gtk_settings_set_long_property gtk_settings_set_long_property
gtk_settings_set_double_property gtk_settings_set_double_property
<SUBSECTION Standard> <SUBSECTION Standard>
GtkSettingsClass
GTK_IS_SETTINGS GTK_IS_SETTINGS
GTK_IS_SETTINGS_CLASS GTK_IS_SETTINGS_CLASS
GTK_SETTINGS GTK_SETTINGS
...@@ -2582,7 +2582,6 @@ gtk_text_view_starts_display_line ...@@ -2582,7 +2582,6 @@ gtk_text_view_starts_display_line
gtk_text_view_move_visually gtk_text_view_move_visually
gtk_text_view_add_child_at_anchor gtk_text_view_add_child_at_anchor
GtkTextChildAnchor GtkTextChildAnchor
GtkTextChildAnchorClass
gtk_text_child_anchor_new gtk_text_child_anchor_new
gtk_text_child_anchor_get_widgets gtk_text_child_anchor_get_widgets
gtk_text_child_anchor_get_deleted gtk_text_child_anchor_get_deleted
...@@ -2619,6 +2618,7 @@ GTK_TYPE_TEXT_VIEW ...@@ -2619,6 +2618,7 @@ GTK_TYPE_TEXT_VIEW
GTK_TEXT_VIEW_CLASS GTK_TEXT_VIEW_CLASS
GTK_IS_TEXT_VIEW_CLASS GTK_IS_TEXT_VIEW_CLASS
GTK_TEXT_VIEW_GET_CLASS GTK_TEXT_VIEW_GET_CLASS
GtkTextChildAnchorClass
GTK_TEXT_CHILD_ANCHOR GTK_TEXT_CHILD_ANCHOR
GTK_IS_TEXT_CHILD_ANCHOR GTK_IS_TEXT_CHILD_ANCHOR
GTK_TYPE_TEXT_CHILD_ANCHOR GTK_TYPE_TEXT_CHILD_ANCHOR
...@@ -3839,7 +3839,6 @@ gtk_gc_release ...@@ -3839,7 +3839,6 @@ gtk_gc_release
<TITLE>GtkStyle</TITLE> <TITLE>GtkStyle</TITLE>
GTK_STYLE_ATTACHED GTK_STYLE_ATTACHED
GtkStyle GtkStyle
GtkStyleClass
gtk_style_new gtk_style_new
gtk_style_copy gtk_style_copy
gtk_style_attach gtk_style_attach
...@@ -3906,6 +3905,7 @@ GtkRcProperty ...@@ -3906,6 +3905,7 @@ GtkRcProperty
GtkRcPropertyParser GtkRcPropertyParser
<SUBSECTION Standard> <SUBSECTION Standard>
GtkStyleClass
GTK_STYLE GTK_STYLE
GTK_IS_STYLE GTK_IS_STYLE
GTK_TYPE_STYLE GTK_TYPE_STYLE
...@@ -3935,7 +3935,6 @@ gtk_theme_engine_get_type ...@@ -3935,7 +3935,6 @@ gtk_theme_engine_get_type
<FILE>gtkrc</FILE> <FILE>gtkrc</FILE>
<TITLE>Resource Files</TITLE> <TITLE>Resource Files</TITLE>
GtkRcStyle GtkRcStyle
GtkRcStyleClass
GtkRcFlags GtkRcFlags
GtkRcTokenType GtkRcTokenType
gtk_rc_scanner_new gtk_rc_scanner_new
...@@ -3966,6 +3965,7 @@ gtk_rc_style_ref ...@@ -3966,6 +3965,7 @@ gtk_rc_style_ref
gtk_rc_style_unref gtk_rc_style_unref
<SUBSECTION Standard> <SUBSECTION Standard>
GtkRcStyleClass
GTK_RC_STYLE GTK_RC_STYLE
GTK_IS_RC_STYLE GTK_IS_RC_STYLE
GTK_TYPE_RC_STYLE GTK_TYPE_RC_STYLE
......
...@@ -45,7 +45,7 @@ on the image, such as button clicks, place the image inside a ...@@ -45,7 +45,7 @@ on the image, such as button clicks, place the image inside a
GdkEventButton *event, GdkEventButton *event,
gpointer data) gpointer data)
{ {
g_print ("Event box clicked at coordinates %%d,%%d\n", g_print ("Event box clicked at coordinates &percent;d,&percent;d\n",
event->x, event->y); event->x, event->y);
/* Returning TRUE means we handled the event, so the signal /* Returning TRUE means we handled the event, so the signal
......
...@@ -53,22 +53,22 @@ current progress. The string can contain the following substitution characters: ...@@ -53,22 +53,22 @@ current progress. The string can contain the following substitution characters:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
%%v - the current progress value. &percent;v - the current progress value.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
%%l - the lower bound for the progress value. &percent;l - the lower bound for the progress value.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
%%u - the upper bound for the progress value. &percent;u - the upper bound for the progress value.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
%%p - the current progress percentage. &percent;p - the current progress percentage.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
......
...@@ -450,7 +450,7 @@ as parameter to your function: ...@@ -450,7 +450,7 @@ as parameter to your function:
<programlisting> <programlisting>
static void button_clicked_int (GtkButton* button, gpointer func_data) static void button_clicked_int (GtkButton* button, gpointer func_data)
{ {
g_print ("button pressed: %%d\n", GPOINTER_TO_INT (func_data)); g_print ("button pressed: &percent;d\n", GPOINTER_TO_INT (func_data));
} }
/* By calling this function, you will make the g_print above /* By calling this function, you will make the g_print above
......
...@@ -103,7 +103,7 @@ the second is much more common, as you often get paths from callbacks. ...@@ -103,7 +103,7 @@ the second is much more common, as you often get paths from callbacks.
<para> <para>
<example> <example>
<title>Acquiring a <structname>GtkTreeIter</structname></title> <title>Acquiring a <structname>GtkTreeIter</structname></title>
<programlisting><![CDATA[ <programlisting>
/* Three ways of getting the iter pointing to the location /* Three ways of getting the iter pointing to the location
*/ */
{ {
...@@ -112,22 +112,21 @@ the second is much more common, as you often get paths from callbacks. ...@@ -112,22 +112,21 @@ the second is much more common, as you often get paths from callbacks.
GtkTreeIter parent_iter; GtkTreeIter parent_iter;
/* get the iterator from a string */ /* get the iterator from a string */
gtk_tree_model_get_iter_from_string (model, &iter, "3:2:5"); gtk_tree_model_get_iter_from_string (model, &amp;iter, "3:2:5");
/* get the iterator from a path */ /* get the iterator from a path */
path = gtk_tree_path_new_from_string ("3:2:5"); path = gtk_tree_path_new_from_string ("3:2:5");
gtk_tree_model_get_iter (model, &iter, path); gtk_tree_model_get_iter (model, &amp;iter, path);
gtk_tree_path_free (path); gtk_tree_path_free (path);
/* walk the tree to find the iterator */ /* walk the tree to find the iterator */
gtk_tree_model_get_nth_child (model, &iter, NULL, 3); gtk_tree_model_get_nth_child (model, &amp;iter, NULL, 3);
parent_iter = iter; parent_iter = iter;
gtk_tree_model_get_nth_child (model, &iter, &parent_iter, 2); gtk_tree_model_get_nth_child (model, &amp;iter, &amp;parent_iter, 2);
parent_iter = iter; parent_iter = iter;
gtk_tree_model_get_nth_child (model, &iter, NULL, 5); gtk_tree_model_get_nth_child (model, &amp;iter, NULL, 5);
} }
]]>
</programlisting> </programlisting>
</example> </example>
</para> </para>
...@@ -140,7 +139,7 @@ it is specific to the #GtkListStore. For information on how to write ...@@ -140,7 +139,7 @@ it is specific to the #GtkListStore. For information on how to write
such a function, see the #GtkListStore documentation. such a function, see the #GtkListStore documentation.
<example> <example>
<title>Reading data from a <structname>GtkTreeModel</structname></title> <title>Reading data from a <structname>GtkTreeModel</structname></title>
<programlisting><![CDATA[ <programlisting>
enum enum
{ {
STRING_COLUMN, STRING_COLUMN,
...@@ -159,7 +158,7 @@ enum ...@@ -159,7 +158,7 @@ enum
populate_model (list_store); populate_model (list_store);
/* Get the first iter in the list */ /* Get the first iter in the list */
if (gtk_tree_model_get_iter_first (model, &iter)) if (gtk_tree_model_get_iter_first (model, &amp;iter))
{ {
gint row_count = 0; gint row_count = 0;
...@@ -169,30 +168,28 @@ enum ...@@ -169,30 +168,28 @@ enum
gchar *str_data; gchar *str_data;
gint int_data; gint int_data;
/* Make sure you terminate calls to gtk_tree_model_get /* Make sure you terminate calls to gtk_tree_model_get(<!>)
* with a '-1' value * with a '-1' value
*/ */
gtk_tree_model_get (list_store, gtk_tree_model_get (list_store, &amp;iter,
STRING_COLUMN, &str_data, STRING_COLUMN, &amp;str_data,
INT_COLUMN, &int_data, INT_COLUMN, &amp;int_data,
-1); -1);
/* Do something with the data */ /* Do something with the data */
g_print ("Row %d: (%s,%d)\n", row_count, str_data, int_data); g_print ("Row &percent;d: (&percent;s,&percent;d)\n", row_count, str_data, int_data);
g_free (str_data); g_free (str_data);
row_count ++; row_count ++;
} }
while (gtk_tree_model_iter_next (model, &iter)); while (gtk_tree_model_iter_next (model, &amp;iter));
} }
else else
{ {
/* As gtk_tree_model_get_iter_first returned FALSE, the list is empty */ /* As gtk_tree_model_get_iter_first(<!>) returned FALSE, the list is empty */
g_print ("Model is empty.\n"); g_print ("Model is empty.\n");
} }
} }
]]>
</programlisting> </programlisting>
</example> </example>
</para> </para>
...@@ -795,3 +792,48 @@ versions of GTK+. ...@@ -795,3 +792,48 @@ versions of GTK+.
@new_order: @new_order:
<!-- ##### SIGNAL GtkTreeModel::row-changed ##### -->
<para>
</para>
@treemodel: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeModel::row-deleted ##### -->
<para>
</para>
@treemodel: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkTreeModel::row-has-child-toggled ##### -->
<para>
</para>
@treemodel: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeModel::row-inserted ##### -->
<para>
</para>
@treemodel: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeModel::rows-reordered ##### -->
<para>
</para>
@treemodel: the object which received the signal.
@arg1:
@arg2:
@arg3:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment