ui/gfx/text_constants.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_GFX_TEXT_CONSTANTS_H_
   6 #define UI_GFX_TEXT_CONSTANTS_H_
   7
   8 namespace gfx {
   9
  10 // TODO(msw): Distinguish between logical character stops and glyph stops?
  11 // TODO(msw): Merge with base::i18n::BreakIterator::BreakType.
  12 enum BreakType {
  13   CHARACTER_BREAK = 0, // Stop cursor movement on neighboring characters.
  14   WORD_BREAK,          // Stop cursor movement on nearest word boundaries.
  15   LINE_BREAK,          // Stop cursor movement on line ends as shown on screen.
  16 };
  17
  18 // Specifies the word wrapping behavior when a word would exceed the available
  19 // display width. All words that are too wide will be put on a new line, and
  20 // then:
  21 enum WordWrapBehavior {
  22   IGNORE_LONG_WORDS,   // Overflowing word text is left on that line.
  23   TRUNCATE_LONG_WORDS, // Overflowing word text is truncated.
  24   ELIDE_LONG_WORDS,    // Overflowing word text is elided at the ellipsis.
  25   WRAP_LONG_WORDS,     // Overflowing word text is wrapped over multiple lines.
  26 };
  27
  28 // Horizontal text alignment modes.
  29 enum HorizontalAlignment {
  30   ALIGN_LEFT = 0, // Align the text's left edge with that of its display area.
  31   ALIGN_CENTER,   // Align the text's center with that of its display area.
  32   ALIGN_RIGHT,    // Align the text's right edge with that of its display area.
  33   ALIGN_TO_HEAD,  // Align the text to its first strong character's direction.
  34 };
  35
  36 // The directionality modes used to determine the base text direction.
  37 enum DirectionalityMode {
  38   DIRECTIONALITY_FROM_TEXT = 0, // Use the first strong character's direction.
  39   DIRECTIONALITY_FROM_UI,       // Use the UI locale's text reading direction.
  40   DIRECTIONALITY_FORCE_LTR,     // Use LTR regardless of content or UI locale.
  41   DIRECTIONALITY_FORCE_RTL,     // Use RTL regardless of content or UI locale.
  42 };
  43
  44 // Text styles and adornments.
  45 // TODO(msw): Merge with gfx::Font::FontStyle.
  46 enum TextStyle {
  47   BOLD = 0,
  48   ITALIC,
  49   STRIKE,
  50   DIAGONAL_STRIKE,
  51   UNDERLINE,
  52   NUM_TEXT_STYLES,
  53 };
  54
  55 // Text baseline offset types.
  56 // Figure of font metrics:
  57 //   +--------+--------+------------------------+-------------+
  58 //   |        |        | internal leading       | SUPERSCRIPT |
  59 //   |        |        +------------+-----------|             |
  60 //   |        | ascent |            | SUPERIOR  |-------------+
  61 //   | height |        | cap height |-----------|
  62 //   |        |        |            | INFERIOR  |-------------+
  63 //   |        |--------+------------+-----------|             |
  64 //   |        | descent                         | SUBSCRIPT   |
  65 //   +--------+---------------------------------+-------------+
  66 enum BaselineStyle {
  67   NORMAL_BASELINE = 0,
  68   SUPERSCRIPT,  // e.g. a mathematical exponent would be superscript.
  69   SUPERIOR,     // e.g. 8th, the "th" would be superior script.
  70   INFERIOR,     // e.g. 1/2, the "2" would be inferior ("1" is superior).
  71   SUBSCRIPT,    // e.g. H2O, the "2" would be subscript.
  72 };
  73
  74 // Elision behaviors of text that exceeds constrained dimensions.
  75 enum ElideBehavior {
  76   NO_ELIDE = 0, // Do not modify the text, it may overflow its available bounds.
  77   TRUNCATE,     // Do not elide or fade, just truncate at the end of the string.
  78   ELIDE_HEAD,   // Add an ellipsis at the start of the string.
  79   ELIDE_MIDDLE, // Add an ellipsis in the middle of the string.
  80   ELIDE_TAIL,   // Add an ellipsis at the end of the string.
  81   ELIDE_EMAIL,  // Add ellipses to username and domain substrings.
  82   FADE_TAIL,    // Fade the string's end opposite of its horizontal alignment.
  83 };
  84
  85 }  // namespace gfx
  86
  87 #endif  // UI_GFX_TEXT_CONSTANTS_H_