class qtitem(base_qtobject):
"""Base class for the GUI controls of other items"""
initial_view = u"controls"
def __init__(self):
"""Constructor"""
# The auto-widgets are stored in name -> (var, widget) dictionaries
self.auto_line_edit = {}
self.auto_combobox = {}
self.auto_spinbox = {}
self.auto_slider = {}
self.auto_editor = {}
self.auto_checkbox = {}
self.init_edit_widget()
self.lock = False
self.maximized = False
debug.msg(u"created %s" % self.name)
@property
def main_window(self):
return self.experiment.main_window
@property
def theme(self):
return self.experiment.main_window.theme
@property
def tabwidget(self):
return self.experiment.main_window.tabwidget
@property
def console(self):
return self.experiment.main_window.console
@property
def extension_manager(self):
return self.experiment.main_window.extension_manager
def open_tab(self, select_in_tree=True):
"""
desc:
Opens the tab if it wasn't yet open, and switches to it.
"""
unsaved = self.main_window.unsaved_changes
self.tabwidget.add(self.widget(), self.item_icon(), self.name)
self.main_window.set_unsaved(unsaved)
if select_in_tree:
self.experiment.main_window.ui.itemtree.select_item(self.name)
def close_tab(self):
"""
desc:
Closes the tab if it was open.
"""
self.tabwidget.remove(self.widget())
def set_focus(self):
"""
desc:
Gives focus to the most important widget.
"""
if hasattr(self, u"focus_widget") and self.focus_widget is not None:
self.focus_widget.setFocus()
def set_focus_widget(self, widget, override=False):
"""
desc:
Sets the widget that receives focus when the tab is opened.
arguments:
widget:
desc: The widget to receive focus or `None` to reset.
type: [QWidget, NoneType]
keywords:
override:
desc: Indicates whether the focus widget should be changed if
there already is a focus widget.
type: bool
"""
if override or not hasattr(self, u"focus_widget") or self.focus_widget is None:
self.focus_widget = widget
def update_item_icon(self):
"""
desc:
Updates the item icon.
"""
self.tabwidget.set_icon(self.widget(), self.item_icon())
self.experiment.items.set_icon(self.name, self.item_icon())
self.header_item_icon.setPixmap(self.theme.qpixmap(self.item_icon(), 32))
def item_icon(self):
"""
returns:
desc: The name of the item icon.
type: unicode
"""
return self.item_type
def show_tab(self):
"""
desc:
Is called when the tab becomes visible, and updated the contents.
"""
self.update_script()
self.edit_widget()
self.main_window.ui.itemtree.select_item(self.name, open_tab=False)
def widget(self):
"""
returns:
desc: The widget that is added to the tabwidget.
type: QWidget
"""
return self.container_widget
def init_edit_widget(self, stretch=True):
"""
desc:
Builds the UI.
keywords:
stretch:
desc: Indicates whether a vertical stretch should be added to
the bottom of the controls. This is necessary if the
controls don't expand.
type: bool
"""
# Header widget
self.header = header_widget.header_widget(self)
self.user_hint_widget = user_hint_widget.user_hint_widget(self.experiment.main_window, self)
self.header_hbox = QtGui.QHBoxLayout()
self.header_item_icon = self.theme.qlabel(self.item_icon())
self.header_hbox.addWidget(self.header_item_icon)
self.header_hbox.addWidget(self.header)
self.header_hbox.setContentsMargins(0, 2, 0, 0)
# Maximize button
self.button_toggle_maximize = QtGui.QPushButton(self.theme.qicon(u"view-fullscreen"), u"")
self.button_toggle_maximize.setToolTip(_(u"Toggle pop-out"))
self.button_toggle_maximize.setIconSize(QtCore.QSize(16, 16))
self.button_toggle_maximize.clicked.connect(self.toggle_maximize)
self.header_hbox.addWidget(self.button_toggle_maximize)
# View button
self.button_view = item_view_button(self)
self.header_hbox.addWidget(self.button_view)
# Help button
self.button_help = QtGui.QPushButton(self.theme.qicon(u"help"), u"")
self.button_help.setToolTip(_(u"Tell me more about the %s item") % self.item_type)
self.button_help.setIconSize(QtCore.QSize(16, 16))
self.button_help.clicked.connect(self.open_help_tab)
self.header_hbox.addWidget(self.button_help)
self.header_widget = QtGui.QWidget()
self.header_widget.setLayout(self.header_hbox)
# The edit_grid is the layout that contains the actual controls for the
# items.
self.edit_grid = QtGui.QGridLayout()
self.edit_grid.setColumnStretch(2, 2)
self.edit_grid_widget = QtGui.QWidget()
self.edit_grid_widget.setLayout(self.edit_grid)
# The edit_vbox contains the edit_grid and the header widget
self.edit_vbox = QtGui.QVBoxLayout()
self.edit_vbox.addWidget(self.user_hint_widget)
self.edit_vbox.addWidget(self.edit_grid_widget)
self.edit_vbox.setContentsMargins(0, 0, 0, 0)
self.edit_vbox.setSpacing(0)
if stretch:
self.edit_vbox.addStretch()
self._edit_widget = QtGui.QWidget()
self._edit_widget.setWindowIcon(self.theme.qicon(self.item_type))
self._edit_widget.setLayout(self.edit_vbox)
# The _script_widget contains the script editor
from QProgEdit import QTabManager
self._script_widget = QTabManager(handlerButtonText=_(u"Apply and close"), cfg=cfg)
self._script_widget.focusLost.connect(self.apply_script_changes)
self._script_widget.cursorRowChanged.connect(self.apply_script_changes)
self._script_widget.handlerButtonClicked.connect(self.set_view_controls)
self._script_widget.addTab(u"Script").setLang(u"OpenSesame")
# The container_widget is the top-level widget that is actually inserted
# into the tab widget.
self.splitter = qtitem_splitter(self)
if self.initial_view == u"controls":
self.set_view_controls()
elif self.initial_view == u"script":
self.set_view_script()
elif self.initial_view == u"split":
self.set_view_split()
else:
debug.msg(u"Invalid initial_view: %s" % self.initial_view, reason=u"warning")
self.set_view_controls()
self.splitter.splitterMoved.connect(self.splitter_moved)
self.container_vbox = QtGui.QVBoxLayout()
self.container_vbox.setContentsMargins(4, 0, 4, 4)
self.container_vbox.addWidget(self.header_widget)
self.container_vbox.addWidget(self.splitter)
self.container_widget = QtGui.QWidget()
self.container_widget.setLayout(self.container_vbox)
self.container_widget.on_activate = self.show_tab
self.container_widget.__item__ = self.name
def splitter_moved(self, pos, index):
"""
desc:
Is called when the splitter handle is manually moved.
arguments:
pos:
desc: The splitter-handle position.
type: int
index:
desc: The index of the splitter handle. Since there is only
one handle, this is always 0.
type: int
"""
sizes = self.splitter.sizes()
self.edit_size = sizes[0]
self.script_size = sizes[1]
if self.script_size == 0:
self.button_view.set_view_icon(u"controls")
elif self.edit_size == 0:
self.button_view.set_view_icon(u"script")
else:
self.button_view.set_view_icon(u"split")
def set_view_controls(self):
"""
desc:
Puts the splitter in control view.
"""
self.splitter.setSizes([self.splitter.width(), 0])
self.button_view.set_view_icon(u"controls")
def set_view_script(self):
"""
desc:
Puts the splitter in script view.
"""
self.splitter.setSizes([0, self.splitter.width()])
self.button_view.set_view_icon(u"script")
def set_view_split(self):
"""
desc:
Puts the splitter in split view.
"""
self.splitter.setSizes([self.splitter.width() / 2, self.splitter.width() / 2])
self.button_view.set_view_icon(u"split")
def update(self):
"""
desc:
Updates both the script and the controls.
"""
self.update_script()
self.edit_widget()
def update_script(self):
"""
desc:
Regenerates the script and updates the script widget.
"""
# Normally, the script starts with a 'define' line and is indented by
# a tab. We want to undo this, and present only unindented content.
import textwrap
script = self.to_string()
script = script[script.find(u"\t") :]
script = textwrap.dedent(script)
if self._script_widget.text() != script:
self.main_window.set_unsaved()
self._script_widget.setText(script)
self.extension_manager.fire(u"change_item", name=self.name)
def edit_widget(self, *deprecated, **_deprecated):
"""
desc:
This function updates the controls based on the item state.
"""
self.auto_edit_widget()
self.header.refresh()
def apply_edit_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the graphical controls.
"""
self.auto_apply_edit_changes()
self.update_script()
return True
def apply_script_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script, by re-parsing the item from string.
"""
old_script = self.to_string()
new_script = self._script_widget.text()
try:
self.from_string(new_script)
except osexception as e:
md = _(u"# Error\n\nFailed to apply script for the " u"following reason:\n\n- ") + e.markdown()
self.tabwidget.open_markdown(md)
self.console.write(e)
self.from_string(old_script)
if old_script != new_script:
self.main_window.set_unsaved()
self.edit_widget()
def rename(self, from_name, to_name):
"""
desc:
Handles renaming of an item (not necesarrily the current item).
arguments:
from_name:
desc: The old item name.
type: unicode
to_name:
desc: The new item name
type: unicode
"""
if self.name != from_name:
return
self.name = to_name
self.container_widget.__item__ = self.name
self.header.set_name(to_name)
index = self.tabwidget.indexOf(self.widget())
if index is not None:
self.tabwidget.setTabText(index, to_name)
def open_help_tab(self):
"""
desc:
Opens a help tab.
"""
self.experiment.main_window.ui.tabwidget.open_help(self.item_type)
def toggle_maximize(self):
"""
desc:
Toggles edit-widget maximization.
"""
if not self.maximized:
# Always ignore close events. This is necessary, because otherwise
# the pop-out widget can be closed without re-enabling the main
# window.
self.main_window.block_close_event = True
self.container_widget.closeEvent = lambda e: e.ignore()
self.container_widget.setParent(None)
self.container_widget.setWindowFlags(
QtCore.Qt.WindowStaysOnTopHint | QtCore.Qt.WindowMaximizeButtonHint | QtCore.Qt.CustomizeWindowHint
)
self.container_widget.showMaximized()
self.container_widget.show()
self.button_toggle_maximize.setIcon(self.theme.qicon(u"view-restore"))
else:
self.main_window.block_close_event = False
self.container_widget.setParent(self.main_window)
self.open_tab()
self.button_toggle_maximize.setIcon(self.theme.qicon(u"view-fullscreen"))
self.maximized = not self.maximized
self.user_hint_widget.disable(self.maximized)
self.button_help.setDisabled(self.maximized)
self.main_window.setDisabled(self.maximized)
def delete(self, item_name, item_parent=None, index=None):
"""
desc:
Is called when an item is deleted (not necessarily the current one).
arguments:
item_name:
desc: The name of the item to be deleted.
type: str
keywords:
item_parent:
desc: The name of the parent item.
type: str
index:
desc: The index of the item in the parent.
type: int
"""
pass
def build_item_tree(self, toplevel=None, items=[], max_depth=-1, extra_info=None):
"""
desc:
Constructs an item tree.
keywords:
toplevel:
desc: The toplevel widget.
type: tree_base_item
items:
desc: A list of item names that have already been added, to
prevent recursion.
tyep: list
returns:
type: tree_item_item
"""
widget = tree_item_item(self, extra_info=extra_info)
items.append(self.name)
if toplevel is not None:
toplevel.addChild(widget)
return widget
def parents(self):
"""
returns:
desc: A list of all parents (names) of the current item.
type: list
"""
l = [self.name]
for item in self.experiment.items:
if self.experiment.items[item].is_child_item(self.name):
l.append(item)
return l
def get_ready(self):
"""
desc:
This function should be overridden to do any last-minute stuff that
and item should do before an experiment is actually run, such as
applying pending script changes.
returns:
desc: True if some action has been taken, False if nothing was
done.
type: bool
"""
return False
def auto_edit_widget(self):
"""
desc:
Updates the GUI controls based on the auto-widgets.
"""
for var, edit in self.auto_line_edit.items():
if isinstance(var, int):
continue
if var in self.var:
val = safe_decode(self.var.get(var, _eval=False))
else:
val = u""
if val != edit.text():
edit.setText(val)
for var, combobox in self.auto_combobox.items():
if isinstance(var, int):
continue
val = self.var.get(var, _eval=False, default=u"")
i = combobox.findText(safe_decode(val))
# Set the combobox to the select item
if i >= 0:
if i != combobox.currentIndex() or not combobox.isEnabled():
combobox.setDisabled(False)
combobox.setCurrentIndex(i)
# If no value was specified, set the combobox to a blank item
elif val == u"":
if combobox.currentIndex() >= 0 or not combobox.isEnabled():
combobox.setDisabled(False)
combobox.setCurrentIndex(-1)
# If an unknown value has been specified, notify the user
else:
if combobox.isEnabled():
combobox.setDisabled(True)
self.user_hint_widget.add(
_(
u'"%s" is set to a variable or '
u"unknown value and can only be edited through "
u"the script."
)
% var
)
for var, spinbox in list(self.auto_spinbox.items()) + list(self.auto_slider.items()):
if isinstance(var, int):
continue
if var in self.var:
val = self.var.get(var, _eval=False)
if type(val) in (float, int):
if spinbox.value() == val and spinbox.isEnabled():
continue
spinbox.setDisabled(False)
try:
spinbox.setValue(val)
except Exception as e:
self.experiment.notify(_(u"Failed to set control '%s': %s") % (var, e))
else:
if not spinbox.isEnabled():
continue
spinbox.setDisabled(True)
self.user_hint_widget.add(
_(u'"%s" is defined using ' "variables and can only be edited through the " "script.") % var
)
for var, checkbox in self.auto_checkbox.items():
if isinstance(var, int):
continue
if var in self.var:
val = self.var.get(var, _eval=False)
if val in [u"yes", u"no"]:
checkbox.setDisabled(False)
checked = val == u"yes"
if checked != checkbox.isChecked():
checkbox.setChecked(checked)
else:
checkbox.setDisabled(True)
self.user_hint_widget.add(
_(
u'"%s" is defined using '
u"variables or has an invalid value, and can only be "
u"edited through the script."
)
% var
)
for var, qprogedit in self.auto_editor.items():
if isinstance(var, int):
continue
if var in self.var:
val = safe_decode(self.var.get(var, _eval=False))
if val != qprogedit.text():
qprogedit.setText(val)
self.user_hint_widget.refresh()
def auto_apply_edit_changes(self, rebuild=True):
"""
desc:
Applies the auto-widget controls.
keywords:
rebuild: Deprecated (does nothing).
"""
for var, edit in self.auto_line_edit.items():
if isinstance(var, int):
continue
if edit.isEnabled() and isinstance(var, basestring):
val = str(edit.text()).strip()
if val != u"":
self.var.set(var, val)
continue
# If no text was entered, we use a default if available ...
if hasattr(edit, u"default"):
self.var.set(var, edit.default)
continue
# ... or unset the variable if no default is available.
self.var.unset(var)
for var, combobox in self.auto_combobox.items():
if isinstance(var, int):
continue
if combobox.isEnabled() and isinstance(var, basestring):
self.var.set(var, str(combobox.currentText()))
for var, spinbox in self.auto_spinbox.items():
if isinstance(var, int):
continue
if spinbox.isEnabled() and isinstance(var, basestring):
self.var.set(var, spinbox.value())
for var, slider in self.auto_slider.items():
if isinstance(var, int):
continue
if slider.isEnabled() and isinstance(var, basestring):
self.var.set(var, slider.value())
for var, checkbox in self.auto_checkbox.items():
if isinstance(var, int):
continue
if checkbox.isEnabled() and isinstance(var, basestring):
if checkbox.isChecked():
val = u"yes"
else:
val = u"no"
self.var.set(var, val)
for var, qprogedit in self.auto_editor.items():
if isinstance(var, int):
continue
if isinstance(var, basestring):
self.var.set(var, qprogedit.text())
return True
def auto_add_widget(self, widget, var=None):
"""
desc:
Adds a widget to the list of auto-widgets.
arguments:
widget:
type: QWidget
keywords:
var: The name of the experimental variable to be linked to the
widget, or None to use an automatically chosen name.
type: [str, NoneType]
"""
# Use the object id as a fallback name
if var is None:
var = id(widget)
debug.msg(var)
self.set_focus_widget(widget)
if isinstance(widget, QtGui.QSpinBox) or isinstance(widget, QtGui.QDoubleSpinBox):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_spinbox[var] = widget
elif isinstance(widget, QtGui.QComboBox):
widget.activated.connect(self.apply_edit_changes)
self.auto_combobox[var] = widget
elif isinstance(widget, QtGui.QSlider) or isinstance(widget, QtGui.QDial):
widget.valueChanged.connect(self.apply_edit_changes)
self.auto_slider[var] = widget
elif isinstance(widget, QtGui.QLineEdit):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_line_edit[var] = widget
elif isinstance(widget, QtGui.QCheckBox):
widget.clicked.connect(self.apply_edit_changes)
self.auto_checkbox[var] = widget
else:
raise Exception(u"Cannot auto-add widget of type %s" % widget)
def clean_cond(self, cond, default=u"always"):
"""
desc:
Cleans a conditional statement. May raise a dialog box if problems
are encountered.
arguments:
cond:
desc: A conditional statement.
type: str
keywords:
default:
desc: A default conditional statement, which is used for empty
and invalid statements.
type: str
returns:
cond:
desc: A clean conditional statement.
type: str
"""
cond = self.syntax.sanitize(cond)
if cond.strip() == u"":
cond = default
try:
self.syntax.compile_cond(cond)
except osexception as e:
self.experiment.notify(u'Failed to compile conditional statement "%s": %s' % (cond, e))
return default
return cond
def children(self):
"""
returns:
desc: A list of children, including grand children, and so on.
type: list
"""
return []
def is_child_item(self, item_name):
"""
desc:
Checks if an item is somewhere downstream from the current item
in the experimental hierarchy.
arguments:
item_name:
desc: The name of the child item.
type: unicode
returns:
desc: True if the current item is offspring of the item, False
otherwise.
type: bool
"""
return False
def insert_child_item(self, item_name, index=0):
"""
desc:
Inserts a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item.
type: int
"""
pass
def remove_child_item(self, item_name, index=0):
"""
desc:
Removes a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item, if applicable. A negative
value indicates all instances.
type: int
"""
pass
class qtitem(base_qtobject):
"""Base class for the GUI controls of other items"""
initial_view = u'controls'
label_align = u'right'
help_url = None
lazy_init = False
def __init__(self):
"""Constructor"""
# The auto-widgets are stored in name -> (var, widget) dictionaries
self.auto_line_edit = {}
self.auto_combobox = {}
self.auto_spinbox = {}
self.auto_slider = {}
self.auto_editor = {}
self.auto_checkbox = {}
# Lazy initialization means that the control widgets are initialized
# only when they are shown for the first time. This dramatically speeds
# up opening of files. However, with some items this is not currently
# possible, because their widgets are also referred when they are not
# shown. Currently this means the inline_script.
if self.lazy_init:
self.container_widget = None
else:
self.init_edit_widget()
self.lock = False
self.maximized = False
self.set_validator()
debug.msg(u'created %s' % self.name)
@property
def main_window(self):
return self.experiment.main_window
@property
def overview_area(self):
return self.experiment.main_window.ui.itemtree
@property
def theme(self):
return self.experiment.main_window.theme
@property
def tabwidget(self):
return self.experiment.main_window.tabwidget
@property
def console(self):
return self.experiment.main_window.console
@property
def extension_manager(self):
return self.experiment.main_window.extension_manager
@property
def default_description(self):
return _(u'Default description')
def open_tab(self, select_in_tree=True):
"""
desc:
Opens the tab if it wasn't yet open, and switches to it.
"""
unsaved = self.main_window.unsaved_changes
self.tabwidget.add(self.widget(), self.item_icon(), self.name)
self.main_window.set_unsaved(unsaved)
if select_in_tree:
self.experiment.main_window.ui.itemtree.select_item(self.name)
def close_tab(self):
"""
desc:
Closes the tab if it was open.
"""
self.tabwidget.remove(self.widget())
def set_focus(self):
"""
desc:
Gives focus to the most important widget.
"""
if hasattr(self, u'focus_widget') and self.focus_widget is not None:
self.focus_widget.setFocus()
def set_focus_widget(self, widget, override=False):
"""
desc:
Sets the widget that receives focus when the tab is opened.
arguments:
widget:
desc: The widget to receive focus or `None` to reset.
type: [QWidget, NoneType]
keywords:
override:
desc: Indicates whether the focus widget should be changed if
there already is a focus widget.
type: bool
"""
if override or not hasattr(
self, u'focus_widget') or self.focus_widget is None:
self.focus_widget = widget
def update_item_icon(self):
"""
desc:
Updates the item icon.
"""
self.tabwidget.set_icon(self.widget(), self.item_icon())
self.experiment.items.set_icon(self.name, self.item_icon())
self.header_item_icon.setPixmap(
self.theme.qpixmap(self.item_icon(), 32))
def item_icon(self):
"""
returns:
desc: The name of the item icon.
type: unicode
"""
return self.item_type
def show_tab(self):
"""
desc:
Is called when the tab becomes visible, and updated the contents.
"""
self.update_script()
self.edit_widget()
self.main_window.ui.itemtree.select_item(self.name, open_tab=False)
@requires_init
def widget(self):
"""
returns:
desc: The widget that is added to the tabwidget.
type: QWidget
"""
return self.container_widget
def init_edit_widget(self, stretch=True):
"""
desc:
Builds the UI.
keywords:
stretch:
desc: Indicates whether a vertical stretch should be added to
the bottom of the controls. This is necessary if the
controls don't expand.
type: bool
"""
# Header widget
self.header = header_widget.header_widget(self)
self.header_hbox = QtWidgets.QHBoxLayout()
self.header_item_icon = self.theme.qlabel(self.item_icon())
self.header_hbox.addWidget(self.header_item_icon)
self.header_hbox.addWidget(self.header)
self.header_hbox.setContentsMargins(0, 0, 0, 0)
self.header_hbox.setSpacing(12)
# Maximize button
self.button_toggle_maximize = QtWidgets.QPushButton(
self.theme.qicon(u'view-fullscreen'), u'')
self.button_toggle_maximize.setToolTip(_(u'Toggle pop-out'))
self.button_toggle_maximize.setIconSize(QtCore.QSize(16, 16))
self.button_toggle_maximize.clicked.connect(self.toggle_maximize)
self.header_hbox.addWidget(self.button_toggle_maximize)
# View button
self.button_view = item_view_button(self)
self.header_hbox.addWidget(self.button_view)
# Help button
self.button_help = QtWidgets.QPushButton(self.theme.qicon(u"help"),
u"")
self.button_help.setToolTip(
_(u"Tell me more about the %s item") % self.item_type)
self.button_help.setIconSize(QtCore.QSize(16, 16))
self.button_help.clicked.connect(self.open_help_tab)
self.header_hbox.addWidget(self.button_help)
self.header_widget = QtWidgets.QWidget()
self.header_widget.setLayout(self.header_hbox)
# The edit_grid is the layout that contains the actual controls for the
# items.
self.edit_grid = QtWidgets.QFormLayout()
if self.label_align == u'right':
self.edit_grid.setLabelAlignment(QtCore.Qt.AlignRight)
self.edit_grid.setFieldGrowthPolicy(
QtWidgets.QFormLayout.FieldsStayAtSizeHint)
self.edit_grid.setContentsMargins(0, 0, 0, 0)
self.edit_grid.setVerticalSpacing(6)
self.edit_grid.setHorizontalSpacing(12)
self.edit_grid_widget = QtWidgets.QWidget()
self.edit_grid_widget.setLayout(self.edit_grid)
# The edit_vbox contains the edit_grid and the header widget
self.edit_vbox = QtWidgets.QVBoxLayout()
self.edit_vbox.addWidget(self.edit_grid_widget)
self.edit_vbox.setContentsMargins(0, 0, 0, 0)
self.edit_vbox.setSpacing(12)
if stretch:
self.edit_vbox.addStretch()
self._edit_widget = QtWidgets.QWidget()
self._edit_widget.setWindowIcon(self.theme.qicon(self.item_type))
self._edit_widget.setLayout(self.edit_vbox)
# The _script_widget contains the script editor
from QProgEdit import QTabManager
self._script_widget = QTabManager(
handlerButtonText=_(u'Apply and close'), cfg=cfg)
self._script_widget.focusLost.connect(self.apply_script_changes)
self._script_widget.cursorRowChanged.connect(self.apply_script_changes)
self._script_widget.handlerButtonClicked.connect(
self.apply_script_changes_and_switch_view)
self._script_widget.addTab(u'Script').setLang(u'OpenSesame')
# The container_widget is the top-level widget that is actually inserted
# into the tab widget.
self.splitter = qtitem_splitter(self)
if self.initial_view == u'controls':
self.set_view_controls()
elif self.initial_view == u'script':
self.set_view_script()
elif self.initial_view == u'split':
self.set_view_split()
else:
debug.msg(u'Invalid initial_view: %s' % self.initial_view,
reason=u'warning')
self.set_view_controls()
self.splitter.splitterMoved.connect(self.splitter_moved)
self.container_vbox = QtWidgets.QVBoxLayout()
self.container_vbox.setContentsMargins(12, 12, 12, 12)
self.container_vbox.setSpacing(18)
self.container_vbox.addWidget(self.header_widget)
self.container_vbox.addWidget(self.splitter)
self.container_widget = QtWidgets.QWidget()
self.container_widget.setLayout(self.container_vbox)
self.container_widget.on_activate = self.show_tab
self.container_widget.__item__ = self.name
def splitter_moved(self, pos, index):
"""
desc:
Is called when the splitter handle is manually moved.
arguments:
pos:
desc: The splitter-handle position.
type: int
index:
desc: The index of the splitter handle. Since there is only
one handle, this is always 0.
type: int
"""
sizes = self.splitter.sizes()
self.edit_size = sizes[0]
self.script_size = sizes[1]
if self.script_size == 0:
self.button_view.set_view_icon(u'controls')
elif self.edit_size == 0:
self.button_view.set_view_icon(u'script')
else:
self.button_view.set_view_icon(u'split')
def set_view_controls(self):
"""
desc:
Puts the splitter in control view.
"""
self.splitter.setSizes([self.splitter.width(), 0])
self.button_view.set_view_icon(u'controls')
def set_view_script(self):
"""
desc:
Puts the splitter in script view.
"""
self.splitter.setSizes([0, self.splitter.width()])
self.button_view.set_view_icon(u'script')
def set_view_split(self):
"""
desc:
Puts the splitter in split view.
"""
self.splitter.setSizes(
[self.splitter.width() / 2,
self.splitter.width() / 2])
self.button_view.set_view_icon(u'split')
def update(self):
"""
desc:
Updates both the script and the controls.
"""
# Items are updated when their tab is shown, so we don't need to update
# them if they aren't shown.
if self.tabwidget.current_item() != self.name:
return
self.update_script()
self.edit_widget()
def update_script(self):
"""
desc:
Regenerates the script and updates the script widget.
"""
# Normally, the script starts with a 'define' line and is indented by
# a tab. We want to undo this, and present only unindented content.
import textwrap
script = self.to_string()
script = script[script.find(u'\t'):]
script = textwrap.dedent(script)
if self._script_widget.text() != script:
self.main_window.set_unsaved()
self._script_widget.setText(script)
self.extension_manager.fire(u'change_item', name=self.name)
def edit_widget(self, *deprecated, **_deprecated):
"""
desc:
This function updates the controls based on the item state.
"""
self.auto_edit_widget()
self.header.refresh()
def apply_edit_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the graphical controls.
"""
self.auto_apply_edit_changes()
self.update_script()
return True
def apply_script_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script.
"""
if not self.validate_script():
return
new_script = self._script_widget.text()
old_script = self.to_string()
self.from_string(new_script)
if old_script != new_script:
self.main_window.set_unsaved()
self.edit_widget()
def apply_script_changes_and_switch_view(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script if possible. If so, switches to the
controls view.
"""
if self.validate_script():
self.set_view_controls()
def validate_script(self):
"""
desc:
Checks whether the script is syntactically valid. If not, the
offending line is highlighted if QProgEdit suppors setInvalid().
returns:
type: bool
"""
script = self._script_widget.text()
# First create a dummy item to see if the string can be parsed.
try:
self.validator(self.name, self.experiment, script)
return True
except Exception as e:
# If an error occurs, we first parse the first line, then the first
# and second, and so on, until we find the error.
l = script.split(u'\n')
for line_nr, line in enumerate(l):
test_script = u'\n'.join(l[:line_nr])
try:
self.validator(self.name, self.experiment, test_script)
except Exception as e_:
if not isinstance(e_, osexception):
e_ = osexception(e_)
if hasattr(self._script_widget, u'setInvalid'):
self._script_widget.setInvalid(line_nr, e_.markdown())
break
self.console.write(e)
return False
def set_validator(self):
"""
desc:
Sets the validator class, that is, the class that is used to parse
scripts to see if they are syntactically correct. Currently, we use
the class that defines from_string().
"""
import inspect
meth = self.from_string
for cls in inspect.getmro(self.__class__):
if meth.__name__ in cls.__dict__:
break
debug.msg(u'validator: %s' % cls)
self.validator = cls
def rename(self, from_name, to_name):
"""
desc:
Handles renaming of an item (not necesarrily the current item).
arguments:
from_name:
desc: The old item name.
type: unicode
to_name:
desc: The new item name
type: unicode
"""
if self.name != from_name:
return
self.name = to_name
self.container_widget.__item__ = self.name
self.header.set_name(to_name)
index = self.tabwidget.indexOf(self.widget())
if index is not None:
self.tabwidget.setTabText(index, to_name)
def open_help_tab(self):
"""
desc:
Opens a help tab.
"""
if self.help_url is None:
self.tabwidget.open_help(self.item_type)
else:
self.tabwidget.open_osdoc(self.help_url)
def toggle_maximize(self):
"""
desc:
Toggles edit-widget maximization.
"""
if not self.maximized:
# Always ignore close events. This is necessary, because otherwise
# the pop-out widget can be closed without re-enabling the main
# window.
self.main_window.block_close_event = True
self.container_widget.closeEvent = lambda e: e.ignore()
self.container_widget.setParent(None)
self.container_widget.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint|\
QtCore.Qt.WindowMaximizeButtonHint|\
QtCore.Qt.CustomizeWindowHint)
self.container_widget.showMaximized()
self.container_widget.show()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-restore'))
else:
self.main_window.block_close_event = False
self.container_widget.setParent(self.main_window)
self.open_tab()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-fullscreen'))
self.maximized = not self.maximized
self.button_help.setDisabled(self.maximized)
self.main_window.setDisabled(self.maximized)
def delete(self, item_name, item_parent=None, index=None):
"""
desc:
Is called when an item is deleted (not necessarily the current one).
arguments:
item_name:
desc: The name of the item to be deleted.
type: str
keywords:
item_parent:
desc: The name of the parent item.
type: str
index:
desc: The index of the item in the parent.
type: int
"""
pass
def build_item_tree(self,
toplevel=None,
items=[],
max_depth=-1,
extra_info=None):
"""
desc:
Constructs an item tree.
keywords:
toplevel:
desc: The toplevel widget.
type: tree_base_item
items:
desc: A list of item names that have already been added, to
prevent recursion.
tyep: list
returns:
type: tree_item_item
"""
widget = tree_item_item(self, extra_info=extra_info)
items.append(self.name)
if toplevel is not None:
toplevel.addChild(widget)
return widget
def parents(self):
"""
returns:
desc: A list of all parents (names) of the current item.
type: list
"""
l = [self.name]
for item in self.experiment.items:
if self.experiment.items[item].is_child_item(self.name):
l.append(item)
return l
def get_ready(self):
"""
desc:
This function should be overridden to do any last-minute stuff that
and item should do before an experiment is actually run, such as
applying pending script changes.
returns:
desc: True if some action has been taken, False if nothing was
done.
type: bool
"""
return False
def auto_edit_widget(self):
"""
desc:
Updates the GUI controls based on the auto-widgets.
"""
for var, edit in self.auto_line_edit.items():
if isinstance(var, int):
continue
if var in self.var:
val = safe_decode(self.var.get(var, _eval=False))
else:
val = u''
if val != edit.text():
edit.setText(val)
for var, combobox in self.auto_combobox.items():
if isinstance(var, int):
continue
val = self.var.get(var, _eval=False, default=u'')
i = combobox.findText(safe_decode(val))
# Set the combobox to the select item
if i >= 0:
if i != combobox.currentIndex() or not combobox.isEnabled():
combobox.setDisabled(False)
combobox.setCurrentIndex(i)
# If no value was specified, set the combobox to a blank item
elif val == u'':
if combobox.currentIndex() >= 0 or not combobox.isEnabled():
combobox.setDisabled(False)
combobox.setCurrentIndex(-1)
# If an unknown value has been specified, notify the user
else:
if combobox.isEnabled():
combobox.setDisabled(True)
self.extension_manager.fire(
u'notify',
message=_(
u'"%s" is set to a variable or '
u'unknown value and can only be edited through '
u'the script.') % var,
category=u'info')
for var, spinbox in list(self.auto_spinbox.items()) \
+ list(self.auto_slider.items()):
if isinstance(var, int):
continue
if var in self.var:
val = self.var.get(var, _eval=False)
if type(val) in (float, int):
if spinbox.value() == val and spinbox.isEnabled():
continue
spinbox.setDisabled(False)
try:
spinbox.setValue(val)
except Exception as e:
self.experiment.notify(
_(u"Failed to set control '%s': %s") % (var, e))
else:
if not spinbox.isEnabled():
continue
spinbox.setDisabled(True)
self.extension_manager.fire(
u'notify',
message=_(
u'"%s" is defined using '
'variables and can only be edited through the '
'script.') % var,
category=u'info')
for var, checkbox in self.auto_checkbox.items():
if isinstance(var, int):
continue
if var in self.var:
val = self.var.get(var, _eval=False)
if val in [u'yes', u'no']:
checkbox.setDisabled(False)
checked = val == u'yes'
if checked != checkbox.isChecked():
checkbox.setChecked(checked)
else:
checkbox.setDisabled(True)
self.extension_manager.fire(
u'notify',
message=
_(u'"%s" is defined using '
u'variables or has an invalid value, and can only be '
u'edited through the script.') % var,
category=u'info')
for var, qprogedit in self.auto_editor.items():
if isinstance(var, int):
continue
if var in self.var:
val = safe_decode(self.var.get(var, _eval=False))
if val != qprogedit.text():
qprogedit.setText(val)
def auto_apply_edit_changes(self, rebuild=True):
"""
desc:
Applies the auto-widget controls.
keywords:
rebuild: Deprecated (does nothing).
"""
for var, edit in self.auto_line_edit.items():
if isinstance(var, int):
continue
if edit.isEnabled() and isinstance(var, basestring):
val = str(edit.text()).strip()
if val != u'':
self.var.set(var, val)
continue
# If no text was entered, we use a default if available ...
if hasattr(edit, u'default'):
self.var.set(var, edit.default)
continue
# ... or unset the variable if no default is available.
self.var.unset(var)
for var, combobox in self.auto_combobox.items():
if isinstance(var, int):
continue
if combobox.isEnabled() and isinstance(var, basestring):
self.var.set(var, str(combobox.currentText()))
for var, spinbox in self.auto_spinbox.items():
if isinstance(var, int):
continue
if spinbox.isEnabled() and isinstance(var, basestring):
self.var.set(var, spinbox.value())
for var, slider in self.auto_slider.items():
if isinstance(var, int):
continue
if slider.isEnabled() and isinstance(var, basestring):
self.var.set(var, slider.value())
for var, checkbox in self.auto_checkbox.items():
if isinstance(var, int):
continue
if checkbox.isEnabled() and isinstance(var, basestring):
if checkbox.isChecked():
val = u"yes"
else:
val = u"no"
self.var.set(var, val)
for var, qprogedit in self.auto_editor.items():
if isinstance(var, int):
continue
if isinstance(var, basestring):
self.var.set(var, qprogedit.text())
return True
def auto_add_widget(self, widget, var=None, apply_func=None):
"""
desc:
Adds a widget to the list of auto-widgets.
arguments:
widget:
type: QWidget
keywords:
var: The name of the experimental variable to be linked to the
widget, or None to use an automatically chosen name.
type: [str, NoneType]
"""
# Use the object id as a fallback name
if var is None:
var = id(widget)
if apply_func is None:
apply_func = self.apply_edit_changes
debug.msg(var)
self.set_focus_widget(widget)
if isinstance(widget, QtWidgets.QSpinBox) or isinstance(
widget, QtWidgets.QDoubleSpinBox):
widget.editingFinished.connect(apply_func)
self.auto_spinbox[var] = widget
elif isinstance(widget, QtWidgets.QComboBox):
widget.activated.connect(apply_func)
self.auto_combobox[var] = widget
elif isinstance(widget, QtWidgets.QSlider) \
or isinstance(widget, QtWidgets.QDial):
widget.valueChanged.connect(apply_func)
self.auto_slider[var] = widget
elif isinstance(widget, QtWidgets.QLineEdit) or isinstance(
widget, pool_select):
widget.editingFinished.connect(apply_func)
self.auto_line_edit[var] = widget
elif isinstance(widget, QtWidgets.QCheckBox):
widget.clicked.connect(apply_func)
self.auto_checkbox[var] = widget
else:
raise Exception(u"Cannot auto-add widget of type %s" % widget)
def children(self):
"""
returns:
desc: A list of children, including grand children, and so on.
type: list
"""
return []
def is_child_item(self, item_name):
"""
desc:
Checks if an item is somewhere downstream from the current item
in the experimental hierarchy.
arguments:
item_name:
desc: The name of the child item.
type: unicode
returns:
desc: True if the current item is offspring of the item, False
otherwise.
type: bool
"""
return False
def insert_child_item(self, item_name, index=0):
"""
desc:
Inserts a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item.
type: int
"""
pass
def remove_child_item(self, item_name, index=0):
"""
desc:
Removes a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item, if applicable. A negative
value indicates all instances.
type: int
"""
pass
class qtitem(QtCore.QObject):
"""Base class for the GUI controls of other items"""
initial_view = u'controls'
def __init__(self):
"""Constructor"""
QtCore.QObject.__init__(self)
# The auto-widgets are stored in name -> (var, widget) dictionaries
self.auto_line_edit = {}
self.auto_combobox = {}
self.auto_spinbox = {}
self.auto_slider = {}
self.auto_editor = {}
self.auto_checkbox = {}
self.init_edit_widget()
self.lock = False
self.maximized = False
debug.msg(u'created %s' % self.name)
@property
def main_window(self):
return self.experiment.main_window
@property
def theme(self):
return self.experiment.main_window.theme
@property
def tabwidget(self):
return self.experiment.main_window.tabwidget
def open_tab(self, select_in_tree=True):
"""
desc:
Opens the tab if it wasn't yet open, and switches to it.
"""
self.tabwidget.add(self.widget(), self.item_icon(), self.name)
if select_in_tree:
self.experiment.main_window.ui.itemtree.select_item(self.name)
def close_tab(self):
"""
desc:
Closes the tab if it was open.
"""
self.tabwidget.remove(self.widget())
def set_focus(self):
"""
desc:
Gives focus to the most important widget.
"""
if hasattr(self, u'focus_widget') and self.focus_widget != None:
self.focus_widget.setFocus()
def set_focus_widget(self, widget, override=False):
"""
desc:
Sets the widget that receives focus when the tab is opened.
arguments:
widget:
desc: The widget to receive focus or `None` to reset.
type: [QWidget, NoneType]
keywords:
override:
desc: Indicates whether the focus widget should be changed if
there already is a focus widget.
type: bool
"""
if override or not hasattr(
self, u'focus_widget') or self.focus_widget == None:
self.focus_widget = widget
def update_item_icon(self):
"""
desc:
Updates the item icon.
"""
self.tabwidget.set_icon(self.widget(), self.item_icon())
self.experiment.items.set_icon(self.name, self.item_icon())
self.header_item_icon.setPixmap(
self.theme.qpixmap(self.item_icon(), 32))
def item_icon(self):
"""
returns:
desc: The name of the item icon.
type: unicode
"""
return self.item_type
def show_tab(self):
"""
desc:
Is called when the tab becomes visible, and updated the contents.
"""
self.update_script()
self.edit_widget()
self.set_focus()
def widget(self):
"""
returns:
desc: The widget that is added to the tabwidget.
type: QWidget
"""
return self.container_widget
def init_edit_widget(self, stretch=True):
"""
desc:
Builds the UI.
keywords:
stretch:
desc: Indicates whether a vertical stretch should be added to
the bottom of the controls. This is necessary if the
controls don't expand.
type: bool
"""
# Header widget
self.header = header_widget.header_widget(self)
self.user_hint_widget = user_hint_widget.user_hint_widget(
self.experiment.main_window, self)
self.header_hbox = QtGui.QHBoxLayout()
self.header_item_icon = self.experiment.label_image(self.item_icon())
self.header_hbox.addWidget(self.header_item_icon)
self.header_hbox.addWidget(self.header)
self.header_hbox.setContentsMargins(0, 5, 0, 10)
# Maximize button
self.button_toggle_maximize = QtGui.QPushButton(
self.theme.qicon(u'view-fullscreen'), u'')
self.button_toggle_maximize.setToolTip(_(u'Toggle pop-out'))
self.button_toggle_maximize.setIconSize(QtCore.QSize(16, 16))
self.button_toggle_maximize.clicked.connect(self.toggle_maximize)
self.header_hbox.addWidget(self.button_toggle_maximize)
# View button
self.button_view = item_view_button(self)
self.header_hbox.addWidget(self.button_view)
# Help button
self.button_help = QtGui.QPushButton(self.experiment.icon(u"help"),
u"")
self.button_help.setToolTip(
_(u"Tell me more about the %s item") % self.item_type)
self.button_help.setIconSize(QtCore.QSize(16, 16))
self.button_help.clicked.connect(self.open_help_tab)
self.header_hbox.addWidget(self.button_help)
self.header_widget = QtGui.QWidget()
self.header_widget.setLayout(self.header_hbox)
# The edit_grid is the layout that contains the actual controls for the
# items.
self.edit_grid = QtGui.QGridLayout()
self.edit_grid.setColumnStretch(2, 2)
self.edit_grid_widget = QtGui.QWidget()
self.edit_grid.setMargin(0)
self.edit_grid_widget.setLayout(self.edit_grid)
# The edit_vbox contains the edit_grid and the header widget
self.edit_vbox = QtGui.QVBoxLayout()
self.edit_vbox.setMargin(5)
self.edit_vbox.addWidget(self.user_hint_widget)
self.edit_vbox.addWidget(self.edit_grid_widget)
if stretch:
self.edit_vbox.addStretch()
self._edit_widget = QtGui.QWidget()
self._edit_widget.setWindowIcon(self.experiment.icon(self.item_type))
self._edit_widget.setLayout(self.edit_vbox)
# The _script_widget contains the script editor
from QProgEdit import QTabManager
self._script_widget = QTabManager(
handlerButtonText=_(u'Apply and close'), cfg=cfg)
self._script_widget.focusLost.connect(self.apply_script_changes)
self._script_widget.handlerButtonClicked.connect(
self.set_view_controls)
self._script_widget.addTab(u'Script').setLang(u'OpenSesame')
# The container_widget is the top-level widget that is actually inserted
# into the tab widget.
self.splitter = qtitem_splitter(self)
if self.initial_view == u'controls':
self.set_view_controls()
elif self.initial_view == u'script':
self.set_view_script()
elif self.initial_view == u'split':
self.set_view_split()
else:
debug.msg(u'Invalid initial_view: %s' % self.initial_view,
reason=u'warning')
self.set_view_controls()
self.splitter.splitterMoved.connect(self.splitter_moved)
self.container_vbox = QtGui.QVBoxLayout()
self.container_vbox.addWidget(self.header_widget)
self.container_vbox.addWidget(self.splitter)
self.container_widget = QtGui.QWidget()
self.container_widget.setLayout(self.container_vbox)
self.container_widget.on_activate = self.show_tab
self.container_widget.__item__ = self.name
def splitter_moved(self, pos, index):
"""
desc:
Is called when the splitter handle is manually moved.
arguments:
pos:
desc: The splitter-handle position.
type: int
index:
desc: The index of the splitter handle. Since there is only
one handle, this is always 0.
type: int
"""
sizes = self.splitter.sizes()
self.edit_size = sizes[0]
self.script_size = sizes[1]
if self.script_size == 0:
self.button_view.set_view_icon(u'controls')
elif self.edit_size == 0:
self.button_view.set_view_icon(u'script')
else:
self.button_view.set_view_icon(u'split')
def set_view_controls(self):
"""
desc:
Puts the splitter in control view.
"""
self.splitter.setSizes([self.splitter.width(), 0])
self.button_view.set_view_icon(u'controls')
def set_view_script(self):
"""
desc:
Puts the splitter in script view.
"""
self.splitter.setSizes([0, self.splitter.width()])
self.button_view.set_view_icon(u'script')
def set_view_split(self):
"""
desc:
Puts the splitter in split view.
"""
self.splitter.setSizes(
[self.splitter.width() / 2,
self.splitter.width() / 2])
self.button_view.set_view_icon(u'split')
def update(self):
"""
desc:
Updates both the script and the controls.
"""
self.update_script()
self.edit_widget()
def update_script(self):
"""
desc:
Regenerates the script and updates the script widget.
"""
# Normally, the script starts with a 'define' line and is indented by
# a tab. We want to undo this, and present only unindented content.
import textwrap
script = self.to_string()
script = script[script.find(u'\t'):]
script = textwrap.dedent(script)
self._script_widget.setText(script)
def edit_widget(self, *deprecated, **_deprecated):
"""
desc:
This function updates the controls based on the item state.
"""
debug.msg()
self.auto_edit_widget()
self.header.refresh()
def apply_edit_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the graphical controls.
"""
debug.msg()
self.auto_apply_edit_changes()
self.update_script()
self.main_window.set_unsaved(True)
return True
def apply_script_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script, by re-parsing the item from string.
"""
debug.msg()
old_script = self.to_string()
new_script = self._script_widget.text()
try:
self.from_string(new_script)
except osexception as e:
self.experiment.notify(e.html())
self.main_window.print_debug_window(e)
self.from_string(old_script)
self.edit_widget()
self.main_window.set_unsaved(True)
def rename(self, from_name, to_name):
"""
desc:
Handles renaming of an item (not necesarrily the current item).
arguments:
from_name:
desc: The old item name.
type: unicode
to_name:
desc: The new item name
type: unicode
"""
if self.name != from_name:
return
self.name = to_name
self.container_widget.__item__ = self.name
self.header.set_name(to_name)
index = self.tabwidget.indexOf(self.widget())
if index != None:
self.tabwidget.setTabText(index, to_name)
def open_help_tab(self):
"""
desc:
Opens a help tab.
"""
self.experiment.main_window.ui.tabwidget.open_help(self.item_type)
def toggle_maximize(self):
"""
desc:
Toggles edit-widget maximization.
"""
if not self.maximized:
# Always ignore close events. This is necessary, because otherwise
# the pop-out widget can be closed without re-enabling the main
# window.
self.container_widget.closeEvent = lambda e: e.ignore()
self.container_widget.setParent(None)
self.container_widget.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint|\
QtCore.Qt.WindowMaximizeButtonHint|\
QtCore.Qt.CustomizeWindowHint)
self.container_widget.showMaximized()
self.container_widget.show()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-restore'))
else:
self.container_widget.setParent(self.main_window)
self.open_tab()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-fullscreen'))
self.maximized = not self.maximized
self.user_hint_widget.disable(self.maximized)
self.button_help.setDisabled(self.maximized)
self.main_window.setDisabled(self.maximized)
def delete(self, item_name, item_parent=None, index=None):
"""
Delete an item (not necessarily the current one)
Arguments:
item_name -- the name of the item to be deleted
Keywords arguments:
item_parent -- the parent item (default=None)
index -- the index of the item in the parent (default=None)
"""
pass
def build_item_tree(self,
toplevel=None,
items=[],
max_depth=-1,
extra_info=None):
"""
Construct an item tree
Keyword arguments:
toplevel -- the toplevel widget (default = None)
items -- a list of items that have been added, to prevent recursion
(default=[])
"""
widget = tree_item_item(self, extra_info=extra_info)
items.append(self.name)
if toplevel != None:
toplevel.addChild(widget)
return widget
def parents(self):
"""
Creates a list of all the items that the current sequences is connected
to upstream
Returns:
A list of item names
"""
l = [self.name]
for item in self.experiment.items:
if self.experiment.items[item].is_child_item(self.name):
l.append(item)
return l
def variable_vars(self, exclude=[]):
"""
Determines if one of the variables of the current item is defined in
terms of another variable
Keywords arguments:
exclude -- a list of variables that should not be checked
Returns:
True if there are variably defined variables, False otherwise
"""
for var in self.variables:
if var not in exclude:
val = self.variables[var]
if self.experiment.varref(val):
return True
return False
def get_ready(self):
"""
This function should be overridden to do any last-minute stuff that
and item should do before an experiment is actually run, such as
applying pending script changes.
Returns:
True if some action has been taken, False if nothing was done
"""
return False
def auto_edit_widget(self):
"""Update the GUI controls based on the auto-widgets"""
debug.msg()
for var, edit in self.auto_line_edit.iteritems():
if self.has(var):
edit.setText(self.unistr(self.get(var, _eval=False)))
else:
edit.setText(u'')
for var, combobox in self.auto_combobox.iteritems():
val = self.get_check(var, _eval=False, default=u'')
i = combobox.findText(self.unistr(val))
# Set the combobox to the select item
if i >= 0:
combobox.setDisabled(False)
combobox.setCurrentIndex(i)
# If no value was specified, set the combobox to a blank item
elif val == u'':
combobox.setDisabled(False)
combobox.setCurrentIndex(-1)
# If an unknown value has been specified, notify the user
else:
combobox.setDisabled(True)
self.user_hint_widget.add(
_(u'"%s" is set to a '
u'variable or unknown value and can only be edited through '
u'the script.' % var))
for var, spinbox in self.auto_spinbox.iteritems():
if self.has(var):
val = self.get(var, _eval=False)
if type(val) in (float, int):
spinbox.setDisabled(False)
try:
spinbox.setValue(val)
except Exception as e:
self.experiment.notify(_( \
u"Failed to set control '%s': %s") % (var, e))
else:
spinbox.setDisabled(True)
self.user_hint_widget.add(_( \
u'"%s" is defined using variables and can only be edited through the script.' \
% var))
for var, slider in self.auto_slider.iteritems():
if self.has(var):
val = self.get(var, _eval=False)
if type(val) in (float, int):
slider.setDisabled(False)
try:
slider.setValue(val)
except Exception as e:
self.experiment.notify(_( \
u"Failed to set control '%s': %s") % (var, e))
else:
slider.setDisabled(True)
self.user_hint_widget.add(_( \
u'"%s" is defined using variables and can only be edited through the script.' \
% var))
for var, checkbox in self.auto_checkbox.iteritems():
if self.has(var):
try:
checkbox.setChecked(self.get(var, _eval=False) == u"yes")
except Exception as e:
self.experiment.notify(_(u"Failed to set control '%s': %s") \
% (var, e))
for var, qprogedit in self.auto_editor.iteritems():
if self.has(var):
try:
qprogedit.setText(self.unistr(self.get(var, _eval=False)))
except Exception as e:
self.experiment.notify(_(u"Failed to set control '%s': %s") \
% (var, e))
def sanitize_check(self, s, strict=False, allow_vars=True, notify=True):
"""
Checks whether a string is sane (i.e. unchanged by sanitize()) and
optionally presents a warning.
Arguments:
s -- The string to check.
Keyword arguments:
strict -- See sanitize().
allow_vars -- See sanitize().
notify -- Indicates whether a notification should be presented if
the string is not sane.
Returns:
True if s is sane, False otherwise.
"""
sane = s == self.sanitize(s, strict=strict, allow_vars=allow_vars)
if not sane and notify:
if strict:
self.experiment.notify(
_(u'All non-alphanumeric characters except underscores have been stripped'
))
else:
self.experiment.notify(
_(u'The following characters are not allowed and have been stripped: double-quote ("), backslash (\), and newline'
))
return sane
def auto_apply_edit_changes(self, rebuild=True):
"""
Apply the auto-widget controls
Keyword arguments:
rebuild -- deprecated (does nothing) (default=True)
"""
debug.msg()
for var, edit in self.auto_line_edit.iteritems():
if edit.isEnabled() and isinstance(var, basestring):
val = unicode(edit.text()).strip()
if val != u"":
self.set(var, val)
# If the variable has no value, we assign a default value if it
# has been specified, and unset it otherwise.
elif hasattr(edit, u"default"):
self.set(var, edit.default)
else:
self.unset(var)
for var, combobox in self.auto_combobox.iteritems():
if combobox.isEnabled() and isinstance(var, basestring):
self.set(var, unicode(combobox.currentText()))
for var, spinbox in self.auto_spinbox.iteritems():
if spinbox.isEnabled() and isinstance(var, basestring):
self.set(var, spinbox.value())
for var, slider in self.auto_slider.iteritems():
if slider.isEnabled() and isinstance(var, basestring):
self.set(var, slider.value())
for var, checkbox in self.auto_checkbox.iteritems():
if checkbox.isEnabled() and isinstance(var, basestring):
if checkbox.isChecked():
val = u"yes"
else:
val = u"no"
self.set(var, val)
for var, qprogedit in self.auto_editor.iteritems():
if isinstance(var, basestring):
self.set(var, qprogedit.text())
return True
def auto_add_widget(self, widget, var=None):
"""
Add a widget to the list of auto-widgets
Arguments:
widget -- a QWidget
Keyword arguments:
var -- the variable to be linked to the widget (default=None)
"""
# Use the object id as a fallback name
if var == None:
var = id(widget)
debug.msg(var)
self.set_focus_widget(widget)
if isinstance(widget, QtGui.QSpinBox) or isinstance(
widget, QtGui.QDoubleSpinBox):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_spinbox[var] = widget
elif isinstance(widget, QtGui.QComboBox):
widget.activated.connect(self.apply_edit_changes)
self.auto_combobox[var] = widget
elif isinstance(widget, QtGui.QSlider):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_slider[var] = widget
elif isinstance(widget, QtGui.QLineEdit):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_line_edit[var] = widget
elif isinstance(widget, QtGui.QCheckBox):
widget.clicked.connect(self.apply_edit_changes)
self.auto_checkbox[var] = widget
else:
raise Exception(u"Cannot auto-add widget of type %s" % widget)
def clean_cond(self, cond, default=u'always'):
"""
Cleans a conditional statement. May raise a dialog box if problems are
encountered.
Arguments:
cond -- A (potentially filthy) conditional statement.
Keyword arguments:
default -- A default value to use for empty
Returns:
cond -- A clean conditional statement conditional statements.
(default=u'always')
"""
cond = self.unistr(cond)
if not self.sanitize_check(cond):
cond = self.sanitize(cond)
if cond.strip() == u'':
cond = default
try:
self.compile_cond(cond)
except osexception as e:
self.experiment.notify( \
u'Failed to compile conditional statement "%s": %s' % (cond, e))
return default
return cond
def children(self):
"""
returns:
desc: A list of children, including grand children, and so on.
type: list
"""
return []
def is_child_item(self, item_name):
"""
desc:
Checks if an item is somewhere downstream from the current item
in the experimental hierarchy.
arguments:
item_name:
desc: The name of the child item.
type: unicode
returns:
desc: True if the current item is offspring of the item, False
otherwise.
type: bool
"""
return False
def insert_child_item(self, item_name, index=0):
"""
desc:
Inserts a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item.
type: int
"""
pass
def remove_child_item(self, item_name, index=0):
"""
desc:
Removes a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item, if applicable. A negative
value indicates all instances.
type: int
"""
pass
class qtitem(QtCore.QObject):
"""Base class for the GUI controls of other items"""
initial_view = u'controls'
def __init__(self):
"""Constructor"""
QtCore.QObject.__init__(self)
# The auto-widgets are stored in name -> (var, widget) dictionaries
self.auto_line_edit = {}
self.auto_combobox = {}
self.auto_spinbox = {}
self.auto_slider = {}
self.auto_editor = {}
self.auto_checkbox = {}
self.init_edit_widget()
self.lock = False
self.maximized = False
debug.msg(u'created %s' % self.name)
@property
def main_window(self):
return self.experiment.main_window
@property
def theme(self):
return self.experiment.main_window.theme
@property
def tabwidget(self):
return self.experiment.main_window.tabwidget
def open_tab(self, select_in_tree=True):
"""
desc:
Opens the tab if it wasn't yet open, and switches to it.
"""
self.tabwidget.add(self.widget(), self.item_icon(), self.name)
if select_in_tree:
self.experiment.main_window.ui.itemtree.select_item(self.name)
def close_tab(self):
"""
desc:
Closes the tab if it was open.
"""
self.tabwidget.remove(self.widget())
def set_focus(self):
"""
desc:
Gives focus to the most important widget.
"""
if hasattr(self, u'focus_widget') and self.focus_widget != None:
self.focus_widget.setFocus()
def set_focus_widget(self, widget, override=False):
"""
desc:
Sets the widget that receives focus when the tab is opened.
arguments:
widget:
desc: The widget to receive focus or `None` to reset.
type: [QWidget, NoneType]
keywords:
override:
desc: Indicates whether the focus widget should be changed if
there already is a focus widget.
type: bool
"""
if override or not hasattr(self, u'focus_widget') or self.focus_widget == None:
self.focus_widget = widget
def update_item_icon(self):
"""
desc:
Updates the item icon.
"""
self.tabwidget.set_icon(self.widget(), self.item_icon())
self.experiment.items.set_icon(self.name, self.item_icon())
self.header_item_icon.setPixmap(
self.theme.qpixmap(self.item_icon(), 32))
def item_icon(self):
"""
returns:
desc: The name of the item icon.
type: unicode
"""
return self.item_type
def show_tab(self):
"""
desc:
Is called when the tab becomes visible, and updated the contents.
"""
self.update_script()
self.edit_widget()
self.set_focus()
def widget(self):
"""
returns:
desc: The widget that is added to the tabwidget.
type: QWidget
"""
return self.container_widget
def init_edit_widget(self, stretch=True):
"""
desc:
Builds the UI.
keywords:
stretch:
desc: Indicates whether a vertical stretch should be added to
the bottom of the controls. This is necessary if the
controls don't expand.
type: bool
"""
# Header widget
self.header = header_widget.header_widget(self)
self.user_hint_widget = user_hint_widget.user_hint_widget(
self.experiment.main_window, self)
self.header_hbox = QtGui.QHBoxLayout()
self.header_item_icon = self.experiment.label_image(self.item_icon())
self.header_hbox.addWidget(self.header_item_icon)
self.header_hbox.addWidget(self.header)
self.header_hbox.setContentsMargins(0, 5, 0, 10)
# Maximize button
self.button_toggle_maximize = QtGui.QPushButton(
self.theme.qicon(u'view-fullscreen'), u'')
self.button_toggle_maximize.setToolTip(_(u'Toggle pop-out'))
self.button_toggle_maximize.setIconSize(QtCore.QSize(16, 16))
self.button_toggle_maximize.clicked.connect(self.toggle_maximize)
self.header_hbox.addWidget(self.button_toggle_maximize)
# View button
self.button_view = item_view_button(self)
self.header_hbox.addWidget(self.button_view)
# Help button
self.button_help = QtGui.QPushButton(self.experiment.icon(u"help"), u"")
self.button_help.setToolTip(
_(u"Tell me more about the %s item") % self.item_type)
self.button_help.setIconSize(QtCore.QSize(16, 16))
self.button_help.clicked.connect(self.open_help_tab)
self.header_hbox.addWidget(self.button_help)
self.header_widget = QtGui.QWidget()
self.header_widget.setLayout(self.header_hbox)
# The edit_grid is the layout that contains the actual controls for the
# items.
self.edit_grid = QtGui.QGridLayout()
self.edit_grid.setColumnStretch(2, 2)
self.edit_grid_widget = QtGui.QWidget()
self.edit_grid.setMargin(0)
self.edit_grid_widget.setLayout(self.edit_grid)
# The edit_vbox contains the edit_grid and the header widget
self.edit_vbox = QtGui.QVBoxLayout()
self.edit_vbox.setMargin(5)
self.edit_vbox.addWidget(self.user_hint_widget)
self.edit_vbox.addWidget(self.edit_grid_widget)
if stretch:
self.edit_vbox.addStretch()
self._edit_widget = QtGui.QWidget()
self._edit_widget.setWindowIcon(self.experiment.icon(self.item_type))
self._edit_widget.setLayout(self.edit_vbox)
# The _script_widget contains the script editor
from QProgEdit import QTabManager
self._script_widget = QTabManager(
handlerButtonText=_(u'Apply and close'), cfg=cfg)
self._script_widget.focusLost.connect(self.apply_script_changes)
self._script_widget.handlerButtonClicked.connect(self.set_view_controls)
self._script_widget.addTab(u'Script').setLang(u'OpenSesame')
# The container_widget is the top-level widget that is actually inserted
# into the tab widget.
self.splitter = qtitem_splitter(self)
if self.initial_view == u'controls':
self.set_view_controls()
elif self.initial_view == u'script':
self.set_view_script()
elif self.initial_view == u'split':
self.set_view_split()
else:
debug.msg(u'Invalid initial_view: %s' % self.initial_view,
reason=u'warning')
self.set_view_controls()
self.splitter.splitterMoved.connect(self.splitter_moved)
self.container_vbox = QtGui.QVBoxLayout()
self.container_vbox.addWidget(self.header_widget)
self.container_vbox.addWidget(self.splitter)
self.container_widget = QtGui.QWidget()
self.container_widget.setLayout(self.container_vbox)
self.container_widget.on_activate = self.show_tab
self.container_widget.__item__ = self.name
def splitter_moved(self, pos, index):
"""
desc:
Is called when the splitter handle is manually moved.
arguments:
pos:
desc: The splitter-handle position.
type: int
index:
desc: The index of the splitter handle. Since there is only
one handle, this is always 0.
type: int
"""
sizes = self.splitter.sizes()
self.edit_size = sizes[0]
self.script_size = sizes[1]
if self.script_size == 0:
self.button_view.set_view_icon(u'controls')
elif self.edit_size == 0:
self.button_view.set_view_icon(u'script')
else:
self.button_view.set_view_icon(u'split')
def set_view_controls(self):
"""
desc:
Puts the splitter in control view.
"""
self.splitter.setSizes([self.splitter.width(), 0])
self.button_view.set_view_icon(u'controls')
def set_view_script(self):
"""
desc:
Puts the splitter in script view.
"""
self.splitter.setSizes([0, self.splitter.width()])
self.button_view.set_view_icon(u'script')
def set_view_split(self):
"""
desc:
Puts the splitter in split view.
"""
self.splitter.setSizes([self.splitter.width()/2,
self.splitter.width()/2])
self.button_view.set_view_icon(u'split')
def update(self):
"""
desc:
Updates both the script and the controls.
"""
self.update_script()
self.edit_widget()
def update_script(self):
"""
desc:
Regenerates the script and updates the script widget.
"""
# Normally, the script starts with a 'define' line and is indented by
# a tab. We want to undo this, and present only unindented content.
import textwrap
script = self.to_string()
script = script[script.find(u'\t'):]
script = textwrap.dedent(script)
self._script_widget.setText(script)
def edit_widget(self, *deprecated, **_deprecated):
"""
desc:
This function updates the controls based on the item state.
"""
debug.msg()
self.auto_edit_widget()
self.header.refresh()
def apply_edit_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the graphical controls.
"""
debug.msg()
self.auto_apply_edit_changes()
self.update_script()
self.main_window.set_unsaved(True)
return True
def apply_script_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script, by re-parsing the item from string.
"""
debug.msg()
old_script = self.to_string()
new_script = self._script_widget.text()
try:
self.from_string(new_script)
except osexception as e:
self.experiment.notify(e.html())
self.main_window.print_debug_window(e)
self.from_string(old_script)
self.edit_widget()
self.main_window.set_unsaved(True)
def rename(self, from_name, to_name):
"""
desc:
Handles renaming of an item (not necesarrily the current item).
arguments:
from_name:
desc: The old item name.
type: unicode
to_name:
desc: The new item name
type: unicode
"""
if self.name != from_name:
return
self.name = to_name
self.container_widget.__item__ = self.name
self.header.set_name(to_name)
index = self.tabwidget.indexOf(self.widget())
if index != None:
self.tabwidget.setTabText(index, to_name)
def open_help_tab(self):
"""
desc:
Opens a help tab.
"""
self.experiment.main_window.ui.tabwidget.open_help(self.item_type)
def toggle_maximize(self):
"""
desc:
Toggles edit-widget maximization.
"""
if not self.maximized:
# Always ignore close events. This is necessary, because otherwise
# the pop-out widget can be closed without re-enabling the main
# window.
self.container_widget.closeEvent = lambda e: e.ignore()
self.container_widget.setParent(None)
self.container_widget.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint|\
QtCore.Qt.WindowMaximizeButtonHint|\
QtCore.Qt.CustomizeWindowHint)
self.container_widget.showMaximized()
self.container_widget.show()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-restore'))
else:
self.container_widget.setParent(self.main_window)
self.open_tab()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-fullscreen'))
self.maximized = not self.maximized
self.user_hint_widget.disable(self.maximized)
self.button_help.setDisabled(self.maximized)
self.main_window.setDisabled(self.maximized)
def delete(self, item_name, item_parent=None, index=None):
"""
Delete an item (not necessarily the current one)
Arguments:
item_name -- the name of the item to be deleted
Keywords arguments:
item_parent -- the parent item (default=None)
index -- the index of the item in the parent (default=None)
"""
pass
def build_item_tree(self, toplevel=None, items=[], max_depth=-1,
extra_info=None):
"""
Construct an item tree
Keyword arguments:
toplevel -- the toplevel widget (default = None)
items -- a list of items that have been added, to prevent recursion
(default=[])
"""
widget = tree_item_item(self, extra_info=extra_info)
items.append(self.name)
if toplevel != None:
toplevel.addChild(widget)
return widget
def parents(self):
"""
Creates a list of all the items that the current sequences is connected
to upstream
Returns:
A list of item names
"""
l = [self.name]
for item in self.experiment.items:
if self.experiment.items[item].is_child_item(self.name):
l.append(item)
return l
def variable_vars(self, exclude=[]):
"""
Determines if one of the variables of the current item is defined in
terms of another variable
Keywords arguments:
exclude -- a list of variables that should not be checked
Returns:
True if there are variably defined variables, False otherwise
"""
for var in self.variables:
if var not in exclude:
val = self.variables[var]
if self.experiment.varref(val):
return True
return False
def get_ready(self):
"""
This function should be overridden to do any last-minute stuff that
and item should do before an experiment is actually run, such as
applying pending script changes.
Returns:
True if some action has been taken, False if nothing was done
"""
return False
def auto_edit_widget(self):
"""Update the GUI controls based on the auto-widgets"""
debug.msg()
for var, edit in self.auto_line_edit.iteritems():
if self.has(var):
edit.setText(self.unistr(self.get(var, _eval=False)))
else:
edit.setText(u'')
for var, combobox in self.auto_combobox.iteritems():
val = self.get_check(var, _eval=False, default=u'')
i = combobox.findText(self.unistr(val))
# Set the combobox to the select item
if i >= 0:
combobox.setDisabled(False)
combobox.setCurrentIndex(i)
# If no value was specified, set the combobox to a blank item
elif val == u'':
combobox.setDisabled(False)
combobox.setCurrentIndex(-1)
# If an unknown value has been specified, notify the user
else:
combobox.setDisabled(True)
self.user_hint_widget.add(_(u'"%s" is set to a '
u'variable or unknown value and can only be edited through '
u'the script.' % var))
for var, spinbox in self.auto_spinbox.iteritems():
if self.has(var):
val = self.get(var, _eval=False)
if type(val) in (float, int):
spinbox.setDisabled(False)
try:
spinbox.setValue(val)
except Exception as e:
self.experiment.notify(_( \
u"Failed to set control '%s': %s") % (var, e))
else:
spinbox.setDisabled(True)
self.user_hint_widget.add(_( \
u'"%s" is defined using variables and can only be edited through the script.' \
% var))
for var, slider in self.auto_slider.iteritems():
if self.has(var):
val = self.get(var, _eval=False)
if type(val) in (float, int):
slider.setDisabled(False)
try:
slider.setValue(val)
except Exception as e:
self.experiment.notify(_( \
u"Failed to set control '%s': %s") % (var, e))
else:
slider.setDisabled(True)
self.user_hint_widget.add(_( \
u'"%s" is defined using variables and can only be edited through the script.' \
% var))
for var, checkbox in self.auto_checkbox.iteritems():
if self.has(var):
try:
checkbox.setChecked(self.get(var, _eval=False) == u"yes")
except Exception as e:
self.experiment.notify(_(u"Failed to set control '%s': %s") \
% (var, e))
for var, qprogedit in self.auto_editor.iteritems():
if self.has(var):
try:
qprogedit.setText(self.unistr(self.get(var, _eval=False)))
except Exception as e:
self.experiment.notify(_(u"Failed to set control '%s': %s") \
% (var, e))
def sanitize_check(self, s, strict=False, allow_vars=True, notify=True):
"""
Checks whether a string is sane (i.e. unchanged by sanitize()) and
optionally presents a warning.
Arguments:
s -- The string to check.
Keyword arguments:
strict -- See sanitize().
allow_vars -- See sanitize().
notify -- Indicates whether a notification should be presented if
the string is not sane.
Returns:
True if s is sane, False otherwise.
"""
sane = s == self.sanitize(s, strict=strict, allow_vars=allow_vars)
if not sane and notify:
if strict:
self.experiment.notify(
_(u'All non-alphanumeric characters except underscores have been stripped'))
else:
self.experiment.notify(
_(u'The following characters are not allowed and have been stripped: double-quote ("), backslash (\), and newline'))
return sane
def auto_apply_edit_changes(self, rebuild=True):
"""
Apply the auto-widget controls
Keyword arguments:
rebuild -- deprecated (does nothing) (default=True)
"""
debug.msg()
for var, edit in self.auto_line_edit.iteritems():
if edit.isEnabled() and isinstance(var, basestring):
val = unicode(edit.text()).strip()
if val != u"":
self.set(var, val)
# If the variable has no value, we assign a default value if it
# has been specified, and unset it otherwise.
elif hasattr(edit, u"default"):
self.set(var, edit.default)
else:
self.unset(var)
for var, combobox in self.auto_combobox.iteritems():
if combobox.isEnabled() and isinstance(var, basestring):
self.set(var, unicode(combobox.currentText()))
for var, spinbox in self.auto_spinbox.iteritems():
if spinbox.isEnabled() and isinstance(var, basestring):
self.set(var, spinbox.value())
for var, slider in self.auto_slider.iteritems():
if slider.isEnabled() and isinstance(var, basestring):
self.set(var, slider.value())
for var, checkbox in self.auto_checkbox.iteritems():
if checkbox.isEnabled() and isinstance(var, basestring):
if checkbox.isChecked():
val = u"yes"
else:
val = u"no"
self.set(var, val)
for var, qprogedit in self.auto_editor.iteritems():
if isinstance(var, basestring):
self.set(var, qprogedit.text())
return True
def auto_add_widget(self, widget, var=None):
"""
Add a widget to the list of auto-widgets
Arguments:
widget -- a QWidget
Keyword arguments:
var -- the variable to be linked to the widget (default=None)
"""
# Use the object id as a fallback name
if var == None:
var = id(widget)
debug.msg(var)
self.set_focus_widget(widget)
if isinstance(widget, QtGui.QSpinBox) or isinstance(widget,
QtGui.QDoubleSpinBox):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_spinbox[var] = widget
elif isinstance(widget, QtGui.QComboBox):
widget.activated.connect(self.apply_edit_changes)
self.auto_combobox[var] = widget
elif isinstance(widget, QtGui.QSlider):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_slider[var] = widget
elif isinstance(widget, QtGui.QLineEdit):
widget.editingFinished.connect(self.apply_edit_changes)
self.auto_line_edit[var] = widget
elif isinstance(widget, QtGui.QCheckBox):
widget.clicked.connect(self.apply_edit_changes)
self.auto_checkbox[var] = widget
else:
raise Exception(u"Cannot auto-add widget of type %s" % widget)
def clean_cond(self, cond, default=u'always'):
"""
Cleans a conditional statement. May raise a dialog box if problems are
encountered.
Arguments:
cond -- A (potentially filthy) conditional statement.
Keyword arguments:
default -- A default value to use for empty
Returns:
cond -- A clean conditional statement conditional statements.
(default=u'always')
"""
cond = self.unistr(cond)
if not self.sanitize_check(cond):
cond = self.sanitize(cond)
if cond.strip() == u'':
cond = default
try:
self.compile_cond(cond)
except osexception as e:
self.experiment.notify( \
u'Failed to compile conditional statement "%s": %s' % (cond, e))
return default
return cond
def children(self):
"""
returns:
desc: A list of children, including grand children, and so on.
type: list
"""
return []
def is_child_item(self, item_name):
"""
desc:
Checks if an item is somewhere downstream from the current item
in the experimental hierarchy.
arguments:
item_name:
desc: The name of the child item.
type: unicode
returns:
desc: True if the current item is offspring of the item, False
otherwise.
type: bool
"""
return False
def insert_child_item(self, item_name, index=0):
"""
desc:
Inserts a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item.
type: int
"""
pass
def remove_child_item(self, item_name, index=0):
"""
desc:
Removes a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item, if applicable. A negative
value indicates all instances.
type: int
"""
pass
class qtitem(base_qtobject):
"""Base class for the GUI controls of other items"""
initial_view = u'controls'
label_align = u'right'
help_url = None
lazy_init = False
def __init__(self):
"""Constructor"""
# The auto-widgets are stored in name -> (var, widget) dictionaries
self.auto_line_edit = {}
self.auto_combobox = {}
self.auto_spinbox = {}
self.auto_slider = {}
self.auto_editor = {}
self.auto_checkbox = {}
# Lazy initialization means that the control widgets are initialized
# only when they are shown for the first time. This dramatically speeds
# up opening of files. However, with some items this is not currently
# possible, because their widgets are also referred when they are not
# shown. Currently this means the inline_script.
if self.lazy_init:
self.container_widget = None
else:
self.init_edit_widget()
self.lock = False
self.maximized = False
self.set_validator()
debug.msg(u'created %s' % self.name)
@property
def main_window(self):
return self.experiment.main_window
@property
def overview_area(self):
return self.experiment.main_window.ui.itemtree
@property
def theme(self):
return self.experiment.main_window.theme
@property
def tabwidget(self):
return self.experiment.main_window.tabwidget
@property
def console(self):
return self.experiment.main_window.console
@property
def extension_manager(self):
return self.experiment.main_window.extension_manager
@property
def default_description(self):
return _(u'Default description')
def open_tab(self, select_in_tree=True):
"""
desc:
Opens the tab if it wasn't yet open, and switches to it.
"""
unsaved = self.main_window.unsaved_changes
self.tabwidget.add(self.widget(), self.item_icon(), self.name)
self.main_window.set_unsaved(unsaved)
if select_in_tree:
self.experiment.main_window.ui.itemtree.select_item(self.name)
def close_tab(self):
"""
desc:
Closes the tab if it was open.
"""
self.tabwidget.remove(self.widget())
def set_focus(self):
"""
desc:
Gives focus to the most important widget.
"""
if hasattr(self, u'focus_widget') and self.focus_widget is not None:
self.focus_widget.setFocus()
def set_focus_widget(self, widget, override=False):
"""
desc:
Sets the widget that receives focus when the tab is opened.
arguments:
widget:
desc: The widget to receive focus or `None` to reset.
type: [QWidget, NoneType]
keywords:
override:
desc: Indicates whether the focus widget should be changed if
there already is a focus widget.
type: bool
"""
if override or not hasattr(self, u'focus_widget') or self.focus_widget is None:
self.focus_widget = widget
def update_item_icon(self):
"""
desc:
Updates the item icon.
"""
self.tabwidget.set_icon(self.widget(), self.item_icon())
self.experiment.items.set_icon(self.name, self.item_icon())
self.header_item_icon.setPixmap(
self.theme.qpixmap(self.item_icon(), 32))
def item_icon(self):
"""
returns:
desc: The name of the item icon.
type: unicode
"""
return self.item_type
def show_tab(self):
"""
desc:
Is called when the tab becomes visible, and updated the contents.
"""
self.extension_manager.fire(u'prepare_open_item', name=self.name)
self.update_script()
self.edit_widget()
self.main_window.ui.itemtree.select_item(self.name, open_tab=False)
self.extension_manager.fire(u'open_item', name=self.name)
@requires_init
def widget(self):
"""
returns:
desc: The widget that is added to the tabwidget.
type: QWidget
"""
return self.container_widget
def init_edit_widget(self, stretch=True):
"""
desc:
Builds the UI.
keywords:
stretch:
desc: Indicates whether a vertical stretch should be added to
the bottom of the controls. This is necessary if the
controls don't expand.
type: bool
"""
# Header widget
self.header = header_widget.header_widget(self)
self.header_hbox = QtWidgets.QHBoxLayout()
self.header_item_icon = self.theme.qlabel(self.item_icon())
self.header_hbox.addWidget(self.header_item_icon)
self.header_hbox.addWidget(self.header)
self.header_hbox.setContentsMargins(0, 0, 0, 0)
self.header_hbox.setSpacing(12)
# Maximize button
self.button_toggle_maximize = QtWidgets.QPushButton(
self.theme.qicon(u'view-fullscreen'), u'')
self.button_toggle_maximize.setToolTip(_(u'Toggle pop-out'))
self.button_toggle_maximize.setIconSize(QtCore.QSize(16, 16))
self.button_toggle_maximize.clicked.connect(self.toggle_maximize)
self.header_hbox.addWidget(self.button_toggle_maximize)
# View button
self.button_view = item_view_button(self)
self.header_hbox.addWidget(self.button_view)
# Help button
self.button_help = QtWidgets.QPushButton(self.theme.qicon(u"help"), u"")
self.button_help.setToolTip(
_(u"Tell me more about the %s item") % self.item_type)
self.button_help.setIconSize(QtCore.QSize(16, 16))
self.button_help.clicked.connect(self.open_help_tab)
self.header_hbox.addWidget(self.button_help)
self.header_widget = QtWidgets.QWidget()
self.header_widget.setLayout(self.header_hbox)
# The edit_grid is the layout that contains the actual controls for the
# items.
self.edit_grid = QtWidgets.QFormLayout()
if self.label_align == u'right':
self.edit_grid.setLabelAlignment(QtCore.Qt.AlignRight)
self.edit_grid.setFieldGrowthPolicy(
QtWidgets.QFormLayout.FieldsStayAtSizeHint)
self.edit_grid.setContentsMargins(0, 0, 0, 0)
self.edit_grid.setVerticalSpacing(6)
self.edit_grid.setHorizontalSpacing(12)
self.edit_grid_widget = QtWidgets.QWidget()
self.edit_grid_widget.setLayout(self.edit_grid)
# The edit_vbox contains the edit_grid and the header widget
self.edit_vbox = QtWidgets.QVBoxLayout()
self.edit_vbox.addWidget(self.edit_grid_widget)
self.edit_vbox.setContentsMargins(0, 0, 0, 0)
self.edit_vbox.setSpacing(12)
if stretch:
self.edit_vbox.addStretch()
self._edit_widget = QtWidgets.QWidget()
self._edit_widget.setWindowIcon(self.theme.qicon(self.item_type))
self._edit_widget.setLayout(self.edit_vbox)
# The _script_widget contains the script editor
from QProgEdit import QTabManager
self._script_widget = QTabManager(
handlerButtonText=_(u'Apply and close'), cfg=cfg)
self._script_widget.focusLost.connect(self.apply_script_changes)
self._script_widget.cursorRowChanged.connect(self.apply_script_changes)
self._script_widget.handlerButtonClicked.connect(
self.apply_script_changes_and_switch_view)
self._script_widget.addTab(u'Script').setLang(u'OpenSesame')
# The container_widget is the top-level widget that is actually inserted
# into the tab widget.
self.splitter = qtitem_splitter(self)
if self.initial_view == u'controls':
self.set_view_controls()
elif self.initial_view == u'script':
self.set_view_script()
elif self.initial_view == u'split':
self.set_view_split()
else:
debug.msg(u'Invalid initial_view: %s' % self.initial_view,
reason=u'warning')
self.set_view_controls()
self.splitter.splitterMoved.connect(self.splitter_moved)
self.container_vbox = QtWidgets.QVBoxLayout()
self.container_vbox.setContentsMargins(12, 12, 12, 12)
self.container_vbox.setSpacing(18)
self.container_vbox.addWidget(self.header_widget)
self.container_vbox.addWidget(self.splitter)
self.container_widget = QtWidgets.QWidget()
self.container_widget.setLayout(self.container_vbox)
self.container_widget.on_activate = self.show_tab
self.container_widget.__item__ = self.name
def splitter_moved(self, pos, index):
"""
desc:
Is called when the splitter handle is manually moved.
arguments:
pos:
desc: The splitter-handle position.
type: int
index:
desc: The index of the splitter handle. Since there is only
one handle, this is always 0.
type: int
"""
sizes = self.splitter.sizes()
self.edit_size = sizes[0]
self.script_size = sizes[1]
if self.script_size == 0:
self.button_view.set_view_icon(u'controls')
elif self.edit_size == 0:
self.button_view.set_view_icon(u'script')
else:
self.button_view.set_view_icon(u'split')
def set_view_controls(self):
"""
desc:
Puts the splitter in control view.
"""
self.splitter.setSizes([self.splitter.width(), 0])
self.button_view.set_view_icon(u'controls')
def set_view_script(self):
"""
desc:
Puts the splitter in script view.
"""
self.splitter.setSizes([0, self.splitter.width()])
self.button_view.set_view_icon(u'script')
def set_view_split(self):
"""
desc:
Puts the splitter in split view.
"""
self.splitter.setSizes([self.splitter.width()/2,
self.splitter.width()/2])
self.button_view.set_view_icon(u'split')
def update(self):
"""
desc:
Updates both the script and the controls.
"""
# Items are updated when their tab is shown, so we don't need to update
# them if they aren't shown.
if self.tabwidget.current_item() != self.name:
return False
self.update_script()
self.edit_widget()
return True
def update_script(self):
"""
desc:
Regenerates the script and updates the script widget.
"""
# Normally, the script starts with a 'define' line and is indented by
# a tab. We want to undo this, and present only unindented content.
import textwrap
script = self.to_string()
script = script[script.find(u'\t'):]
script = textwrap.dedent(script)
if self._script_widget.text() != script:
self.main_window.set_unsaved()
self._script_widget.setText(script)
self.extension_manager.fire(u'change_item', name=self.name)
def edit_widget(self, *deprecated, **_deprecated):
"""
desc:
This function updates the controls based on the item state.
"""
self.auto_edit_widget()
self.header.refresh()
def apply_edit_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the graphical controls.
"""
self.auto_apply_edit_changes()
self.update_script()
return True
def apply_script_changes(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script.
"""
if not self.validate_script():
return
new_script = self._script_widget.text()
old_script = self.to_string()
self.from_string(new_script)
if old_script != new_script:
self.main_window.set_unsaved()
self.edit_widget()
def apply_script_changes_and_switch_view(self, *deprecated, **_deprecated):
"""
desc:
Applies changes to the script if possible. If so, switches to the
controls view.
"""
if self.validate_script():
self.set_view_controls()
def validate_script(self):
"""
desc:
Checks whether the script is syntactically valid. If not, the
offending line is highlighted if QProgEdit suppors setInvalid().
returns:
type: bool
"""
script = self._script_widget.text()
# First create a dummy item to see if the string can be parsed.
try:
self.validator(self.name, self.experiment, script)
return True
except Exception as e:
# If an error occurs, we first parse the first line, then the first
# and second, and so on, until we find the error.
l = script.split(u'\n')
for line_nr, line in enumerate(l):
test_script = u'\n'.join(l[:line_nr])
try:
self.validator(self.name, self.experiment, test_script)
except Exception as e_:
if not isinstance(e_, osexception):
e_ = osexception(e_)
if hasattr(self._script_widget, u'setInvalid'):
self._script_widget.setInvalid(line_nr, e_.markdown())
break
self.console.write(e)
return False
def set_validator(self):
"""
desc:
Sets the validator class, that is, the class that is used to parse
scripts to see if they are syntactically correct. Currently, we use
the class that defines from_string().
"""
import inspect
meth = self.from_string
for cls in inspect.getmro(self.__class__):
if meth.__name__ in cls.__dict__:
break
debug.msg(u'validator: %s' % cls)
self.validator = cls
@requires_init
def rename(self, from_name, to_name):
"""
desc:
Handles renaming of an item (not necesarrily the current item).
arguments:
from_name:
desc: The old item name.
type: unicode
to_name:
desc: The new item name
type: unicode
"""
if self.name != from_name:
return
self.name = to_name
self.container_widget.__item__ = self.name
self.header.set_name(to_name)
index = self.tabwidget.indexOf(self.widget())
if index is not None:
self.tabwidget.setTabText(index, to_name)
def open_help_tab(self):
"""
desc:
Opens a help tab.
"""
if self.help_url is None:
self.tabwidget.open_help(self.item_type)
else:
self.tabwidget.open_osdoc(self.help_url)
def toggle_maximize(self):
"""
desc:
Toggles edit-widget maximization.
"""
if not self.maximized:
# Always ignore close events. This is necessary, because otherwise
# the pop-out widget can be closed without re-enabling the main
# window.
self.main_window.block_close_event = True
self.container_widget.closeEvent = lambda e: e.ignore()
self.container_widget.setParent(None)
self.container_widget.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint|\
QtCore.Qt.WindowMaximizeButtonHint|\
QtCore.Qt.CustomizeWindowHint)
self.container_widget.showMaximized()
self.container_widget.show()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-restore'))
else:
self.main_window.block_close_event = False
self.container_widget.setParent(self.main_window)
self.open_tab()
self.button_toggle_maximize.setIcon(
self.theme.qicon(u'view-fullscreen'))
self.maximized = not self.maximized
self.button_help.setDisabled(self.maximized)
self.main_window.setDisabled(self.maximized)
def delete(self, item_name, item_parent=None, index=None):
"""
desc:
Is called when an item is deleted (not necessarily the current one).
arguments:
item_name:
desc: The name of the item to be deleted.
type: str
keywords:
item_parent:
desc: The name of the parent item.
type: str
index:
desc: The index of the item in the parent.
type: int
"""
pass
def build_item_tree(self, toplevel=None, items=[], max_depth=-1,
extra_info=None):
"""
desc:
Constructs an item tree.
keywords:
toplevel:
desc: The toplevel widget.
type: tree_base_item
items:
desc: A list of item names that have already been added, to
prevent recursion.
tyep: list
returns:
type: tree_item_item
"""
widget = tree_item_item(self, extra_info=extra_info)
items.append(self.name)
if toplevel is not None:
toplevel.addChild(widget)
return widget
def parents(self):
"""
returns:
desc: A list of all parents (names) of the current item.
type: list
"""
l = [self.name]
for item in self.experiment.items:
if self.experiment.items[item].is_child_item(self.name):
l.append(item)
return l
def get_ready(self):
"""
desc:
This function should be overridden to do any last-minute stuff that
and item should do before an experiment is actually run, such as
applying pending script changes.
returns:
desc: True if some action has been taken, False if nothing was
done.
type: bool
"""
return False
def auto_edit_widget(self):
"""
desc:
Updates the GUI controls based on the auto-widgets.
"""
for var, edit in self.auto_line_edit.items():
if isinstance(var, int):
continue
if var in self.var:
val = safe_decode(self.var.get(var, _eval=False))
else:
val = u''
if val != edit.text():
edit.setText(val)
for var, combobox in self.auto_combobox.items():
if isinstance(var, int):
continue
val = self.var.get(var, _eval=False, default=u'')
i = combobox.findText(safe_decode(val))
# Set the combobox to the select item
if i >= 0:
if i != combobox.currentIndex() or not combobox.isEnabled():
combobox.setDisabled(False)
combobox.setCurrentIndex(i)
# If no value was specified, set the combobox to a blank item
elif val == u'':
if combobox.currentIndex() >= 0 or not combobox.isEnabled():
combobox.setDisabled(False)
combobox.setCurrentIndex(-1)
# If an unknown value has been specified, notify the user
else:
if combobox.isEnabled():
combobox.setDisabled(True)
self.extension_manager.fire(u'notify',
message=_(u'"%s" is set to a variable or '
u'unknown value and can only be edited through '
u'the script.') % var, category=u'info')
for var, spinbox in list(self.auto_spinbox.items()) \
+ list(self.auto_slider.items()):
if isinstance(var, int):
continue
if var in self.var:
val = self.var.get(var, _eval=False)
if type(val) in (float, int):
if spinbox.value() == val and spinbox.isEnabled():
continue
spinbox.setDisabled(False)
try:
spinbox.setValue(val)
except Exception as e:
self.experiment.notify(
_(u"Failed to set control '%s': %s") % (var, e))
else:
if not spinbox.isEnabled():
continue
spinbox.setDisabled(True)
self.extension_manager.fire(u'notify',
message=_(u'"%s" is defined using '
'variables and can only be edited through the '
'script.') % var, category=u'info')
for var, checkbox in self.auto_checkbox.items():
if isinstance(var, int):
continue
if var in self.var:
val = self.var.get(var, _eval=False)
if val in [u'yes', u'no']:
checkbox.setDisabled(False)
checked = val == u'yes'
if checked != checkbox.isChecked():
checkbox.setChecked(checked)
else:
checkbox.setDisabled(True)
self.extension_manager.fire(u'notify',
message=_(u'"%s" is defined using '
u'variables or has an invalid value, and can only be '
u'edited through the script.') % var,
category=u'info')
for var, qprogedit in self.auto_editor.items():
if isinstance(var, int):
continue
if var in self.var:
val = safe_decode(self.var.get(var, _eval=False))
if val != qprogedit.text():
qprogedit.setText(val)
def auto_apply_edit_changes(self, rebuild=True):
"""
desc:
Applies the auto-widget controls.
keywords:
rebuild: Deprecated (does nothing).
"""
for var, edit in self.auto_line_edit.items():
if isinstance(var, int):
continue
if edit.isEnabled() and isinstance(var, basestring):
val = str(edit.text()).strip()
if val != u'':
self.var.set(var, val)
continue
# If no text was entered, we use a default if available ...
if hasattr(edit, u'default'):
self.var.set(var, edit.default)
continue
# ... or unset the variable if no default is available.
self.var.unset(var)
for var, combobox in self.auto_combobox.items():
if isinstance(var, int):
continue
if combobox.isEnabled() and isinstance(var, basestring):
self.var.set(var, str(combobox.currentText()))
for var, spinbox in self.auto_spinbox.items():
if isinstance(var, int):
continue
if spinbox.isEnabled() and isinstance(var, basestring):
self.var.set(var, spinbox.value())
for var, slider in self.auto_slider.items():
if isinstance(var, int):
continue
if slider.isEnabled() and isinstance(var, basestring):
self.var.set(var, slider.value())
for var, checkbox in self.auto_checkbox.items():
if isinstance(var, int):
continue
if checkbox.isEnabled() and isinstance(var, basestring):
if checkbox.isChecked():
val = u"yes"
else:
val = u"no"
self.var.set(var, val)
for var, qprogedit in self.auto_editor.items():
if isinstance(var, int):
continue
if isinstance(var, basestring):
self.var.set(var, qprogedit.text())
return True
def auto_add_widget(self, widget, var=None, apply_func=None):
"""
desc:
Adds a widget to the list of auto-widgets.
arguments:
widget:
type: QWidget
keywords:
var: The name of the experimental variable to be linked to the
widget, or None to use an automatically chosen name.
type: [str, NoneType]
"""
# Use the object id as a fallback name
if var is None:
var = id(widget)
if apply_func is None:
apply_func = self.apply_edit_changes
debug.msg(var)
self.set_focus_widget(widget)
if isinstance(widget, QtWidgets.QSpinBox) or isinstance(widget,
QtWidgets.QDoubleSpinBox):
widget.editingFinished.connect(apply_func)
self.auto_spinbox[var] = widget
elif isinstance(widget, QtWidgets.QComboBox):
widget.activated.connect(apply_func)
self.auto_combobox[var] = widget
elif isinstance(widget, QtWidgets.QSlider) \
or isinstance(widget, QtWidgets.QDial):
widget.valueChanged.connect(apply_func)
self.auto_slider[var] = widget
elif isinstance(widget, QtWidgets.QLineEdit) or isinstance(widget,
pool_select):
widget.editingFinished.connect(apply_func)
self.auto_line_edit[var] = widget
elif isinstance(widget, QtWidgets.QCheckBox):
widget.clicked.connect(apply_func)
self.auto_checkbox[var] = widget
else:
raise Exception(u"Cannot auto-add widget of type %s" % widget)
def children(self):
"""
returns:
desc: A list of children, including grand children, and so on.
type: list
"""
return []
def is_child_item(self, item_name):
"""
desc:
Checks if an item is somewhere downstream from the current item
in the experimental hierarchy.
arguments:
item_name:
desc: The name of the child item.
type: unicode
returns:
desc: True if the current item is offspring of the item, False
otherwise.
type: bool
"""
return False
def insert_child_item(self, item_name, index=0):
"""
desc:
Inserts a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item.
type: int
"""
pass
def remove_child_item(self, item_name, index=0):
"""
desc:
Removes a child item, if applicable to the item type.
arguments:
item_name:
desc: The name of the child item.
type: unicode
keywords:
index:
desc: The index of the child item, if applicable. A negative
value indicates all instances.
type: int
"""
pass
