You're viewing unfinished documentation for an unstable version of OpenSesame
Image functions
class ImageWidget
The Image widget is used to display a non-interactive image.
Example (OpenSesame script):
widget 0 0 1 1 image path='5.png'
Example (Python):
form = Form()
# The full path to the image needs to be provided.
# self.experiment.pool can be used to retrieve the full path
# to an image in the file pool.
image = ImageWidget(path=pool['5.png'])
form.set_widget(image, (0,0))
form._exec()
- class ImageWidget
- function ImageWidget.__init__(form, path=None, adjust=True, frame=False)
- function ImageWidget._init_canvas_elements()
- function ImageWidget._update()
- function ImageWidget._update_frame(rect=None, style=u'normal')
- function ImageWidget.coroutine()
- function ImageWidget.on_key_press(key)
- function ImageWidget.on_mouse_click(pos)
- function ImageWidget.set_rect(rect)
- function ImageWidget.set_var(val, var=None)
function ImageWidget.__init__(form, path=None, adjust=True, frame=False)
Constructor to create a new ImageWidget object. You do not
generally call this constructor directly, but use the
ImageWidget() factory function, which is described here:
/python/common/.
Arguments:
form-- The parent form.- Type: form
Keywords:
path-- The full path to the image. To show an image from the file pool, you need to first useexperiment.get_fileto determine the full path to the image.- Type: str, unicode, NoneType
- Default: None
adjust-- Indicates whether the image should be scaled according to the size of the widget.- Type: bool
- Default: True
frame-- Indicates whether a frame should be drawn around the widget.- Type: bool
- Default: False
function ImageWidget._init_canvas_elements()
Initializes all canvas elements.
function ImageWidget._update()
Draws the widget.
function ImageWidget._update_frame(rect=None, style=u'normal')
Draws a simple frame around the widget.
Keywords:
rect-- A (left, top, width, height) tuple for the frame geometry orNoneto use the widget geometry.- Type: tuple, NoneType
- Default: None
style-- A visual style. Should be 'normal', 'active', or 'light'.- Type: str, unicode
- Default: 'normal'
function ImageWidget.coroutine()
Implements the interaction. This can be overridden to implement more complicated keyboard/ mouse interactions.
function ImageWidget.on_key_press(key)
Is called whenever the widget is focused and the users enters a key.
Arguments:
key-- A key- Type: str
function ImageWidget.on_mouse_click(pos)
Is called whenever the user clicks on the widget.
Arguments:
pos-- An (x, y) coordinates tuple.- Type: tuple
function ImageWidget.set_rect(rect)
Sets the widget geometry.
Arguments:
rect-- A (left, top, width, height) tuple.- Type: tuple
function ImageWidget.set_var(val, var=None)
Sets an experimental variable.
Arguments:
val-- A value.
Keywords:
var-- A variable name, or None to use widget default.- Type: str, unicode, NoneType
- Default: None
