wxTextAttrEx

wxTextAttrEx

Functions/Procedures
Supertopics

wxTextAttrEx

[func]
get_textattrex_bullet_font
( atom attr )

Category: wxTextAttrEx

Returns a string containing the name of the font associated with the bullet symbol. Only valid for attributes with wxTEXT_ATTR_BULLET_SYMBOL.


wxTextAttrEx

[func]
get_textattrex_bullet_name
( atom attr )

Category: wxTextAttrEx

Returns the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.

Currently the following standard bullet names are supported:


wxTextAttrEx

[func]
get_textattrex_bullet_number
( atom attr )

Category: wxTextAttrEx

Returns the bullet number.


wxTextAttrEx

[func]
get_textattrex_bullet_spacing
( atom attr )

Category: wxTextAttrEx


wxTextAttrEx

[func]
get_textattrex_bullet_text
( atom attr )

Category: wxTextAttrEx

Returns the bullet text, which could be a symbol, or (for example) cached outline text.


wxTextAttrEx

[func]
get_textattrex_char_style
( atom attr )

Category: wxTextAttrEx

Returns the name of the character style.


wxTextAttrEx

[func]
get_textattrex_effects
( atom attr )

Category: wxTextAttrEx

Returns the text effects, a bit list of styles. See set_textattrex_effects for details.


wxTextAttrEx

[func]
get_textattrex_effect_flags
( atom attr )

Category: wxTextAttrEx

Returns the text effect bits of interest. See set_textattrex_flags for further information.


wxTextAttrEx

[func]
get_textattrex_line_spacing
( atom attr )

Category: wxTextAttrEx

Returns the line spacing value, one of wxTEXT_ATTR_LINE_SPACING_NORMAL, wxTEXT_ATTR_LINE_SPACING_HALF, and wxTEXT_ATTR_LINE_SPACING_TWICE.


wxTextAttrEx

[func]
get_textattrex_list_style
( atom attr )

Category: wxTextAttrEx

Returns the name of the list style.


wxTextAttrEx

[func]
get_textattrex_outline_level
( atom attr )

Category: wxTextAttrEx

Returns the outline level.


wxTextAttrEx

[func]
get_textattrex_para_spacing_after
( atom attr )

Category: wxTextAttrEx

Returns the space in tenths of a millimeter after the paragraph.


wxTextAttrEx

[func]
get_textattrex_para_spacing_before
( atom attr )

Category: wxTextAttrEx

Returns the space in tenths of a millimeter before the paragraph.


wxTextAttrEx

[func]
get_textattrex_para_style
( atom attr )

Category: wxTextAttrEx

Returns the name of the paragraph style.


wxTextAttrEx

[func]
get_textattrex_url
( atom attr )

Category: wxTextAttrEx

Returns the URL for the content. Content with wxTEXT_ATTR_URL style causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates a wxTextUrlEvent when the content is clicked.


wxTextAttrEx

[func]
has_bullet_name_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a standard bullet name.


wxTextAttrEx

[func]
has_bullet_number_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a bullet number.


wxTextAttrEx

[func]
has_bullet_style_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a bullet style.


wxTextAttrEx

[func]
has_bullet_text_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies bullet text (usually containing a symbol).


wxTextAttrEx

[func]
has_char_style_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a character style name.


wxTextAttrEx

[func]
has_font_italic_textattrex
( atom attr )

Category: wxTextAttrEx


wxTextAttrEx

[func]
has_font_name_textattrex
( atom attr )

Category: wxTextAttrEx


wxTextAttrEx

[func]
has_font_size_textattrex
( atom attr )

Category: wxTextAttrEx


wxTextAttrEx

[func]
has_font_underlined_textattrex
( atom attr )

Category: wxTextAttrEx


wxTextAttrEx

[func]
has_font_weight_textattrex
( atom attr )

Category: wxTextAttrEx


wxTextAttrEx

[func]
has_line_spacing_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies line spacing.


wxTextAttrEx

[func]
has_list_style_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a list style name.


wxTextAttrEx

[func]
has_outline_level_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies an outline level.


wxTextAttrEx

[func]
has_page_break_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a page break before this paragraph.


wxTextAttrEx

[func]
has_para_spacing_after_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies spacing after a paragraph.


wxTextAttrEx

[func]
has_para_spacing_before_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies spacing after a paragraph.


wxTextAttrEx

[func]
has_para_style_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a paragraph style name.


wxTextAttrEx

[func]
has_text_effects_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies text effects.


wxTextAttrEx

[func]
has_text_effect_textattrex
( atom attr, atom effect )

Category: wxTextAttrEx


wxTextAttrEx

[func]
has_url_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the attribute object specifies a URL.


wxTextAttrEx

[func]
is_char_style_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the object represents a character style, that is, the flags specify a font or a text background or foreground colour.


wxTextAttrEx

[func]
is_default_textattrex
( atom attr )

Category: wxTextAttrEx

Returns false if we have any attributes set, true otherwise.


wxTextAttrEx

[func]
is_para_style_textattrex
( atom attr )

Category: wxTextAttrEx

Returns true if the object represents a paragraph style, that is, the flags specify alignment, indentation, tabs, paragraph spacing, or bullet style.


wxTextAttrEx

[proc]
set_textattrex_bullet_font
( atom attr, object font_name )

Category: wxTextAttrEx

Sets the name of the font associated with the bullet symbol. Only valid for attributes with wxTEXT_ATTR_BULLET_SYMBOL.


wxTextAttrEx

