fife-parpg: engine/extensions/pychan/widgets/widget.py annotate

annotate engine/extensions/pychan/widgets/widget.py @ 330:33dd55160a9d

* Added a new method Widget.getNamedChildren * Made the distribute and mapEvents methods (a whole lot) faster. * Added a new (internal) attribute to Widget (has_name) * Added a small decorator for profiling rarely called functions.

author	phoku@33b003aa-7bff-0310-803a-e67f0ece8222
date	Mon, 24 Aug 2009 11:45:28 +0000
parents	aca5744f017a
children	48c99636453e

rev	line source
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	1 # -- coding: utf-8 --
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	2
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	3 from pychan.widgets.common import *
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	4
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	5 class Widget(object):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	6 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	7 This is the common widget base class, which provides most of the wrapping
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	8 functionality.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	9
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	10 Attributes
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	11 ==========
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	12
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	13 Widgets are manipulated (mostly) through attributes - and these can all be set by XML attributes.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	14 Derived widgets will have other attributes. Please see their B{New Attributes} sections. The types of the
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	15 attributes are pretty straightforward, but note that Position and Color attribute types will also accept
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	16 C{fife.Point} and C{fife.Color} values.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	17
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	18 - name: String: The identification of the widget, most useful if it is unique within a given widget hiarachy.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	19 This is used to find widgets by L{mapEvents},L{distributeInitialData},L{distributeData} and L{collectData}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	20 - position: Position: The position relative to the parent widget - or on screen, if this is the root widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	21 - size: Position: The real size of the widget (including border and margins). Usually you do not need to set this.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	22 A notable exception is the L{ScrollArea}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	23 - min_size: Position: The minimal size this widget is allowed to have. This is enforced through the accessor methods
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	24 of the actual size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	25 - max_size: Position: The maximal size this widget is allowed to have. This is enforced through the accessor methods
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	26 of the actual size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	27 - base_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	28 - background_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	29 - foreground_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	30 - selection_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	31 - font: String: This should identify a font that was loaded via L{loadFonts} before.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	32 - helptext: Unicode: Text which can be used for e.g. tooltips.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	33 - border_size: Integer: The size of the border in pixels.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	34 - position_technique: This can be either "automatic" or "explicit" - only L{Window} has this set to "automatic" which
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	35 results in new windows being centered on screen (for now).
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	36 If it is set to "explicit" the position attribute will not be touched.
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	37 - vexpand: Integer: >= 0. Proportion to expand this widget vertically.
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	38 - hexpand: Integer: >= 0. Proportion to expand this widget horizontally.
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	39
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	40 Convenience Attributes
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	41 ======================
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	42
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	43 These attributes are convenience/shorthand versions of above mentioned attributes and assignment will reflect
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	44 the associated attributes values. E.g. the following is equivalent::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	45 # Set X position, leave Y alone
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	46 widget.x = 10
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	47 # Same here
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	48 posi = widget.position
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	49 widget.position = (10, posi[1])
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	50
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	51 Here they are.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	52
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	53 - x: Integer: The horizontal part of the position attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	54 - y: Integer: The vertical part of the position attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	55 - width: Integer: The horizontal part of the size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	56 - height: Integer: The vertical part of the size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	57
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	58 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	59
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	60 ATTRIBUTES = [ Attr('name'), PointAttr('position'),
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	61 PointAttr('min_size'), PointAttr('size'), PointAttr('max_size'),
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	62 ColorAttr('base_color'),ColorAttr('background_color'),ColorAttr('foreground_color'),ColorAttr('selection_color'),
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	63 Attr('style'), Attr('font'),IntAttr('border_size'),Attr('position_technique'),
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	64 IntAttr('vexpand'),IntAttr('hexpand'),
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	65 UnicodeAttr('helptext'), BoolAttr('is_focusable')
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	66 ]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	67
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	68 DEFAULT_NAME = '__unnamed__'
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	69 DEFAULT_HEXPAND = 0
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	70 DEFAULT_VEXPAND = 0
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	71 DEFAULT_MAX_SIZE = 500000, 500000
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	72
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	73 HIDE_SHOW_ERROR = """\
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	74 You can only show/hide the top widget of a hierachy.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	75 Use 'addChild' or 'removeChild' to add/remove labels for example.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	76 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	77
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	78
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	79 def __init__(self,parent = None, name = DEFAULT_NAME,
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	80 size = (-1,-1), min_size=(0,0), max_size=DEFAULT_MAX_SIZE,
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	81 helptext=u"",
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	82 position = (0,0),
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	83 style = None, **kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	84
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	85 assert( hasattr(self,'real_widget') )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	86 self.event_mapper = events.EventMapper(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	87 self._visible = False
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	88 self._extra_border = (0,0)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	89 self.hexpand = kwargs.get("hexpand",self.DEFAULT_HEXPAND)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	90 self.vexpand = kwargs.get("vexpand",self.DEFAULT_VEXPAND)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	91 # Simple way to get at least some compat layout:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	92 if get_manager().compat_layout:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	93 self.hexpand, self.vexpand = 0,0
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	94
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	95 # Data distribution & retrieval settings
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	96 self.accepts_data = False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	97 self.accepts_initial_data = False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	98
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	99 # Parent attribute makes sure we only have one parent,
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	100 # that tests self.__parent - so make sure we have the attr here.
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	101 self.__parent = None
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	102 self.parent = parent
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	103
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	104 self.has_name = False
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	105 self.name = name
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	106
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	107 self.position = position
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	108 self.min_size = min_size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	109 self.max_size = max_size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	110 self.size = size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	111 self.position_technique = "explicit"
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	112 self.font = 'default'
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	113
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	114 # Inherit style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	115 if style is None and parent:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	116 style = parent.style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	117 self.style = style or "default"
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	118
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	119 self.helptext = helptext
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	120 # Not needed as attrib assignment will trigger manager.stylize call
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	121 #manager.stylize(self,self.style)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	122
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	123 def execute(self,bind):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	124 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	125 Execute a dialog synchronously.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	126
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	127 As argument a dictionary mapping widget names to return values
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	128 is expected. Events from these widgets will cause this function
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	129 to return with the associated return value.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	130
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	131 This function will not return until such an event occurs.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	132 The widget will be shown before execution and hidden afterwards.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	133 You can only execute root widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	134
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	135 Note: This feature is not tested well, and the API will probably
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	136 change. Otherwise have fun::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	137 # Okay this a very condensed example :-)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	138 return pychan.loadXML("contents/gui/dialog.xml").execute({ 'okButton' : True, 'closeButton' : False })
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	139
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	140 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	141 if not get_manager().can_execute:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	142 raise RuntimeError("Synchronous execution is not set up!")
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	143 if self.__parent:
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	144 raise RuntimeError("You can only 'execute' root widgets, not %s!" % str(self))
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	145
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	146 for name,returnValue in bind.items():
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	147 def _quitThisDialog(returnValue = returnValue ):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	148 get_manager().breakFromMainLoop( returnValue )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	149 self.hide()
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	150 self.findChild(name=name).capture( _quitThisDialog , group_name = "__execute__" )
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	151 self.show()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	152 return get_manager().mainLoop()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	153
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	154 def match(self,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	155 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	156 Matches the widget against a list of key-value pairs.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	157 Only if all keys are attributes and their value is the same it returns True.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	158 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	159 for k,v in kwargs.items():
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	160 if v != getattr(self,k,None):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	161 return False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	162 return True
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	163
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	164 def capture(self, callback, event_name="action", group_name="default"):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	165 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	166 Add a callback to be executed when the widget event occurs on this widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	167
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	168 The callback must be either a callable or None.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	169 The old event handler (if any) will be overridden by the callback.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	170 If None is given, the event will be disabled. You can query L{isCaptured}
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	171 wether this widgets events are currently captured.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	172
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	173 It might be useful to check out L{tools.callbackWithArguments}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	174
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	175 @param callback: Event callback - may accept keyword arguments event and widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	176 @paran event_name: The event to capture - may be one of L{events.EVENTS} and defaults to "action"
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	177 @paran group_name: Event group.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	178
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	179 Event groups are used to have different B{channels} which don't interfere with each other.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	180 For derived widgets that need to capture events it's advised to use the group_name 'widget'.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	181 The 'default' group is used by default, and should be reserved for the application programmers.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	182 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	183 self.event_mapper.capture( event_name, callback, group_name )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	184
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	185 def isCaptured(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	186 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	187 Check whether this widgets events are captured
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	188 (a callback is installed) or not.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	189 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	190 return bool(self.event_mapper.getCapturedEvents())
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	191
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	192 def show(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	193 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	194 Show the widget and all contained widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	195 """
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	196 if self.parent:
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	197 raise RuntimeError(Widget.HIDE_SHOW_ERROR)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	198 if self._visible: return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	199 self.adaptLayout()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	200 self.beforeShow()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	201 get_manager().show(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	202 self._visible = True
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	203
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	204 def hide(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	205 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	206 Hide the widget and all contained widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	207 """
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	208 if self.parent:
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	209 raise RuntimeError(Widget.HIDE_SHOW_ERROR)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	210 if not self._visible: return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	211
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	212 get_manager().hide(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	213
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	214 self.afterHide()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	215 self._visible = False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	216
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	217 def isVisible(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	218 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	219 Check whether the widget is currently shown,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	220 either directly or as part of a container widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	221 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	222 widget = self
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	223 while widget.parent:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	224 widget = widget.parent
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	225 return widget._visible
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	226
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	227 def adaptLayout(self,recurse=True):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	228 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	229 Execute the Layout engine. Automatically called by L{show}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	230 In case you want to relayout a visible widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	231 This function will automatically perform the layout adaption
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	232 from the top-most layouted widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	233
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	234 To make this clear consider this arrangement::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	235 VBox 1
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	236 - Container
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	237 - VBox 2
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	238 - HBox
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	239 - Label
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	240
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	241 If you call adaptLayout on the Label the layout from the VBox 2
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	242 will get recalculated, while the VBox 1 stays untouched.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	243
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	244 @param recurse Pass False here to force the layout to start from
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	245 this widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	246 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	247 widget = self
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	248 while widget.parent and recurse:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	249 if not isLayouted(widget.parent):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	250 break
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	251 widget = widget.parent
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	252 widget._recursiveResizeToContent()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	253 widget._recursiveExpandContent()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	254
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	255 def beforeShow(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	256 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	257 This method is called just before the widget is shown.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	258 You can override this in derived widgets to add finalization
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	259 behaviour.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	260 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	261
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	262 def afterHide(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	263 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	264 This method is called just before the widget is hidden.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	265 You can override this in derived widgets to add finalization
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	266 behaviour.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	267 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	268
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	269 def findChildren(self,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	270 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	271 Find all contained child widgets by attribute values.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	272
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	273 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	274 closeButtons = root_widget.findChildren(name='close')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	275 buttons = root_widget.findChildren(__class__=pychan.widgets.Button)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	276 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	277
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	278 children = []
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	279 def _childCollector(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	280 if widget.match(**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	281 children.append(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	282 self.deepApply(_childCollector)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	283 return children
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	284
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	285 def getNamedChildren(self):
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	286 """
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	287 Create a dictionary of child widgets with the keys being
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	288 their name. This will contain only Widgets which have
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	289 a name different from "__unnamed__" (which is the default).
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	290
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	291 The values are lists of widgets, so not only unique names
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	292 are handled correctly.
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	293
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	294 Usage::
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	295 children = widget.getNamedChildren()
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	296 for widget in children.get("info",[])
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	297 print widget.name , " == info"
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	298 """
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	299 children = {}
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	300 def _childCollector(widget):
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	301 if widget.has_name:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	302 children.setdefault(widget._name,[]).append(widget)
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	303 self.deepApply(_childCollector)
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	304 return children
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	305
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	306 def findChild(self,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	307 """ Find the first contained child widgets by attribute values.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	308
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	309 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	310 closeButton = root_widget.findChild(name='close')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	311 """
329 aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	312 if kwargs.keys() == ["name"]:
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	313 return self.findChildByName(kwargs["name"])
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	314
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	315 children = self.findChildren(**kwargs)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	316 if children:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	317 return children[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	318 return None
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	319
329 aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	320 def findChildByName(self,name):
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	321 """
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	322 Find first contained child widget by its name.
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	323
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	324 Note that this is the fast version of findChild(name="...")
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	325 and that you don't have to call this explicitly, it is used
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	326 if possible.
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	327 """
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	328 result = []
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	329 def _childCollector(widget):
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	330 if widget._name == name:
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	331 result.append(widget)
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	332 raise StopTreeWalking
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	333 try:
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	334 self.deepApply(_childCollector)
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	335 except StopTreeWalking:
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	336 return result[0]
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	337 return None
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	338
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	339 def addChild(self,widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	340 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	341 This function adds a widget as child widget and is only implemented
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	342 in container widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	343
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	344 You'll need to call L{adaptLayout} if the container is already shown,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	345 to adapt the layout to the new widget. This doesn't happen
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	346 automatically.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	347 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	348 raise RuntimeError("Trying to add a widget to %s, which doesn't allow this." % repr(self))
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	349
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	350 def insertChild(self, widget, position):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	351 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	352 This function inserts a widget a given index in the child list.
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	353
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	354 See L{addChild} and L{insertChildBefore}
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	355 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	356 raise RuntimeError("Trying to insert a widget to %s, which doesn't allow this." % repr(self))
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	357
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	358 def insertChildBefore(self, widget, before):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	359 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	360 Inserts a child widget before a given widget. If the widget isn't found,
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	361 the widget is appended to the children list.
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	362
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	363 See L{addChild} and L{insertChild}
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	364 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	365 raise RuntimeError("Trying to insert a widget to %s, which doesn't allow this." % repr(self))
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	366
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	367 def addChildren(self,*widgets):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	368 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	369 Add multiple widgets as children.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	370 Only implemented for container widgets. See also L{addChild}
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	371
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	372 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	373 container.addChildren( widget1, widget2, ... )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	374 # or you can use this on a list
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	375 container.addChildren( [widget1,widget2,...] )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	376 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	377 if len(widgets) == 1 and not isinstance(widgets[0],Widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	378 widgets = widgets[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	379 for widget in widgets:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	380 self.addChild(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	381
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	382 def removeChild(self,widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	383 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	384 This function removes a direct child widget and is only implemented
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	385 in container widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	386
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	387 You'll need to call L{adaptLayout} if the container is already shown,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	388 to adapt the layout to the removed widget. This doesn't happen
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	389 automatically.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	390 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	391 raise RuntimeError("Trying to remove a widget from %s, which is not a container widget." % repr(self))
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	392
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	393 def removeChildren(self,*widgets):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	394 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	395 Remove a list of direct child widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	396 All widgets have to be direct child widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	397 To 'clear' a container take a look at L{removeAllChildren}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	398 See also L{removeChild}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	399
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	400 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	401 container.removeChildren( widget1, widget2, ... )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	402 # or you can use this on a list
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	403 container.removeChildren( [widget1,widget2,...] )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	404 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	405 if len(widgets) == 1 and not isinstance(widgets[0],Widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	406 widgets = widgets[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	407 for widget in widgets:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	408 self.removeChild(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	409
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	410 def removeAllChildren(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	411 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	412 This function will remove all direct child widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	413 This will work even for non-container widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	414 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	415 children = self.findChildren(parent=self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	416 for widget in children:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	417 self.removeChild(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	418
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	419 def mapEvents(self,eventMap,ignoreMissing = False):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	420 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	421 Convenience function to map widget events to functions
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	422 in a batch.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	423
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	424 Subsequent calls of mapEvents will merge events with different
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	425 widget names and override the previously set callback.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	426 You can also pass C{None} instead of a callback, which will
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	427 disable the event completely.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	428
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	429 @param eventMap: A dictionary with widget/event names as keys and callbacks as values.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	430 @param ignoreMissing: Normally this method raises an RuntimeError, when a widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	431 can not be found - this behaviour can be overriden by passing True here.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	432
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	433 The keys in the dictionary are parsed as C{"widgetName/eventName"} with the slash
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	434 separating the two. If no slash is found the eventName is assumed to be "action".
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	435
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	436 Additionally you can supply a group name or channel C{"widgetName/eventName/groupName"}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	437 Event handlers from one group are not overridden by handlers from another group.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	438 The default group name is C{"default"}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	439
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	440 Example::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	441 guiElement.mapEvents({
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	442 "button" : guiElement.hide,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	443 "button/mouseEntered" : toggleButtonColorGreen,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	444 "button/mouseExited" : toggleButtonColorBlue,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	445 })
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	446
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	447 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	448 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	449 for descr,func in eventMap.items():
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	450 name, event_name, group_name = events.splitEventDescriptor(descr)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	451 #print name, event_name, group_name
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	452 widgets = children.get(name,[])
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	453 if widgets:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	454 for widget in widgets:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	455 widget.capture( func, event_name = event_name, group_name = group_name )
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	456 elif not ignoreMissing:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	457 raise RuntimeError("No widget with the name: %s" % name)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	458
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	459 def setInitialData(self,data):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	460 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	461 Set the initial data on a widget, what this means depends on the Widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	462 In case the widget does not accept initial data, a L{RuntimeError} is thrown.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	463 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	464 if not self.accepts_initial_data:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	465 raise RuntimeError("Trying to set data on a widget that does not accept initial data. Widget: %s Data: %s " % (repr(self),repr(data)))
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	466 self._realSetInitialData(data)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	467
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	468 def setData(self,data):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	469 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	470 Set the user-mutable data on a widget, what this means depends on the Widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	471 In case the widget does not accept data, a L{RuntimeError} is thrown.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	472 This is inverse to L{getData}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	473 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	474 if not self.accepts_data:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	475 raise RuntimeError("Trying to set data on a widget that does not accept data.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	476 self._realSetData(data)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	477
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	478 def getData(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	479 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	480 Get the user-mutable data of a widget, what this means depends on the Widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	481 In case the widget does not have user mutable data, a L{RuntimeError} is thrown.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	482 This is inverse to L{setData}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	483 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	484 if not self.accepts_data:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	485 raise RuntimeError("Trying to retrieve data from a widget that does not accept data.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	486 return self._realGetData()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	487
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	488 def distributeInitialData(self,initialDataMap):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	489 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	490 Distribute B{initial} (not mutable by the user) data from a dictionary over the widgets in the hierachy
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	491 using the keys as names and the values as the data (which is set via L{setInitialData}).
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	492 If more than one widget matches - the data is set on ALL matching widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	493 By default a missing widget is just ignored.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	494
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	495 Use it like this::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	496 guiElement.distributeInitialData({
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	497 'myTextField' : 'Hello World!',
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	498 'myListBox' : ["1","2","3"]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	499 })
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	500
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	501 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	502 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	503 for name,data in initialDataMap.items():
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	504 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	505 for widget in widgetList:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	506 widget.setInitialData(data)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	507
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	508 def distributeData(self,dataMap):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	509 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	510 Distribute data from a dictionary over the widgets in the hierachy
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	511 using the keys as names and the values as the data (which is set via L{setData}).
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	512 This will only accept unique matches.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	513
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	514 Use it like this::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	515 guiElement.distributeData({
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	516 'myTextField' : 'Hello World!',
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	517 'myListBox' : ["1","2","3"]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	518 })
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	519
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	520 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	521 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	522 for name,data in dataMap.items():
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	523 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	524 if len(widgetList) != 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	525 if get_manager().debug:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	526 self.listNamedWidgets()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	527 raise RuntimeError("DistributeData can only handle widgets with unique names.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	528 widgetList[0].setData(data)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	529
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	530 def collectDataAsDict(self,widgetNames):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	531 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	532 Collect data from a widget hierachy by names into a dictionary.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	533 This can only handle UNIQUE widget names (in the hierachy)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	534 and will raise a RuntimeError if the number of matching widgets
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	535 is not equal to one.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	536
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	537 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	538 data = guiElement.collectDataAsDict(['myTextField','myListBox'])
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	539 print "You entered:",data['myTextField']," and selected ",data['myListBox']
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	540
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	541 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	542 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	543 dataMap = {}
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	544 for name in widgetNames:
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	545 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	546 if len(widgetList) != 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	547 if get_manager().debug:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	548 self.listNamedWidgets()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	549 raise RuntimeError("CollectData can only handle widgets with unique names.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	550
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	551 dataMap[name] = widgetList[0].getData()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	552 return dataMap
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	553
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	554 def collectData(self,*widgetNames):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	555 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	556 Collect data from a widget hierachy by names.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	557 This can only handle UNIQUE widget names (in the hierachy)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	558 and will raise a RuntimeError if the number of matching widgets
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	559 is not equal to one.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	560
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	561 This function takes an arbitrary number of widget names and
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	562 returns a list of the collected data in the same order.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	563
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	564 In case only one argument is given, it will return just the
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	565 data, with out putting it into a list.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	566
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	567 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	568 # Multiple element extraction:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	569 text, selected = guiElement.collectData('myTextField','myListBox')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	570 print "You entered:",text," and selected item nr",selected
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	571 # Single elements are handled gracefully, too:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	572 test = guiElement.collectData('testElement')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	573
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	574 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	575 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	576 dataList = []
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	577 for name in widgetNames:
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	578 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	579 if len(widgetList) != 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	580 if get_manager().debug:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	581 self.listNamedWidgets()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	582 raise RuntimeError("CollectData can only handle widgets with unique names.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	583 dataList.append( widgetList[0].getData() )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	584 if len(dataList) == 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	585 return dataList[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	586 return dataList
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	587
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	588 def listNamedWidgets(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	589 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	590 This function will print a list of all currently named child-widgets
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	591 to the standard output. This is useful for debugging purposes.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	592 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	593 def _printNamedWidget(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	594 if widget.name != Widget.DEFAULT_NAME:
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	595 print widget.name.ljust(20),repr(widget).ljust(50),repr(widget.__parent)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	596 print "Named child widgets of ",repr(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	597 print "name".ljust(20),"widget".ljust(50),"parent"
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	598 self.deepApply(_printNamedWidget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	599
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	600 def stylize(self,style,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	601 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	602 Recursively apply a style to all widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	603 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	604 def _restyle(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	605 get_manager().stylize(widget,style,**kwargs)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	606 self.deepApply(_restyle)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	607
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	608 def resizeToContent(self,recurse = True):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	609 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	610 Try to shrink the widget, so that it fits closely around its content.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	611 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	612 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	613
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	614 def expandContent(self,recurse = True):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	615 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	616 Try to expand any spacer in the widget within the current size.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	617 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	618 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	619
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	620
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	621 def _recursiveResizeToContent(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	622 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	623 Recursively call L{resizeToContent}. Uses L{deepApply}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	624 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	625 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	626 def _callResizeToContent(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	627 #print "RTC:",widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	628 widget.resizeToContent()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	629 self.deepApply(_callResizeToContent)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	630
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	631 def _recursiveExpandContent(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	632 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	633 Recursively call L{expandContent}. Uses L{deepApply}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	634 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	635 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	636 def _callExpandContent(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	637 #print "ETC:",widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	638 widget.expandContent()
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	639 self.deepApply(_callExpandContent, leaves_first=False)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	640
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	641 def deepApply(self,visitorFunc, leaves_first = True):
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	642 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	643 Recursively apply a callable to all contained widgets and then the widget itself.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	644 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	645 visitorFunc(self)
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	646
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	647 def getAbsolutePos(self):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	648 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	649 Get absolute position on screen
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	650 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	651 absX = self.x
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	652 absY = self.y
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	653 parent = self.parent
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	654 while parent is not None:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	655 absX += parent.x
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	656 absY += parent.y
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	657 parent = parent.parent
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	658 return (absX, absY)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	659
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	660 def sizeChanged(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	661 pass
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	662
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	663 def __str__(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	664 return "%s(name='%s')" % (self.__class__.__name__,self.name)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	665
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	666 def __repr__(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	667 return "<%s(name='%s') at %x>" % (self.__class__.__name__,self.name,id(self))
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	668
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	669 def _setSize(self,size):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	670 if isinstance(size,fife.Point):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	671 self.width, self.height = size.x, size.y
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	672 else:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	673 self.width, self.height = size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	674
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	675 def _getSize(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	676 return self.width, self.height
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	677
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	678 def _setPosition(self,size):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	679 if isinstance(size,fife.Point):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	680 self.x, self.y = size.x, size.y
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	681 else:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	682 self.x, self.y = size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	683
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	684 def _getPosition(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	685 return self.x, self.y
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	686
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	687 def _setX(self,x):self.real_widget.setX(x)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	688 def _getX(self): return self.real_widget.getX()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	689 def _setY(self,y): self.real_widget.setY(y)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	690 def _getY(self): return self.real_widget.getY()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	691
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	692 def _setWidth(self,w):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	693 old_width = self.width
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	694 w = max(self.min_size[0],w)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	695 w = min(self.max_size[0],w)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	696 self.real_widget.setWidth(w)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	697 if w != old_width:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	698 self.sizeChanged()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	699
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	700 def _getWidth(self): return self.real_widget.getWidth()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	701 def _setHeight(self,h):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	702 old_height = self.height
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	703 h = max(self.min_size[1],h)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	704 h = min(self.max_size[1],h)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	705 self.real_widget.setHeight(h)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	706 if h != old_height:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	707 self.sizeChanged()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	708
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	709 def _getHeight(self): return self.real_widget.getHeight()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	710
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	711 def _getMinWidth(self): return self.min_size[0]
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	712 def _getMaxWidth(self): return self.max_size[0]
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	713 def _getMinHeight(self): return self.min_size[1]
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	714 def _getMaxHeight(self): return self.max_size[1]
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	715 def _setMinWidth(self,w):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	716 self.min_size = w, self.min_size[1]
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	717 def _setMaxWidth(self,w):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	718 self.max_size = w, self.max_size[1]
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	719 def _setMinHeight(self,h):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	720 self.min_size = self.min_size[0],h
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	721 def _setMaxHeight(self,h):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	722 self.max_size = self.max_size[0],h
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	723
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	724 def _setFont(self, font):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	725 self._font = font
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	726 self.real_font = get_manager().getFont(font)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	727 self.real_widget.setFont(self.real_font)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	728 def _getFont(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	729 return self._font
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	730
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	731 def _getBorderSize(self): return self.real_widget.getFrameSize()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	732 def _setBorderSize(self,size): self.real_widget.setFrameSize(size)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	733
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	734 base_color = ColorProperty("BaseColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	735 background_color = ColorProperty("BackgroundColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	736 foreground_color = ColorProperty("ForegroundColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	737 selection_color = ColorProperty("SelectionColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	738
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	739 def _getStyle(self): return self._style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	740 def _setStyle(self,style):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	741 self._style = style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	742 get_manager().stylize(self,style)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	743 style = property(_getStyle,_setStyle)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	744
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	745 def _getParent(self): return self.__parent
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	746 def _setParent(self,parent):
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	747 if self.__parent is not parent:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	748 if self.__parent and parent is not None:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	749 print "Widget containment fumble:", self, self.__parent, parent
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	750 self.__parent.removeChild(self)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	751 self.__parent = parent
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	752 parent = property(_getParent,_setParent)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	753
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	754 def _setName(self,name):
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	755 self._name = name
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	756 if name != Widget.DEFAULT_NAME:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	757 self.has_name = True
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	758 def _getName(self):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	759 # __str__ relies on self.name
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	760 return getattr(self,'_name','__no_name_yet__')
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	761 name = property(_getName,_setName)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	762
253 6ab09eb765a1 * Added patch by MadMonk that exposes the guichan focus functions to pychan nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 249 diff changeset	763 def _setFocusable(self, b): self.real_widget.setFocusable(b)
6ab09eb765a1 * Added patch by MadMonk that exposes the guichan focus functions to pychan nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 249 diff changeset	764 def _isFocusable(self):
6ab09eb765a1 * Added patch by MadMonk that exposes the guichan focus functions to pychan nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 249 diff changeset	765 return self.real_widget.isFocusable()
6ab09eb765a1 * Added patch by MadMonk that exposes the guichan focus functions to pychan nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 249 diff changeset	766
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	767 x = property(_getX,_setX)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	768 y = property(_getY,_setY)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	769 width = property(_getWidth,_setWidth)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	770 height = property(_getHeight,_setHeight)
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	771 min_width = property(_getMinWidth,_setMinWidth)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	772 min_height = property(_getMinHeight,_setMinHeight)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	773 max_width = property(_getMaxWidth,_setMaxWidth)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	774 max_height = property(_getMaxHeight,_setMaxHeight)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	775 size = property(_getSize,_setSize)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	776 position = property(_getPosition,_setPosition)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	777 font = property(_getFont,_setFont)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	778 border_size = property(_getBorderSize,_setBorderSize)
253 6ab09eb765a1 * Added patch by MadMonk that exposes the guichan focus functions to pychan nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 249 diff changeset	779 is_focusable = property(_isFocusable,_setFocusable)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	780
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	781 def setEnterCallback(self, cb):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	782 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	783 DEPRECATED
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	784
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	785 Callback is called when mouse enters the area of Widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	786 callback should have form of function(button)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	787 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	788 if cb is None:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	789 self.capture(None, event_name = "mouseEntered" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	790 return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	791
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	792 def callback(widget=None):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	793 return cb(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	794 print "PyChan: You are using the DEPRECATED functionality: setEnterCallback."
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	795 self.capture(callback, event_name = "mouseEntered" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	796
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	797 def setExitCallback(self, cb):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	798 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	799 DEPRECATED
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	800
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	801 Callback is called when mouse exits the area of Widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	802 callback should have form of function(button)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	803 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	804 if cb is None:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	805 self.capture(None, event_name = "mouseExited" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	806 return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	807
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	808 def callback(widget=None):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	809 return cb(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	810 print "PyChan: You are using the DEPRECATED functionality: setExitCallback."
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	811 self.capture(callback, event_name = "mouseExited" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	812

Mercurial > fife-parpg

annotate engine/extensions/pychan/widgets/widget.py @ 330:33dd55160a9d