.. 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.FileDialogChoice:
==========================================================================================================================================
|phoenix_title| **wx.FileDialogChoice**
==========================================================================================================================================
Represents a custom read-only combobox inside :ref:`wx.FileDialog`.
Objects of this class can only be created by :meth:`wx.FileDialogCustomize.AddChoice` .
It is possible to bind to wxEVT_CHOICE events on this object, which will be generated when the selection in the combobox changes.
See :ref:`wx.FileDialogCustomControl` for more information.
.. versionadded:: 4.1/wxWidgets-3.1.7
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
FileDialogChoice:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileDialogChoice.GetSelection` Return the index of the selected item, possibly ``wx.NOT_FOUND``.
:meth:`~wx.FileDialogChoice.SetSelection` Set the selection to the item with the given index.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileDialogChoice.Selection` See :meth:`~wx.FileDialogChoice.GetSelection` and :meth:`~wx.FileDialogChoice.SetSelection`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileDialogChoice(FileDialogCustomControl)
Represents a custom read-only combobox inside FileDialog.
.. method:: GetSelection(self)
Return the index of the selected item, possibly ``wx.NOT_FOUND``.
:rtype: `int`
.. method:: SetSelection(self, n : int)
Set the selection to the item with the given index.
Using ``NOT_FOUND`` for `n` is not supported, once a selection is made it cannot be undone.
:param `n`:
:type `n`: int
:rtype: `None`
.. attribute:: Selection
See :meth:`~wx.FileDialogChoice.GetSelection` and :meth:`~wx.FileDialogChoice.SetSelection`