]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtkenums.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtkenums.sgml
index ee02d4aceb2942c130ef7953564f4b8e87ae11f3..579e1c0274e18fcf7819f65d0e4582b6e544d6d1 100644 (file)
@@ -14,6 +14,12 @@ Public enumerated types used throughout GTK+
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### ENUM GtkAccelFlags ##### -->
 <para>
 
@@ -46,6 +52,15 @@ Public enumerated types used throughout GTK+
 @GTK_ANCHOR_W: 
 @GTK_ANCHOR_E: 
 
+<!-- ##### ENUM GtkArrowPlacement ##### -->
+<para>
+Used to specify the placement of scroll arrows in scrolling menus.
+</para>
+
+@GTK_ARROWS_BOTH: Place one arrow on each end of the menu.
+@GTK_ARROWS_START: Place both arrows at the top of the menu.
+@GTK_ARROWS_END: Place both arrows at the bottom of the menu.
+
 <!-- ##### ENUM GtkArrowType ##### -->
 <para>
 Used to indicate the direction in which a #GtkArrow should point.
@@ -55,6 +70,7 @@ Used to indicate the direction in which a #GtkArrow should point.
 @GTK_ARROW_DOWN: Represents a downward pointing arrow.
 @GTK_ARROW_LEFT: Represents a left pointing arrow.
 @GTK_ARROW_RIGHT: Represents a right pointing arrow.
+@GTK_ARROW_NONE: No arrow. Since 2.10.
 
 <!-- ##### ENUM GtkAttachOptions ##### -->
 <para>
@@ -74,12 +90,13 @@ contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
 </para>
 
 @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).
+@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box.
+@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box.
+@GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box, 
+  (on the left for a HBox, or the top for a VBox).
+@GTK_BUTTONBOX_END: Buttons are grouped towards the end of the box, 
+  (on the right for a HBox, or the bottom for a VBox).
+@GTK_BUTTONBOX_CENTER: Buttons are centered in the box. Since 2.12
 
 <!-- ##### ENUM GtkCornerType ##### -->
 <para>
@@ -97,15 +114,6 @@ widget.
 @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
 widget.
 
-<!-- ##### ENUM GtkCurveType ##### -->
-<para>
-
-</para>
-
-@GTK_CURVE_TYPE_LINEAR: 
-@GTK_CURVE_TYPE_SPLINE: 
-@GTK_CURVE_TYPE_FREE: 
-
 <!-- ##### ENUM GtkDeleteType ##### -->
 <para>
 
@@ -149,6 +157,7 @@ Used to specify the style of the expanders drawn by a #GtkTreeView.
 
 @GTK_IM_PREEDIT_NOTHING: 
 @GTK_IM_PREEDIT_CALLBACK: 
+@GTK_IM_PREEDIT_NONE: 
 
 <!-- ##### ENUM GtkIMStatusStyle ##### -->
 <para>
@@ -157,6 +166,7 @@ Used to specify the style of the expanders drawn by a #GtkTreeView.
 
 @GTK_IM_STATUS_NOTHING: 
 @GTK_IM_STATUS_CALLBACK: 
+@GTK_IM_STATUS_NONE: 
 
 <!-- ##### ENUM GtkJustification ##### -->
 <para>
@@ -169,18 +179,6 @@ Used for justifying the text inside a #GtkLabel widget. (See also
 @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.
 
-<!-- ##### ENUM GtkMatchType ##### -->
-<para>
-
-</para>
-
-@GTK_MATCH_ALL: 
-@GTK_MATCH_ALL_TAIL: 
-@GTK_MATCH_HEAD: 
-@GTK_MATCH_TAIL: 
-@GTK_MATCH_EXACT: 
-@GTK_MATCH_LAST: 
-
 <!-- ##### ENUM GtkMetricType ##### -->
 <para>
 Used to indicate which metric is used by a #GtkRuler.
@@ -267,15 +265,6 @@ tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
 @GTK_POS_TOP: The feature is at the top edge.
 @GTK_POS_BOTTOM: The feature is at the bottom edge.
 
-<!-- ##### ENUM GtkPreviewType ##### -->
-<para>
-An enumeration which describes whether a preview
-contains grayscale or red-green-blue data.
-</para>
-
-@GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
-@GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
-
 <!-- ##### ENUM GtkReliefStyle ##### -->
 <para>
 Indicated the relief to be drawn around a #GtkButton.
@@ -292,7 +281,19 @@ Indicated the relief to be drawn around a #GtkButton.
 
 @GTK_RESIZE_PARENT: 
 @GTK_RESIZE_QUEUE: 
-@GTK_RESIZE_IMMEDIATE: 
+@GTK_RESIZE_IMMEDIATE: Deprecated.
+
+<!-- ##### ENUM GtkScrollStep ##### -->
+<para>
+
+</para>
+
+@GTK_SCROLL_STEPS: 
+@GTK_SCROLL_PAGES: 
+@GTK_SCROLL_ENDS: 
+@GTK_SCROLL_HORIZONTAL_STEPS: 
+@GTK_SCROLL_HORIZONTAL_PAGES: 
+@GTK_SCROLL_HORIZONTAL_ENDS: 
 
 <!-- ##### ENUM GtkScrollType ##### -->
 <para>
