1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 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>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.pydocview.FilePropertiesService.html" title="wx.lib.pydocview.FilePropertiesService" alt="" coords="5,237,280,267"/> <area shape="rect" id="node2" href="wx.lib.pydocview.DocService.html" title="wx.lib.pydocview.DocService" alt="" coords="37,160,248,189"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="84,83,201,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="39,5,126,35"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="151,5,257,35"/> </map>
</p>
</div>
|
|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.
|