wx.richtext Functions

The functions and macros defined in the wx.richtext module are described here: you can look up a function using the alphabetical listing of them.

Function Summary

R | T

R

• wx.richtext.RichTextApplyStyle

• wx.richtext.RichTextBitlistsEqPartial

• wx.richtext.RichTextCombineBitlists

• wx.richtext.RichTextDecimalToRoman

• wx.richtext.RichTextHasStyle

• wx.richtext.RichTextModuleInit

• wx.richtext.RichTextRemoveStyle

• wx.richtext.RichTextSplitParaCharStyles

• wx.richtext.RichTextTabsEq

T

• wx.richtext.TextAttrCollectCommonAttributes

• wx.richtext.TextAttrEq

Functions

---

wx.richtext.RichTextApplyStyle(destStyle : RichTextAttr, style : RichTextAttr, compareWith: Optional[RichTextAttr]=None)

Apply one style to another.

Parameters:

• destStyle (wx.richtext.RichTextAttr) –

• style (wx.richtext.RichTextAttr) –

• compareWith (wx.richtext.RichTextAttr) –

Return type:

bool

---

wx.richtext.RichTextBitlistsEqPartial(valueA : int, valueB : int, flags : int)

Compare two bitlists.

Parameters:

• valueA (int) –

• valueB (int) –

• flags (int) –

Return type:

bool

---

wx.richtext.RichTextCombineBitlists(valueA : int, valueB : int, flagsA : int, flagsB : int)

Combine two bitlists.

Parameters:

• valueA (int) –

• valueB (int) –

• flagsA (int) –

• flagsB (int) –

Return type:

bool

---

wx.richtext.RichTextDecimalToRoman(n : int)

Convert a decimal to Roman numerals.

Parameters:

n (long) –

Return type:

str

---

wx.richtext.RichTextHasStyle(flags : int, style : int)

Utilities

Parameters:

• flags (int) –

• style (int) –

Return type:

bool

---

wx.richtext.RichTextModuleInit()

Return type:

None

---

wx.richtext.RichTextRemoveStyle(destStyle : RichTextAttr, style : RichTextAttr)

Parameters:

• destStyle (wx.richtext.RichTextAttr) –

• style (wx.richtext.RichTextAttr) –

Return type:

bool

---

wx.richtext.RichTextSplitParaCharStyles(style : RichTextAttr, parStyle : RichTextAttr, charStyle : RichTextAttr)

Split into paragraph and character styles.

Parameters:

• style (wx.richtext.RichTextAttr) –

• parStyle (wx.richtext.RichTextAttr) –

• charStyle (wx.richtext.RichTextAttr) –

Return type:

bool

---

wx.richtext.RichTextTabsEq(tabs1 : List[int], tabs2 : List[int])

Compare tabs.

Parameters:

• tabs1 (list of integers) –

• tabs2 (list of integers) –

Return type:

bool

---

wx.richtext.TextAttrCollectCommonAttributes(currentStyle : TextAttr, attr : TextAttr, clashingAttr : TextAttr, absentAttr : TextAttr)

Parameters:

• currentStyle (wx.TextAttr) –

• attr (wx.TextAttr) –

• clashingAttr (wx.TextAttr) –

• absentAttr (wx.TextAttr) –

Return type:

None

---

wx.richtext.TextAttrEq(attr1 : RichTextAttr, attr2 : RichTextAttr)

Compare two attribute objects.

Parameters:

• attr1 (wx.richtext.RichTextAttr) –

• attr2 (wx.richtext.RichTextAttr) –

Return type:

bool