* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+#ifndef __GTK_ENUMS_H__
+#define __GTK_ENUMS_H__
+
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
-#ifndef __GTK_ENUMS_H__
-#define __GTK_ENUMS_H__
-
#include <glib-object.h>
+
+/**
+ * SECTION:gtkenum
+ * @Short_description: Public enumerated types used throughout GTK+
+ * @Title: Standard Enumerations
+ */
+
+
G_BEGIN_DECLS
/**
* you have for example a 16x16 icon inside a 32x32 space, the icon
* could be scaled and stretched, it could be centered, or it could be
* positioned to one side of the space.
+ *
+ * Note that in horizontal context @GTK_ALIGN_START and @GTK_ALIGN_END
+ * are interpreted relative to text direction.
*/
typedef enum
{
GTK_ALIGN_CENTER
} GtkAlign;
-/* Arrow placement */
+
+/**
+ * GtkArrowPlacement:
+ * @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.
+ *
+ * Used to specify the placement of scroll arrows in scrolling menus.
+ */
typedef enum
{
GTK_ARROWS_BOTH,
GTK_ARROWS_END
} GtkArrowPlacement;
-/* Arrow types */
+/**
+ * GtkArrowType:
+ * @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.
+ * @GTK_ARROW_NONE: No arrow. Since 2.10.
+ *
+ * Used to indicate the direction in which a #GtkArrow should point.
+ */
typedef enum
{
GTK_ARROW_UP,
GTK_ARROW_NONE
} GtkArrowType;
-/* Attach options (for tables) */
+/**
+ * GtkAttachOptions:
+ * @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.
+ *
+ * Denotes the expansion properties that a widget will have when it (or its
+ * parent) is resized.
+ */
typedef enum
{
GTK_EXPAND = 1 << 0,
GTK_FILL = 1 << 2
} GtkAttachOptions;
-/* Button box styles */
+/**
+ * GtkButtonBoxStyle:
+ * @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
+ * @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.
+ *
+ * Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
+ * contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
+ */
typedef enum
{
GTK_BUTTONBOX_SPREAD = 1,
GTK_BUTTONBOX_CENTER
} GtkButtonBoxStyle;
+
typedef enum
{
GTK_DELETE_CHARS,
GTK_DIR_RIGHT
} GtkDirectionType;
-/* Expander styles */
+/**
+ * GtkExpanderStyle:
+ * @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.
+ *
+ * Used to specify the style of the expanders drawn by a #GtkTreeView.
+ */
typedef enum
{
GTK_EXPANDER_COLLAPSED,
GTK_TEXT_DIR_RTL
} GtkTextDirection;
-/* justification for label and maybe other widgets (text?) */
+/**
+ * GtkJustification:
+ * @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.
+ *
+ * Used for justifying the text inside a #GtkLabel widget. (See also
+ * #GtkAlignment).
+ */
typedef enum
{
GTK_JUSTIFY_LEFT,
GTK_JUSTIFY_FILL
} GtkJustification;
-/* Menu keyboard movement types */
+/**
+ * GtkMenuDirectionType:
+ * @GTK_MENU_DIR_PARENT: To the parent menu shell
+ * @GTK_MENU_DIR_CHILD: To the submenu, if any, associated with the item
+ * @GTK_MENU_DIR_NEXT: To the next menu item
+ * @GTK_MENU_DIR_PREV: To the previous menu item
+ *
+ * An enumeration representing directional movements within a menu.
+ */
typedef enum
{
GTK_MENU_DIR_PARENT,
/**
* GtkMessageType:
* @GTK_MESSAGE_INFO: Informational message
- * @GTK_MESSAGE_WARNING: Nonfatal warning message
+ * @GTK_MESSAGE_WARNING: Non-fatal warning message
* @GTK_MESSAGE_QUESTION: Question requiring a choice
* @GTK_MESSAGE_ERROR: Fatal error message
* @GTK_MESSAGE_OTHER: None of the above, doesn't get an icon
GTK_SCROLL_HORIZONTAL_ENDS
} GtkScrollStep;
-/* Orientation for toolbars, etc. */
+/**
+ * GtkOrientation:
+ * @GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
+ * @GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.
+ *
+ * Represents the orientation of widgets which can be switched between horizontal
+ * and vertical orientation on the fly, like #GtkToolbar.
+ */
typedef enum
{
GTK_ORIENTATION_HORIZONTAL,
GTK_ORIENTATION_VERTICAL
} GtkOrientation;
-/* Placement type for scrolled window */
+/**
+ * GtkCornerType:
+ * @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.
+ *
+ * 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.
+ */
typedef enum
{
GTK_CORNER_TOP_LEFT,
GTK_CORNER_BOTTOM_RIGHT
} GtkCornerType;
-/* Packing types (for boxes) */
+/**
+ * GtkPackType:
+ * @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
+ *
+ * Represents the packing location #GtkBox children. (See: #GtkVBox,
+ * #GtkHBox, and #GtkButtonBox).
+ */
typedef enum
{
GTK_PACK_START,
GTK_PATH_CLASS
} GtkPathType;
-/* Scrollbar policy types (for scrolled windows) */
+/**
+ * GtkPolicyType:
+ * @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.
+ *
+ * Determines when a scroll bar will be visible.
+ */
typedef enum
{
GTK_POLICY_ALWAYS,
GTK_POLICY_NEVER
} GtkPolicyType;
+/**
+ * GtkPositionType:
+ * @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.
+ *
+ * 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.
+ */
typedef enum
{
GTK_POS_LEFT,
GTK_POS_BOTTOM
} GtkPositionType;
-/* Style for buttons */
+/**
+ * GtkReliefStyle:
+ * @GTK_RELIEF_NORMAL: Draw a normal relief.
+ * @GTK_RELIEF_HALF: A half relief.
+ * @GTK_RELIEF_NONE: No relief.
+ *
+ * Indicated the relief to be drawn around a #GtkButton.
+ */
typedef enum
{
GTK_RELIEF_NORMAL,
GTK_RELIEF_NONE
} GtkReliefStyle;
-/* Resize type */
+/**
+ * GtkResizeMode:
+ * @GTK_RESIZE_PARENT: Pass resize request to the parent
+ * @GTK_RESIZE_QUEUE: Queue resizes on this widget
+ * @GTK_RESIZE_IMMEDIATE: Resize immediately. Deprecated.
+ */
typedef enum
{
- GTK_RESIZE_PARENT, /* Pass resize request to the parent */
- GTK_RESIZE_QUEUE, /* Queue resizes on this widget */
- GTK_RESIZE_IMMEDIATE /* Perform the resizes now */
+ GTK_RESIZE_PARENT,
+ GTK_RESIZE_QUEUE,
+ GTK_RESIZE_IMMEDIATE
} GtkResizeMode;
/* scrolling types */
GTK_SCROLL_END
} GtkScrollType;
-/* list selection modes */
+/**
+ * GtkSelectionMode:
+ * @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.
+ * 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.
+ *
+ * Used to control what selections users are allowed to make.
+ */
typedef enum
{
- GTK_SELECTION_NONE, /* Nothing can be selected */
+ GTK_SELECTION_NONE,
GTK_SELECTION_SINGLE,
GTK_SELECTION_BROWSE,
GTK_SELECTION_MULTIPLE
} GtkSelectionMode;
-/* Shadow types */
+/**
+ * GtkShadowType:
+ * @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 has a sunken 3d appearance.
+ * @GTK_SHADOW_ETCHED_OUT: The outline has a raised 3d appearance.
+ *
+ * Used to change the appearance of an outline typically provided by a #GtkFrame.
+ */
typedef enum
{
GTK_SHADOW_NONE,
} GtkShadowType;
/* Widget states */
+
+/**
+ * GtkStateType:
+ * @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.
+ * @GTK_STATE_INCONSISTENT: The widget is inconsistent, such as checkbuttons
+ * or radiobuttons that aren't either set to %TRUE nor %FALSE,
+ * or buttons requiring the user attention.
+ * @GTK_STATE_FOCUSED: The widget has the keyboard focus.
+ *
+ * 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.
+ */
typedef enum
{
GTK_STATE_NORMAL,
GTK_STATE_ACTIVE,
GTK_STATE_PRELIGHT,
GTK_STATE_SELECTED,
- GTK_STATE_INSENSITIVE
+ GTK_STATE_INSENSITIVE,
+ GTK_STATE_INCONSISTENT,
+ GTK_STATE_FOCUSED
} GtkStateType;
-/* Style for toolbars */
+/**
+ * GtkToolbarStyle:
+ * @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
+ *
+ * Used to customize the appearance of a #GtkToolbar. Note that
+ * setting the toolbar style overrides the user's preferences
+ * 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.
+ */
typedef enum
{
GTK_TOOLBAR_ICONS,
GTK_TOOLBAR_BOTH_HORIZ
} GtkToolbarStyle;
-/* Data update types (for ranges) */
-typedef enum
-{
- GTK_UPDATE_CONTINUOUS,
- GTK_UPDATE_DISCONTINUOUS,
- GTK_UPDATE_DELAYED
-} GtkUpdateType;
-
-/* Window position types */
+/**
+ * GtkWindowPosition:
+ * @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()).
+ *
+ * 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.
+ */
typedef enum
{
GTK_WIN_POS_NONE,
GTK_WIN_POS_CENTER_ON_PARENT
} GtkWindowPosition;
-/* Window types */
+/**
+ * GtkWindowType:
+ * @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
+ * @GTK_WINDOW_POPUP: A special window such as a tooltip.
+ *
+ * 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.
+ */
typedef enum
{
GTK_WINDOW_TOPLEVEL,
GTK_WINDOW_POPUP
} GtkWindowType;
-/* Text wrap */
+/**
+ * GtkWrapMode:
+ * @GTK_WRAP_NONE: do not wrap lines; just make the text area wider
+ * @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can
+ * appear (between characters, usually - if you want to be technical,
+ * between graphemes, see pango_get_log_attrs())
+ * @GTK_WRAP_WORD: wrap text, breaking lines in between words
+ * @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if
+ * that is not enough, also between graphemes
+ *
+ * Describes a type of line wrapping.
+ */
typedef enum
{
GTK_WRAP_NONE,
GTK_WRAP_WORD_CHAR
} GtkWrapMode;
-/* How to sort */
+/**
+ * GtkSortType:
+ * @GTK_SORT_ASCENDING: Sorting is in ascending order.
+ * @GTK_SORT_DESCENDING: Sorting is in descending order.
+ *
+ * Determines the direction of a sort.
+ */
typedef enum
{
GTK_SORT_ASCENDING,
GTK_IM_STATUS_NONE
} GtkIMStatusStyle;
+/**
+ * GtkPackDirection:
+ * @GTK_PACK_DIRECTION_LTR: Widgets are packed left-to-right
+ * @GTK_PACK_DIRECTION_RTL: Widgets are packed right-to-left
+ * @GTK_PACK_DIRECTION_TTB: Widgets are packed top-to-bottom
+ * @GTK_PACK_DIRECTION_BTT: Widgets are packed bottom-to-top
+ *
+ * Determines how widgets should be packed inside menubars
+ * and menuitems contained in menubars.
+ */
typedef enum
{
GTK_PACK_DIRECTION_LTR,
GTK_PAGE_SET_ODD
} GtkPageSet;
+/**
+ * GtkNumberUpLayout:
+ * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-lrtb.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-lrbt.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-rltb.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-rlbt.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-tblr.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-tbrl.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-btlr.png" format="PNG"></inlinegraphic>
+ * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-btrl.png" format="PNG"></inlinegraphic>
+ *
+ * Used to determine the layout of pages on a sheet when printing
+ * multiple pages per sheet.
+ */
typedef enum
{
GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/
typedef enum
{
- GTK_UNIT_PIXEL,
+ GTK_UNIT_NONE,
GTK_UNIT_POINTS,
GTK_UNIT_INCH,
GTK_UNIT_MM
} GtkUnit;
+#define GTK_UNIT_PIXEL GTK_UNIT_NONE
+
/**
* GtkTreeViewGridLines:
* @GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
GTK_TREE_VIEW_GRID_LINES_BOTH
} GtkTreeViewGridLines;
+/**
+ * GtkDragResult:
+ * @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.
+ *
+ * Gives an indication why a drag operation failed.
+ * The value can by obtained by connecting to the
+ * #GtkWidget::drag-failed signal.
+ */
typedef enum
{
GTK_DRAG_RESULT_SUCCESS,
GTK_DRAG_RESULT_ERROR
} GtkDragResult;
+/**
+ * GtkSizeGroupMode:
+ * @GTK_SIZE_GROUP_NONE: group has no effect
+ * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition
+ * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition
+ * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition
+ *
+ * The mode of the size group determines the directions in which the size
+ * group affects the requested sizes of its component widgets.
+ **/
+typedef enum {
+ GTK_SIZE_GROUP_NONE,
+ GTK_SIZE_GROUP_HORIZONTAL,
+ GTK_SIZE_GROUP_VERTICAL,
+ GTK_SIZE_GROUP_BOTH
+} GtkSizeGroupMode;
+
/**
* GtkSizeRequestMode:
* @GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH: Prefer height-for-width geometry management
* @GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT: Prefer width-for-height geometry management
+ * @GTK_SIZE_REQUEST_CONSTANT_SIZE: Don't trade height-for-width or width-for-height
*
* Specifies a preference for height-for-width or
* width-for-height geometry management.
typedef enum
{
GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH = 0,
- GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT
+ GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT,
+ GTK_SIZE_REQUEST_CONSTANT_SIZE
} GtkSizeRequestMode;
/**
GTK_SCROLL_NATURAL
} GtkScrollablePolicy;
+/**
+ * GtkStateFlags:
+ * @GTK_STATE_FLAG_NORMAL: State during normal operation.
+ * @GTK_STATE_FLAG_ACTIVE: Widget is active.
+ * @GTK_STATE_FLAG_PRELIGHT: Widget has a mouse pointer over it.
+ * @GTK_STATE_FLAG_SELECTED: Widget is selected.
+ * @GTK_STATE_FLAG_INSENSITIVE: Widget is insensitive.
+ * @GTK_STATE_FLAG_INCONSISTENT: Widget is inconsistent.
+ * @GTK_STATE_FLAG_FOCUSED: Widget has the keyboard focus.
+ * @GTK_STATE_FLAG_BACKDROP: Widget is in a background toplevel window.
+ * @GTK_STATE_FLAG_DIR_LTR: Widget is in left-to-right text direction. Since 3.8
+ * @GTK_STATE_FLAG_DIR_RTL: Widget is in right-to-left text direction. Since 3.8
+ *
+ * Describes a widget state. Widget states are used to match the widget
+ * against CSS pseudo-classes. Note that GTK extends the regular CSS
+ * classes and sometimes uses different names.
+ */
+typedef enum
+{
+ GTK_STATE_FLAG_NORMAL = 0,
+ GTK_STATE_FLAG_ACTIVE = 1 << 0,
+ GTK_STATE_FLAG_PRELIGHT = 1 << 1,
+ GTK_STATE_FLAG_SELECTED = 1 << 2,
+ GTK_STATE_FLAG_INSENSITIVE = 1 << 3,
+ GTK_STATE_FLAG_INCONSISTENT = 1 << 4,
+ GTK_STATE_FLAG_FOCUSED = 1 << 5,
+ GTK_STATE_FLAG_BACKDROP = 1 << 6,
+ GTK_STATE_FLAG_DIR_LTR = 1 << 7,
+ GTK_STATE_FLAG_DIR_RTL = 1 << 8
+} GtkStateFlags;
+
+/**
+ * GtkRegionFlags:
+ * @GTK_REGION_EVEN: Region has an even number within a set.
+ * @GTK_REGION_ODD: Region has an odd number within a set.
+ * @GTK_REGION_FIRST: Region is the first one within a set.
+ * @GTK_REGION_LAST: Region is the last one within a set.
+ * @GTK_REGION_ONLY: Region is the only one within a set.
+ * @GTK_REGION_SORTED: Region is part of a sorted area.
+ *
+ * Describes a region within a widget.
+ */
+typedef enum {
+ GTK_REGION_EVEN = 1 << 0,
+ GTK_REGION_ODD = 1 << 1,
+ GTK_REGION_FIRST = 1 << 2,
+ GTK_REGION_LAST = 1 << 3,
+ GTK_REGION_ONLY = 1 << 4,
+ GTK_REGION_SORTED = 1 << 5
+} GtkRegionFlags;
+
+/**
+ * GtkJunctionSides:
+ * @GTK_JUNCTION_NONE: No junctions.
+ * @GTK_JUNCTION_CORNER_TOPLEFT: Element connects on the top-left corner.
+ * @GTK_JUNCTION_CORNER_TOPRIGHT: Element connects on the top-right corner.
+ * @GTK_JUNCTION_CORNER_BOTTOMLEFT: Element connects on the bottom-left corner.
+ * @GTK_JUNCTION_CORNER_BOTTOMRIGHT: Element connects on the bottom-right corner.
+ * @GTK_JUNCTION_TOP: Element connects on the top side.
+ * @GTK_JUNCTION_BOTTOM: Element connects on the bottom side.
+ * @GTK_JUNCTION_LEFT: Element connects on the left side.
+ * @GTK_JUNCTION_RIGHT: Element connects on the right side.
+ *
+ * Describes how a rendered element connects to adjacent elements.
+ */
+typedef enum {
+ GTK_JUNCTION_NONE = 0,
+ GTK_JUNCTION_CORNER_TOPLEFT = 1 << 0,
+ GTK_JUNCTION_CORNER_TOPRIGHT = 1 << 1,
+ GTK_JUNCTION_CORNER_BOTTOMLEFT = 1 << 2,
+ GTK_JUNCTION_CORNER_BOTTOMRIGHT = 1 << 3,
+ GTK_JUNCTION_TOP = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_TOPRIGHT),
+ GTK_JUNCTION_BOTTOM = (GTK_JUNCTION_CORNER_BOTTOMLEFT | GTK_JUNCTION_CORNER_BOTTOMRIGHT),
+ GTK_JUNCTION_LEFT = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_BOTTOMLEFT),
+ GTK_JUNCTION_RIGHT = (GTK_JUNCTION_CORNER_TOPRIGHT | GTK_JUNCTION_CORNER_BOTTOMRIGHT)
+} GtkJunctionSides;
+
+/**
+ * GtkBorderStyle:
+ * @GTK_BORDER_STYLE_NONE: No visible border
+ * @GTK_BORDER_STYLE_SOLID: A single line segment
+ * @GTK_BORDER_STYLE_INSET: Looks as if the content is sunken into the canvas
+ * @GTK_BORDER_STYLE_OUTSET: Looks as if the content is coming out of the canvas
+ * @GTK_BORDER_STYLE_HIDDEN: Same as @GTK_BORDER_STYLE_NONE
+ * @GTK_BORDER_STYLE_DOTTED: A series of round dots
+ * @GTK_BORDER_STYLE_DASHED: A series of square-ended dashes
+ * @GTK_BORDER_STYLE_DOUBLE: Two parallel lines with some space between them
+ * @GTK_BORDER_STYLE_GROOVE: Looks as if it were carved in the canvas
+ * @GTK_BORDER_STYLE_RIDGE: Looks as if it were coming out of the canvas
+ *
+ * Describes how the border of a UI element should be rendered.
+ */
+typedef enum {
+ GTK_BORDER_STYLE_NONE,
+ GTK_BORDER_STYLE_SOLID,
+ GTK_BORDER_STYLE_INSET,
+ GTK_BORDER_STYLE_OUTSET,
+ GTK_BORDER_STYLE_HIDDEN,
+ GTK_BORDER_STYLE_DOTTED,
+ GTK_BORDER_STYLE_DASHED,
+ GTK_BORDER_STYLE_DOUBLE,
+ GTK_BORDER_STYLE_GROOVE,
+ GTK_BORDER_STYLE_RIDGE
+} GtkBorderStyle;
+
+/**
+ * GtkLevelBarMode:
+ * @GTK_LEVEL_BAR_MODE_CONTINUOUS: the bar has a continuous mode
+ * @GTK_LEVEL_BAR_MODE_DISCRETE: the bar has a discrete mode
+ *
+ * Describes how #GtkLevelBar contents should be rendered.
+ * Note that this enumeration could be extended with additional modes
+ * in the future.
+ *
+ * Since: 3.6
+ */
+typedef enum {
+ GTK_LEVEL_BAR_MODE_CONTINUOUS,
+ GTK_LEVEL_BAR_MODE_DISCRETE
+} GtkLevelBarMode;
G_END_DECLS
+/**
+ * GtkInputPurpose:
+ * @GTK_INPUT_PURPOSE_FREE_FORM: Allow any character
+ * @GTK_INPUT_PURPOSE_ALPHA: Allow only alphabetic characters
+ * @GTK_INPUT_PURPOSE_DIGITS: Allow only digits
+ * @GTK_INPUT_PURPOSE_NUMBER: Edited field expects numbers
+ * @GTK_INPUT_PURPOSE_PHONE: Edited field expects phone number
+ * @GTK_INPUT_PURPOSE_URL: Edited field expects URL
+ * @GTK_INPUT_PURPOSE_EMAIL: Edited field expects email address
+ * @GTK_INPUT_PURPOSE_NAME: Edited field expects the name of a person
+ * @GTK_INPUT_PURPOSE_PASSWORD: Like @GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden
+ * @GTK_INPUT_PURPOSE_PIN: Like @GTK_INPUT_PURPOSE_DIGITS, but characters are hidden
+ *
+ * Describes primary purpose of the input widget. This information is
+ * useful for on-screen keyboards and similar input methods to decide
+ * which keys should be presented to the user.
+ *
+ * Note that the purpose is not meant to impose a totally strict rule
+ * about allowed characters, and does not replace input validation.
+ * It is fine for an on-screen keyboard to let the user override the
+ * character set restriction that is expressed by the purpose. The
+ * application is expected to validate the entry contents, even if
+ * it specified a purpose.
+ *
+ * The difference between @GTK_INPUT_PURPOSE_DIGITS and
+ * @GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits
+ * while the latter also some punctuation (like commas or points, plus,
+ * minus) and 'e' or 'E' as in 3.14E+000.
+ *
+ * This enumeration may be extended in the future; input methods should
+ * interpret unknown values as 'free form'.
+ *
+ * Since: 3.6
+ */
+typedef enum
+{
+ GTK_INPUT_PURPOSE_FREE_FORM,
+ GTK_INPUT_PURPOSE_ALPHA,
+ GTK_INPUT_PURPOSE_DIGITS,
+ GTK_INPUT_PURPOSE_NUMBER,
+ GTK_INPUT_PURPOSE_PHONE,
+ GTK_INPUT_PURPOSE_URL,
+ GTK_INPUT_PURPOSE_EMAIL,
+ GTK_INPUT_PURPOSE_NAME,
+ GTK_INPUT_PURPOSE_PASSWORD,
+ GTK_INPUT_PURPOSE_PIN
+} GtkInputPurpose;
+
+/**
+ * GtkInputHints:
+ * @GTK_INPUT_HINT_NONE: No special behaviour suggested
+ * @GTK_INPUT_HINT_SPELLCHECK: Suggest checking for typos
+ * @GTK_INPUT_HINT_NO_SPELLCHECK: Suggest not checking for typos
+ * @GTK_INPUT_HINT_WORD_COMPLETION: Suggest word completion
+ * @GTK_INPUT_HINT_LOWERCASE: Suggest to convert all text to lowercase
+ * @GTK_INPUT_HINT_UPPERCASE_CHARS: Suggest to capitalize all text
+ * @GTK_INPUT_HINT_UPPERCASE_WORDS: Suggest to capitalize the first
+ * character of each word
+ * @GTK_INPUT_HINT_UPPERCASE_SENTENCES: Suggest to capitalize the
+ * first word of each sentence
+ * @GTK_INPUT_HINT_INHIBIT_OSK: Suggest to not show an onscreen keyboard
+ * (e.g for a calculator that already has all the keys).
+ *
+ * Describes hints that might be taken into account by input methods
+ * or applications. Note that input methods may already tailor their
+ * behaviour according to the #GtkInputPurpose of the entry.
+ *
+ * Some common sense is expected when using these flags - mixing
+ * @GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
+ *
+ * This enumeration may be extended in the future; input methods should
+ * ignore unknown values.
+ *
+ * Since: 3.6
+ */
+typedef enum
+{
+ GTK_INPUT_HINT_NONE = 0,
+ GTK_INPUT_HINT_SPELLCHECK = 1 << 0,
+ GTK_INPUT_HINT_NO_SPELLCHECK = 1 << 1,
+ GTK_INPUT_HINT_WORD_COMPLETION = 1 << 2,
+ GTK_INPUT_HINT_LOWERCASE = 1 << 3,
+ GTK_INPUT_HINT_UPPERCASE_CHARS = 1 << 4,
+ GTK_INPUT_HINT_UPPERCASE_WORDS = 1 << 5,
+ GTK_INPUT_HINT_UPPERCASE_SENTENCES = 1 << 6,
+ GTK_INPUT_HINT_INHIBIT_OSK = 1 << 7
+} GtkInputHints;
#endif /* __GTK_ENUMS_H__ */
projects / ~andy / gtk / blobdiff