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.
    Inherited from 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.
  OnCloseFrame(self, event)
Called when the a docview frame is being closed.
  OnExit(self)
Called when the the docview application is being closed.
  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.
    Inherited from EvtHandler
  __repr__(self)
  AddPendingEvent(self, event)
  Bind(self, event, handler, source, id, id2)
Bind an event to an event handler.
  Connect(self, id, lastId, eventType, func)
bool Disconnect(self, id, lastId, eventType)
bool GetEvtHandlerEnabled(self)
EvtHandler GetNextHandler(self)
EvtHandler GetPreviousHandler(self)
  ProcessPendingEvents(self)
  SetEvtHandlerEnabled(self, enabled)
  SetNextHandler(self, handler)
  SetPreviousHandler(self, handler)
  Unbind(self, event, source, id, id2)
Disconencts the event handler binding for event from self.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

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 Sat Jun 16 16:44:08 2007 http://epydoc.sf.net