wxRichTextAttr

Table of Contents
wxRichTextAttr
wxWidgets Documentation for wxRichTextAttr

Functions/Procedures
Supertopics

wxRichTextAttr

Table of Contents

[proc]
apply_rich_attr ( atom attr, atom compare_with )

Category: wxRichTextAttr

Applies the attributes in style to the original object, but not those attributes from style that are the same as those in compareWith (if passed).

See also combine_rich_attr for a function that does almost the same but returns a new object instead of modifying the original object.

wxRichTextAttr

Table of Contents

[func]
create_font_from_rich_attr ( atom attr )

Category: wxRichTextAttr

Creates a font from the font attributes.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_alignment ( atom attr )

Category: wxRichTextAttr

Returns the alignment flags. See set_rich_attr_alignment for a list of available styles.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_back_color ( atom attr )

Category: wxRichTextAttr

Returns the background colour.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_bullet_font ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_bullet_name ( atom attr )

Category: wxRichTextAttr

Returns the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD. Currently the following standard bullet names are supported:

If you wish your application to support further bullet graphics, you can derive a class from wxRichTextRenderer or wxRichTextStdRenderer, override DrawStandardBullet and EnumerateStandardBulletNames, and set an instance of the class using set_rich_text_renderer.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_bullet_number ( atom attr )

Category: wxRichTextAttr

Returns the bullet number.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_bullet_style ( atom attr )

Category: wxRichTextAttr

Returns the bullet style. See set_rich_attr_bullet_style for a list of available styles.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_bullet_text ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_char_style ( atom attr )

Category: wxRichTextAttr

Returns the name of the character style.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_color ( atom attr )

Category: wxRichTextAttr

Returns the text foreground colour.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_effects ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_effect_flags ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_flags ( atom attr )

Category: wxRichTextAttr

Returns flags indicating which attributes are applicable. See set_rich_attr_flags for a list of available flags.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_font_attributes ( atom attr, atom font )

Category: wxRichTextAttr

Sets the font attributes from the given font.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_font_name ( atom attr )

Category: wxRichTextAttr

Returns the font face name.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_font_size ( atom attr )

Category: wxRichTextAttr

Returns the font size in points.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_font_style ( atom attr )

Category: wxRichTextAttr

Returns the font style.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_font_weight ( atom attr )

Category: wxRichTextAttr

Returns the font weight

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_left_indent ( atom attr )

Category: wxRichTextAttr

Returns the left indent in tenths of a millimetre.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_left_sub_indent ( atom attr )

Category: wxRichTextAttr

Returns the left sub-indent in tenths of a millimetre.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_line_spacing ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_list_style ( atom attr )

Category: wxRichTextAttr

Returns the name of the list style.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_outline_level ( atom attr )

Category: wxRichTextAttr

Returns the outline level.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_para_spacing_after ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_para_spacing_before ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_para_style ( atom attr )

Category: wxRichTextAttr

Returns the name of the paragraph style.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_right_indent ( atom attr )

Category: wxRichTextAttr

Returns the right indent in tenths of a millimeter.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_tabs ( atom attr )

Category: wxRichTextAttr

Returns a sequence of tab stops, each expressed in tenths of a millimeter. Each stop is measured from the left margin and therefore each value must be larger than the last.

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_underlined ( atom attr )

Category: wxRichTextAttr

wxRichTextAttr

Table of Contents

[func]
get_rich_attr_url ( atom attr )

Category: wxRichTextAttr

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.

wxRichTextAttr

Table of Contents

[func]
has_alignment_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies alignment.

wxRichTextAttr

Table of Contents

[func]
has_back_color_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a background colour.

wxRichTextAttr

Table of Contents

[func]
has_bullet_name_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_bullet_number_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a bullet number.

wxRichTextAttr

Table of Contents

[func]
has_bullet_style_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a bullet style.

wxRichTextAttr

Table of Contents

[func]
has_bullet_text_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_char_style_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_effects_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies text effects.

wxRichTextAttr

Table of Contents

[func]
has_effect_rich_attr ( atom attr, atom effect )

Category: wxRichTextAttr

Returns true if the attribute object specifies a text effect.

wxRichTextAttr

Table of Contents

[func]
has_flag_rich_attr ( atom attr, atom flag )

Category: wxRichTextAttr

Returns true if the flag is present in the attribute object's flag bitlist.

wxRichTextAttr

Table of Contents

[func]
has_font_name_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a font face name.

wxRichTextAttr

Table of Contents

[func]
has_font_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies any font attributes.

wxRichTextAttr

Table of Contents

[func]
has_font_size_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a font point size.

wxRichTextAttr

Table of Contents

[func]
has_font_weight_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies font weight (bold, light or normal).

