Commit 8b69a33d authored by Federico Mena Quintero's avatar Federico Mena Quintero Committed by Federico Mena Quintero
Browse files

Start of the GTK+ glossary.

2004-07-12  Federico Mena Quintero  <federico@ximian.com>

	* gtk/glossary.xml: Start of the GTK+ glossary.

	* gtk/Makefile.am (content_files): Added glossary.xml.

	* gtk/gtk-docs.sgml: Likewise.
parent 24162d33
2004-07-12 Federico Mena Quintero <federico@ximian.com>
* gtk/glossary.xml: Start of the GTK+ glossary.
* gtk/Makefile.am (content_files): Added glossary.xml.
* gtk/gtk-docs.sgml: Likewise.
2004-07-12 Matthias Clasen <mclasen@redhat.com>
* gtk/gtk-docs.sgml: Add GtkAboutDialog to "Display
......
......@@ -138,6 +138,33 @@ They are not covered by the same stability guarantees as the regular
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_format_is_disabled ##### -->
<para>
</para>
@format:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_format_set_disabled ##### -->
<para>
</para>
@format:
@disabled:
<!-- ##### FUNCTION gdk_pixbuf_format_get_license ##### -->
<para>
</para>
@format:
@Returns:
<!-- ##### STRUCT GdkPixbufFormat ##### -->
<para>
A #GdkPixbufFormat contains information about the image format accepted by a
......
......@@ -200,3 +200,33 @@ End:
@color2:
<!-- ##### ENUM GdkPixbufRotation ##### -->
<para>
</para>
@GDK_PIXBUF_ROTATE_NONE:
@GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE:
@GDK_PIXBUF_ROTATE_UPSIDEDOWN:
@GDK_PIXBUF_ROTATE_CLOCKWISE:
<!-- ##### FUNCTION gdk_pixbuf_rotate_simple ##### -->
<para>
</para>
@src:
@angle:
@Returns:
<!-- ##### FUNCTION gdk_pixbuf_flip ##### -->
<para>
</para>
@src:
@horizontal:
@Returns:
......@@ -405,6 +405,20 @@ Generated when a setting is modified.
%GDK_SETTING_ACTION_CHANGED or %GDK_SETTING_ACTION_DELETED).
@name: the name of the setting.
<!-- ##### STRUCT GdkEventOwnerChange ##### -->
<para>
</para>
@type:
@window:
@send_event:
@owner:
@reason:
@selection:
@time:
@selection_time:
<!-- ##### ENUM GdkScrollDirection ##### -->
<para>
Specifies the direction for #GdkEventScroll.
......@@ -486,3 +500,12 @@ Specifies the kind of modification applied to a setting in a #GdkEventSetting.
@GDK_SETTING_ACTION_CHANGED: a setting was changed.
@GDK_SETTING_ACTION_DELETED: a setting was deleted.
<!-- ##### ENUM GdkOwnerChange ##### -->
<para>
</para>
@GDK_OWNER_CHANGE_NEW_OWNER:
@GDK_OWNER_CHANGE_DESTROY:
@GDK_OWNER_CHANGE_CLOSE:
......@@ -122,7 +122,7 @@ useful. For bitmaps, %GDK_AND and %GDK_OR are also useful.
</para>
@drawable:
@Returns:
@Returns:
<!-- ##### FUNCTION gdk_gc_new_with_values ##### -->
......@@ -132,7 +132,7 @@ useful. For bitmaps, %GDK_AND and %GDK_OR are also useful.
@drawable:
@values:
@values_mask:
@values_mask:
@Returns:
......@@ -167,9 +167,10 @@ useful. For bitmaps, %GDK_AND and %GDK_OR are also useful.
This function is obsolete and should not be used.
</para>
@Deprecated: Use gdk_object_unref() instead
<!-- # Unused Parameters # -->
@gc: a #GdkGC.
@Deprecated: Use gdk_object_unref() instead
<!-- ##### FUNCTION gdk_gc_set_values ##### -->
<para>
......@@ -186,8 +187,8 @@ This function is obsolete and should not be used.
</para>
@gc:
@values:
@gc:
@values:
<!-- ##### FUNCTION gdk_gc_set_foreground ##### -->
......@@ -204,8 +205,8 @@ This function is obsolete and should not be used.
</para>
@gc:
@color:
@gc:
@color:
<!-- ##### FUNCTION gdk_gc_set_rgb_fg_color ##### -->
......@@ -231,8 +232,8 @@ This function is obsolete and should not be used.
</para>
@gc:
@font:
@gc:
@font:
<!-- ##### FUNCTION gdk_gc_set_function ##### -->
......@@ -240,7 +241,7 @@ This function is obsolete and should not be used.
</para>
@gc:
@gc:
@function:
......@@ -249,8 +250,8 @@ This function is obsolete and should not be used.
</para>
@gc:
@fill:
@gc:
@fill:
<!-- ##### ENUM GdkFill ##### -->
......@@ -274,8 +275,8 @@ Determines how primitives are drawn.
</para>
@gc:
@tile:
@gc:
@tile:
<!-- ##### FUNCTION gdk_gc_set_stipple ##### -->
......@@ -292,7 +293,7 @@ Determines how primitives are drawn.
</para>
@gc:
@gc:
@x:
@y:
......@@ -302,7 +303,7 @@ Determines how primitives are drawn.
</para>
@gc:
@gc:
@x:
@y:
......@@ -329,7 +330,7 @@ Determines how primitives are drawn.
</para>
@gc:
@gc:
@region:
......@@ -369,7 +370,7 @@ windows of that window.
@line_width:
@line_style:
@cap_style:
@join_style:
@join_style:
<!-- ##### ENUM GdkLineStyle ##### -->
......@@ -423,7 +424,7 @@ Determines how the joins between segments of a polygon are drawn.
</para>
@dst_gc:
@dst_gc:
@src_gc:
......
......@@ -93,6 +93,7 @@ content_files = \
changes-2.0.sgml \
compiling.sgml \
framebuffer.sgml \
glossary.xml \
migrating-checklist.sgml \
migrating-GtkAction.sgml \
migrating-GtkComboBox.sgml \
......
<glossary id="glossary">
<title>Glossary</title>
<glossentry id="allocation">
<glossterm>allocation</glossterm>
<glossdef>
<para>
The final size of a <glossterm
linkend="widget">widget</glossterm> within its <glossterm
linkend="parent">parent</glossterm>. For example, a widget
may request a minimum size of 20&times;20 pixels, but its
parent may decide to allocate 50&times;20 pixels for it
instead.
</para>
<glossseealso>
<glossterm linkend="requisition">requisition</glossterm>
</glossseealso>
</glossdef>
</glossentry>
<glossentry id="bin">
<glossterm>bin</glossterm>
<glossdef>
<para>
A <glossterm linkend="container">container</glossterm> that
can hold at most one child widget. The base class for bins is
<link linkend="GtkBin">GtkBin</link>.
</para>
<glossseealso>
<glossterm linkend="container">container</glossterm>
</glossseealso>
</glossdef>
</glossentry>
<glossentry id="child">
<glossterm>child</glossterm>
<glossdef>
<para>
A <glossterm linkend="container">container's</glossterm> child
is a <glossterm linkend="widget">widget</glossterm> contained
inside it.
</para>
</glossdef>
</glossentry>
<glossentry id="column">
<glossterm>column</glossterm>
<glossdef>
<para>
FIXME
</para>
<glossseealso>model column</glossseealso>
<glossseealso>view column</glossseealso>
</glossdef>
</glossentry>
<glossentry id="container">
<glossterm>container</glossterm>
<glossdef>
<para>
A <glossterm linkend="widget">widget</glossterm> that contains
other widgets; in that case, the container is the
<emphasis>parent</emphasis> of the <emphasis>child</emphasis>
widgets. Some containers don't draw anything on their own,
but rather just organize their children's <glossterm
linkend="geometry">geometry</glossterm>; for example, <link
linkend="GtkVBox">GtkVBox</link> lays out its children
vertically without painting anything on its own. Other
containers include decorative elements; for example, <link
linkend="GtkFrame">GtkFrame</link> contains the frame's child
and a label in addition to the shaded frame it draws. The
base class for containers is <link
linkend="GtkContainer">GtkContainer</link>.
</para>
<glossseealso>
<glossterm linkend="container">widget</glossterm>
<glossterm linkend="container">geometry</glossterm>
</glossseealso>
</glossdef>
</glossentry>
<glossentry id="display">
<glossterm>display</glossterm>
<glossdef>
<para>
FIXME
</para>
</glossdef>
</glossentry>
<glossentry id="event">
<glossterm>event</glossterm>
<glossdef>
<para>
FIXME
</para>
</glossdef>
</glossentry>
<glossentry id="geometry">
<glossterm>geometry</glossterm>
<glossdef>
<para>
A <glossterm linkend="widget">widget's</glossterm> position
and size. Within its parent, this is called the widget's
<glossterm linkend="allocation">allocation</glossterm>.
</para>
</glossdef>
</glossentry>
<glossentry id="mapping">
<glossterm>mapping</glossterm>
<glossdef>
<para>
This is the step in a <glossterm
linkend="widget">widget's</glossterm> life cycle where it
actually shows the GdkWindows it created when it was
<glossterm linkend="realization">realized</glossterm>. When a
widget is mapped, it must turn on its
<constant>GTK_MAPPED</constant> <link
linkend="GtkWidgetFlags">flag</link>.
</para>
<para>
Note that due to the asynchronous nature of the X window
system, a widget's window may not appear on the screen
immediatly after one calls <link
linkend="gdk-window-show"><function>gdk_window_show()</function></link>:
you must wait for the corresponding map <glossterm
linkend="event">event</glossterm> to be received. You can do
this with the <link
linkend="GtkWidget-map-event"><methodname>GtkWidget::map-event</methodname>
signal</link>.
</para>
</glossdef>
</glossentry>
<glossentry id="model-column">
<glossterm>model column</glossterm>
<glossdef>
<para>
FIXME
</para>
</glossdef>
</glossentry>
<glossentry id="no-window">
<glossterm>no-window widget</glossterm>
<glossdef>
<para>
A widget that does not have a GdkWindow of its own on which to
draw its contents, but rather shares its <glossterm
linkend="parent">parent's</glossterm>. Such a widget has the
<constant>GTK_NO_WINDOW</constant> <link
linkend="GtkWidgetFlags">flag</link> set, and can be tested
with the <link
linkend="gtk-widget-no-window-caps"><function>GTK_WIDGET_NO_WINDOW()</function></link>
macro.
</para>
</glossdef>
</glossentry>
<glossentry id="parent">
<glossterm>parent</glossterm>
<glossdef>
<para>
A <glossterm linkend="widget">widget's</glossterm> parent is
the <glossterm linkend="container">container</glossterm>
inside which it resides.
</para>
</glossdef>
</glossentry>
<glossentry id="realization">
<glossterm>realization</glossterm>
<glossdef>
<para>
This is the step in a <glossterm
linkend="widget">widget's</glossterm> life cycle where it
creates its own GdkWindow, or otherwise associates itself with
its <glossterm linkend="parent">parent's</glossterm>
GdkWindow. If the widget has its own window, then it must
also attach a <glossterm linkend="style">style</glossterm> to
it. A widget becomes unrealized by destroying its associated
GdkWindow. When a widget is realized, it must turn on its
<constant>GTK_REALIZED</constant> <link
linkend="GtkWidgetFlags">flag</link>.
</para>
<para>
Widgets that don't own the GdkWindow on which they draw are
called <glossterm linkend="no-window">no-window
widgets</glossterm>. This can be tested with the <link
linkend="gtk-widget-no-window-caps"><function>GTK_WIDGET_NO_WINDOW()</function></link>
macro. Normally, these widgets draw on their parent's
GdkWindow.
</para>
<para>
Note that when a widget creates a window in its <link
linkend="gtkwidget-realize"><methodname>::realize()</methodname></link>
handler, it does not actually show the window. That is, the
window's structure is just created in memory. The widget
actually shows the window when it gets <glossterm
linkend="mapping">mapped</glossterm>.
</para>
</glossdef>
</glossentry>
<glossentry id="requisition">
<glossterm>requisition</glossterm>
<glossdef>
<para>
The size requisition of a <glossterm
linkend="widget">widget</glossterm> is the minimum amount of
space it requests from its <glossterm
linkend="parent">parent</glossterm>. Once the parent computes
the widget's final size, it gives it its <glossterm
linkend="allocation">size allocation</glossterm>.
</para>
<glossseealso>
<glossterm linkend="allocation">allocation</glossterm>
</glossseealso>
</glossdef>
</glossentry>
<glossentry id="screen">
<glossterm>screen</glossterm>
<glossdef>
<para>
FIXME
</para>
</glossdef>
</glossentry>
<glossentry id="style">
<glossterm>style</glossterm>
<glossdef>
<para>
FIXME
</para>
</glossdef>
</glossentry>
<glossentry id="toplevel">
<glossterm>toplevel</glossterm>
<glossdef>
<para>
A <glossterm linkend="widget">widget</glossterm> that does not
require a <glossterm linkend="parent">parent</glossterm>
container. The only toplevel widget in GTK+ is <link
linkend="GtkWindow">GtkWindow</link>.
</para>
<glossseealso>
<glossterm linkend="container">container</glossterm>
</glossseealso>
</glossdef>
</glossentry>
<glossentry id="unmap">
<glossterm>unmap</glossterm>
<glosssee><glossterm linkend="mapping">mapping</glossterm></glosssee>
</glossentry>
<glossentry id="unrealize">
<glossterm>unrealize</glossterm>
<glosssee><glossterm linkend="realization">realization</glossterm></glosssee>
</glossentry>
<glossentry id="view-column">
<glossterm>view column</glossterm>
<glossdef>
<para>
FIXME
</para>
</glossdef>
</glossentry>
<glossentry id="widget">
<glossterm>widget</glossterm>
<glossdef>
<para>
A control in a graphical user interface. Widgets can draw
themselves and process events from the mouse and keyboard.
Widget types include buttons, menus, text entry lines, and
lists. Widgets can be arranged into <glossterm
linkend="container">containers</glossterm>, and these take
care of assigning the <glossterm
linkend="geometry">geometry</glossterm> of the widgets: every
widget thus has a parent except those widgets which are
<glossterm linkend="toplevel">toplevels</glossterm>. The base
class for widgets is <link
linkend="GtkWidget">GtkWidget</link>.
</para>
<glossseealso>
<glossterm linkend="container">container</glossterm>
</glossseealso>
</glossdef>
</glossentry>
</glossary>
<!--
Local variables:
mode: sgml
sgml-parent-document: ("gtk-docs.sgml" "book" "glossary")
End:
-->
......@@ -188,6 +188,7 @@
<!ENTITY gtk-migrating-GtkComboBox SYSTEM "migrating-GtkComboBox.sgml">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY gtk-query-immodules SYSTEM "gtk-query-immodules-2.0.xml">
<!ENTITY gtk-glossary SYSTEM "glossary.xml">
]>
<book id="index">
<bookinfo>
......@@ -563,6 +564,8 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
&gtk-query-immodules;
</part>
&gtk-glossary;
<index>
<title>Index</title>
</index>
......
......@@ -2166,6 +2166,13 @@ will be shown, or NULL to show all spacings.
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
<!-- ##### FUNCTION gtk_icon_view_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_identifier_get_type ##### -->
<para>
Get the type of GtkIdentifier.
......
......@@ -331,11 +331,3 @@ A widget which displays a list of icons in a grid
@path:
<!-- ##### FUNCTION gtk_icon_view_get_type ##### -->
<para>
</para>
@Returns:
......@@ -1021,7 +1021,7 @@ returns.
@model: the #GtkTreeModel
@iter: a #GtkTreeIter pointing at a row in @model
@data: user data
@data: user data
@Returns: %TRUE if the row is a separator
......@@ -1030,8 +1030,8 @@ returns.
</para>
@tree_view:
@Returns:
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->
......@@ -1040,8 +1040,8 @@ returns.
</para>
@tree_view:
@func:
@data:
@func:
@data:
@destroy: