1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
#!/usr/bin/env python
"""
A text line stimulus.
This module contains a class implementing a text line stimulus.
"""
__author__ = 'Florian Krause <florian@expyriment.org>, \
Oliver Lindemann <oliver@expyriment.org>'
__version__ = '0.7.0'
__revision__ = '55a4e7e'
__date__ = 'Wed Mar 26 14:33:37 2014 +0100'
import os
import pygame
import defaults
from _visual import Visual
from expyriment.misc import find_font, unicode2str, str2unicode
import expyriment
class TextLine(Visual):
"""A class implementing a single text line."""
def __init__(self, text, position=None, text_font=None, text_size=None,
text_bold=None, text_italic=None, text_underline=None,
text_colour=None, background_colour=None):
"""Create a text line stimulus.
NOTE: text_font can be both, a name or path to a font file!
When text_font is a name, Expyriment will try to find a font that
best matches the given name.
If no matching font can be found, or if the given font file cannot be
found, the Pygame system default will be used.
In any case the value of the attribute text_font will always
resemble the font that is actually in use!
Parameters
----------
text : str
text to show (str)
position : (int, int), optional
position of the stimulus
text_font : str, optional
font to use as name or as path to a font file
text_size : int, optional
text size
text_bold : bool, optional
font should be bold
text_italic : bool, optional
font should be italic
text_underline : bool, optional
font should get an underline
text_colour : (int, int, int), optional
text colour
background_colour : (int, int, int), optional
background colour
"""
pygame.font.init()
if position is None:
position = defaults.textline_position
Visual.__init__(self, position, log_comment=text)
self._text = text
if text_size is None:
text_size = defaults.textline_text_size
if text_size is not None:
self._text_size = text_size
else:
self._text_size = expyriment._active_exp.text_size
if text_font is None:
text_font = defaults.textline_text_font
if text_font is not None:
self._text_font = find_font(text_font)
else:
self._text_font = find_font(expyriment._active_exp.text_font)
try:
_font = pygame.font.Font(unicode2str(self._text_font, fse=True),
10)
_font = None
except:
raise IOError("Font '{0}' not found!".format(text_font))
if text_bold is not None:
self._text_bold = text_bold
else:
self._text_bold = defaults.textline_text_bold
if text_italic is not None:
self._text_italic = text_italic
else:
self._text_italic = defaults.textline_text_italic
if text_underline is not None:
self._text_underline = text_underline
else:
self._text_underline = defaults.textline_text_underline
if text_colour is None:
text_colour = defaults.textline_text_colour
if text_colour is not None:
self._text_colour = text_colour
else:
self._text_colour = expyriment._active_exp.foreground_colour
if background_colour is not None:
self._background_colour = background_colour
else:
self._background_colour = \
defaults.textline_background_colour
_getter_exception_message = "Cannot set {0} if surface exists!"
@property
def text(self):
"""Getter for text."""
return self._text
@text.setter
def text(self, value):
"""Setter for text."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text"))
else:
self._text = value
@property
def text_font(self):
"""Getter for text_font."""
return self._text_font
@text_font.setter
def text_font(self, value):
"""Setter for text_font."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text_font"))
else:
self._text_font = value
@property
def text_size(self):
"""Getter for text_size."""
return self._text_size
@text_size.setter
def text_size(self, value):
"""Setter for text_size."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text_size"))
else:
self._text_size = value
@property
def text_bold(self):
"""Getter for text_bold."""
return self._text_bold
@text_bold.setter
def text_bold(self, value):
"""Setter for text_bold."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text_bold"))
else:
self._text_bold = value
@property
def text_italic(self):
"""Getter for text_italic."""
return self._text_italic
@text_italic.setter
def text_italic(self, value):
"""Setter for text_italic."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text_italic"))
else:
self._text_italic = value
@property
def text_underline(self):
"""Getter for text_underline."""
return self._text_underline
@text_underline.setter
def text_underline(self, value):
"""Setter for text_underline."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text_underline"))
else:
self._text_underline = value
@property
def text_colour(self):
"""Getter for text_colour."""
return self._text_colour
@text_colour.setter
def text_colour(self, value):
"""Setter for text_colour."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"text_colour"))
else:
self._text_colour = value
@property
def background_colour(self):
"""Getter for background_colour."""
return self._background_colour
@background_colour.setter
def background_colour(self, value):
"""Setter for background_colour."""
if self.has_surface:
raise AttributeError(TextLine._getter_exception_message.format(
"background_colour"))
else:
self._background_colour = value
def _create_surface(self):
"""Create the surface of the stimulus."""
if os.path.isfile(self._text_font):
_font = pygame.font.Font(unicode2str(self._text_font, fse=True),
self._text_size)
else:
_font = pygame.font.Font(self._text_font, self._text_size)
_font.set_bold(self.text_bold)
_font.set_italic(self.text_italic)
_font.set_underline(self.text_underline)
if type(self.text) is not unicode:
# Pygame wants latin-1 encoding here for character strings
_text = str2unicode(self.text).encode('latin-1')
else:
_text = self.text
if self.background_colour:
text = _font.render(_text, True, self.text_colour,
self.background_colour)
else:
text = _font.render(_text, True, self.text_colour)
text.convert_alpha()
surface = text
return surface
if __name__ == "__main__":
from expyriment import control
control.set_develop_mode(True)
defaults.event_logging = 0
exp = control.initialize()
textline = TextLine("abcde fghijk lmnopqrstuvwxyz 12 348 56789",
text_font="Helvetica",
text_size=20, text_bold=False)
textline.present()
exp.clock.wait(1000)
|