wxPython/wxPython/lib/filebrowsebutton.py

   1 #----------------------------------------------------------------------
   2 # Name:        wxPython.lib.filebrowsebutton
   3 # Purpose:     Composite controls that provide a Browse button next to
   4 #              either a wxTextCtrl or a wxComboBox.  The Browse button
   5 #              launches a wxFileDialog and loads the result into the
   6 #              other control.
   7 #
   8 # Author:      Mike Fletcher
   9 #
  10 # RCS-ID:      $Id$
  11 # Copyright:   (c) 2000 by Total Control Software
  12 # Licence:     wxWindows license
  13 #----------------------------------------------------------------------
  14
  15 from wxPython.wx import *
  16 import os
  17
  18 #----------------------------------------------------------------------
  19
  20 class FileBrowseButton(wxPanel):
  21     """ A control to allow the user to type in a filename
  22     or browse with the standard file dialog to select file
  23
  24     __init__ (
  25         parent, id, pos, size -- passed directly to wxPanel initialisation
  26         style = wxTAB_TRAVERSAL -- passed directly to wxPanel initialisation
  27         labelText -- Text for label to left of text field
  28         buttonText -- Text for button which launches the file dialog
  29         toolTip -- Help text
  30         dialogTitle -- Title used in file dialog
  31         startDirectory -- Default directory for file dialog startup
  32         fileMask -- File mask (glob pattern, such as *.*) to use in file dialog
  33         fileMode -- wxOPEN or wxSAVE, indicates type of file dialog to use
  34         changeCallback -- callback receives all > > changes in value of control
  35     )
  36     GetValue() -- retrieve current value of text control
  37     SetValue(string) -- set current value of text control
  38     label -- pointer to internal label widget
  39     textControl -- pointer to internal text control
  40     browseButton -- pointer to button
  41     """
  42     def __init__ (self, parent, id= -1,
  43               pos = wxDefaultPosition, size = wxDefaultSize,
  44               style = wxTAB_TRAVERSAL,
  45               labelText= "File Entry:",
  46               buttonText= "Browse",
  47               toolTip= "Type filename or click browse to choose file",
  48               # following are the values for a file dialog box
  49               dialogTitle = "Choose a file",
  50               startDirectory = ".",
  51               initialValue = "",
  52               fileMask = "*.*",
  53               fileMode = wxOPEN,
  54               # callback for when value changes (optional)
  55               changeCallback= lambda x:x
  56         ):
  57         # store variables
  58         self.labelText = labelText
  59         self.buttonText = buttonText
  60         self.toolTip = toolTip
  61         self.dialogTitle = dialogTitle
  62         self.startDirectory = startDirectory
  63         self.initialValue = initialValue
  64         self.fileMask = fileMask
  65         self.fileMode = fileMode
  66         self.changeCallback = changeCallback
  67         self.callCallback = true
  68
  69
  70         # get background to match it
  71         try:
  72             self._bc = parent.GetBackgroundColour()
  73         except:
  74             pass
  75
  76         # create the dialog
  77         self.createDialog(parent, id, pos, size, style )
  78         # Setting a value causes the changeCallback to be called.
  79         # In this case that would be before the return of the
  80         # constructor. Not good. So a default value on
  81         # SetValue is used to disable the callback
  82         self.SetValue( initialValue, 0)
  83
  84     def createDialog( self, parent, id, pos, size, style ):
  85         """Setup the graphic representation of the dialog"""
  86         wxPanel.__init__ (self, parent, id, pos, size, style)
  87         # try to set the background colour
  88         try:
  89             self.SetBackgroundColour(self._bc)
  90         except:
  91             pass
  92         box = wxBoxSizer(wxHORIZONTAL)
  93
  94         self.label = self.createLabel( )
  95         box.Add( self.label, 0, wxCENTER )
  96
  97         self.textControl = self.createTextControl()
  98         box.Add( self.textControl, 1, wxLEFT|wxCENTER, 5)
  99
 100         self.browseButton = self.createBrowseButton()
 101         box.Add( self.browseButton, 0, wxCENTER)
 102
 103         # add a border around the whole thing and resize the panel to fit
 104         outsidebox = wxBoxSizer(wxVERTICAL)
 105         outsidebox.Add(box, 1, wxEXPAND|wxALL, 3)
 106         outsidebox.Fit(self)
 107
 108         self.SetAutoLayout(true)
 109         self.SetSizer( outsidebox )
 110         self.Layout()
 111         if size.width != -1 or size.height != -1:
 112             self.SetSize(size)
 113
 114     def SetBackgroundColour(self,color):
 115         wxPanel.SetBackgroundColour(self,color)
 116         self.label.SetBackgroundColour(color)
 117
 118     def createLabel( self ):
 119         """Create the label/caption"""
 120         label = wxStaticText(self, -1, self.labelText, style =wxALIGN_RIGHT )
 121         font = label.GetFont()
 122         w, h, d, e = self.GetFullTextExtent(self.labelText, font)
 123         label.SetSize(wxSize(w+5, h))
 124         return label
 125
 126     def createTextControl( self):
 127         """Create the text control"""
 128         ID = wxNewId()
 129         textControl = wxTextCtrl(self, ID)
 130         textControl.SetToolTipString( self.toolTip )
 131         if self.changeCallback:
 132             EVT_TEXT(textControl, ID, self.OnChanged)
 133             EVT_COMBOBOX(textControl, ID, self.OnChanged)
 134         return textControl
 135
 136     def OnChanged(self, evt):
 137         if self.callCallback:
 138             self.changeCallback(evt)
 139
 140     def createBrowseButton( self):
 141         """Create the browse-button control"""
 142         ID = wxNewId()
 143         button =wxButton(self, ID, self.buttonText)
 144         button.SetToolTipString( self.toolTip )
 145         EVT_BUTTON(button, ID, self.OnBrowse)
 146         return button
 147
 148
 149     def OnBrowse (self, event = None):
 150         """ Going to browse for file... """
 151         current = self.GetValue()
 152         directory = os.path.split(current)
 153         if os.path.isdir( current):
 154             directory = current
 155             current = ''
 156         elif directory and os.path.isdir( directory[0] ):
 157             current = directory[1]
 158             directory = directory [0]
 159         else:
 160             directory = self.startDirectory
 161         dlg = wxFileDialog(self, self.dialogTitle, directory, current, self.fileMask, self.fileMode)
 162
 163         if dlg.ShowModal() == wxID_OK:
 164             self.SetValue (dlg.GetPath())
 165         dlg.Destroy()
 166
 167
 168
 169     def GetValue (self):
 170         """ Convenient access to text control value """
 171         return self.textControl.GetValue ()
 172
 173     def SetValue (self, value, callBack=1):
 174         """ Convenient setting of text control value """
 175         save = self.callCallback
 176         self.callCallback = callBack
 177         self.textControl.SetValue(value)
 178         self.callCallback =  save
 179
 180
 181     def Enable (self, value):
 182         """ Convenient enabling/disabling of entire control """
 183         self.label.Enable (value)
 184         self.textControl.Enable (value)
 185         return self.browseButton.Enable (value)
 186
 187     def GetLabel( self ):
 188         """ Retrieve the label's current text """
 189         return self.label.GetLabel()
 190
 191     def SetLabel( self, value ):
 192         """ Set the label's current text """
 193         rvalue = self.label.SetLabel( value )
 194         self.Refresh( true )
 195         return rvalue
 196
 197
 198
 199 class FileBrowseButtonWithHistory( FileBrowseButton ):
 200     """ with following additions:
 201         __init__(..., history=None)
 202
 203             history -- optional list of paths for initial history drop-down
 204                 (must be passed by name, not a positional argument)
 205                 If history is callable it will must return a list used
 206                 for the history drop-down
 207             changeCallback -- as for FileBrowseButton, but with a work-around
 208                 for win32 systems which don't appear to create EVT_COMBOBOX
 209                 events properly.  There is a (slight) chance that this work-around
 210                 will cause some systems to create two events for each Combobox
 211                 selection. If you discover this condition, please report it!
 212             As for a FileBrowseButton.__init__ otherwise.
 213         GetHistoryControl()
 214             Return reference to the control which implements interfaces
 215             required for manipulating the history list.  See GetHistoryControl
 216             documentation for description of what that interface is.
 217         GetHistory()
 218             Return current history list
 219         SetHistory( value=(), selectionIndex = None )
 220             Set current history list, if selectionIndex is not None, select that index
 221         """
 222     def __init__( self, *arguments, **namedarguments):
 223         self.history = namedarguments.get( "history" )
 224         if self.history:
 225             del namedarguments["history"]
 226
 227         self.historyCallBack=None
 228         if callable(self.history):
 229             self.historyCallBack=self.history
 230             self.history=None
 231         apply( FileBrowseButton.__init__, ( self,)+arguments, namedarguments)
 232
 233     def createTextControl( self):
 234         """Create the text control"""
 235         ID = wxNewId()
 236         textControl = wxComboBox(self, ID, style = wxCB_DROPDOWN )
 237         textControl.SetToolTipString( self.toolTip )
 238         EVT_SET_FOCUS(textControl, self.OnSetFocus)
 239         if self.changeCallback:
 240             EVT_TEXT(textControl, ID, self.changeCallback)
 241             EVT_COMBOBOX(textControl, ID, self.changeCallback)
 242         if self.history:
 243             history=self.history
 244             self.history=None
 245             self.SetHistory( history, control=textControl)
 246         return textControl
 247
 248     def GetHistoryControl( self ):
 249         """Return a pointer to the control which provides (at least)
 250         the following methods for manipulating the history list.:
 251             Append( item ) -- add item
 252             Clear() -- clear all items
 253             Delete( index ) -- 0-based index to delete from list
 254             SetSelection( index ) -- 0-based index to select in list
 255         Semantics of the methods follow those for the wxComboBox control
 256         """
 257         return self.textControl
 258
 259     def SetHistory( self, value=(), selectionIndex = None, control=None ):
 260         """Set the current history list"""
 261         if control is None:
 262             control = self.GetHistoryControl()
 263         if self.history == value:
 264             return
 265         self.history = value
 266         # Clear history values not the selected one.
 267         tempValue=control.GetValue()
 268         # clear previous values
 269         control.Clear()
 270         control.SetValue(tempValue)
 271         # walk through, appending new values
 272         for path in value:
 273             control.Append( path )
 274         if selectionIndex is not None:
 275             control.SetSelection( selectionIndex )
 276
 277     def GetHistory( self ):
 278         """Return the current history list"""
 279         if self.historyCallBack != None:
 280             return self.historyCallBack()
 281         else:
 282             return list( self.history )
 283
 284     def OnSetFocus(self, event):
 285         """When the history scroll is selected, update the history"""
 286         if self.historyCallBack != None:
 287             self.SetHistory( self.historyCallBack(), control=self.textControl)
 288         event.Skip()
 289
 290     if wxPlatform == "__WXMSW__":
 291         def SetValue (self, value, callBack=1):
 292             """ Convenient setting of text control value, works
 293                 around limitation of wxComboBox """
 294             save = self.callCallback
 295             self.callCallback = callBack
 296             self.textControl.SetValue(value)
 297             self.callCallback =  save
 298
 299             # Hack to call an event handler
 300             class LocalEvent:
 301                 def __init__(self, string):
 302                     self._string=string
 303                 def GetString(self):
 304                     return self._string
 305             if callBack==1:
 306                 # The callback wasn't being called when SetValue was used ??
 307                 # So added this explicit call to it
 308                 self.changeCallback(LocalEvent(value))
 309
 310
 311 class DirBrowseButton(FileBrowseButton):
 312     def __init__(self, parent, id = -1,
 313                  pos = wxDefaultPosition, size = wxDefaultSize,
 314                  style = wxTAB_TRAVERSAL,
 315                  labelText = 'Select a directory:',
 316                  buttonText = 'Browse',
 317                  toolTip = 'Type directory name or browse to select',
 318                  dialogTitle = '',
 319                  startDirectory = '.',
 320                  changeCallback = None,
 321                  dialogClass = wxDirDialog):
 322         FileBrowseButton.__init__(self, parent, id, pos, size, style,
 323                                   labelText, buttonText, toolTip,
 324                                   dialogTitle, startDirectory,
 325                                   changeCallback = changeCallback)
 326         #
 327         self._dirDialog = dialogClass(self,
 328                                       message = dialogTitle,
 329                                       defaultPath = startDirectory)
 330     #
 331     def OnBrowse(self, ev = None):
 332         dialog = self._dirDialog
 333         if dialog.ShowModal() == wxID_OK:
 334             self.SetValue(dialog.GetPath())
 335     #
 336     def __del__(self):
 337         if self.__dict__.has_key('_dirDialog'):
 338             self._dirDialog.Destroy()
 339
 340
 341 #----------------------------------------------------------------------
 342
 343
 344 if __name__ == "__main__":
 345     #from skeletonbuilder import rulesfile
 346     class SimpleCallback:
 347         def __init__( self, tag ):
 348             self.tag = tag
 349         def __call__( self, event ):
 350             print self.tag, event.GetString()
 351     class DemoFrame( wxFrame ):
 352         def __init__(self, parent):
 353             wxFrame.__init__(self, parent, 2400, "File entry with browse", size=(500,260) )
 354             EVT_CLOSE(self, self.OnCloseWindow)
 355             panel = wxPanel (self,-1)
 356             innerbox = wxBoxSizer(wxVERTICAL)
 357             control = FileBrowseButton(
 358                 panel,
 359                 initialValue = "z:\\temp",
 360             )
 361             innerbox.Add(  control, 0, wxEXPAND )
 362             middlecontrol = FileBrowseButtonWithHistory(
 363                 panel,
 364                 labelText = "With History",
 365                 initialValue = "d:\\temp",
 366                 history = ["c:\\temp", "c:\\tmp", "r:\\temp","z:\\temp"],
 367                 changeCallback= SimpleCallback( "With History" ),
 368             )
 369             innerbox.Add( middlecontrol, 0, wxEXPAND )
 370             middlecontrol = FileBrowseButtonWithHistory(
 371                 panel,
 372                 labelText = "History callback",
 373                 initialValue = "d:\\temp",
 374                 history = self.historyCallBack,
 375                 changeCallback= SimpleCallback( "History callback" ),
 376             )
 377             innerbox.Add( middlecontrol, 0, wxEXPAND )
 378             self.bottomcontrol = control = FileBrowseButton(
 379                 panel,
 380                 labelText = "With Callback",
 381                 style = wxSUNKEN_BORDER|wxCLIP_CHILDREN ,
 382                 changeCallback= SimpleCallback( "With Callback" ),
 383             )
 384             innerbox.Add(  control, 0, wxEXPAND)
 385             self.bottommostcontrol = control = DirBrowseButton(
 386                 panel,
 387                 labelText = "Simple dir browse button",
 388                 style = wxSUNKEN_BORDER|wxCLIP_CHILDREN)
 389             innerbox.Add(  control, 0, wxEXPAND)
 390             ID = wxNewId()
 391             innerbox.Add( wxButton( panel, ID,"Change Label",  ), 1, wxEXPAND)
 392             EVT_BUTTON( self, ID, self.OnChangeLabel )
 393             ID = wxNewId()
 394             innerbox.Add( wxButton( panel, ID,"Change Value",  ), 1, wxEXPAND)
 395             EVT_BUTTON( self, ID, self.OnChangeValue )
 396             panel.SetAutoLayout(true)
 397             panel.SetSizer( innerbox )
 398             self.history={"c:\\temp":1, "c:\\tmp":1, "r:\\temp":1,"z:\\temp":1}
 399
 400         def historyCallBack(self):
 401             keys=self.history.keys()
 402             keys.sort()
 403             return keys
 404
 405         def OnFileNameChangedHistory (self, event):
 406             self.history[event.GetString ()]=1
 407
 408         def OnCloseMe(self, event):
 409             self.Close(true)
 410         def OnChangeLabel( self, event ):
 411             self.bottomcontrol.SetLabel( "Label Updated" )
 412         def OnChangeValue( self, event ):
 413             self.bottomcontrol.SetValue( "r:\\somewhere\\over\\the\\rainbow.htm" )
 414
 415         def OnCloseWindow(self, event):
 416             self.Destroy()
 417
 418     class DemoApp(wxApp):
 419         def OnInit(self):
 420             wxImage_AddHandler(wxJPEGHandler())
 421             wxImage_AddHandler(wxPNGHandler())
 422             wxImage_AddHandler(wxGIFHandler())
 423             frame = DemoFrame(NULL)
 424             #frame = RulesPanel(NULL )
 425             frame.Show(true)
 426             self.SetTopWindow(frame)
 427             return true
 428
 429     def test( ):
 430         app = DemoApp(0)
 431         app.MainLoop()
 432     print 'Creating dialog'
 433     test( )
 434
 435
 436