Phoenix Logo

phoenix_title 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 Class Hierarchy

Inheritance diagram for class RichTextFormattingDialogFactory:


method_summary 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.

property_summary Properties Summary

PageIdCount See GetPageIdCount

api Class API



class wx.richtext.RichTextFormattingDialogFactory(Object)

Possible constructors:

RichTextFormattingDialogFactory()

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


Methods



__init__(self)

Constructor.



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:
Return type:

Panel



CreatePages(self, pages, dialog)

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

Parameters:
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:
Return type:

bool


Properties



PageIdCount

See GetPageIdCount