From c3e01fe599d7f6d7cb313545f9c136afb6a9fd68 Mon Sep 17 00:00:00 2001 From: Damon Chaplin Date: Sat, 25 Sep 1999 09:20:23 +0000 Subject: [PATCH] partially written documentation from Paul Schifferer 1999-09-24 Damon Chaplin * gtk/tmpl/gtkclist.sgml: partially written documentation from Paul Schifferer who won't be able to finish it --- docs/reference/gtk/tmpl/gtkclist.sgml | 371 ++++++++++++++---------- docs/reference/gtk/tmpl/gtkimage.sgml | 4 +- docs/reference/gtk/tmpl/gtkmenubar.sgml | 2 +- 3 files changed, 216 insertions(+), 161 deletions(-) diff --git a/docs/reference/gtk/tmpl/gtkclist.sgml b/docs/reference/gtk/tmpl/gtkclist.sgml index 0c5263ce8..28138a5cc 100644 --- a/docs/reference/gtk/tmpl/gtkclist.sgml +++ b/docs/reference/gtk/tmpl/gtkclist.sgml @@ -2,11 +2,13 @@ GtkCList - +A multi-columned scrolling list widget. - +The #GtkCList widget is a very useful multi-columned scrolling list. It can display +data in nicely aligned vertical columns, with titles at the top of the list. +FIXME: More info @@ -16,13 +18,14 @@ GtkCList - +This is the embodiment of the #GtkCList widget. - +Identifies the type of element in the current cell of the CList. Cells can +contain text, pixmaps, or even other widgets. @GTK_CELL_EMPTY: @@ -43,36 +46,36 @@ GtkCList - +Reads the current flags of the specified CList. -@clist: +@clist: The #GtkCList widget from which to get the flags - +A macro to set a particular flag for the specified CList. -@clist: -@flag: +@clist: The #GtkCList widget to affect. +@flag: A single #GtkCList flag to set. NOTE: Do not add the GTK_ prefix. - +A macro to clear a particular flag for the specified CList. -@clist: -@flag: +@clist: The #GtkCList widget to affect. +@flag: A single #GtkCList flag to clear. NOTE: Do not add the GTK_ prefix. - +A macro to check whether the #GtkCList is in "drag mode." -@clist: +@clist: The #GtkCList to check. @@ -85,18 +88,20 @@ GtkCList - +A macro to check whether the flag for showing the +widget's column titles is set. -@clist: +@clist: The #GtkCList widget to check. - +A macro to check whether a child widget of the CList +has the focus. -@clist: +@clist: The #GtkCList widget to check. @@ -157,42 +162,42 @@ GtkCList - +A macro to cast a GList element to a CListRow pointer. -@_glist_: +@_glist_: The GList element to convert. - +A macro to cast a generic #GtkCList cell item to a GtkCellText pointer. -@cell: +@cell: The #GtkCList cell item to convert. - +A macro to cast a generic #GtkCList cell item to a GtkCellPixmap pointer. -@cell: +@cell: The #GtkCList cell item to convert. - +A macro to cast a generic #GtkCList cell item to a GtkCellPixText pointer. -@cell: +@cell: The #GtkCList cell item to convert. - +A macro to cast a generic #GtkCList cell item to a GtkCellWidget pointer. -@cell: +@cell: The #GtkCList cell item to convert. @@ -208,7 +213,8 @@ GtkCList - +A structure that the #GtkCList widget uses to keep track of information +about its columns. @title: @@ -227,7 +233,8 @@ GtkCList - +A structure that the #GtkCList widget uses to keep track of information +about its rows. @cell: @@ -243,7 +250,8 @@ GtkCList - +A structure that the #GtkCList widget uses to keep track of #GtkCList cells +that contain text. @type: @@ -254,7 +262,8 @@ GtkCList - +A structure that the #GtkCList widget uses to keep track of #GtkCList cells +that contain a GdkPixmap. @type: @@ -266,7 +275,8 @@ GtkCList - +A structure that the #GtkCList widget uses to keep track of #GtkCList cells +that contain a combination of text and a GdkPixmap. @type: @@ -280,7 +290,8 @@ GtkCList - +A structure that the #GtkCList widget uses to keep track of #GtkCList cells +that contain another widget. @type: @@ -291,7 +302,8 @@ GtkCList - +A generic structure that the #GtkCList widget uses to keep track of the +contents of each of its cells. @type: @@ -328,224 +340,261 @@ GtkCList - +Initializes a previously allocated #GtkCList widget for use. This should not +normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. -@clist: -@columns: -@titles: +@clist: A pointer to an uninitialized #GtkCList widget. +@columns: The number of columns the #GtkCList should have. +@titles: An array of strings that should be used as the titles i +of the columns. There should be enough strings in the array for +the number of columns specified. - +Creates a new #GtkCList widget for use. -@columns: -@Returns: +@columns: The number of columns the #GtkCList should have. +@Returns: A pointer to a new GtkCList object. - +Creates a new #GtkCList widget with column titles for use. -@columns: -@titles: -@Returns: +@columns: The number of columns the #GtkCList should have. +@titles: A string array of titles for the widget. There should be +enough strings in the array for the specified number of columns. +@Returns: A pointer to a new GtkCList object. - +Sets the shadow type for the specified CList. Changing this value +will cause the #GtkCList to update its visuals. -@clist: -@type: +@clist: The #GtkCList to affect. +@type: The GtkShadowType desired. - +Sets the selection mode for the specified CList. This allows you to +set whether only one or more than one item can be selected at a time +in the widget. Note that setting the widget's selection mode to one +of GTK_SELECTION_BROWSE or GTK_SELECTION_SINGLE will cause all the +items in the #GtkCList to become deselected. -@clist: -@mode: +@clist: The #GtkCList to affect. +@mode: The GtkSelectionMode type to set for this CList. - +Causes the #GtkCList to stop updating its visuals until a matching call to +gtk_clist_thaw() is made. This function is useful if a lot of changes +will be made to the widget that may cause a lot of visual updating to +occur. Note that calls to gtk_clist_freeze() can be nested. -@clist: +@clist: The #GtkCList to freeze. - +Causes the specified #GtkCList to allow visual updates. -@clist: +@clist: The #GtkCList to thaw. - +This function causes the #GtkCList to show its column titles, if +they are not already showing. -@clist: +@clist: The #GtkCList to affect. - +Causes the #GtkCList to hide its column titles, if they are currently +showing. -@clist: +@clist: The #GtkCList to affect. - +Sets the specified column in the #GtkCList to become selectable. You can +then respond to events from the user clicking on a title button, and take +appropriate action. -@clist: -@column: +@clist: The #GtkCList to affect. +@column: The column to make active, counting from 0. - +Causes the specified column title button to become passive, i.e., does +not respond to events, such as the user clicking on it. -@clist: -@column: +@clist: The #GtkCList to affect. +@column: The column to make passive, counting from 0. - +Causes all column title buttons to become active. This is the same +as calling gtk_clist_column_title_active() for each column. -@clist: +@clist: The #GtkCList to affect. - +Causes all column title buttons to become passive. This is the same +as calling gtk_clist_column_title_passive() for each column. -@clist: +@clist: The #GtkCList to affect. - +Sets the title for the specified column. -@clist: -@column: -@title: +@clist: The #GtkCList to affect. +@column: The column whose title should be changed. +@title: A string to be the column's title. - +Sets a widget to be used as the specified column's title. This +can be used to place a pixmap or something else as the column +title, instead of the standard text. -@clist: -@column: -@widget: +@clist: The #GtkCList to affect. +@column: The column whose title should be a widget. +@widget: A pointer to a previously create widget. - +Sets the justification to be used for all text in the specified +column. -@clist: -@column: -@justification: +@clist: The #GtkCList to affect. +@column: The column which should be affected. +@justification: A GtkJustification value for the column. - +Allows you to set whether a specified column in the #GtkCList should +be hidden or shown. Note that at least one column must always be +showing, so attempting to hide the last visible column will be +ignored. -@clist: -@column: -@visible: +@clist: The #GtkCList to affect. +@column: The column to set visibility. +@visible: %TRUE or %FALSE. - +Lets you specify whether a specified column should be resizeable +by the user. Note that turning on resizeability for the column will +automatically shut off auto-resizing, but turning off resizeability +will NOT turn on auto-resizing. This must be done manually via a +call to gtk_clist_set_column_auto_resize(). -@clist: -@column: -@resizeable: +@clist: The #GtkCList to affect. +@column: The column on which to set resizeability. +@resizeable: %TRUE or %FALSE. - +Lets you specify whether a column should be automatically resized +by the widget when data is added or removed. Enabling auto-resize +on a column explicity disallows user-resizing of the column. -@clist: -@column: -@auto_resize: +@clist: The #GtkCList to affect. +@column: The column on which to set auto-resizing. +@auto_resize: %TRUE or %FALSE. - +Gets the required width in pixels that is needed to show +everything in the specified column. -@clist: -@column: -@Returns: +@clist: The #GtkCList to check. +@column: The column to check. +@Returns: The required width in pixels for the column. - +Causes the column specified for the #GtkCList to be set to +a specified width. -@clist: -@column: -@width: +@clist: The #GtkCList to affect. +@column: The column to set the width. +@width: The width, in pixels. - +Causes the column specified to have a minimum width, preventing +the user from resizing it smaller than that specified. -@clist: -@column: -@min_width: +@clist: The #GtkCList to affect. +@column: The column to set the minimum width. +@min_width: The width, in pixels. - +Causes the column specified to have a maximum width, preventing +the user from resizing it larger than that specified. -@clist: -@column: -@max_width: +@clist: The #GtkCList to affect. +@column: The column to set the maximum width. +@max_width: The width, in pixels. - +Causes the #GtkCList to have a specified height for its +rows. Setting the row height to 0 allows the #GtkCList to adjust +automatically to data in the row. -@clist: -@height: +@clist: The #GtkCList to affect. +@height: The height, in pixels. @@ -553,7 +602,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @row_align: @@ -586,7 +635,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @text: @@ -609,7 +658,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @pixmap: @@ -634,7 +683,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @text: @@ -663,7 +712,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @color: @@ -673,7 +722,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @color: @@ -683,7 +732,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @style: @@ -705,7 +754,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @style: @@ -725,7 +774,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @vertical: @@ -737,7 +786,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @selectable: @@ -757,7 +806,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @text: @Returns: @@ -767,7 +816,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @text: @Returns: @@ -777,7 +826,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @text: @Returns: @@ -788,7 +837,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @@ -797,7 +846,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @data: @@ -807,7 +856,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @data: @destroy: @@ -838,7 +887,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @@ -848,7 +897,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row: @column: @@ -858,7 +907,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @@ -866,7 +915,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @@ -887,7 +936,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @@ -895,7 +944,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @@ -903,7 +952,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @row1: @row2: @@ -913,7 +962,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @cmp_func: @@ -922,7 +971,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @column: @@ -931,7 +980,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @sort_type: @@ -940,7 +989,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @@ -948,7 +997,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @auto_sort: @@ -957,7 +1006,7 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @Returns: @@ -992,19 +1041,22 @@ GtkCList - +Gets the #GtkAdjustment currently being used for the vertical +aspect. -@clist: -@Returns: +@clist: The #GtkCList to check. +@Returns: A #GtkAdjustment widget, or NULL if none is currently +being used. - +Allows you to move a row from one position to another in the +list. -@clist: +@clist: The #GtkCList to affect. @source_row: @dest_row: @@ -1014,18 +1066,19 @@ GtkCList -@clist: +@clist: The #GtkCList to affect. @button: @button_actions: - +Allows you to set the #GtkAdjustment to be used for the horizontal +aspect of the #GtkCList widget. -@clist: -@adjustment: +@clist: The #GtkCList to affect. +@adjustment: A pointer to a #GtkAdjustment widget, or NULL. @@ -1039,20 +1092,22 @@ GtkCList - +Determines whether the #GtkClist should use icons when +doing drag-and-drop operations. -@clist: -@use_icons: +@clist: The #GtkCList to affect. +@use_icons: %TRUE or %FALSE. - +Allows you to set the #GtkAdjustment to be used for the vertical +aspect of the #GtkCList widget. -@clist: -@adjustment: +@clist: The #GtkCList to affect. +@adjustment: A pointer to a #GtkAdjustment widget, or NULL. @@ -1176,7 +1231,7 @@ GtkCList @clist: the object which received the signal. @scroll_type: -@position: +@position: a value between 0.0 and 1.0. diff --git a/docs/reference/gtk/tmpl/gtkimage.sgml b/docs/reference/gtk/tmpl/gtkimage.sgml index c9ba6f1a3..4e6b178ac 100644 --- a/docs/reference/gtk/tmpl/gtkimage.sgml +++ b/docs/reference/gtk/tmpl/gtkimage.sgml @@ -35,7 +35,7 @@ Creates the new GtkImage using the value and the mask. @val: @mask: a GDKBitmap that indicates which parts of the image should be transparent. -@Returns: the GtkImage +@Returns: the GtkImage @@ -53,7 +53,7 @@ Sets the GtkImage Gets the GtkImage -@image: a #GdkPixmap +@image: a #GdkPixmap @val: @mask: a GDKBitmap that indicates which parts of the image should be transparent. diff --git a/docs/reference/gtk/tmpl/gtkmenubar.sgml b/docs/reference/gtk/tmpl/gtkmenubar.sgml index c1c63280e..ba992c0cc 100644 --- a/docs/reference/gtk/tmpl/gtkmenubar.sgml +++ b/docs/reference/gtk/tmpl/gtkmenubar.sgml @@ -19,6 +19,7 @@ The #GtkMenuBar is a subclass of #GtkMenuShell which contains one to many #GtkMe The #GtkMenuBar struct contains the following fields. (These fields should be considered read-only. They should never be set by an application.) + Creates the new #GtkMenuBar @@ -70,4 +71,3 @@ GTK_SHADOW_NONE, GTK_SHADOW_IN, GTK_SHADOW_OUT, GTK_SHADOW_ETCHED_IN, and GTK_SH Used by #GtkMenuBar to determine the shadow type. - -- 2.43.2