class_label

Label

Inherits: Range\n\n

Brief Description

Control that displays formatted text.

Member Functions

• void ** set_align ** ( int align )
• int ** get_align ** ( ) const
• void ** set_valign ** ( int valign )
• int ** get_valign ** ( ) const
• void ** set_text ** ( String text )
• String ** get_text ** ( ) const
• void ** set_autowrap ** ( bool enable )
• bool ** has_autowrap ** ( ) const
• void ** set_uppercase ** ( bool enable )
• bool ** is_uppercase ** ( ) const
• int ** get_line_height ** ( ) const
• int ** get_line_count ** ( ) const
• int ** get_total_character_count ** ( ) const
• void ** set_visible_characters ** ( int arg0 )
• void ** set_percent_visible ** ( real percent_visible )
• real ** get_percent_visible ** ( ) const

Numeric Constants

• ALIGN_LEFT = 0 - Align rows to the left (default).
• ALIGN_CENTER = 1 - Align rows centered.
• ALIGN_RIGHT = 2 - Align rows to the right (default).
• ALIGN_FILL = 3 - Expand row whitespaces to fit the width.
• VALIGN_TOP = 0 - Align the whole text to the top.
• VALIGN_CENTER = 1 - Align the whole text to the center.
• VALIGN_BOTTOM = 2 - Align the whole text to the bottom.
• VALIGN_FILL = 3 - Align the whole text by spreading the rows.

Description

Label is a control that displays formatted text, optionally autowrapping it to the control area. It inherits from range to be able to scroll wrapped text vertically.

Member Function Description

set_align

• void ** set_align ** ( int align ) \ Set the alignmend mode to any of the ALIGN_* enumeration values.

get_align

• int ** get_align ** ( ) const \ Return the alignmend mode (any of the ALIGN_* enumeration values).

set_text

• void ** set_text ** ( String text ) \ Set the label text. Text can contain newlines.

get_text

• String ** get_text ** ( ) const \ Return the label text. Text can contain newlines.

set_autowrap

• void ** set_autowrap ** ( bool enable ) \ Set //autowrap// mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows.

has_autowrap

• bool ** has_autowrap ** ( ) const \ Return the state of the //autowrap// mode (see #set_autowrap).

get_line_height

• int ** get_line_height ** ( ) const \ Return the height of a line.

get_line_count

• int ** get_line_count ** ( ) const \ Return the amount of lines.