@@ -318,14 +319,22 @@ Indicated the relief to be drawn around a #GtkButton.
 
 <!-- ##### ENUM GtkSelectionMode ##### -->
 <para>
-
+Used to control what selections users are allowed to make.
 </para>
 
-@GTK_SELECTION_NONE: 
-@GTK_SELECTION_SINGLE: 
-@GTK_SELECTION_BROWSE: 
-@GTK_SELECTION_MULTIPLE: 
-@GTK_SELECTION_EXTENDED: 
+@GTK_SELECTION_NONE: No selection is possible.
+@GTK_SELECTION_SINGLE: Zero or one element may be selected.
+@GTK_SELECTION_BROWSE: Exactly one element is selected. In some circumstances,
+  such as initially or during a search operation, it's possible for no element 
+  to be selected with %GTK_SELECTION_BROWSE. What is really enforced is that 
+  the user can't deselect a currently selected element except by selecting 
+  another element.
+@GTK_SELECTION_MULTIPLE: Any number of elements may be selected. 
+   Clicks toggle the state of an item. Any number of elements may be selected. 
+   The Ctrl key may be used to enlarge the selection, and Shift key to select 
+   between the focus and the child pointed to. Some widgets may also allow
+   Click-drag to select a range of elements.
+@GTK_SELECTION_EXTENDED: Deprecated, behaves identical to %GTK_SELECTION_MULTIPLE.
 
 <!-- ##### ENUM GtkShadowType ##### -->
 <para>
@@ -335,19 +344,8 @@ Used to change the appearance of an outline typically provided by a #GtkFrame.
 @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: 
-
-<!-- ##### ENUM GtkSideType ##### -->
-<para>
-
-</para>
-
-@GTK_SIDE_TOP: 
-@GTK_SIDE_BOTTOM: 
-@GTK_SIDE_LEFT: 
-@GTK_SIDE_RIGHT: 
+@GTK_SHADOW_ETCHED_IN: The outline has a sunken 3d appearance.
+@GTK_SHADOW_ETCHED_OUT: The outline has a raised 3d appearance
 
 <!-- ##### ENUM GtkStateType ##### -->
 <para>
@@ -370,8 +368,8 @@ unresponsive to user actions.
 Indicates the direction a sub-menu will appear.
 </para>
 
-@GTK_DIRECTION_LEFT: A sub-menu will appear
-@GTK_DIRECTION_RIGHT: 
+@GTK_DIRECTION_LEFT: A sub-menu will appear to the left of the current menu.
+@GTK_DIRECTION_RIGHT: A sub-menu will appear to the right of the current menu.
 
 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
 <para>
@@ -385,7 +383,9 @@ Indicates the direction a sub-menu will appear.
 <para>
 Used to customize the appearance of a #GtkToolbar. Note that 
 setting the toolbar style overrides the user's preferences
-for the default toolbar style.
+for the default toolbar style.  Note that if the button has only
+a label set and GTK_TOOLBAR_ICONS is used, the label will be
+visible, and vice versa.
 </para>
 
 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
@@ -396,12 +396,12 @@ other, rather than vertically stacked
 
 <!-- ##### ENUM GtkUpdateType ##### -->
 <para>
-
+Used by #GtkRange to control the policy for notifying value changes.
 </para>
 
-@GTK_UPDATE_CONTINUOUS: 
-@GTK_UPDATE_DISCONTINUOUS: 
-@GTK_UPDATE_DELAYED: 
+@GTK_UPDATE_CONTINUOUS: Notify updates whenever the value changed
+@GTK_UPDATE_DISCONTINUOUS: Notify updates when the mouse button has been released
+@GTK_UPDATE_DELAYED: Space out updates with a small timeout
 
 <!-- ##### ENUM GtkVisibility ##### -->
 <para>
@@ -414,7 +414,9 @@ Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
 
 <!-- ##### ENUM GtkWindowPosition ##### -->
 <para>
-Window placement can be influenced using this enumeration.
+Window placement can be influenced using this enumeration. Note that
+using #GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea. 
+It won't necessarily work well with all window managers or on all windowing systems.
 </para>
 
 @GTK_WIN_POS_NONE: No influence is made on placement.
@@ -452,3 +454,19 @@ Determines the direction of a sort.
 @GTK_SORT_ASCENDING: Sorting is in ascending order.
 @GTK_SORT_DESCENDING: Sorting is in descending order.
 
+<!-- ##### ENUM GtkDragResult ##### -->
+<para>
+Gives an indication why a drag operation failed. 
+The value can by obtained by connecting to the
+#GtkWidget::drag-failed signal.
+</para>
+
+@GTK_DRAG_RESULT_SUCCESS: The drag operation was successful
+@GTK_DRAG_RESULT_NO_TARGET: No suitable drag target
+@GTK_DRAG_RESULT_USER_CANCELLED: The user cancelled the drag operation
+@GTK_DRAG_RESULT_TIMEOUT_EXPIRED: The drag operation timed out
+@GTK_DRAG_RESULT_GRAB_BROKEN: The pointer or keyboard grab used
+   for the drag operation was broken
+@GTK_DRAG_RESULT_ERROR: The drag operation failed due to some 
+   unspecified error
+