Atk.TextAttribute
Description: Reference for Atk.TextAttribute

### Enumeration

# AtkTextAttribute

#### Declaration

    enum Atk.TextAttribute

#### Description [src]

Describes the text attributes supported.

#### Members

`ATK_TEXT_ATTR_INVALID`

  Invalid attribute, like bad spelling or grammar.

  - Value: `0`
  - Available since: 1.0
`ATK_TEXT_ATTR_LEFT_MARGIN`

  The pixel width of the left margin.

  - Value: `1`
  - Available since: 1.0
`ATK_TEXT_ATTR_RIGHT_MARGIN`

  The pixel width of the right margin.

  - Value: `2`
  - Available since: 1.0
`ATK_TEXT_ATTR_INDENT`

  The number of pixels that the text is indented.

  - Value: `3`
  - Available since: 1.0
`ATK_TEXT_ATTR_INVISIBLE`

  Either “true” or “false” indicating whether text is visible or not.

  - Value: `4`
  - Available since: 1.0
`ATK_TEXT_ATTR_EDITABLE`

  Either “true” or “false” indicating whether text is editable or not.

  - Value: `5`
  - Available since: 1.0
`ATK_TEXT_ATTR_PIXELS_ABOVE_LINES`

  Pixels of blank space to leave above each newline-terminated line.

  - Value: `6`
  - Available since: 1.0
`ATK_TEXT_ATTR_PIXELS_BELOW_LINES`

  Pixels of blank space to leave below each newline-terminated line.

  - Value: `7`
  - Available since: 1.0
`ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP`

  Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).

  - Value: `8`
  - Available since: 1.0
`ATK_TEXT_ATTR_BG_FULL_HEIGHT`

  “true” or “false” whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.

  - Value: `9`
  - Available since: 1.0
`ATK_TEXT_ATTR_RISE`

  Number of pixels that the characters are risen above the baseline. See also ATK_TEXT_ATTR_TEXT_POSITION.

  - Value: `10`
  - Available since: 1.0
`ATK_TEXT_ATTR_UNDERLINE`

  “none”, “single”, “double”, “low”, or “error”.

  - Value: `11`
  - Available since: 1.0
`ATK_TEXT_ATTR_STRIKETHROUGH`

  “true” or “false” whether the text is strikethrough.

  - Value: `12`
  - Available since: 1.0
`ATK_TEXT_ATTR_SIZE`

  The size of the characters in points. eg: 10.

  - Value: `13`
  - Available since: 1.0
`ATK_TEXT_ATTR_SCALE`

  The scale of the characters. The value is a string representation of a double.

  - Value: `14`
  - Available since: 1.0
`ATK_TEXT_ATTR_WEIGHT`

  The weight of the characters.

  - Value: `15`
  - Available since: 1.0
`ATK_TEXT_ATTR_LANGUAGE`

  The language used.

  - Value: `16`
  - Available since: 1.0
`ATK_TEXT_ATTR_FAMILY_NAME`

  The font family name.

  - Value: `17`
  - Available since: 1.0
`ATK_TEXT_ATTR_BG_COLOR`

  The background color. The value is an RGB value of the format “%u,%u,%u”.

  - Value: `18`
  - Available since: 1.0
`ATK_TEXT_ATTR_FG_COLOR`

  The foreground color. The value is an RGB value of the format “%u,%u,%u”.

  - Value: `19`
  - Available since: 1.0
`ATK_TEXT_ATTR_BG_STIPPLE`

  “true” if a `GdkBitmap` is set for stippling the background color.

  - Value: `20`
  - Available since: 1.0
`ATK_TEXT_ATTR_FG_STIPPLE`

  “true” if a `GdkBitmap` is set for stippling the foreground color.

  - Value: `21`
  - Available since: 1.0
`ATK_TEXT_ATTR_WRAP_MODE`

  The wrap mode of the text, if any. Values are “none”, “char”, “word”, or “word_char”.

  - Value: `22`
  - Available since: 1.0
`ATK_TEXT_ATTR_DIRECTION`

  The direction of the text, if set. Values are “none”, “ltr” or “rtl”.

  - Value: `23`
  - Available since: 1.0
`ATK_TEXT_ATTR_JUSTIFICATION`

  The justification of the text, if set. Values are “left”, “right”, “center” or “fill”.

  - Value: `24`
  - Available since: 1.0
`ATK_TEXT_ATTR_STRETCH`

  The stretch of the text, if set. Values are “ultra_condensed”, “extra_condensed”, “condensed”, “semi_condensed”, “normal”, “semi_expanded”, “expanded”, “extra_expanded” or “ultra_expanded”.

  - Value: `25`
  - Available since: 1.0
`ATK_TEXT_ATTR_VARIANT`

  The capitalization variant of the text, if set. Values are “normal” or “small_caps”.

  - Value: `26`
  - Available since: 1.0
`ATK_TEXT_ATTR_STYLE`

  The slant style of the text, if set. Values are “normal”, “oblique” or “italic”.

  - Value: `27`
  - Available since: 1.0
`ATK_TEXT_ATTR_TEXT_POSITION`

  The vertical position with respect to the baseline. Values are “baseline”, “super”, or “sub”. Note that a super or sub text attribute refers to position with respect to the baseline of the prior character.

  - Value: `28`
  - Available since: 1.0
`ATK_TEXT_ATTR_MARK`

  A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose that is clear from context. This is similar to ATK_ROLE_MARK, but this is used where it may apply to a partial span of text in an object, rather than to an entire object. Values are “true” or “false”.

  - Value: `29`
  - Available since: 2.60
`ATK_TEXT_ATTR_LAST_DEFINED`

  Not a valid text attribute, used for finding end of enumeration.

  - Value: `30`
  - Available since: 1.0

#### Type functions

###### atk_text_attribute_for_name

Get the `AtkTextAttribute` type corresponding to a text attribute name.

###### atk_text_attribute_get_name

Gets the name corresponding to the `AtkTextAttribute`.

###### atk_text_attribute_get_value

Gets the value for the index of the `AtkTextAttribute`.

###### atk_text_attribute_register

Associate `name` with a new `AtkTextAttribute`.