Package wx :: Package lib :: Module pydocview :: Class DocOptionsService

[frames | no frames]

## Type DocOptionsService

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
            DocService --+
                         |
                        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.

Method Summary
| ``__init__`(self, showGeneralOptions, supportedModes)` 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.
| ``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.
| ``InstallControls`(self, frame, menuBar, toolBar, statusBar, document)` 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.

Property Summary

Method Details

### __init__(self, showGeneralOptions=True, supportedModes=0)
(Constructor)

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.

  Overrides:
    `wx.lib.pydocview.DocService.__init__`

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

  Overrides:
    `wx.lib.pydocview.DocService.InstallControls`

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

  Overrides:
    `wx.lib.pydocview.DocService.ProcessEvent`

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

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:13:30 2007 | http://epydoc.sf.net