Table Of Contents

Previous topic

psychopy.filters - helper functions for creating filters

Next topic

psychopy.hardware - hardware interfaces

Quick links

psychopy.gui - create dialogue boxes

DlgFromDict

class psychopy.gui.DlgFromDict(dictionary, title='', fixed=[])

Creates a dialogue box that represents a dictionary of values. Any values changed by the user are change (in-place) by this dialogue box. e.g.:

info = {'Observer':'jwp', 'GratingOri':45, 'ExpVersion': 1.1}
infoDlg = gui.DlgFromDict(dictionary=info, title='TestExperiment', fixed=['ExpVersion'])
if infoDlg.OK:
    print info
else: print 'User Cancelled'

In the code above, the contents of info will be updated to the values returned by the dialogue box.

If the user cancels (rather than pressing OK), then the dictionary remains unchanged. If you want to check whether the user hit OK, then check whether DlgFromDict.OK equals True or False

Dlg

class psychopy.gui.Dlg(title='PsychoPy dialogue', pos=None, size=wx.Size(-1, -1), style=536877057)

A simple dialogue box. You can add text or input boxes (sequentially) and then retrieve the values.

see also the function dlgFromDict for an even simpler version

Example:

from psychopy import gui

myDlg = gui.Dlg(title="JWP's experiment")
myDlg.addText('Subject info')
myDlg.addField('Name:')
myDlg.addField('Age:', 21)
myDlg.addText('Experiment Info')
myDlg.addField('Grating Ori:',45)
if myDlg.show()==gui.OK:
    thisInfo = myDlg.data
    print thisInfo
else: print 'user cancelled'
addField(label='', initial='')
Adds a (labelled) input field to the dialogue box Returns a handle to the field (but not to the label).
addFixedField(label='', value='')
Adds a field to the dialogue box (like addField) but the field cannot be edited. e.g. Display experiment version.
addText(text)
show()

fileOpenDlg

class psychopy.gui.fileOpenDlg

A simple dialogue allowing access to the file system. (Useful in case you collect an hour of data and then try to save to a non-existent directory!!)

usage:
validPathName = fileSaveDlg(initFilePath,initFileName)

If initFilePath or initFileName are empty or invalid then current path and empty names are used to start search.

If user cancels the None is returned.

fileSaveDlg

class psychopy.gui.fileSaveDlg

A simple dialogue allowing access to the file system. (Useful in case you collect an hour of data and then try to save to a non-existent directory!!)

usage:
validPathName = fileSaveDlg(initFilePath,initFileName)

If initFilePath or initFileName are empty or invalid then current path and empty names are used to start search.

If user cancels the None is returned.