wx.richtext.RichTextFormattingDialog¶

This dialog allows the user to edit a character and/or paragraph style.

In the constructor, specify the pages that will be created. Use wx.richtext.RichTextFormattingDialog.GetStyle to retrieve the common style for a given range, and then use wx.richtext.RichTextFormattingDialog.ApplyStyle to apply the user-selected formatting to a control.

For example:

if self.richTextCtrl.HasSelection():
    range = self.richTextCtrl.GetSelectionRange()
else:
    range = wx.RichTextRange(0, self.richTextCtrl.GetLastPosition()+1)

pages = wx.richtext.RICHTEXT_FORMAT_FONT \
        | wx.richtext.RICHTEXT_FORMAT_INDENTS_SPACING \
        | wx.richtext.RICHTEXT_FORMAT_TABS \
        | wx.richtext.RICHTEXT_FORMAT_BULLETS

with wx.richtext.RichTextFormattingDialog(pages, self) as dlg:
    dlg.GetStyle(self.richTextCtrl, range)
    if dlg.ShowModal() == wx.ID_OK:
        dlg.ApplyStyle(self.richTextCtrl, range)

Class Hierarchy¶

Inheritance diagram for class RichTextFormattingDialog:

Methods Summary¶

`__init__`	Default constructor.
`ApplyStyle`	Apply attributes to the given range, only changing attributes that need to be changed.
`Create`	Creation: see wx.richtext.RichTextFormattingDialog “the constructor” for details about the parameters.
`GetAttributes`
`GetClassDefaultAttributes`
`GetColourData`	Returns the custom colour data for use by the colour dialog.
`GetDialog`	Helper for pages to get the top-level dialog.
`GetDialogAttributes`	Helper for pages to get the attributes.
`GetDialogStyleDefinition`	Helper for pages to get the style.
`GetFormattingDialogFactory`	Returns the object to be used to customize the dialog and provide pages.
`GetImageList`	Returns the image list associated with the dialog, used for example if showing the dialog as a toolbook.
`GetLastPage`	Returns the page identifier of the last page selected (not the control id).
`GetOptions`	Gets the dialog options, determining what the interface presents to the user.
`GetRestoreLastPage`	Returns `True` if the dialog will restore the last-selected page.
`GetStyle`	Gets common attributes from the given range and calls `SetAttributes` .
`GetStyleDefinition`	Gets the associated style definition, if any.
`GetStyleSheet`	Gets the associated style sheet, if any.
`HasOption`	Returns `True` if the given option is present.
`SetAttributes`	Sets the attributes to be edited.
`SetColourData`	Sets the custom colour data for use by the colour dialog.
`SetFormattingDialogFactory`	Sets the formatting factory object to be used for customization and page creation.
`SetImageList`	Sets the image list associated with the dialog’s property sheet.
`SetLastPage`	Sets the page identifier of the last page selected (not the control id).
`SetOptions`	Sets the dialog options, determining what the interface presents to the user.
`SetRestoreLastPage`	Pass `True` if the dialog should restore the last-selected page.
`SetStyle`	Sets the attributes and optionally updates the display, if update is `True`.
`SetStyleDefinition`	Sets the style definition and optionally update the display, if update is `True`.
`UpdateDisplay`	Updates the display.

Properties Summary¶

`Attributes`	See `GetAttributes` and `SetAttributes`
`ImageList`	See `GetImageList` and `SetImageList`
`Options`	See `GetOptions` and `SetOptions`
`StyleDefinition`	See `GetStyleDefinition` and `SetStyleDefinition`
`StyleSheet`	See `GetStyleSheet`

Class API¶

class wx.richtext.RichTextFormattingDialog(PropertySheetDialog)¶

Possible constructors:

RichTextFormattingDialog() -> None

RichTextFormattingDialog(flags : int, parent : Window, title:
                         str="Formatting", id: int=ID_ANY, pos: Point=DefaultPosition, sz:
                         Size=DefaultSize, style: int=DEFAULT_DIALOG_STYLE) -> None

This dialog allows the user to edit a character and/or paragraph style.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Return type:: None

__init__ (self, flags : int, parent : Window, title: str=”Formatting”, id: int=ID_ANY, pos: Point=DefaultPosition, sz: Size=DefaultSize, style: int=DEFAULT_DIALOG_STYLE)

Constructors.

Parameters:

flags (long) – The pages to show.
parent (wx.Window) – The dialog’s parent.
title (string) – The dialog’s title.
id (wx.WindowID) – The dialog’s ID.
pos (wx.Point) – The dialog’s position.
sz (wx.Size) – The dialog’s size.
style (long) – The dialog’s window style.

Return type:

None

ApplyStyle(self, ctrl: RichTextCtrl, range: RichTextRange, flags: int = RICHTEXT_SETSTYLE_WITH_UNDO | RICHTEXT_SETSTYLE_OPTIMIZE)¶

Apply attributes to the given range, only changing attributes that need to be changed.

Parameters:

