.. 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
.. currentmodule:: wx.lib.filebrowsebutton
.. highlight:: python
.. _wx.lib.filebrowsebutton.FileBrowseButton:
==========================================================================================================================================
|phoenix_title| **wx.lib.filebrowsebutton.FileBrowseButton**
==========================================================================================================================================
A control to allow the user to type in a filename or browse with
the standard file dialog to select file
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
FileBrowseButton:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.filebrowsebutton.DirBrowseButton`, :class:`wx.lib.filebrowsebutton.FileBrowseButtonWithHistory`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Panel`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.__init__` :param labelText: Text for label to left of text field
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createBrowseButton` Create the browse-button control
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createDialog` Setup the graphic representation of the dialog
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createLabel` Create the label/caption
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.createTextControl` Create the text control
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.GetLabel` Retrieve the label's current text
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.GetValue` retrieve current value of text control
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.OnBrowse` Going to browse for file...
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.OnChanged`
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.SetBackgroundColour` SetBackgroundColour(colour : Colour) -> bool
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.SetLabel` Set the label's current text
:meth:`~wx.lib.filebrowsebutton.FileBrowseButton.SetValue` set current value of text control
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: FileBrowseButton(wx.Panel)
A control to allow the user to type in a filename or browse with
the standard file dialog to select file
.. method:: __init__ (self, parent, id= -1, pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.TAB_TRAVERSAL, labelText= "File Entry:", buttonText= "Browse", toolTip= "Type filename or click browse to choose file", dialogTitle = "Choose a file", startDirectory = ".", initialValue = "", fileMask = "\*.\*", fileMode = wx.FD_OPEN, changeCallback= lambda x:x, labelWidth = 0, name = 'fileBrowseButton', )
:param labelText: Text for label to left of text field
:param buttonText: Text for button which launches the file dialog
:param toolTip: Help text
:param dialogTitle: Title used in file dialog
:param startDirectory: Default directory for file dialog startup
:param initialValue: Value initially present in the text field
:param fileMask: File mask (glob pattern, such as *.*) to use in file dialog
:param fileMode: wx.FD_OPEN or wx.FD_SAVE, indicates type of file dialog to use
:param changeCallback: Optional callback called for all changes in value of the control
:param labelWidth: Width of the label
.. method:: createBrowseButton( self)
Create the browse-button control
.. method:: createDialog( self, parent, id, pos, size, style, name )
Setup the graphic representation of the dialog
.. method:: createLabel( self )
Create the label/caption
.. method:: createTextControl( self)
Create the text control
.. method:: GetLabel( self )
Retrieve the label's current text
.. method:: GetValue (self)
retrieve current value of text control
.. method:: OnBrowse (self, event = None)
Going to browse for file...
.. method:: OnChanged(self, evt)
.. method:: SetBackgroundColour(self,color)
SetBackgroundColour(colour : Colour) -> bool
Sets the background colour of the window.
.. method:: SetLabel( self, value )
Set the label's current text
.. method:: SetValue (self, value, callBack=1)
set current value of text control