Cross-platform C SDK logo

Cross-platform C SDK

TextView

❮ Back
Next ❯
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*textview_create (void)
voidtextview_size (...)
voidtextview_clear (...)
uint32_ttextview_printf (...)
voidtextview_writef (...)
voidtextview_rtf (...)
voidtextview_units (...)
voidtextview_family (...)
voidtextview_fsize (...)
voidtextview_fstyle (...)
voidtextview_color (...)
voidtextview_bgcolor (...)
voidtextview_pgcolor (...)
voidtextview_halign (...)
voidtextview_lspacing (...)
voidtextview_bfspace (...)
voidtextview_afspace (...)
voidtextview_scroll_down (...)
voidtextview_editable (...)

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.


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 change the font.

Use textview_fsize to change the character size.

Use textview_fstyle to change the style.

Use textview_color to change the color of the text.

Use textview_bgcolor to change the background color of the text.

Selection of fonts and text attributes.
Figure 2: Typical Character Format Controls.

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.

Formatting a paragraph of text.
Figure 3: Typical controls for paragraph formatting.

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).


textview_create ()

Create a text view.

TextView*
textview_create(void);

Return

The text view.


textview_size ()

Sets the default size of the view.

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

The view.

size

The 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);
view

The 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
view

The view.

format

String in type-printf format with a variable number of parameters.

...

Printf arguments or variables.

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);
view

The view.

str

String C UTF8 terminated in null character '\0'.


textview_rtf ()

Insert text in Microsoft RTF format.

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

The view.

rtf_in

Reading stream with RTF content.


textview_units ()

Sets the text units.

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

The view.

units

Units ekFPIXELS or ekFPOINTS.

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);
view

The view.

family

The font 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);
view

The view.

size

The 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);
view

The view.

fstyle

Combination of ekFBOLD, ekFITALIC, ekFSTRIKEOUT, ekFUNDERLINE ekFSUBSCRIPT, ekFSUPSCRIPT. To override any previous style use ekFNORMAL.


textview_color ()

Sets the text color.

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

The view.

color

The color. Use kCOLOR_DEFAULT to restore the default color.


textview_bgcolor ()

Sets the background color of the text.

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

The view.

color

The color. Use kCOLOR_DEFAULT to restore the default color.


textview_pgcolor ()

Sets the background color of the control.

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

The view.

color

The color. Use kCOLOR_DEFAULT to restore the default color.


textview_halign ()

Sets the alignment of text in a paragraph.

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

The view.

align

The alignment. By default ekLEFT.


textview_lspacing ()

Sets the line spacing of the paragraph.

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

The view.

scale

Scale factor in font height. 1 is the default value, 2 twice this height, 3 triple, etc. Intermediate values ​​are also valid (eg 1.25).


textview_bfspace ()

Sets a vertical space before the paragraph.

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

The view.

space

The space in the preset units.


textview_afspace ()

Sets a vertical space after the paragraph.

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

The view.

space

The space in the preset units.


textview_scroll_down ()

Forces a scroll to the lower limit of the content of the view.

void
textview_scroll_down(TextView *view);
view

The view.

Remarks

Will make the last inserted content visible.


textview_editable ()

Sets whether or not the control text is editable.

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

The view.

is_editable

TRUE will allow you to edit the text. By default FALSE.

❮ Back
Next ❯