[proc]
set_textattrex_bullet_name
( atom attr, object name )

Category: wxTextAttrEx

Sets the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD. See get_textattrex_bullet_name for a list of supported names, and how to expand the range of supported types.


wxTextAttrEx

[proc]
set_textattrex_bullet_number
( atom attr, atom num )

Category: wxTextAttrEx

Sets the bullet number.


wxTextAttrEx

[proc]
set_textattrex_bullet_style
( atom attr, atom style )

Category: wxTextAttrEx

Sets the bullet style. The following styles can be passed:

#define wxTEXT_ATTR_BULLET_STYLE_NONE             0x00000000
#define wxTEXT_ATTR_BULLET_STYLE_ARABIC           0x00000001
#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER        0x00000002
#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER        0x00000004
#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER      0x00000008
#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER      0x00000010
#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL           0x00000020
#define wxTEXT_ATTR_BULLET_STYLE_BITMAP           0x00000040
#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES      0x00000080
#define wxTEXT_ATTR_BULLET_STYLE_PERIOD           0x00000100
#define wxTEXT_ATTR_BULLET_STYLE_STANDARD         0x00000200
#define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS    0x00000400
#define wxTEXT_ATTR_BULLET_STYLE_OUTLINE          0x00000800
#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT       0x00000000
#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT      0x00001000
#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE     0x00002000

Currently wxTEXT_ATTR_BULLET_STYLE_BITMAP is not supported.


wxTextAttrEx

[proc]
set_textattrex_bullet_text
( atom attr, object text )

Category: wxTextAttrEx

Sets the bullet text, which could be a symbol, or (for example) cached outline text.


wxTextAttrEx

[proc]
set_textattrex_char_style_name
( atom attr, object name )

Category: wxTextAttrEx

Sets the character style name.


wxTextAttrEx

[proc]
set_textattrex_effects
( atom attr, atom effects )

Category: wxTextAttrEx

Sets the text effects, a bit list of styles.

The following styles can be passed:

#define wxTEXT_ATTR_EFFECT_NONE                   0x00000000
#define wxTEXT_ATTR_EFFECT_CAPITALS               0x00000001
#define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS         0x00000002
#define wxTEXT_ATTR_EFFECT_STRIKETHROUGH          0x00000004
#define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH   0x00000008
#define wxTEXT_ATTR_EFFECT_SHADOW                 0x00000010
#define wxTEXT_ATTR_EFFECT_EMBOSS                 0x00000020
#define wxTEXT_ATTR_EFFECT_OUTLINE                    0x00000040
#define wxTEXT_ATTR_EFFECT_ENGRAVE                    0x00000080
#define wxTEXT_ATTR_EFFECT_SUPERSCRIPT                0x00000100
#define wxTEXT_ATTR_EFFECT_SUBSCRIPT              0x00000200

Of these, only wxTEXT_ATTR_EFFECT_CAPITALS and wxTEXT_ATTR_EFFECT_STRIKETHROUGH are implemented. wxTEXT_ATTR_EFFECT_CAPITALS capitalises text when displayed (leaving the case of the actual buffer text unchanged), and wxTEXT_ATTR_EFFECT_STRIKETHROUGH draws a line through text.

To set effects, you should also pass wxTEXT_ATTR_EFFECTS to wxTextAttr::SetFlags, and call wxTextAttrEx::SetTextEffectFlags with the styles (taken from the above set) that you are interested in setting.


wxTextAttrEx

[proc]
set_textattrex_effect_flags
( atom attr, atom flags )

Category: wxTextAttrEx

Sets the text effect bits of interest. You should also pass wxTEXT_ATTR_EFFECTS to set_textattrex_flags.


wxTextAttrEx

[proc]
set_textattrex_line_spacing
( atom attr, atom spacing )

Category: wxTextAttrEx

Sets the line spacing. spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.

The following constants are defined for convenience:

#define wxTEXT_ATTR_LINE_SPACING_NORMAL       10
#define wxTEXT_ATTR_LINE_SPACING_HALF         15
#define wxTEXT_ATTR_LINE_SPACING_TWICE        20

wxTextAttrEx

[proc]
set_textattrex_list_style_name
( atom attr, object name )

Category: wxTextAttrEx

Sets the list style name.


wxTextAttrEx

[proc]
set_textattrex_outline_level
( atom attr, atom level )

Category: wxTextAttrEx

Specifies the outline level. Zero represents normal text. At present, the outline level is not used, but may be used in future for determining list levels and for applications that need to store document structure information.


wxTextAttrEx

[proc]
set_textattrex_page_break
( atom attr, atom page_break )

Category: wxTextAttrEx

Specifies a page break before this paragraph.


wxTextAttrEx

[proc]
set_textattrex_para_spacing_after
( atom attr, atom after )

Category: wxTextAttrEx

Sets the spacing after a paragraph, in tenths of a millimetre.


wxTextAttrEx

[proc]
set_textattrex_para_spacing_before
( atom attr, atom before )

Category: wxTextAttrEx

Sets the spacing before a paragraph, in tenths of a millimetre.


wxTextAttrEx

[proc]
set_textattrex_para_style_name
( atom attr, object name )

Category: wxTextAttrEx

Sets the name of the paragraph style.


wxTextAttrEx

[proc]
set_textattrex_url_name
( atom attr, object url )

Category: wxTextAttrEx

Sets the URL for the content. Sets the wxTEXT_ATTR_URL style; content with this style causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates a wxTextUrlEvent when the content is clicked.