.. include:: headings.inc

.. currentmodule:: lib.pydocview

.. highlight:: python



.. _lib.pydocview.WindowMenuService:

==========================================================================================================================================
|phoenix_title|  **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.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **WindowMenuService**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.pydocview.WindowMenuService_inheritance.png" alt="Inheritance diagram of WindowMenuService" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.pydocview.DocService.html" title="An abstract class used to add reusable services to a docview application." alt="" coords="396,5,583,35"/> <area shape="rect" id="node5" href="lib.pydocview.WindowMenuService.html" title="The WindowMenuService is a service that implements a standard Window menu that is used" alt="" coords="633,5,889,35"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node7" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`lib.pydocview.DocService`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.pydocview.WindowMenuService.__init__`                                Initializes the WindowMenu and its globals.
:meth:`~lib.pydocview.WindowMenuService.BuildWindowMenu`                         Builds the Window menu and adds menu items for all of the open documents in the DocManager.
:meth:`~lib.pydocview.WindowMenuService.InstallControls`                         Installs the Window menu.
:meth:`~lib.pydocview.WindowMenuService.OnArrangeWindows`                        Called by Window/Arrange and tiles the frames on the desktop.
:meth:`~lib.pydocview.WindowMenuService.OnCtrlKeySelect`                         
:meth:`~lib.pydocview.WindowMenuService.OnSelectMoreWindows`                     Called when the "Window/Select More Windows..." menu item is selected and enables user to
:meth:`~lib.pydocview.WindowMenuService.OnSelectWindowMenu`                      Called when the Window menu item representing a Frame is selected and brings the selected
:meth:`~lib.pydocview.WindowMenuService.ProcessEvent`                            Processes a Window menu event.
:meth:`~lib.pydocview.WindowMenuService.ProcessUpdateUIEvent`                    Updates the Window menu items.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: WindowMenuService(DocService)

   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:: __init__(self)

      Initializes the WindowMenu and its globals.


   .. method:: BuildWindowMenu(self, currentFrame)

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


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

      Installs the Window menu.


   .. method:: OnArrangeWindows(self, event)

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


   .. method:: OnCtrlKeySelect(self, event)


   .. method:: 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.


   .. method:: 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.


   .. method:: ProcessEvent(self, event)

      Processes a Window menu event.


   .. method:: ProcessUpdateUIEvent(self, event)

      Updates the Window menu items.