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

==========================================================================================================================================
|phoenix_title|  **wx.propgrid.MultiChoiceProperty**
==========================================================================================================================================

Property that manages a value resulting from :ref:`wx.MultiChoiceDialog`.          

Value is array of strings. You can get value as array of choice values/indices by calling :meth:`wx.propgrid.MultiChoiceProperty.GetValueAsArrayInt` . 

**Supported special attributes:**

- "UserStringMode": If > 0, allow user to manually enter strings that are not in the list of choices. If this value is 1, user strings are preferably placed in front of valid choices. If value is 2, then those strings will placed behind valid choices.  


          




|

|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>MultiChoiceProperty</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.MultiChoiceProperty_inheritance.png" alt="Inheritance diagram of MultiChoiceProperty" 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.MultiChoiceProperty.html" title="wx.propgrid.MultiChoiceProperty" alt="" coords="5,160,232,189"/> <area shape="rect" id="node2" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="33,83,204,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="77,5,159,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.propgrid.MultiChoiceProperty.__init__`                                
:meth:`~wx.propgrid.MultiChoiceProperty.GetValueAsArrayInt`                      
:meth:`~wx.propgrid.MultiChoiceProperty.OnEvent`                                 Events received by editor widgets are processed here.
:meth:`~wx.propgrid.MultiChoiceProperty.OnSetValue`                              This virtual function is called after m_value has been set.
:meth:`~wx.propgrid.MultiChoiceProperty.StringToValue`                           Converts text into :ref:`Variant`  value appropriate for this property.
:meth:`~wx.propgrid.MultiChoiceProperty.ValueToString`                           Converts property value into a text representation.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.propgrid.MultiChoiceProperty.ValueAsArrayInt`                         See :meth:`~wx.propgrid.MultiChoiceProperty.GetValueAsArrayInt`
================================================================================ ================================================================================


|


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


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

   **Possible constructors**::

       MultiChoiceProperty(label, name=PG_LABEL, choices=[], value=[])
       
       MultiChoiceProperty(label, name, choices, value=[])
       
       MultiChoiceProperty(label=PG_LABEL, name=PG_LABEL, value=[])
       
   
   Property that manages a value resulting from MultiChoiceDialog.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self, label, name=PG_LABEL, choices=[], value=[])`
      
      
      
      
      :param `label`: 
      :type `label`: string
      :param `name`: 
      :type `name`: string
      :param `choices`: 
      :type `choices`: list of strings
      :param `value`: 
      :type `value`: list of strings
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, label, name, choices, value=[])`
      
      
      
      
      :param `label`: 
      :type `label`: string
      :param `name`: 
      :type `name`: string
      :param `choices`: 
      :type `choices`: wx.propgrid.PGChoices
      :param `value`: 
      :type `value`: list of strings
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, label=PG_LABEL, name=PG_LABEL, value=[])`
      
      
      
      
      :param `label`: 
      :type `label`: string
      :param `name`: 
      :type `name`: string
      :param `value`: 
      :type `value`: list of strings
      
      
      
      
      
      
      **~~~**






   .. method:: GetValueAsArrayInt(self)



      :rtype: `list of integers`








   .. method:: OnEvent(self, propgrid, wnd_primary, event)

      Events received by editor widgets are processed here.                  

      Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, can be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, :ref:`wx.propgrid.SystemColourProperty`  custom handles  ``wxEVT_CHOICE``   to display colour picker dialog when 'custom' selection is made). 

      If the event causes value to be changed, :meth:`SetValueInEvent`   should be called to set the new value. 

      The parameter `event`  is the associated :ref:`wx.Event`. 




      :param `propgrid`: 
      :type `propgrid`: wx.propgrid.PropertyGrid
      :param `wnd_primary`: 
      :type `wnd_primary`: wx.Window
      :param `event`: 
      :type `event`: wx.Event




      return ``True`` if any changes in value should be reported. 



      :rtype: `bool`



                  



      .. note:: 

   

         - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.  











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

      See :meth:`~wx.propgrid.MultiChoiceProperty.GetValueAsArrayInt`