wxRichTextAttr

Table of Contents

[func]
has_italic_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies italic style.

wxRichTextAttr

Table of Contents

[func]
has_left_indent_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a left indent.

wxRichTextAttr

Table of Contents

[func]
has_line_spacing_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies line spacing.

wxRichTextAttr

Table of Contents

[func]
has_list_style_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_outline_level_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies an outline level.

wxRichTextAttr

Table of Contents

[func]
has_page_break_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_para_spacing_after_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_para_spacing_before_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_para_style_rich_attr ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
has_right_indent_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a right indent.

wxRichTextAttr

Table of Contents

[func]
has_tabs_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies tab stops.

wxRichTextAttr

Table of Contents

[func]
has_text_color_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a text foreground colour.

wxRichTextAttr

Table of Contents

[func]
has_underlined_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies either underlining or no underlining.

wxRichTextAttr

Table of Contents

[func]
has_url_rich_attr ( atom attr )

Category: wxRichTextAttr

Returns true if the attribute object specifies a URL.

wxRichTextAttr

Table of Contents

[func]
is_rich_attr_char_style ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
is_rich_attr_default ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
is_rich_attr_para_style ( atom attr )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[func]
rich_to_textex_attr ( atom attr )

Category: wxRichTextAttr

Makes a wxTextAttrEx object from attr.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_alignment ( atom attr, atom align )

Category: wxRichTextAttr

Sets the paragraph alignment.

These are the possible values for alignment:

Of these, wxTEXT_ALIGNMENT_JUSTIFIED is unimplemented. In future justification may be supported when printing or previewing, only.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_back_color ( atom attr, atom color )

Category: wxRichTextAttr

Sets the background colour.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_bullet_font ( atom attr, object font_name )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_bullet_name ( atom attr, object name )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_bullet_number ( atom attr, atom number )

Category: wxRichTextAttr

Sets the bullet number.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_bullet_style ( atom attr, atom style )

Category: wxRichTextAttr

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

Currently wxTEXT_ATTR_BULLET_STYLE_BITMAP is not supported.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_char_style ( atom attr, object style )

Category: wxRichTextAttr

Sets the character style name.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_effects ( atom attr, atom effects )

Category: wxRichTextAttr

Sets the text effects, a bit list of styles. The following styles can be passed:

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 set_rich_attr_flags, and call wxRichTextAttr::SetTextEffectFlags with the styles (taken from the above set) that you are interested in setting.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_effect_flags ( atom attr, atom flags )

Category: wxRichTextAttr

Sets the text effect bits of interest. You should also pass wxTEXT_ATTR_EFFECTS to set_rich_attr_flags. See set_rich_attr_flags for further information.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_flags ( atom attr, atom flags )

Category: wxRichTextAttr

Sets the flags determining which styles are being specified. The following flags can be passed in a bitlist:

Standard wxTextAttr constants:

Extra formatting flags not in wxTextAttr

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_font_name ( atom attr, object name )

Category: wxRichTextAttr

Sets the font face name.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_font_size ( atom attr, atom points )

Category: wxRichTextAttr

Sets the font size in points.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_font_style ( atom attr, atom style )

Category: wxRichTextAttr

Sets the font style (normal, italic or slanted).

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_left_indent ( atom attr, atom indent, atom sub_indent )

Category: wxRichTextAttr

Sets the left indent and left subindent in tenths of a millimetre.

The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph. A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.

wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_line_spacing ( atom attr, atom space )

Category: wxRichTextAttr

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:

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_list_style ( atom attr, object style )

Category: wxRichTextAttr

Sets the list style name.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_outline_level ( atom attr, atom level )

Category: wxRichTextAttr

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.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_page_break ( atom attr, atom page_break )

Category: wxRichTextAttr

Specifies a page break before this paragraph.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_para_spacing_after ( atom attr, atom space )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_para_spacing_before ( atom attr, atom space )

Category: wxRichTextAttr

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

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_para_style ( atom attr, object style )

Category: wxRichTextAttr

Sets the name of the paragraph style.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_right_indent ( atom attr, atom indent )

Category: wxRichTextAttr

Sets the right indent in tenths of a millimetre.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_tabs ( atom attr, object tabs )

Category: wxRichTextAttr

Sets the tab stops, expressed in tenths of a millimetre. Each stop is measured from the left margin and therefore each value must be larger than the last.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_text_color ( atom attr, atom color )

Category: wxRichTextAttr

Sets the text foreground colout.

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_underlined ( atom attr, atom underline )

Category: wxRichTextAttr

wxRichTextAttr

Table of Contents

[proc]
set_rich_attr_url ( atom attr, object url )

Category: wxRichTextAttr

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.