Additions.

[~andy/gtk] / docs / reference / gtk / tmpl / gtkenums.sgml

<!-- ##### SECTION Title ##### -->
Standard Enumerations

<!-- ##### SECTION Short_Description ##### -->
Public enumerated types used throughout GTK+

<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### ENUM GtkAccelFlags ##### -->
<para>

</para>

@GTK_ACCEL_VISIBLE: 
@GTK_ACCEL_LOCKED: 
@GTK_ACCEL_MASK: 

<!-- ##### ENUM GtkAnchorType ##### -->
<para>

</para>

@GTK_ANCHOR_CENTER: 
@GTK_ANCHOR_NORTH: 
@GTK_ANCHOR_NORTH_WEST: 
@GTK_ANCHOR_NORTH_EAST: 
@GTK_ANCHOR_SOUTH: 
@GTK_ANCHOR_SOUTH_WEST: 
@GTK_ANCHOR_SOUTH_EAST: 
@GTK_ANCHOR_WEST: 
@GTK_ANCHOR_EAST: 
@GTK_ANCHOR_N: 
@GTK_ANCHOR_NW: 
@GTK_ANCHOR_NE: 
@GTK_ANCHOR_S: 
@GTK_ANCHOR_SW: 
@GTK_ANCHOR_SE: 
@GTK_ANCHOR_W: 
@GTK_ANCHOR_E: 

<!-- ##### ENUM GtkArrowType ##### -->
<para>
Used to indicate the direction in which a #GtkArrow should point.
</para>

@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.

<!-- ##### ENUM GtkAttachOptions ##### -->
<para>
Denotes the expansion properties that a widget will have when it (or its
parent) is resized.
</para>

@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.

<!-- ##### ENUM GtkButtonBoxStyle ##### -->
<para>
Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
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).

<!-- ##### ENUM GtkCornerType ##### -->
<para>
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.
</para>

@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.

<!-- ##### ENUM GtkCurveType ##### -->
<para>

</para>

@GTK_CURVE_TYPE_LINEAR: 
@GTK_CURVE_TYPE_SPLINE: 
@GTK_CURVE_TYPE_FREE: 

<!-- ##### ENUM GtkDeleteType ##### -->
<para>

</para>

@GTK_DELETE_CHARS: 
@GTK_DELETE_WORD_ENDS: 
@GTK_DELETE_WORDS: 
@GTK_DELETE_DISPLAY_LINES: 
@GTK_DELETE_DISPLAY_LINE_ENDS: 
@GTK_DELETE_PARAGRAPH_ENDS: 
@GTK_DELETE_PARAGRAPHS: 
@GTK_DELETE_WHITESPACE: 

<!-- ##### ENUM GtkDirectionType ##### -->
<para>

</para>

@GTK_DIR_TAB_FORWARD: 
@GTK_DIR_TAB_BACKWARD: 
@GTK_DIR_UP: 
@GTK_DIR_DOWN: 
@GTK_DIR_LEFT: 
@GTK_DIR_RIGHT: 

<!-- ##### ENUM GtkExpanderStyle ##### -->
<para>
Used to specify the style of the expanders drawn by a #GtkTreeView.
</para>

@GTK_EXPANDER_COLLAPSED: The style used for a collapsed subtree.
@GTK_EXPANDER_SEMI_COLLAPSED: Intermediate style used during animation.
@GTK_EXPANDER_SEMI_EXPANDED: Intermediate style used during animation.
@GTK_EXPANDER_EXPANDED: The style used for an expanded subtree.

<!-- ##### ENUM GtkIMPreeditStyle ##### -->
<para>

</para>

@GTK_IM_PREEDIT_NOTHING: 
@GTK_IM_PREEDIT_CALLBACK: 

<!-- ##### ENUM GtkIMStatusStyle ##### -->
<para>

</para>

@GTK_IM_STATUS_NOTHING: 
@GTK_IM_STATUS_CALLBACK: 

<!-- ##### ENUM GtkJustification ##### -->
<para>
Used for justifying the text inside a #GtkLabel widget. (See also
#GtkAlignment).
</para>

@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.

<!-- ##### 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.
</para>

@GTK_PIXELS: Pixels.
@GTK_INCHES: Inches.
@GTK_CENTIMETERS: Centimeters.

<!-- ##### ENUM GtkMovementStep ##### -->
<para>

</para>

@GTK_MOVEMENT_LOGICAL_POSITIONS: 
@GTK_MOVEMENT_VISUAL_POSITIONS: 
@GTK_MOVEMENT_WORDS: 
@GTK_MOVEMENT_DISPLAY_LINES: 
@GTK_MOVEMENT_DISPLAY_LINE_ENDS: 
@GTK_MOVEMENT_PARAGRAPHS: 
@GTK_MOVEMENT_PARAGRAPH_ENDS: 
@GTK_MOVEMENT_PAGES: 
@GTK_MOVEMENT_BUFFER_ENDS: 
@GTK_MOVEMENT_HORIZONTAL_PAGES: 

<!-- ##### ENUM GtkOrientation ##### -->
<para>
Represents the orientation of widgets which can be switched between horizontal
and vertical orientation on the fly, like #GtkToolbar.
</para>

@GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
@GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.

<!-- ##### ENUM GtkPackType ##### -->
<para>
Represents the packing location #GtkBox children. (See: #GtkVBox,
#GtkHBox, and #GtkButtonBox).
</para>

@GTK_PACK_START: The child is packed into the start of the box
@GTK_PACK_END: The child is packed into the end of the box

<!-- ##### ENUM GtkPathPriorityType ##### -->
<para>

</para>

