phoenix_title wx.lib.filebrowsebutton.FileBrowseButtonWithHistory

with following additions:

__init__(…, history=None)

history – optional list of paths for initial history drop-down

(must be passed by name, not a positional argument) If history is callable it will must return a list used for the history drop-down

changeCallback – as for FileBrowseButton, but with a work-around

for win32 systems which don’t appear to create wx.EVT_COMBOBOX events properly. There is a (slight) chance that this work-around will cause some systems to create two events for each Combobox selection. If you discover this condition, please report it!

As for a FileBrowseButton.__init__ otherwise.

GetHistoryControl()

Return reference to the control which implements interfaces required for manipulating the history list. See GetHistoryControl documentation for description of what that interface is.

GetHistory()

Return current history list

SetHistory( value=(), selectionIndex = None )

Set current history list, if selectionIndex is not None, select that index


class_hierarchy Class Hierarchy

Inheritance diagram for class FileBrowseButtonWithHistory:

super_classes Known Superclasses

wx.lib.filebrowsebutton.FileBrowseButton


method_summary Methods Summary

__init__

param labelText:

Text for label to left of text field

createTextControl

Create the text control

GetHistory

Return the current history list

GetHistoryControl

Return a pointer to the control which provides (at least)

OnSetFocus

When the history scroll is selected, update the history

SetHistory

Set the current history list

SetValue

Convenient setting of text control value, works


api Class API

class FileBrowseButtonWithHistory(FileBrowseButton)
with following additions:

__init__(…, history=None)

history – optional list of paths for initial history drop-down

(must be passed by name, not a positional argument) If history is callable it will must return a list used for the history drop-down

changeCallback – as for FileBrowseButton, but with a work-around

for win32 systems which don’t appear to create wx.EVT_COMBOBOX events properly. There is a (slight) chance that this work-around will cause some systems to create two events for each Combobox selection. If you discover this condition, please report it!

As for a FileBrowseButton.__init__ otherwise.

GetHistoryControl()

Return reference to the control which implements interfaces required for manipulating the history list. See GetHistoryControl documentation for description of what that interface is.

GetHistory()

Return current history list

SetHistory( value=(), selectionIndex = None )

Set current history list, if selectionIndex is not None, select that index


Methods

__init__(self, *arguments, **namedarguments)
Parameters:
  • labelText – Text for label to left of text field

  • buttonText – Text for button which launches the file dialog

  • toolTip – Help text

  • dialogTitle – Title used in file dialog

  • startDirectory – Default directory for file dialog startup

  • initialValue – Value initially present in the text field

  • fileMask – File mask (glob pattern, such as .) to use in file dialog

  • fileMode – wx.FD_OPEN or wx.FD_SAVE, indicates type of file dialog to use

  • changeCallback – Optional callback called for all changes in value of the control

  • labelWidth – Width of the label



createTextControl(self)

Create the text control



GetHistory(self)

Return the current history list



GetHistoryControl(self)

Return a pointer to the control which provides (at least) the following methods for manipulating the history list:

Append( item ) – add item Clear() – clear all items Delete( index ) – 0-based index to delete from list SetSelection( index ) – 0-based index to select in list

Semantics of the methods follow those for the wxComboBox control



OnSetFocus(self, event)

When the history scroll is selected, update the history



SetHistory(self, value=(), selectionIndex = None, control=None)

Set the current history list



SetValue(self, value, callBack=1)

Convenient setting of text control value, works around limitation of wx.ComboBox