gui.guistatictext - ICE 0.1 API documentation

ICE 0.1 API documentation

# gui.guistatictext

Static text widget.

enum AlignX;

  Horizontal alignments.

  Right

    Align to right.

  Center

    Align to center.

  Left

    Align to left.

enum AlignY;

  Vertical alignments.

  Top

    Align to top.

  Center

    Align to center.

  Bottom

    Align to bottom.

class GUIStaticText: gui.guielement.GUIElement;

  Static text element.

  Text is broken down into lines to fit width, but no fancy formatting is supported yet.

  @property void textColor(in Color color);

    Set text color.

  const @property string text();

    Return displayed text.

  @property void text(in string text);

    Set text to display.

  static @property uint defaultFontSize();

    Get default font size of GUIStaticText instances.

  protected this(const(GUIElementParams) params, const(Color) textColor, const(immutable(char)[]) text, const(AlignX) alignX, const(AlignY) alignY, const(uint) fontSize, const(immutable(char)[]) font);

    Construct a static text with specified parameters.

    Parameters:

    const(GUIElementParams) params | Parameters for GUIElement constructor.
    const(Color) textColor | Text color.
    const(immutable(char)[]) text | Text to display.
    const(AlignX) alignX | Horizontal alignment of the text.
    const(AlignY) alignY | Vertical alignment of the text.
    const(uint) fontSize | Font size.
    const(immutable(char)[]) font | Name of the font to use.

class GUIStaticTextFactory: gui.guielement.GUIElementFactoryBase!(GUIStaticText).GUIElementFactoryBase;

  Factory used for static text construction.

  See Also:
  GUIElementFactoryBase
  Parameters:

  drawBorder | Draw border of the element? Default; false
  textColor | Color of the text. Default; Color.white
  text | Text to display. Default; ""
  alignX | Horizontal alignment of the text. Default; AlignX.Left
  alignY | Vertical alignment of the text. Default; AlignY.Top
  fontSize | Size of text font.
  font | Name of the font to use. Default; "default"

  this();

    Construct a GUIStaticTextFactory and initialize defaults.

Copyright © Ferdinand Majerech 2011. | Page generated by AutoDDoc and Ddoc.