@GTK_PATH_PRIO_LOWEST: 
@GTK_PATH_PRIO_GTK: 
@GTK_PATH_PRIO_APPLICATION: 
@GTK_PATH_PRIO_THEME: 
@GTK_PATH_PRIO_RC: 
@GTK_PATH_PRIO_HIGHEST: 

<!-- ##### ENUM GtkPathType ##### -->
<para>

</para>

@GTK_PATH_WIDGET: 
@GTK_PATH_WIDGET_CLASS: 
@GTK_PATH_CLASS: 

<!-- ##### ENUM GtkPolicyType ##### -->
<para>
Determines when a scroll bar will be visible. 
</para>

@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.

<!-- ##### ENUM GtkPositionType ##### -->
<para>
Describes which edge of a widget a certain feature is positioned at, e.g. the
tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a 
#GtkScale.
</para>

@GTK_POS_LEFT: The feature is at the left edge.
@GTK_POS_RIGHT: The feature is at the right edge.
@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.
</para>

@GTK_RELIEF_NORMAL: Draw a normal relief.
@GTK_RELIEF_HALF: A half relief.
@GTK_RELIEF_NONE: No relief.

<!-- ##### ENUM GtkResizeMode ##### -->
<para>

</para>

@GTK_RESIZE_PARENT: 
@GTK_RESIZE_QUEUE: 
@GTK_RESIZE_IMMEDIATE: 

<!-- ##### ENUM GtkScrollType ##### -->
<para>

</para>

@GTK_SCROLL_NONE: 
@GTK_SCROLL_JUMP: 
@GTK_SCROLL_STEP_BACKWARD: 
@GTK_SCROLL_STEP_FORWARD: 
@GTK_SCROLL_PAGE_BACKWARD: 
@GTK_SCROLL_PAGE_FORWARD: 
@GTK_SCROLL_STEP_UP: 
@GTK_SCROLL_STEP_DOWN: 
@GTK_SCROLL_PAGE_UP: 
@GTK_SCROLL_PAGE_DOWN: 
@GTK_SCROLL_STEP_LEFT: 
@GTK_SCROLL_STEP_RIGHT: 
@GTK_SCROLL_PAGE_LEFT: 
@GTK_SCROLL_PAGE_RIGHT: 
@GTK_SCROLL_START: 
@GTK_SCROLL_END: 

<!-- ##### ENUM GtkSelectionMode ##### -->
<para>

</para>

@GTK_SELECTION_NONE: 
@GTK_SELECTION_SINGLE: 
@GTK_SELECTION_BROWSE: 
@GTK_SELECTION_MULTIPLE: 
@GTK_SELECTION_EXTENDED: 

<!-- ##### ENUM GtkShadowType ##### -->
<para>
Used to change the appearance of an outline typically provided by a #GtkFrame.
</para>

@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: 

<!-- ##### ENUM GtkStateType ##### -->
<para>
This type indicates the current state of a widget; the state determines how
the widget is drawn. The #GtkStateType enumeration is also used to
identify different colors in a #GtkStyle for drawing, so states can be
used for subparts of a widget as well as entire widgets.
</para>

@GTK_STATE_NORMAL: State during normal operation.
@GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
@GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
the widget and the widget will respond to mouse clicks.
@GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
@GTK_STATE_INSENSITIVE: State indicating that the widget is
unresponsive to user actions.

<!-- ##### ENUM GtkSubmenuDirection ##### -->
<para>
Indicates the direction a sub-menu will appear.
</para>

@GTK_DIRECTION_LEFT: A sub-menu will appear
@GTK_DIRECTION_RIGHT: 

<!-- ##### ENUM GtkSubmenuPlacement ##### -->
<para>

</para>

@GTK_TOP_BOTTOM: 
@GTK_LEFT_RIGHT: 

<!-- ##### ENUM GtkToolbarStyle ##### -->
<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.
</para>

@GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
@GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
@GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
@GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
other, rather than vertically stacked

<!-- ##### ENUM GtkUpdateType ##### -->
<para>

</para>

@GTK_UPDATE_CONTINUOUS: 
@GTK_UPDATE_DISCONTINUOUS: 
@GTK_UPDATE_DELAYED: 

<!-- ##### ENUM GtkVisibility ##### -->
<para>
Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
</para>

@GTK_VISIBILITY_NONE: The row is not visible.
@GTK_VISIBILITY_PARTIAL: The row is partially visible.
@GTK_VISIBILITY_FULL: The row is fully visible.

<!-- ##### ENUM GtkWindowPosition ##### -->
<para>
Window placement can be influenced using this enumeration.
</para>

@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.
@GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
@GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
parent (see gtk_window_set_transient_for()).

<!-- ##### ENUM GtkWindowType ##### -->
<para>
A #GtkWindow can be one of these types. Most things you'd consider a
"window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
are managed by the window manager and have a frame by default (call
gtk_window_set_decorated() to toggle the frame).  Windows with type
#GTK_WINDOW_POPUP are ignored by the window manager; window manager
keybindings won't work on them, the window manager won't decorate the
window with a frame, many GTK+ features that rely on the window
manager will not work (e.g. resize grips and
maximization/minimization). #GTK_WINDOW_POPUP is used to implement
widgets such as #GtkMenu or tooltips that you normally don't think of 
as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
In particular, do not use #GTK_WINDOW_POPUP just to turn off
the window borders; use gtk_window_set_decorated() for that.
</para>

@GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
@GTK_WINDOW_POPUP: A special window such as a tooltip.

<!-- ##### ENUM GtkSortType ##### -->
<para>
Determines the direction of a sort.
</para>

@GTK_SORT_ASCENDING: Sorting is in ascending order.
@GTK_SORT_DESCENDING: Sorting is in descending order.