Package wx :: Package lib :: Module pydocview :: Class WindowMenuService
[frames | no frames]

Type WindowMenuService

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


The WindowMenuService is a service that implements a standard Window menu that is used by the DocSDIFrame. The MDIFrame automatically includes a Window menu and does not use the WindowMenuService.


Method Summary
  __init__(self)
Initializes the WindowMenu and its globals.
  BuildWindowMenu(self, currentFrame)
Builds the Window menu and adds menu items for all of the open documents in the DocManager.
  InstallControls(self, frame, menuBar, toolBar, statusBar, document)
Installs the Window menu.
  OnArrangeWindows(self, event)
Called by Window/Arrange and tiles the frames on the desktop.
  OnCtrlKeySelect(self, event)
  OnSelectMoreWindows(self, event)
Called when the "Window/Select More Windows..." menu item is selected and enables user to select from the Frames that do not in the Window list.
  OnSelectWindowMenu(self, event)
Called when the Window menu item representing a Frame is selected and brings the selected Frame to the front of the desktop.
  ProcessEvent(self, event)
Processes a Window menu event.
  ProcessUpdateUIEvent(self, event)
Updates the Window menu items.
    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.
  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)...

Class Variable Summary
int ARRANGE_WINDOWS_ID = 147                                                                   
int CLOSE_CURRENT_WINDOW_ID = 151                                                                   
int SELECT_MORE_WINDOWS_ID = 148                                                                   
int SELECT_NEXT_WINDOW_ID = 149                                                                   
int SELECT_PREV_WINDOW_ID = 150                                                                   

Method Details

__init__(self)
(Constructor)

Initializes the WindowMenu and its globals.

Overrides:
wx.lib.pydocview.DocService.__init__

BuildWindowMenu(self, currentFrame)

Builds the Window menu and adds menu items for all of the open documents in the DocManager.

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

Installs the Window menu.

Overrides:
wx.lib.pydocview.DocService.InstallControls

OnArrangeWindows(self, event)

Called by Window/Arrange and tiles the frames on the desktop.

OnSelectMoreWindows(self, event)

Called when the "Window/Select More Windows..." menu item is selected and enables user to select from the Frames that do not in the Window list. Useful when there are more than 10 open frames in the application.

OnSelectWindowMenu(self, event)

Called when the Window menu item representing a Frame is selected and brings the selected Frame to the front of the desktop.

ProcessEvent(self, event)

Processes a Window menu event.

Overrides:
wx.lib.pydocview.DocService.ProcessEvent

ProcessUpdateUIEvent(self, event)

Updates the Window menu items.

Overrides:
wx.lib.pydocview.DocService.ProcessUpdateUIEvent

Class Variable Details

ARRANGE_WINDOWS_ID

Type:
int
Value:
147                                                                   

CLOSE_CURRENT_WINDOW_ID

Type:
int
Value:
151                                                                   

SELECT_MORE_WINDOWS_ID

Type:
int
Value:
148                                                                   

SELECT_NEXT_WINDOW_ID

Type:
int
Value:
149                                                                   

SELECT_PREV_WINDOW_ID

Type:
int
Value:
150                                                                   

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:57:08 2007 http://epydoc.sf.net