TextView

This page has been automatically translated using the Google Translate API services. We are working on improving texts. Thank you for your understanding and patience.

Functions

TextView are views designed to work with rich text blocks (Figure 1), where fonts, sizes and colors can be combined. We can consider them as the basis of a text editor. In Hello TextView! you have an example of use.

• Use textview_create to create a text view.
• Use textview_writef to insert text.
• Use textview_printf to insert text in the format of printf.
• Use textview_select to position the caret.
• Use textview_clear to erase all text.

1. Character format

One of the advantages of rich text over plain text is the ability to combine different character formats within the same paragraph (Figure 2). Changes will be applied to new text added to the control.

Use textview_family to set the font.

Use textview_fsize to set the character size.

Use textview_fstyle to set the style.

Use textview_color to set the text color.

Use textview_bgcolor to set the background color of the text.

2. Paragraph format

You can also set attributes per paragraph (Figure 3). The new line character '\n' is considered the closing or end of the paragraph.

Use textview_halign to set to paragraph alignment.

Use textview_lspacing to set line spacing (line spacing).

Use textview_bfspace to indicate the vertical space before the paragraph.

Use textview_afspace to indicate the vertical space after the paragraph.

3. Document format

Finally we have several attributes that affect the entire document or control.

Use textview_units to set the text units.

Use textview_pgcolor to set the background color of the control (page).

4. Apply attributes

The text attributes seen in the previous sections will be applied to new text added to the control using the textview_writef or textview_printf functions. However, we can apply them to text already existing in the control. In Hello TextEditor! you have an example of use.

• Use textview_apply_all to apply the attributes to all the text in the control.
• Use textview_apply_sel to apply the attributes to the selected text.

5. Text wrapping

• Use textview_wrap to turn text wrapping on/off.

By default, the control automatically adjusts the width of the text, cutting lines when necessary. This can be avoided by passing wrap=FALSE, where each line will occupy its natural width and a horizontal scroll bar will appear to scroll the text (Figure 4).

textview_create ()

Create a text view.

TextView*
textview_create(void);

Return

The text view.

textview_OnFilter ()

Set a handler to filter text while editing.

void
textview_OnFilter(TextView *view,
                  Listener *listener);

Remarks

It works the same way as in Edit controls. See Filter texts and GUI Events.

textview_OnFocus ()

Sets a handler for keyboard focus.

void
textview_OnFocus(TextView *view,
                 Listener *listener);

Remarks

See GUI Events.

textview_size ()

Sets the default size of the view.

void
textview_size(TextView *view,
              const S2Df size);

Remarks

It corresponds to the Natural sizing of the control. Default 245x144.

textview_clear ()

Clears all content from view.

void
textview_clear(TextView *view);

textview_printf ()

Writes text to the view, using the format of the printf.

uint32_t
textview_printf(TextView *view,
                const char_t *format,
                ...);

1

textview_printf(view, Code: %-10s Price %5.2f\n", code, price);

Return

The number of bytes written.

textview_writef ()

Write a C UTF8 string to the view.

void
textview_writef(TextView *view,
                const char_t *str);

textview_rtf ()

Insert text in Microsoft RTF format.

void
textview_rtf(TextView *view,
             Stream *rtf_in);

textview_units ()

Sets the text units.

void
textview_units(TextView *view,
               const uint32_t units);

Remarks

ekFPOINTS is the default value and the one normally used by word processors. See Size in points.

textview_family ()

Sets the font family of the text ("Arial", "Times New Roman", "Helvetica", etc).

void
textview_family(TextView *view,
                const char_t *family);

Remarks

Not all families will be present on all platforms. Use font_exists_family or font_installed_families to check.

textview_fsize ()

Set the text size.

void
textview_fsize(TextView *view,
               const real32_t size);

Remarks

The value is conditional on the units established in textview_units.

textview_fstyle ()

Sets the text style.

void
textview_fstyle(TextView *view,
                const uint32_t fstyle);

textview_color ()

Sets the text color.

void
textview_color(TextView *view,
               const color_t color);

textview_bgcolor ()

Sets the background color of the text.

void
textview_bgcolor(TextView *view,
                 const color_t color);

textview_pgcolor ()

Sets the background color of the control.

void
textview_pgcolor(TextView *view,
                 const color_t color);

textview_halign ()

Sets the alignment of text in a paragraph.

void
textview_halign(TextView *view,
                const align_t align);

textview_lspacing ()

Sets the line spacing of the paragraph.

void
textview_lspacing(TextView *view,
                  const real32_t scale);

textview_bfspace ()

Sets a vertical space before the paragraph.

void
textview_bfspace(TextView *view,
                 const real32_t space);

textview_afspace ()

Sets a vertical space after the paragraph.

void
textview_afspace(TextView *view,
                 const real32_t space);

textview_apply_all ()

Applies the character and paragraph attributes to all text in the control. If there is no text, they will be taken as the default attributes of the text added using the keyboard.

void
textview_apply_all(TextView *view);

1
2
3
4
5

textview_family(view, "Arial");
textview_fsize(view, 16);
textview_color(view, kCOLOR_RED);
// Arial:16:Red to all text or default
textview_apply_all(view);

Remarks

See Apply attributes.

textview_apply_sel ()

Applies character and paragraph attributes to selected text.

void
textview_apply_sel(TextView *view);

Remarks

See Apply attributes.

textview_scroll_visible ()

Show or hide scroll bars.

void
textview_scroll_visible(TextView *view,
                        const bool_t horizontal,
                        const bool_t vertical);

textview_editable ()

Sets whether or not the control text is editable.

void
textview_editable(TextView *view,
                  const bool_t is_editable);

textview_select ()

Select text.

void
textview_select(TextView *view,
                const int32_t start,
                const int32_t end);

Remarks

It works the same way as in Edit controls. See Text selection.

textview_show_select ()

Sets whether to show or hide the text selection when keyboard focus is lost.

void
textview_show_select(TextView *view,
                     const bool_t show);

Remarks

When lose keyboard focus, the control will retain the text selection. This feature only affects the visibility of the selection.

textview_scroll_caret ()

In texts that exceed the visible part, it scrolls to the position of the caret.

void
textview_scroll_caret(TextView *view);

textview_get_text ()

Gets the text of the control.

const char_t*
textview_get_text(const TextView *view);

Return

Null-terminated UTF8 C string '\0'.

textview_copy ()

Copies the selected text to the clipboard.

void
textview_copy(const TextView *view);

Remarks

It works the same way as in Edit controls. See Clipboard operations.

textview_cut ()

Cuts the selected text, copying it to the clipboard.

void
textview_cut(TextView *view);

Remarks

It works the same way as in Edit controls. See Clipboard operations.

textview_paste ()

Pastes the text from the clipboard into the caret position.

void
textview_paste(TextView *view);

Remarks

It works the same way as in Edit controls. See Clipboard operations.

textview_wrap ()

Turn automatic text wrapping on or off.

void
textview_wrap(TextView *view,
              const bool_t wrap);

Remarks

See Text wrapping.