.. 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.PGValidationInfo:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PGValidationInfo**
==========================================================================================================================================
Used to convey validation information to and from functions that actually perform validation.
Mostly used in custom property classes.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
PGValidationInfo:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGValidationInfo.GetFailureBehavior`
:meth:`~wx.propgrid.PGValidationInfo.GetFailureMessage` Returns current failure message.
:meth:`~wx.propgrid.PGValidationInfo.GetValue` Returns reference to pending value.
:meth:`~wx.propgrid.PGValidationInfo.SetFailureBehavior` Set validation failure behaviour.
:meth:`~wx.propgrid.PGValidationInfo.SetFailureMessage` Set current failure message.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PGValidationInfo.FailureBehavior` See :meth:`~wx.propgrid.PGValidationInfo.GetFailureBehavior` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureBehavior`
:attr:`~wx.propgrid.PGValidationInfo.FailureMessage` See :meth:`~wx.propgrid.PGValidationInfo.GetFailureMessage` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureMessage`
:attr:`~wx.propgrid.PGValidationInfo.Value` See :meth:`~wx.propgrid.PGValidationInfo.GetValue`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGValidationInfo(object)
Used to convey validation information to and from functions that
actually perform validation.
.. method:: GetFailureBehavior(self)
:rtype: `int`
:returns:
Returns failure behaviour which is a combination of :ref:`PropertyGrid Validation Failure behaviour Flags `.
.. method:: GetFailureMessage(self)
Returns current failure message.
:rtype: `str`
.. method:: GetValue(self)
Returns reference to pending value.
:rtype: `PGVariant`
.. method:: SetFailureBehavior(self, failureBehavior : int)
Set validation failure behaviour.
:param `failureBehavior`: Mixture of :ref:`PropertyGrid Validation Failure behaviour Flags `.
:type `failureBehavior`: wx.byte
:rtype: `None`
.. method:: SetFailureMessage(self, message : str)
Set current failure message.
:param `message`:
:type `message`: string
:rtype: `None`
.. attribute:: FailureBehavior
See :meth:`~wx.propgrid.PGValidationInfo.GetFailureBehavior` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureBehavior`
.. attribute:: FailureMessage
See :meth:`~wx.propgrid.PGValidationInfo.GetFailureMessage` and :meth:`~wx.propgrid.PGValidationInfo.SetFailureMessage`
.. attribute:: Value
See :meth:`~wx.propgrid.PGValidationInfo.GetValue`