.. wxPython Phoenix documentation

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

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

.. include:: headings.inc



.. _wx.propgrid.FileProperty:

==========================================================================================================================================
|phoenix_title|  **wx.propgrid.FileProperty**
==========================================================================================================================================

Like :ref:`wx.propgrid.LongStringProperty`, but the button triggers file selector instead.          

**Supported special attributes:**

- "Wildcard": Sets wildcard (see :ref:`wx.FileDialog`  for format details), "All
files..." is default. 
- "ShowFullPath": Default 1. When 0, only the file name is shown (i.e. drive and directory are hidden). 
- "ShowRelativePath": If set, then the filename is shown relative to the given path string. 
- "InitialPath": Sets the initial path of where to look for files. 
- "DialogTitle": Sets a specific title for the dir dialog.  


          




|

|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>FileProperty</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.propgrid.FileProperty_inheritance.png" alt="Inheritance diagram of FileProperty" 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.propgrid.FileProperty.html" title="wx.propgrid.FileProperty" alt="" coords="5,160,179,189"/> <area shape="rect" id="node2" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="7,83,177,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="51,5,132,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:ref:`wx.propgrid.ImageFileProperty`

|


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

================================================================================ ================================================================================
:meth:`~wx.propgrid.FileProperty.__init__`                                       
:meth:`~wx.propgrid.FileProperty.DoGetValidator`                                 Returns pointer to the :ref:`wx.Validator`  that should be used with the editor of this property (``None`` for no validator).
:meth:`~wx.propgrid.FileProperty.DoSetAttribute`                                 Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.FileProperty.GetClassValidator`                              
:meth:`~wx.propgrid.FileProperty.GetEditorDialog`                                Returns instance of a new :ref:`wx.propgrid.PGEditorDialogAdapter`  instance, which is used when user presses the (optional) button next to the editor control;.
:meth:`~wx.propgrid.FileProperty.GetFileName`                                    Returns filename to file represented by current value.
:meth:`~wx.propgrid.FileProperty.OnSetValue`                                     This virtual function is called after m_value has been set.
:meth:`~wx.propgrid.FileProperty.StringToValue`                                  Converts text into :ref:`Variant`  value appropriate for this property.
:meth:`~wx.propgrid.FileProperty.ValueToString`                                  Converts property value into a text representation.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.propgrid.FileProperty.EditorDialog`                                   See :meth:`~wx.propgrid.FileProperty.GetEditorDialog`
:attr:`~wx.propgrid.FileProperty.FileName`                                       See :meth:`~wx.propgrid.FileProperty.GetFileName`
================================================================================ ================================================================================


|


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


.. class:: wx.propgrid.FileProperty(PGProperty)

   **Possible constructors**::

       FileProperty(label=PG_LABEL, name=PG_LABEL, value="")
       
   
   Like LongStringProperty, but the button triggers file selector
   instead.



   .. method:: __init__(self, label=PG_LABEL, name=PG_LABEL, value=EmptyString)




      :param `label`: 
      :type `label`: string
      :param `name`: 
      :type `name`: string
      :param `value`: 
      :type `value`: string







   .. method:: DoGetValidator(self)

      Returns pointer to the :ref:`wx.Validator`  that should be used with the editor of this property (``None`` for no validator).                  

      Setting validator explicitly via SetPropertyValidator will override this. 

      In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro): 

      ::

          class MyPropertyClass(wx.propgrid.FileProperty):
              ...
              def DoGetValidator(self):
                  validator = MyValidator(...)

                  ... prepare validator...

                  return validator



                

      :rtype: :ref:`Validator`







      .. note:: 

         You can get common filename validator by returning :meth:`wx.propgrid.FileProperty.GetClassValidator` . :ref:`wx.propgrid.DirProperty`, for example, uses it.   








   .. method:: DoSetAttribute(self, name, value)

      Reimplement this member function to add special handling for attributes of this property.                  

                


      :param `name`: 
      :type `name`: string
      :param `value`: 
      :type `value`: PGVariant




      :rtype: `bool`







      :returns: 

         Return ``False`` to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.  







      .. note:: 

         To actually set property attribute values from the application, use :meth:`wx.propgrid.PGProperty.SetAttribute`   instead.   








   .. staticmethod:: GetClassValidator()



      :rtype: :ref:`Validator`








   .. method:: GetEditorDialog(self)

      Returns instance of a new :ref:`wx.propgrid.PGEditorDialogAdapter`  instance, which is used when user presses the (optional) button next to the editor control;.                  

      Default implementation returns ``None`` (ie. no action is generated when button is pressed).                  

      :rtype: :ref:`wx.propgrid.PGEditorDialogAdapter`








   .. method:: GetFileName(self)

      Returns filename to file represented by current value.                  

      :rtype: `string`








   .. method:: OnSetValue(self)

      This virtual function is called after m_value has been set.                  

                 



      .. note:: 

   

         - If m_value was set to Null variant (ie. unspecified value), :meth:`OnSetValue`   will not be called. 
         - m_value may be of any variant type. Typically properties internally support only one variant type, and as such :meth:`OnSetValue`   provides a good opportunity to convert supported values into internal type. 
         - Default implementation does nothing.  











   .. method:: StringToValue(self, variant, text, argFlags=0)

      Converts text into :ref:`Variant`  value appropriate for this property.                  




      :param `variant`: On function entry this is the old value (should not be NullVariant in normal cases). Translated value must be assigned back to it.  
      :type `variant`: PGVariant
      :param `text`: Text to be translated into variant.  
      :type `text`: string
      :param `argFlags`: If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable value instead of displayable one (they may be different). If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, text is interpreted as a part of composite property string value (as generated by :meth:`ValueToString`   called with this same flag).  
      :type `argFlags`: int










      :rtype: `bool`




      You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).                    



      :returns: 

         Returns ``True`` if resulting :ref:`Variant`  value was different.  







      .. note:: 

         Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.  








   .. method:: ValueToString(self, value, argFlags=0)

      Converts property value into a text representation.                  




      :param `value`: Value to be converted.   
      :type `value`: PGVariant
      :param `argFlags`: If 0 (default value), then displayed string is returned. If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable string value instead of displayable. If ``wx.propgrid.PG_EDITABLE_VALUE`` is set, returns string value that must be editable in textctrl. If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, returns text that is appropriate to display as a part of string property's composite text representation.  
      :type `argFlags`: int








      :rtype: `string`



                  



      .. note:: 

         Default implementation calls :meth:`GenerateComposedValue` .   








   .. attribute:: EditorDialog

      See :meth:`~wx.propgrid.FileProperty.GetEditorDialog`


   .. attribute:: FileName

      See :meth:`~wx.propgrid.FileProperty.GetFileName`

