Navigation

phoenix_title wx.lib.pydocview.DocOptionsService

A service that implements an options menu item and an options dialog with notebook tabs. New tabs can be added by other services by calling the “AddOptionsPanel” method.


class_hierarchy Class Hierarchy

Inheritance diagram for class DocOptionsService:

super_classes Known Superclasses

wx.lib.pydocview.DocService


method_summary Methods Summary

__init__

Initializes the options service with the option of suppressing the default

AddOptionsPanel

Adds an options panel to the options dialog.

ClearOptionsPanels

Clears all of the options panels that have been added into the

GetSupportedModes

Return the modes supported by the application. Use docview.DOC_SDI and

InstallControls

Installs a “Tools” menu with an “Options” menu item.

OnOptions

Shows the options dialog, called when the “Options” menu item is selected.

ProcessEvent

Checks to see if the “Options” menu item has been selected.

SetSupportedModes

Sets the modes supported by the application. Use docview.DOC_SDI and

api Class API

class DocOptionsService(DocService)

A service that implements an options menu item and an options dialog with notebook tabs. New tabs can be added by other services by calling the “AddOptionsPanel” method.


Methods

__init__(self, showGeneralOptions=True, supportedModes=wx.lib.docview.DOC_SDI & wx.lib.docview.DOC_MDI)

Initializes the options service with the option of suppressing the default general options pane that is included with the options service by setting showGeneralOptions to False. It allowModeChanges is set to False, the default general options pane will allow users to change the document interface mode between SDI and MDI modes.


AddOptionsPanel(self, optionsPanel)

Adds an options panel to the options dialog.


ClearOptionsPanels(self)

Clears all of the options panels that have been added into the options dialog.


GetSupportedModes(self)

Return the modes supported by the application. Use docview.DOC_SDI and docview.DOC_MDI flags to check if SDI and/or MDI modes are supported.


InstallControls(self, frame, menuBar=None, toolBar=None, statusBar=None, document=None)

Installs a “Tools” menu with an “Options” menu item.


OnOptions(self, event)

Shows the options dialog, called when the “Options” menu item is selected.


ProcessEvent(self, event)

Checks to see if the “Options” menu item has been selected.


SetSupportedModes(self, _supportedModessupportedModes)

Sets the modes supported by the application. Use docview.DOC_SDI and docview.DOC_MDI flags to set if SDI and/or MDI modes are supported.