wx.richtext.RichTextFormattingDialogFactory

This class provides pages for wx.richtext.RichTextFormattingDialog, and allows other customization of the dialog.

A default instance of this class is provided automatically. If you wish to change the behaviour of the formatting dialog (for example add or replace a page), you may derive from this class, override one or more functions, and call the static function wx.richtext.RichTextFormattingDialog.SetFormattingDialogFactory .

Class Hierarchy

Inheritance diagram for class RichTextFormattingDialogFactory:

Methods Summary

__init__	Constructor.
CreateButtons	Creates the main dialog buttons.
CreatePage	Creates a page, given a page identifier.
CreatePages	Creates all pages under the dialog’s book control, also calling AddPage().
GetPageId	Enumerate all available page identifiers.
GetPageIdCount	Gets the number of available page identifiers.
GetPageImage	Gets the image index for the given page identifier.
SetSheetStyle	Set the property sheet style, called at the start of wx.richtext.RichTextFormattingDialog.Create .
ShowHelp	Invokes help for the dialog.

Properties Summary

PageIdCount

See GetPageIdCount

Class API

class wx.richtext.RichTextFormattingDialogFactory(Object)

Possible constructors:

RichTextFormattingDialogFactory() -> None

This class provides pages for RichTextFormattingDialog, and allows other customization of the dialog.

Methods

__init__(self)

Constructor.

Return type:

None

---

CreateButtons(self, dialog: RichTextFormattingDialog)

Creates the main dialog buttons.

Parameters:

dialog (wx.richtext.RichTextFormattingDialog)

Return type:

bool

---

CreatePage(self, page: int, title: str, dialog: RichTextFormattingDialog)

Creates a page, given a page identifier.

Parameters:

• page (int)

• title (string)

• dialog (wx.richtext.RichTextFormattingDialog)

Return type:

Panel

---

CreatePages(self, pages: int, dialog: RichTextFormattingDialog)

Creates all pages under the dialog’s book control, also calling AddPage().

Parameters:

• pages (long)

• dialog (wx.richtext.RichTextFormattingDialog)

Return type:

bool

---

GetPageId(self, i: int)

Enumerate all available page identifiers.

Parameters:

i (int)

Return type:

int

---

GetPageIdCount(self)

Gets the number of available page identifiers.

Return type:

int

---

GetPageImage(self, id: int)

Gets the image index for the given page identifier.

Parameters:

id (int)

Return type:

int

---

SetSheetStyle(self, dialog: RichTextFormattingDialog)

Set the property sheet style, called at the start of wx.richtext.RichTextFormattingDialog.Create .

Parameters:

dialog (wx.richtext.RichTextFormattingDialog)

Return type:

bool

---

ShowHelp(self, page: int, dialog: RichTextFormattingDialog)

Invokes help for the dialog.

Parameters:

• page (int)

• dialog (wx.richtext.RichTextFormattingDialog)

Return type:

bool

Properties

PageIdCount

See GetPageIdCount