From 8b69a33d707ba1e461932fa99f9e6f906de3786a Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Mon, 12 Jul 2004 20:25:34 +0000 Subject: Start of the GTK+ glossary. 2004-07-12 Federico Mena Quintero * gtk/glossary.xml: Start of the GTK+ glossary. * gtk/Makefile.am (content_files): Added glossary.xml. * gtk/gtk-docs.sgml: Likewise. --- docs/reference/ChangeLog | 8 + .../gdk-pixbuf/tmpl/module_interface.sgml | 27 ++ docs/reference/gdk-pixbuf/tmpl/scaling.sgml | 30 ++ docs/reference/gdk/tmpl/event_structs.sgml | 23 ++ docs/reference/gdk/tmpl/gcs.sgml | 39 +-- docs/reference/gtk/Makefile.am | 1 + docs/reference/gtk/glossary.xml | 307 +++++++++++++++++++++ docs/reference/gtk/gtk-docs.sgml | 3 + docs/reference/gtk/tmpl/gtk-unused.sgml | 7 + docs/reference/gtk/tmpl/gtkiconview.sgml | 8 - docs/reference/gtk/tmpl/gtktreeview.sgml | 10 +- 11 files changed, 431 insertions(+), 32 deletions(-) create mode 100644 docs/reference/gtk/glossary.xml (limited to 'docs/reference') diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 352d234a1..09acd1de4 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,11 @@ +2004-07-12 Federico Mena Quintero + + * 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 * gtk/gtk-docs.sgml: Add GtkAboutDialog to "Display diff --git a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml index c745a500a..cca46f9bc 100644 --- a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml @@ -138,6 +138,33 @@ They are not covered by the same stability guarantees as the regular @Returns: + + + + + +@format: +@Returns: + + + + + + + +@format: +@disabled: + + + + + + + +@format: +@Returns: + + A #GdkPixbufFormat contains information about the image format accepted by a diff --git a/docs/reference/gdk-pixbuf/tmpl/scaling.sgml b/docs/reference/gdk-pixbuf/tmpl/scaling.sgml index 6de66aee3..c3a6bc38c 100644 --- a/docs/reference/gdk-pixbuf/tmpl/scaling.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/scaling.sgml @@ -200,3 +200,33 @@ End: @color2: + + + + + +@GDK_PIXBUF_ROTATE_NONE: +@GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE: +@GDK_PIXBUF_ROTATE_UPSIDEDOWN: +@GDK_PIXBUF_ROTATE_CLOCKWISE: + + + + + + +@src: +@angle: +@Returns: + + + + + + + +@src: +@horizontal: +@Returns: + + diff --git a/docs/reference/gdk/tmpl/event_structs.sgml b/docs/reference/gdk/tmpl/event_structs.sgml index 2330c94a0..75790c5d0 100644 --- a/docs/reference/gdk/tmpl/event_structs.sgml +++ b/docs/reference/gdk/tmpl/event_structs.sgml @@ -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. + + + + + +@type: +@window: +@send_event: +@owner: +@reason: +@selection: +@time: +@selection_time: + 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. + + + + + +@GDK_OWNER_CHANGE_NEW_OWNER: +@GDK_OWNER_CHANGE_DESTROY: +@GDK_OWNER_CHANGE_CLOSE: + diff --git a/docs/reference/gdk/tmpl/gcs.sgml b/docs/reference/gdk/tmpl/gcs.sgml index d4fc0562f..884bc5d4d 100644 --- a/docs/reference/gdk/tmpl/gcs.sgml +++ b/docs/reference/gdk/tmpl/gcs.sgml @@ -122,7 +122,7 @@ useful. For bitmaps, %GDK_AND and %GDK_OR are also useful. @drawable: -@Returns: +@Returns: @@ -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. +@Deprecated: Use gdk_object_unref() instead @gc: a #GdkGC. -@Deprecated: Use gdk_object_unref() instead + @@ -186,8 +187,8 @@ This function is obsolete and should not be used. -@gc: -@values: +@gc: +@values: @@ -204,8 +205,8 @@ This function is obsolete and should not be used. -@gc: -@color: +@gc: +@color: @@ -231,8 +232,8 @@ This function is obsolete and should not be used. -@gc: -@font: +@gc: +@font: @@ -240,7 +241,7 @@ This function is obsolete and should not be used. -@gc: +@gc: @function: @@ -249,8 +250,8 @@ This function is obsolete and should not be used. -@gc: -@fill: +@gc: +@fill: @@ -274,8 +275,8 @@ Determines how primitives are drawn. -@gc: -@tile: +@gc: +@tile: @@ -292,7 +293,7 @@ Determines how primitives are drawn. -@gc: +@gc: @x: @y: @@ -302,7 +303,7 @@ Determines how primitives are drawn. -@gc: +@gc: @x: @y: @@ -329,7 +330,7 @@ Determines how primitives are drawn. -@gc: +@gc: @region: @@ -369,7 +370,7 @@ windows of that window. @line_width: @line_style: @cap_style: -@join_style: +@join_style: @@ -423,7 +424,7 @@ Determines how the joins between segments of a polygon are drawn. -@dst_gc: +@dst_gc: @src_gc: diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index 6765cdb6c..cf330ec54 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -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 \ diff --git a/docs/reference/gtk/glossary.xml b/docs/reference/gtk/glossary.xml new file mode 100644 index 000000000..3c2e54099 --- /dev/null +++ b/docs/reference/gtk/glossary.xml @@ -0,0 +1,307 @@ + + Glossary + + + allocation + + + The final size of a widget within its parent. For example, a widget + may request a minimum size of 20×20 pixels, but its + parent may decide to allocate 50×20 pixels for it + instead. + + + requisition + + + + + + bin + + + A container that + can hold at most one child widget. The base class for bins is + GtkBin. + + + container + + + + + + child + + + A container's child + is a widget contained + inside it. + + + + + + column + + + FIXME + + model column + view column + + + + + container + + + A widget that contains + other widgets; in that case, the container is the + parent of the child + widgets. Some containers don't draw anything on their own, + but rather just organize their children's geometry; for example, GtkVBox lays out its children + vertically without painting anything on its own. Other + containers include decorative elements; for example, GtkFrame contains the frame's child + and a label in addition to the shaded frame it draws. The + base class for containers is GtkContainer. + + + widget + geometry + + + + + + display + + + FIXME + + + + + + event + + + FIXME + + + + + + geometry + + + A widget's position + and size. Within its parent, this is called the widget's + allocation. + + + + + + mapping + + + This is the step in a widget's life cycle where it + actually shows the GdkWindows it created when it was + realized. When a + widget is mapped, it must turn on its + GTK_MAPPED flag. + + + + 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 gdk_window_show(): + you must wait for the corresponding map event to be received. You can do + this with the GtkWidget::map-event + signal. + + + + + + model column + + + FIXME + + + + + + no-window widget + + + A widget that does not have a GdkWindow of its own on which to + draw its contents, but rather shares its parent's. Such a widget has the + GTK_NO_WINDOW flag set, and can be tested + with the GTK_WIDGET_NO_WINDOW() + macro. + + + + + + parent + + + A widget's parent is + the container + inside which it resides. + + + + + + realization + + + This is the step in a widget's life cycle where it + creates its own GdkWindow, or otherwise associates itself with + its parent's + GdkWindow. If the widget has its own window, then it must + also attach a style to + it. A widget becomes unrealized by destroying its associated + GdkWindow. When a widget is realized, it must turn on its + GTK_REALIZED flag. + + + + Widgets that don't own the GdkWindow on which they draw are + called no-window + widgets. This can be tested with the GTK_WIDGET_NO_WINDOW() + macro. Normally, these widgets draw on their parent's + GdkWindow. + + + + Note that when a widget creates a window in its ::realize() + 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 mapped. + + + + + + requisition + + + The size requisition of a widget is the minimum amount of + space it requests from its parent. Once the parent computes + the widget's final size, it gives it its size allocation. + + + allocation + + + + + + screen + + + FIXME + + + + + + style + + + FIXME + + + + + + toplevel + + + A widget that does not + require a parent + container. The only toplevel widget in GTK+ is GtkWindow. + + + container + + + + + + unmap + mapping + + + + unrealize + realization + + + + view column + + + FIXME + + + + + + widget + + + 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 containers, and these take + care of assigning the geometry of the widgets: every + widget thus has a parent except those widgets which are + toplevels. The base + class for widgets is GtkWidget. + + + container + + + + + + diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index 8e6eaf57a..efa61b1b0 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -188,6 +188,7 @@ + ]> @@ -563,6 +564,8 @@ that is, GUI components such as GtkButton or >k-query-immodules; + >k-glossary; + Index diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index 32410491b..a8a0016e9 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -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. + + + + + +@Returns: + Get the type of GtkIdentifier. diff --git a/docs/reference/gtk/tmpl/gtkiconview.sgml b/docs/reference/gtk/tmpl/gtkiconview.sgml index 0ec291d9e..1d1d3705f 100644 --- a/docs/reference/gtk/tmpl/gtkiconview.sgml +++ b/docs/reference/gtk/tmpl/gtkiconview.sgml @@ -331,11 +331,3 @@ A widget which displays a list of icons in a grid @path: - - - - - -@Returns: - - diff --git a/docs/reference/gtk/tmpl/gtktreeview.sgml b/docs/reference/gtk/tmpl/gtktreeview.sgml index ef983db4b..a1095d034 100644 --- a/docs/reference/gtk/tmpl/gtktreeview.sgml +++ b/docs/reference/gtk/tmpl/gtktreeview.sgml @@ -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. -@tree_view: -@Returns: +@tree_view: +@Returns: @@ -1040,8 +1040,8 @@ returns. @tree_view: -@func: -@data: +@func: +@data: @destroy: -- cgit v1.2.1