ctrl (wx.richtext.RichTextCtrl)
range (wx.richtext.RichTextRange)
flags (int)

Return type:

bool

Create(self, flags: int, parent: Window, title: str = GetTranslation('Formatting'), id: int = ID_ANY, pos: Point = DefaultPosition, sz: Size = DefaultSize, style: int = DEFAULT_DIALOG_STYLE)¶

Creation: see wx.richtext.RichTextFormattingDialog “the constructor” for details about the parameters.

Parameters:

flags (long)
parent (wx.Window)
title (string)
id (wx.WindowID)
pos (wx.Point)
sz (wx.Size)
style (long)

Return type:

bool

GetAttributes(self)¶

Return type:: TextAttr

static GetClassDefaultAttributes(variant: WindowVariant = WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant)
Return type:: VisualAttributes

static GetColourData()¶

Returns the custom colour data for use by the colour dialog.

Return type:: ColourData

static GetDialog(win: Window)¶

Helper for pages to get the top-level dialog.

Parameters:: win (wx.Window)
Return type:: wx.richtext.RichTextFormattingDialog

static GetDialogAttributes(win: Window)¶

Helper for pages to get the attributes.

Parameters:: win (wx.Window)
Return type:: TextAttr

static GetDialogStyleDefinition(win: Window)¶

Helper for pages to get the style.

Parameters:: win (wx.Window)
Return type:: wx.richtext.RichTextStyleDefinition

static GetFormattingDialogFactory()¶

Returns the object to be used to customize the dialog and provide pages.

Return type:: wx.richtext.RichTextFormattingDialogFactory

GetImageList(self)¶

Returns the image list associated with the dialog, used for example if showing the dialog as a toolbook.

Return type:: ImageList

static GetLastPage()¶

Returns the page identifier of the last page selected (not the control id).

Return type:: int

GetOptions(self)¶

Gets the dialog options, determining what the interface presents to the user.

Currently the only option is Option_AllowPixelFontSize.

Return type:: int

static GetRestoreLastPage()¶

Returns True if the dialog will restore the last-selected page.

Return type:: bool

GetStyle(self, ctrl: RichTextCtrl, range: RichTextRange)¶

Gets common attributes from the given range and calls SetAttributes .

Attributes that do not have common values in the given range will be omitted from the style’s flags.

Parameters:

ctrl (wx.richtext.RichTextCtrl)
range (wx.richtext.RichTextRange)

Return type:

bool

GetStyleDefinition(self)¶

Gets the associated style definition, if any.

Return type:: wx.richtext.RichTextStyleDefinition

GetStyleSheet(self)¶

Gets the associated style sheet, if any.

Return type:: wx.richtext.RichTextStyleSheet

HasOption(self, option: int)¶

Returns True if the given option is present.

Parameters:: option (int)
Return type:: bool

SetAttributes(self, attr: TextAttr)¶

Sets the attributes to be edited.

Parameters:: attr (wx.TextAttr)
Return type:: None

static SetColourData(colourData: ColourData)¶

Sets the custom colour data for use by the colour dialog.

Parameters:: colourData (wx.ColourData)
Return type:: None

static SetFormattingDialogFactory(factory: RichTextFormattingDialogFactory)¶

Sets the formatting factory object to be used for customization and page creation.

It deletes the existing factory object.

Parameters:: factory (wx.richtext.RichTextFormattingDialogFactory)
Return type:: None

SetImageList(self, imageList: ImageList)¶

Sets the image list associated with the dialog’s property sheet.

Parameters:: imageList (wx.ImageList)
Return type:: None

static SetLastPage(lastPage: int)¶

Sets the page identifier of the last page selected (not the control id).

Parameters:: lastPage (int)
Return type:: None

SetOptions(self, options: int)¶

Sets the dialog options, determining what the interface presents to the user.

Currently the only option is Option_AllowPixelFontSize.

Parameters:: options (int)
Return type:: None

static SetRestoreLastPage(b: bool)¶

Pass True if the dialog should restore the last-selected page.

Parameters:: b (bool)
Return type:: None

SetStyle(self, style: TextAttr, update: bool = True)¶

Sets the attributes and optionally updates the display, if update is True.

Parameters:

style (wx.TextAttr)
update (bool)

Return type:

bool

SetStyleDefinition(self, styleDef: RichTextStyleDefinition, sheet: RichTextStyleSheet, update: bool = True)¶

Sets the style definition and optionally update the display, if update is True.

Parameters:

styleDef (wx.richtext.RichTextStyleDefinition)
sheet (wx.richtext.RichTextStyleSheet)
update (bool)

Return type:

bool

UpdateDisplay(self)¶

Updates the display.

Return type:: bool

Properties¶

Attributes¶: See GetAttributes and SetAttributes

ImageList¶: See GetImageList and SetImageList

Options¶: See GetOptions and SetOptions

StyleDefinition¶: See GetStyleDefinition and SetStyleDefinition

StyleSheet¶: See GetStyleSheet

Navigation

wx.richtext.RichTextFormattingDialog¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