From ff8a24c85ade4777f4934369132298c165cdbcf5 Mon Sep 17 00:00:00 2001 From: Damon Chaplin Date: Sat, 22 Apr 2000 11:29:32 +0000 Subject: [PATCH] update from Lee Mallabone 2000-04-22 Damon Chaplin * gtk/tmpl/gtkenums.sgml: update from Lee Mallabone --- docs/reference/ChangeLog | 5 + docs/reference/gtk/tmpl/gtkenums.sgml | 160 +++++++++++++------------- 2 files changed, 88 insertions(+), 77 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 830a412ca7..3f611e6200 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2000-04-22 Damon Chaplin + + * gtk/tmpl/gtkenums.sgml: update from Lee Mallabone + + 2000-04-09 Damon Chaplin * gtk/tmpl/gtkmain.sgml: update from Torsten Landschoff diff --git a/docs/reference/gtk/tmpl/gtkenums.sgml b/docs/reference/gtk/tmpl/gtkenums.sgml index 33ffe7f812..2a04388bfe 100644 --- a/docs/reference/gtk/tmpl/gtkenums.sgml +++ b/docs/reference/gtk/tmpl/gtkenums.sgml @@ -2,7 +2,7 @@ Standard Enumerations - +Public enumerated types used throughout GTK+. @@ -26,43 +26,54 @@ Standard Enumerations - +Used to indicate the direction in which a #GtkArrow should point. -@GTK_ARROW_UP: -@GTK_ARROW_DOWN: -@GTK_ARROW_LEFT: -@GTK_ARROW_RIGHT: +@GTK_ARROW_UP: Represents an upward pointing arrow. +@GTK_ARROW_DOWN: Represents a downward pointing arrow. +@GTK_ARROW_LEFT: Represents a left pointing arrow. +@GTK_ARROW_RIGHT: Represents a right pointing arrow. - +Denotes the expansion properties that a widget will have when it (or it's +parent) is resized. -@GTK_EXPAND: -@GTK_SHRINK: -@GTK_FILL: +@GTK_EXPAND: the widget should expand to take up any extra space in its +container that has been allocated. +@GTK_SHRINK: the widget should shrink as and when possible. +@GTK_FILL: the widget should fill the space allocated to it. - +Used to dictate the style that a #GtkButtonBox uses to layout the buttons it +contains. (See also: #GtkVButtonBox and #GtkHButtonBox). -@GTK_BUTTONBOX_DEFAULT_STYLE: -@GTK_BUTTONBOX_SPREAD: -@GTK_BUTTONBOX_EDGE: -@GTK_BUTTONBOX_START: -@GTK_BUTTONBOX_END: +@GTK_BUTTONBOX_DEFAULT_STYLE: Default packing. +@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox. +@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox. +@GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the +left for a HBox, or the top for a VBox). +@GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the +right for a HBox, or the bottom for a VBox). - +Specifies which corner a child widget should be placed in when packed into +a #GtkScrolledWindow. This is effectively the opposite of where the scroll +bars are placed. -@GTK_CORNER_TOP_LEFT: -@GTK_CORNER_BOTTOM_LEFT: -@GTK_CORNER_TOP_RIGHT: -@GTK_CORNER_BOTTOM_RIGHT: +@GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the +widget (default behaviour). +@GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the +widget. +@GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the +widget. +@GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the +widget. @@ -87,13 +98,14 @@ Standard Enumerations - +Used for justifying the text inside a #GtkLabel widget. (See also +#GtkAlignment). -@GTK_JUSTIFY_LEFT: -@GTK_JUSTIFY_RIGHT: -@GTK_JUSTIFY_CENTER: -@GTK_JUSTIFY_FILL: +@GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label. +@GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label. +@GTK_JUSTIFY_CENTER: The text is placed in the center of the label. +@GTK_JUSTIFY_FILL: The text is placed is distributed across the label. @@ -126,10 +138,11 @@ Standard Enumerations - +Used for packing widgets into #GtkBox widgets. (See also: #GtkVBox, +#GtkHBox, and #GtkButtonBox). -@GTK_PACK_START: +@GTK_PACK_START: The @GTK_PACK_END: @@ -155,12 +168,13 @@ Standard Enumerations - +Determines when a scroll bar will be visible. -@GTK_POLICY_ALWAYS: -@GTK_POLICY_AUTOMATIC: -@GTK_POLICY_NEVER: +@GTK_POLICY_ALWAYS: The scrollbar is always visible. +@GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example, +when all of a #GtkCList can not be seen. +@GTK_POLICY_NEVER: The scrollbar will never appear. @@ -176,26 +190,10 @@ Standard Enumerations An enumeration which describes whether a preview contains grayscale or red-green-blue data. - - - - - - -GTK_PREVIEW_COLOR -the preview contains red-green-blue data. - - - -GTK_PREVIEW_GRAYSCALE -The preview contains grayscale data. - - - -@GTK_PREVIEW_COLOR: -@GTK_PREVIEW_GRAYSCALE: +@GTK_PREVIEW_COLOR: the preview contains red-green-blue data. +@GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data. @@ -239,32 +237,34 @@ contains grayscale or red-green-blue data. - +Used to change the appearance of an outline typically provided by a #GtkFrame. -@GTK_SHADOW_NONE: -@GTK_SHADOW_IN: -@GTK_SHADOW_OUT: -@GTK_SHADOW_ETCHED_IN: +@GTK_SHADOW_NONE: No outline. +@GTK_SHADOW_IN: The outline is bevelled inwards. +@GTK_SHADOW_OUT: The outline is bevelled outwards like a button. +@GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame +does @GTK_SHADOW_ETCHED_OUT: - +This type indicates the current state of a widget. -@GTK_STATE_NORMAL: -@GTK_STATE_ACTIVE: -@GTK_STATE_PRELIGHT: +@GTK_STATE_NORMAL: The state during normal operation. +@GTK_STATE_ACTIVE: The widget is currently active, such as a +@GTK_STATE_PRELIGHT: The mouse pointer is over the widget. @GTK_STATE_SELECTED: -@GTK_STATE_INSENSITIVE: +@GTK_STATE_INSENSITIVE: The state of the widget can not be altered by the +user. Its appearance will usually indicate this. - +Indicates the direction a sub-menu will appear. -@GTK_DIRECTION_LEFT: +@GTK_DIRECTION_LEFT: A sub-menu will appear @GTK_DIRECTION_RIGHT: @@ -277,12 +277,12 @@ contains grayscale or red-green-blue data. - +Used to customize the appearance of a #GtkToolbar. -@GTK_TOOLBAR_ICONS: -@GTK_TOOLBAR_TEXT: -@GTK_TOOLBAR_BOTH: +@GTK_TOOLBAR_ICONS: Buttons should display only icons in the toolbar. +@GTK_TOOLBAR_TEXT: Buttons should display only text labels in the toolbar. +@GTK_TOOLBAR_BOTH: Buttons should display text and icons in the toolbar. @@ -314,27 +314,33 @@ contains grayscale or red-green-blue data. - +Window placement can be influenced using this enumeration. -@GTK_WIN_POS_NONE: -@GTK_WIN_POS_CENTER: -@GTK_WIN_POS_MOUSE: +@GTK_WIN_POS_NONE: No influence is made on placement. +@GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen. +@GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position. - +A #GtkWindow can be of these types. A toplevel window has standard window +decorations by default. A dialog may have fewer decorations and obey a +different placement policy. A popup window will have no decorations. + + +It should be noted that such decorations can often be over-ridden by modern +window managers. -@GTK_WINDOW_TOPLEVEL: -@GTK_WINDOW_DIALOG: -@GTK_WINDOW_POPUP: +@GTK_WINDOW_TOPLEVEL: A window for a typical application. +@GTK_WINDOW_DIALOG: A window for transient messages and dialogs. +@GTK_WINDOW_POPUP: A window for popups. - +Determines the direction of a sort. -@GTK_SORT_ASCENDING: -@GTK_SORT_DESCENDING: +@GTK_SORT_ASCENDING: Sorting is in ascending order. +@GTK_SORT_DESCENDING: Sorting is in descending order.