Package wx :: Package lib :: Module pydocview :: Class DocService

[frames | no frames]

## Type DocService

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                    DocService

Known Subclasses:
  `AboutService`, `DocOptionsService`, `FilePropertiesService`, `WindowMenuService`

An abstract class used to add reusable services to a docview application.

Method Summary
| ``__init__`(self)` Initializes the DocService.
| ``GetDocumentManager`(self)` Returns the DocManager for the docview application.
| ``GetMenuItemPos`(self, menu, id)` Utility method used to find the position of a menu item so that services can easily find where to insert a menu item in InstallControls.
| ``GetView`(self)` Called by WindowMenuService to get views for services that don't have dedicated documents such as the Outline Service.
| ``InstallControls`(self, frame, menuBar, toolBar, statusBar, document)` Called to install controls into the menubar and toolbar of a SDI or MDI window.
| ``OnCloseFrame`(self, event)` Called when the a docview frame is being closed.
| ``OnExit`(self)` Called when the the docview application is being closed.
| ``ProcessEvent`(self, event)` Processes an event, searching event tables and calling zero or more suitable event handler function(s).
| ``ProcessEventBeforeWindows`(self, event)` Processes an event before the main window has a chance to process the window.
| ``ProcessUpdateUIEvent`(self, event)` Processes a UI event, searching event tables and calling zero or more suitable event handler function(s).
| ``ProcessUpdateUIEventBeforeWindows`(self, event)` Processes a UI event before the main window has a chance to process the window.
| ``SetDocumentManager`(self, docManager)` Sets the DocManager for the docview application.

Property Summary

Method Details

### __init__(self)
(Constructor)

Initializes the DocService.

  Overrides:
    `wx.EvtHandler.__init__`

### GetDocumentManager(self)

Returns the DocManager for the docview application.

### GetMenuItemPos(self, menu, id)

Utility method used to find the position of a menu item so that services can easily find where to insert a menu item in InstallControls.

### GetView(self)

Called by WindowMenuService to get views for services that don't have dedicated documents such as the Outline Service.

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

Called to install controls into the menubar and toolbar of a SDI or MDI window. Override this method for a particular service.

### OnCloseFrame(self, event)

Called when the a docview frame is being closed. Override this method so a service can either do cleanup or veto the frame being closed by returning false.

### OnExit(self)

Called when the the docview application is being closed. Override this method so a service can either do cleanup or veto the frame being closed by returning false.

### ProcessEvent(self, event)

Processes an event, searching event tables and calling zero or more suitable event handler function(s). Note that the ProcessEvent method is called from the wxPython docview framework directly since wxPython does not have a virtual ProcessEvent function.

  Overrides:
    `wx.EvtHandler.ProcessEvent`

### ProcessEventBeforeWindows(self, event)

Processes an event before the main window has a chance to process the window. Override this method for a particular service.

### ProcessUpdateUIEvent(self, event)

Processes a UI event, searching event tables and calling zero or more suitable event handler function(s). Note that the ProcessEvent method is called from the wxPython docview framework directly since wxPython does not have a virtual ProcessEvent function.

### ProcessUpdateUIEventBeforeWindows(self, event)

Processes a UI event before the main window has a chance to process the window. Override this method for a particular service.

### SetDocumentManager(self, docManager)

Sets the DocManager for the docview application.

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