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



.. _wx.propgrid.DirProperty:

==========================================================================================================================================
|phoenix_title|  **wx.propgrid.DirProperty**
==========================================================================================================================================

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

**Supported special attributes:**

- ``PG_DIALOG_TITLE``: Sets a specific title for the file dialog (since 3.1.3).  



          




|

|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>DirProperty</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.DirProperty_inheritance.svg" alt="Inheritance diagram of DirProperty" 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.propgrid.DirProperty.html" title="Like wx.propgrid.LongStringProperty, but the button triggers directory selector instead." alt="" coords="39,236,236,265"/> <area shape="rect" id="node2" href="wx.propgrid.EditorDialogProperty.html" title="This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g." alt="" coords="5,159,270,188"/> <area shape="rect" id="node3" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty  is base class for all wx.propgrid.PropertyGrid  properties and as such it is not intended to be instantiated directly." alt="" coords="38,82,237,111"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="88,5,187,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.propgrid.DirProperty.__init__`                                        
:meth:`~wx.propgrid.DirProperty.DisplayEditorDialog`                             Shows editor dialog.
:meth:`~wx.propgrid.DirProperty.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.DirProperty.StringToValue`                                   Converts text into `Variant`       value appropriate for this property.
:meth:`~wx.propgrid.DirProperty.ValueToString`                                   Converts property value into a text representation.
================================================================================ ================================================================================


|


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


.. class:: wx.propgrid.DirProperty(EditorDialogProperty)

   **Possible constructors**::

       DirProperty(label=PG_LABEL, name=PG_LABEL, value='') -> None
       
   
   Like LongStringProperty, but the button triggers directory selector
   instead.



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




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




      :rtype: `None`     








   .. method:: DisplayEditorDialog(self, pg, value)

      Shows editor dialog. 
                 

      Value to be edited should be read from `value`, and if dialog is not cancelled, it should be stored back and ``True`` should be returned. 




      :param `pg`: Property grid in which property is displayed.  
      :type `pg`: wx.propgrid.PropertyGrid
      :param `value`: Value to be edited.  
      :type `value`: PGVariant








      :rtype: :ref:`Tuple[bool, PGVariant]`




                  



      :returns: 

         Returns ``True`` if editor dialog was not cancelled and `value`  was updated.   








   .. 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.DirProperty):
              ...
              def DoGetValidator(self):
                  validator = MyValidator(...)

                  ... prepare validator...

                  return validator




                

      :rtype: `Validator`     







      .. note:: 

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








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

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




      :param `text`: Text to be translated into variant.  
      :type `text`: string
      :param `argFlags`: If ``PG_FULL_VALUE``  is set, returns complete, storable value instead of displayable one (they may be different). If ``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: :ref:`Tuple[bool, PGVariant]`




      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 `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 ``PG_FULL_VALUE``  is set, returns complete, storable string value instead of displayable. If ``PG_EDITABLE_VALUE``  is set, returns string value that must be editable in textctrl. If ``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: `str`




                  



      .. note:: 

         Default implementation calls :meth:`GenerateComposedValue` .   







