.. 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.FileDialogTextCtrl:
==========================================================================================================================================
|phoenix_title| **wx.FileDialogTextCtrl**
==========================================================================================================================================
Represents a custom text control inside :ref:`wx.FileDialog`.
Objects of this class can only be created by :meth:`wx.FileDialogCustomize.AddTextCtrl` .
Objects of this class don't generate any events currently.
See :ref:`wx.FileDialogCustomControl` for more information.
.. versionadded:: 4.1/wxWidgets-3.1.7
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
FileDialogTextCtrl:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileDialogTextCtrl.GetValue` Get the current value entered into the control.
:meth:`~wx.FileDialogTextCtrl.SetValue` Set the current control value.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileDialogTextCtrl.Value` See :meth:`~wx.FileDialogTextCtrl.GetValue` and :meth:`~wx.FileDialogTextCtrl.SetValue`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileDialogTextCtrl(FileDialogCustomControl)
Represents a custom text control inside FileDialog.
.. method:: GetValue(self)
Get the current value entered into the control.
:rtype: `str`
.. method:: SetValue(self, text : str)
Set the current control value.
:param `text`:
:type `text`: string
:rtype: `None`
.. attribute:: Value
See :meth:`~wx.FileDialogTextCtrl.GetValue` and :meth:`~wx.FileDialogTextCtrl.SetValue`