text_class (library)

Author(s): Montserrat Urraca.

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.9#148 (2003/12/4, 17:34:58 CET)

• Usage and interface (text_class)
• Documentation on exports (text_class)

Usage and interface (text_class)

Documentation on exports (text_class)

PREDICATE: coord/2:

Usage: coord(X, Y)

• Description: X and Y specify the coordinates of a point used to position the text on the display.
• Call and exit should be compatible with: X is an integer. (basic_props:int/1) Y is an integer. (basic_props:int/1)
• The following properties should hold at call time: X is currently a term which is not a free variable. (term_typing:nonvar/1) Y is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: point/2:

Usage: point(X, Y)

• Description: X and Y change the coordinates of a point used to position the text on the display.
• Call and exit should be compatible with: X is an integer. (basic_props:int/1) Y is an integer. (basic_props:int/1)
• The following properties should hold at call time: X is currently a term which is not a free variable. (term_typing:nonvar/1) Y is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: text_characters/1:

Usage 1: text_characters(Text)

• Description: Text specifies the characters to be displayed in the text item. This option defaults to an empty string.
• Call and exit should be compatible with: Text is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Text is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: text_characters(Text)

• Description: Gets the text displayed in the text item.
• Call and exit should be compatible with: Text is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Text is a free variable. (term_typing:var/1)

PREDICATE: anchor/1:

Usage 1: anchor(AnchorPos)

• Description: AnchorPos tells how to position the text relative to the positioning point for the text. This option defaluts to center.
• Call and exit should be compatible with: AnchorPos is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: AnchorPos is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: anchor(AnchorPos)

• Description: Gets the position of the text relative to the positioning point.
• Call and exit should be compatible with: AnchorPos is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: AnchorPos is a free variable. (term_typing:var/1)

PREDICATE: font_type/1:

Usage 1: font_type(Font)

• Description: Font specifies the font to use for the text item. This option defaluts to arial.
• Call and exit should be compatible with: Font is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Font is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: font_type(Font)

• Description: Gets the value of the Font used for the text item.
• Call and exit should be compatible with: Font is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: Font is a free variable. (term_typing:var/1)

PREDICATE: justify_text/1:

Usage 1: justify_text(How)

• Description: How specifies how to justify the text within its bounding region. How must be one of the values left, right or center. This option defaluts to left.
• Call and exit should be compatible with: How is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: How is currently a term which is not a free variable. (term_typing:nonvar/1)

Usage 2: justify_text(How)

• Description: Gets How is justified the text.
• Call and exit should be compatible with: How is currently instantiated to an atom. (term_typing:atom/1)
• The following properties should hold at call time: How is a free variable. (term_typing:var/1)

Go to the first, previous, next, last section, table of contents.