.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.pydocview

.. highlight:: python



.. _wx.lib.pydocview.FilePropertiesService:

==========================================================================================================================================
|phoenix_title|  **wx.lib.pydocview.FilePropertiesService**
==========================================================================================================================================

Service that installs under the File menu to show the properties of the file associated
with the current document.



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>FilePropertiesService</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.pydocview.FilePropertiesService_inheritance.png" alt="Inheritance diagram of FilePropertiesService" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="27,5,128,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="79,83,189,112"/> <area shape="rect" id="node2" href="wx.lib.pydocview.DocService.html" title="wx.lib.pydocview.DocService" alt="" coords="35,160,233,189"/> <area shape="rect" id="node5" href="wx.lib.pydocview.FilePropertiesService.html" title="wx.lib.pydocview.FilePropertiesService" alt="" coords="5,237,264,267"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="152,5,233,35"/> </map> 
   </p>

|


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

:class:`wx.lib.pydocview.DocService`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.pydocview.FilePropertiesService.__init__`                         Initializes the PropertyService.
:meth:`~wx.lib.pydocview.FilePropertiesService.AddCustomEventHandler`            Adds a custom event handlers for the PropertyService.  A custom event handler enables
:meth:`~wx.lib.pydocview.FilePropertiesService.chopPath`                         Simple version of textwrap.  textwrap.fill() unfortunately chops lines at spaces
:meth:`~wx.lib.pydocview.FilePropertiesService.GetCustomEventHandlers`           Returns the custom event handlers for the PropertyService.
:meth:`~wx.lib.pydocview.FilePropertiesService.InstallControls`                  Installs a File/Properties menu item.
:meth:`~wx.lib.pydocview.FilePropertiesService.ProcessEvent`                     Detects when the File/Properties menu item is selected.
:meth:`~wx.lib.pydocview.FilePropertiesService.ProcessUpdateUIEvent`             Updates the File/Properties menu item.
:meth:`~wx.lib.pydocview.FilePropertiesService.RemoveCustomEventHandler`         Removes a custom event handler from the PropertyService.
:meth:`~wx.lib.pydocview.FilePropertiesService.ShowPropertiesDialog`             Shows the PropertiesDialog for the specified file.
================================================================================ ================================================================================


|


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


.. class:: FilePropertiesService(DocService)

   Service that installs under the File menu to show the properties of the file associated
   with the current document.

   .. method:: __init__(self)

      Initializes the PropertyService.


   .. method:: AddCustomEventHandler(self, handler)

      Adds a custom event handlers for the PropertyService.  A custom event handler enables
      a different dialog to be provided for a particular file.


   .. method:: chopPath(self, text, length=36)

      Simple version of textwrap.  textwrap.fill() unfortunately chops lines at spaces
      and creates odd word boundaries.  Instead, we will chop the path without regard to
      spaces, but pay attention to path delimiters.


   .. method:: GetCustomEventHandlers(self)

      Returns the custom event handlers for the PropertyService.


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

      Installs a File/Properties menu item.


   .. method:: ProcessEvent(self, event)

      Detects when the File/Properties menu item is selected.


   .. method:: ProcessUpdateUIEvent(self, event)

      Updates the File/Properties menu item.


   .. method:: RemoveCustomEventHandler(self, handler)

      Removes a custom event handler from the PropertyService.


   .. method:: ShowPropertiesDialog(self, filename=None)

      Shows the PropertiesDialog for the specified file.


