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¶
Methods Summary¶
Constructor. |
|
Creates the main dialog buttons. |
|
Creates a page, given a page identifier. |
|
Creates all pages under the dialog’s book control, also calling AddPage(). |
|
Enumerate all available page identifiers. |
|
Gets the number of available page identifiers. |
|
Gets the image index for the given page identifier. |
|
Set the property sheet style, called at the start of |
|
Invokes help for the dialog. |
Properties Summary¶
See |
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)¶
Creates the main dialog buttons.
- Parameters:
dialog (wx.richtext.RichTextFormattingDialog)
- Return type:
bool
- CreatePage(self, page, title, dialog)¶
Creates a page, given a page identifier.
- Parameters:
page (int)
title (string)
dialog (wx.richtext.RichTextFormattingDialog)
- Return type:
Panel
- CreatePages(self, pages, dialog)¶
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)¶
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)¶
Gets the image index for the given page identifier.
- Parameters:
id (int)
- Return type:
int
- SetSheetStyle(self, dialog)¶
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, dialog)¶
Invokes help for the dialog.
- Parameters:
page (int)
dialog (wx.richtext.RichTextFormattingDialog)
- Return type:
bool
Properties¶
- PageIdCount¶
See
GetPageIdCount