.. include:: headings.inc

.. currentmodule:: lib.filebrowsebutton

.. highlight:: python



.. _lib.filebrowsebutton.FileBrowseButton:

==========================================================================================================================================
|phoenix_title|  **FileBrowseButton**
==========================================================================================================================================

A control to allow the user to type in a filename or browse with
the standard file dialog to select file



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **FileBrowseButton**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.filebrowsebutton.FileBrowseButton_inheritance.png" alt="Inheritance diagram of FileBrowseButton" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,5,476,35"/> <area shape="rect" id="node7" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="525,5,597,35"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> <area shape="rect" id="node10" href="lib.filebrowsebutton.FileBrowseButton.html" title="A control to allow the user to type in a filename or browse with" alt="" coords="647,5,916,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:class:`lib.filebrowsebutton.DirBrowseButton`, :class:`lib.filebrowsebutton.FileBrowseButtonWithHistory`

|


|super_classes| Known Superclasses
==================================

:class:`Panel`

|


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

================================================================================ ================================================================================
:meth:`~lib.filebrowsebutton.FileBrowseButton.__init__`                          :param labelText:      Text for label to left of text field
:meth:`~lib.filebrowsebutton.FileBrowseButton.createBrowseButton`                Create the browse-button control
:meth:`~lib.filebrowsebutton.FileBrowseButton.createDialog`                      Setup the graphic representation of the dialog
:meth:`~lib.filebrowsebutton.FileBrowseButton.createLabel`                       Create the label/caption
:meth:`~lib.filebrowsebutton.FileBrowseButton.createTextControl`                 Create the text control
:meth:`~lib.filebrowsebutton.FileBrowseButton.GetLabel`                          Retrieve the label's current text
:meth:`~lib.filebrowsebutton.FileBrowseButton.GetValue`                          retrieve current value of text control
:meth:`~lib.filebrowsebutton.FileBrowseButton.OnBrowse`                          Going to browse for file...
:meth:`~lib.filebrowsebutton.FileBrowseButton.OnChanged`                         
:meth:`~lib.filebrowsebutton.FileBrowseButton.SetBackgroundColour`               
:meth:`~lib.filebrowsebutton.FileBrowseButton.SetLabel`                          Set the label's current text
:meth:`~lib.filebrowsebutton.FileBrowseButton.SetValue`                          set current value of text control
================================================================================ ================================================================================


|


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

.. class:: FileBrowseButton(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 = DefaultPosition, size = DefaultSize, style = TAB_TRAVERSAL, labelText= "File Entry:", buttonText= "Browse", toolTip= "Type filename or click browse to choose file",  dialogTitle = "Choose a file", startDirectory = ".", initialValue = "", fileMask = "\*.\*", fileMode = 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 fileMask:       File mask (glob pattern, such as *.*) to use in file dialog
      :param fileMode:       wx.OPEN or wx.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)


   .. method:: SetLabel( self, value )

      Set the label's current text 


   .. method:: SetValue (self, value, callBack=1)

      set current value of text control