]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkenums.h
Bug 663856 - Make option-foo accelerators use the right symbol
[~andy/gtk] / gtk / gtkenums.h
index d146359c97e259670e59fe4e769da435b747f9ee..7045f922c248a4180eebed31786218b2f2886846 100644 (file)
@@ -63,6 +63,9 @@ 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
 {
@@ -245,7 +248,15 @@ typedef enum
   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,
@@ -469,16 +480,16 @@ typedef enum
  * 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_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.
+ *      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.
  *
  * Used to control what selections users are allowed to make.
@@ -611,7 +622,18 @@ typedef enum
   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,
@@ -648,6 +670,16 @@ typedef enum
   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 insided menubars
+ * and menuitems contained in menubars.
+ */
 typedef enum
 {
   GTK_PACK_DIRECTION_LTR,
@@ -671,6 +703,20 @@ typedef enum
   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 >*/
@@ -761,6 +807,7 @@ typedef enum
  * 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: Dont trade height-for-width or width-for-height
  * 
  * Specifies a preference for height-for-width or
  * width-for-height geometry management.
@@ -768,7 +815,8 @@ typedef enum
 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;
 
 /**
@@ -794,6 +842,7 @@ typedef enum
  * @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_WINDOW_UNFOCUSED: Widget's toplevel window is unfocused.
  *
  * Describes a widget state.
  */
@@ -805,7 +854,8 @@ typedef enum
   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_FOCUSED      = 1 << 5,
+  GTK_STATE_FLAG_WINDOW_UNFOCUSED = 1 << 6
 } GtkStateFlags;
 
 /**
@@ -814,6 +864,7 @@ typedef enum
  * @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.
@@ -823,6 +874,7 @@ typedef enum {
   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;