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

annotate engine/extensions/pychan/widgets/widget.py @ 331:48c99636453e

Added Licence header to all pypthon modules in extension/ Commit 3k, Yay :-)

author	phoku@33b003aa-7bff-0310-803a-e67f0ece8222
date	Mon, 24 Aug 2009 12:01:34 +0000
parents	33dd55160a9d
children	16112ef84609

rev	line source
331 48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	1 #!/usr/bin/env python
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	2 # -- coding: utf-8 --
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	3
331 48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	4 # ####################################################################
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	5 # Copyright (C) 2005-2009 by the FIFE team
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	6 # http://www.fifengine.de
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	7 # This file is part of FIFE.
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	8 #
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	9 # FIFE is free software; you can redistribute it and/or
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	10 # modify it under the terms of the GNU Lesser General Public
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	11 # License as published by the Free Software Foundation; either
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	12 # version 2.1 of the License, or (at your option) any later version.
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	13 #
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	14 # This library is distributed in the hope that it will be useful,
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	17 # Lesser General Public License for more details.
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	18 #
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	19 # You should have received a copy of the GNU Lesser General Public
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	20 # License along with this library; if not, write to the
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	21 # Free Software Foundation, Inc.,
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	23 # ####################################################################
48c99636453e Added Licence header to all pypthon modules in extension/ phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 330 diff changeset	24
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	25 from pychan.widgets.common import *
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	26
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	27 class Widget(object):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	28 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	29 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	30 functionality.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	31
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	32 Attributes
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	33 ==========
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	34
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	35 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	36 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	37 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	38 C{fife.Point} and C{fife.Color} values.
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 - 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	41 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	42 - 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	43 - 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	44 A notable exception is the L{ScrollArea}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	45 - 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	46 of the actual size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	47 - 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	48 of the actual size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	49 - base_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	50 - background_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	51 - foreground_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	52 - selection_color: Color
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	53 - 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	54 - 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	55 - border_size: Integer: The size of the border in pixels.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	56 - 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	57 results in new windows being centered on screen (for now).
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	58 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	59 - 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	60 - hexpand: Integer: >= 0. Proportion to expand this widget horizontally.
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	61
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	62 Convenience Attributes
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	63 ======================
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	64
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	65 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	66 the associated attributes values. E.g. the following is equivalent::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	67 # Set X position, leave Y alone
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	68 widget.x = 10
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	69 # Same here
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	70 posi = widget.position
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	71 widget.position = (10, posi[1])
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 Here they are.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	74
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	75 - x: Integer: The horizontal part of the position attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	76 - y: Integer: The vertical part of the position attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	77 - width: Integer: The horizontal part of the size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	78 - height: Integer: The vertical part of the size attribute.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	79
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	80 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	81
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	82 ATTRIBUTES = [ Attr('name'), PointAttr('position'),
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	83 PointAttr('min_size'), PointAttr('size'), PointAttr('max_size'),
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	84 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	85 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	86 IntAttr('vexpand'),IntAttr('hexpand'),
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	87 UnicodeAttr('helptext'), BoolAttr('is_focusable')
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	88 ]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	89
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	90 DEFAULT_NAME = '__unnamed__'
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	91 DEFAULT_HEXPAND = 0
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	92 DEFAULT_VEXPAND = 0
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	93 DEFAULT_MAX_SIZE = 500000, 500000
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 HIDE_SHOW_ERROR = """\
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	96 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	97 Use 'addChild' or 'removeChild' to add/remove labels for example.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	98 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	99
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	100
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	101 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	102 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	103 helptext=u"",
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	104 position = (0,0),
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	105 style = None, **kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	106
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	107 assert( hasattr(self,'real_widget') )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	108 self.event_mapper = events.EventMapper(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	109 self._visible = False
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	110 self._extra_border = (0,0)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	111 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	112 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	113 # 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	114 if get_manager().compat_layout:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	115 self.hexpand, self.vexpand = 0,0
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	116
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	117 # Data distribution & retrieval settings
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	118 self.accepts_data = False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	119 self.accepts_initial_data = False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	120
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	121 # 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	122 # 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	123 self.__parent = None
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	124 self.parent = parent
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	125
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	126 self.has_name = False
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	127 self.name = name
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	128
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	129 self.position = position
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	130 self.min_size = min_size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	131 self.max_size = max_size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	132 self.size = size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	133 self.position_technique = "explicit"
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	134 self.font = 'default'
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	135
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	136 # Inherit style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	137 if style is None and parent:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	138 style = parent.style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	139 self.style = style or "default"
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 self.helptext = helptext
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	142 # Not needed as attrib assignment will trigger manager.stylize call
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	143 #manager.stylize(self,self.style)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	144
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	145 def execute(self,bind):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	146 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	147 Execute a dialog synchronously.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	148
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	149 As argument a dictionary mapping widget names to return values
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	150 is expected. Events from these widgets will cause this function
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	151 to return with the associated return value.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	152
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	153 This function will not return until such an event occurs.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	154 The widget will be shown before execution and hidden afterwards.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	155 You can only execute root widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	156
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	157 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	158 change. Otherwise have fun::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	159 # Okay this a very condensed example :-)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	160 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	161
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	162 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	163 if not get_manager().can_execute:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	164 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	165 if self.__parent:
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	166 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	167
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	168 for name,returnValue in bind.items():
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	169 def _quitThisDialog(returnValue = returnValue ):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	170 get_manager().breakFromMainLoop( returnValue )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	171 self.hide()
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	172 self.findChild(name=name).capture( _quitThisDialog , group_name = "__execute__" )
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	173 self.show()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	174 return get_manager().mainLoop()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	175
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	176 def match(self,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	177 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	178 Matches the widget against a list of key-value pairs.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	179 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	180 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	181 for k,v in kwargs.items():
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	182 if v != getattr(self,k,None):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	183 return False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	184 return True
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	185
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	186 def capture(self, callback, event_name="action", group_name="default"):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	187 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	188 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	189
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	190 The callback must be either a callable or None.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	191 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	192 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	193 wether this widgets events are currently captured.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	194
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	195 It might be useful to check out L{tools.callbackWithArguments}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	196
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	197 @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	198 @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	199 @paran group_name: Event group.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	200
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	201 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	202 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	203 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	204 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	205 self.event_mapper.capture( event_name, callback, group_name )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	206
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	207 def isCaptured(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	208 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	209 Check whether this widgets events are captured
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	210 (a callback is installed) or not.
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 return bool(self.event_mapper.getCapturedEvents())
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 def show(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	215 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	216 Show the widget and all contained widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	217 """
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	218 if self.parent:
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	219 raise RuntimeError(Widget.HIDE_SHOW_ERROR)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	220 if self._visible: return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	221 self.adaptLayout()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	222 self.beforeShow()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	223 get_manager().show(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	224 self._visible = True
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	225
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	226 def hide(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	227 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	228 Hide the widget and all contained widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	229 """
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	230 if self.parent:
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	231 raise RuntimeError(Widget.HIDE_SHOW_ERROR)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	232 if not self._visible: return
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 get_manager().hide(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	235
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	236 self.afterHide()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	237 self._visible = False
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	238
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	239 def isVisible(self):
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 Check whether the widget is currently shown,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	242 either directly or as part of a container widget.
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 widget = self
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	245 while widget.parent:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	246 widget = widget.parent
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	247 return widget._visible
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	248
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	249 def adaptLayout(self,recurse=True):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	250 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	251 Execute the Layout engine. Automatically called by L{show}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	252 In case you want to relayout a visible widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	253 This function will automatically perform the layout adaption
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	254 from the top-most layouted widget.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	255
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	256 To make this clear consider this arrangement::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	257 VBox 1
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	258 - Container
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	259 - VBox 2
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	260 - HBox
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	261 - Label
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	262
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	263 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	264 will get recalculated, while the VBox 1 stays untouched.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	265
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	266 @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	267 this widget.
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 widget = self
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	270 while widget.parent and recurse:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	271 if not isLayouted(widget.parent):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	272 break
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	273 widget = widget.parent
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	274 widget._recursiveResizeToContent()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	275 widget._recursiveExpandContent()
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 def beforeShow(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	278 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	279 This method is called just before the widget is shown.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	280 You can override this in derived widgets to add finalization
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	281 behaviour.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	282 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	283
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	284 def afterHide(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	285 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	286 This method is called just before the widget is hidden.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	287 You can override this in derived widgets to add finalization
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	288 behaviour.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	289 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	290
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	291 def findChildren(self,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	292 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	293 Find all contained child widgets by attribute values.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	294
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	295 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	296 closeButtons = root_widget.findChildren(name='close')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	297 buttons = root_widget.findChildren(__class__=pychan.widgets.Button)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	298 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	299
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	300 children = []
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	301 def _childCollector(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	302 if widget.match(**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	303 children.append(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	304 self.deepApply(_childCollector)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	305 return children
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	306
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	307 def getNamedChildren(self):
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	308 """
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	309 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	310 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	311 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	312
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	313 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	314 are handled correctly.
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	315
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	316 Usage::
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	317 children = widget.getNamedChildren()
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	318 for widget in children.get("info",[])
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	319 print widget.name , " == info"
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	320 """
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	321 children = {}
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	322 def _childCollector(widget):
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	323 if widget.has_name:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	324 children.setdefault(widget._name,[]).append(widget)
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	325 self.deepApply(_childCollector)
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	326 return children
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	327
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	328 def findChild(self,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	329 """ Find the first contained child widgets by attribute values.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	330
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	331 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	332 closeButton = root_widget.findChild(name='close')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	333 """
329 aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	334 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	335 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	336
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	337 children = self.findChildren(**kwargs)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	338 if children:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	339 return children[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	340 return None
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	341
329 aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	342 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	343 """
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	344 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	345
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	346 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	347 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	348 if possible.
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	349 """
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	350 result = []
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	351 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	352 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	353 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	354 raise StopTreeWalking
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	355 try:
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	356 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	357 except StopTreeWalking:
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	358 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	359 return None
aca5744f017a Added fast path for Widget.findChild(name=name). Roughly 10x faster. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 255 diff changeset	360
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	361 def addChild(self,widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	362 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	363 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	364 in container widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	365
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	366 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	367 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	368 automatically.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	369 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	370 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	371
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	372 def insertChild(self, widget, position):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	373 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	374 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	375
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	376 See L{addChild} and L{insertChildBefore}
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	377 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	378 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	379
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	380 def insertChildBefore(self, widget, before):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	381 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	382 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	383 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	384
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	385 See L{addChild} and L{insertChild}
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	386 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	387 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	388
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	389 def addChildren(self,*widgets):
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 Add multiple widgets as children.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	392 Only implemented for container widgets. See also L{addChild}
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	393
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	394 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	395 container.addChildren( widget1, widget2, ... )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	396 # or you can use this on a list
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	397 container.addChildren( [widget1,widget2,...] )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	398 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	399 if len(widgets) == 1 and not isinstance(widgets[0],Widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	400 widgets = widgets[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	401 for widget in widgets:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	402 self.addChild(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	403
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	404 def removeChild(self,widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	405 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	406 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	407 in container widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	408
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	409 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	410 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	411 automatically.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	412 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	413 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	414
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	415 def removeChildren(self,*widgets):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	416 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	417 Remove a list of direct child widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	418 All widgets have to be direct child widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	419 To 'clear' a container take a look at L{removeAllChildren}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	420 See also L{removeChild}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	421
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	422 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	423 container.removeChildren( widget1, widget2, ... )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	424 # or you can use this on a list
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	425 container.removeChildren( [widget1,widget2,...] )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	426 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	427 if len(widgets) == 1 and not isinstance(widgets[0],Widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	428 widgets = widgets[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	429 for widget in widgets:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	430 self.removeChild(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	431
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	432 def removeAllChildren(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	433 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	434 This function will remove all direct child widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	435 This will work even for non-container widgets.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	436 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	437 children = self.findChildren(parent=self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	438 for widget in children:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	439 self.removeChild(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	440
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	441 def mapEvents(self,eventMap,ignoreMissing = False):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	442 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	443 Convenience function to map widget events to functions
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	444 in a batch.
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 Subsequent calls of mapEvents will merge events with different
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	447 widget names and override the previously set callback.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	448 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	449 disable the event completely.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	450
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	451 @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	452 @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	453 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	454
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	455 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	456 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	457
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	458 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	459 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	460 The default group name is C{"default"}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	461
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	462 Example::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	463 guiElement.mapEvents({
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	464 "button" : guiElement.hide,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	465 "button/mouseEntered" : toggleButtonColorGreen,
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	466 "button/mouseExited" : toggleButtonColorBlue,
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
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	469 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	470 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	471 for descr,func in eventMap.items():
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	472 name, event_name, group_name = events.splitEventDescriptor(descr)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	473 #print name, event_name, group_name
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	474 widgets = children.get(name,[])
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	475 if widgets:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	476 for widget in widgets:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	477 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	478 elif not ignoreMissing:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	479 raise RuntimeError("No widget with the name: %s" % name)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	480
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	481 def setInitialData(self,data):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	482 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	483 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	484 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	485 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	486 if not self.accepts_initial_data:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	487 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	488 self._realSetInitialData(data)
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 def setData(self,data):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	491 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	492 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	493 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	494 This is inverse to L{getData}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	495 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	496 if not self.accepts_data:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	497 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	498 self._realSetData(data)
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 def getData(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	501 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	502 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	503 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	504 This is inverse to L{setData}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	505 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	506 if not self.accepts_data:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	507 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	508 return self._realGetData()
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 def distributeInitialData(self,initialDataMap):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	511 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	512 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	513 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	514 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	515 By default a missing widget is just ignored.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	516
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	517 Use it like this::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	518 guiElement.distributeInitialData({
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	519 'myTextField' : 'Hello World!',
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	520 'myListBox' : ["1","2","3"]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	521 })
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	522
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	523 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	524 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	525 for name,data in initialDataMap.items():
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	526 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	527 for widget in widgetList:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	528 widget.setInitialData(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 distributeData(self,dataMap):
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 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	533 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	534 This will only accept unique matches.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	535
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	536 Use it like this::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	537 guiElement.distributeData({
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	538 'myTextField' : 'Hello World!',
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	539 'myListBox' : ["1","2","3"]
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
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	542 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	543 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	544 for name,data in dataMap.items():
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("DistributeData can only handle widgets with unique names.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	550 widgetList[0].setData(data)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	551
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	552 def collectDataAsDict(self,widgetNames):
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 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	555 This can only handle UNIQUE widget names (in the hierachy)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	556 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	557 is not equal to one.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	558
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	559 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	560 data = guiElement.collectDataAsDict(['myTextField','myListBox'])
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	561 print "You entered:",data['myTextField']," and selected ",data['myListBox']
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	562
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	563 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	564 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	565 dataMap = {}
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	566 for name in widgetNames:
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	567 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	568 if len(widgetList) != 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	569 if get_manager().debug:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	570 self.listNamedWidgets()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	571 raise RuntimeError("CollectData can only handle widgets with unique names.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	572
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	573 dataMap[name] = widgetList[0].getData()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	574 return dataMap
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	575
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	576 def collectData(self,*widgetNames):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	577 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	578 Collect data from a widget hierachy by names.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	579 This can only handle UNIQUE widget names (in the hierachy)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	580 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	581 is not equal to one.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	582
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	583 This function takes an arbitrary number of widget names and
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	584 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	585
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	586 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	587 data, with out putting it into a list.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	588
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	589 Usage::
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	590 # Multiple element extraction:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	591 text, selected = guiElement.collectData('myTextField','myListBox')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	592 print "You entered:",text," and selected item nr",selected
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	593 # Single elements are handled gracefully, too:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	594 test = guiElement.collectData('testElement')
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	595
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	596 """
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	597 children = self.getNamedChildren()
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	598 dataList = []
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	599 for name in widgetNames:
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	600 widgetList = children.get(name,[])
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	601 if len(widgetList) != 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	602 if get_manager().debug:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	603 self.listNamedWidgets()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	604 raise RuntimeError("CollectData can only handle widgets with unique names.")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	605 dataList.append( widgetList[0].getData() )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	606 if len(dataList) == 1:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	607 return dataList[0]
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	608 return dataList
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 def listNamedWidgets(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	611 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	612 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	613 to the standard output. This is useful for debugging purposes.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	614 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	615 def _printNamedWidget(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	616 if widget.name != Widget.DEFAULT_NAME:
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	617 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	618 print "Named child widgets of ",repr(self)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	619 print "name".ljust(20),"widget".ljust(50),"parent"
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	620 self.deepApply(_printNamedWidget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	621
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	622 def stylize(self,style,**kwargs):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	623 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	624 Recursively apply a style to all widgets.
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 _restyle(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	627 get_manager().stylize(widget,style,**kwargs)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	628 self.deepApply(_restyle)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	629
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	630 def resizeToContent(self,recurse = True):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	631 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	632 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	633 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	634 """
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 expandContent(self,recurse = True):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	637 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	638 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	639 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	640 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	641
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 def _recursiveResizeToContent(self):
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 Recursively call L{resizeToContent}. Uses L{deepApply}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	646 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	647 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	648 def _callResizeToContent(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	649 #print "RTC:",widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	650 widget.resizeToContent()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	651 self.deepApply(_callResizeToContent)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	652
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	653 def _recursiveExpandContent(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	654 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	655 Recursively call L{expandContent}. Uses L{deepApply}.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	656 Do not call directly.
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	657 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	658 def _callExpandContent(widget):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	659 #print "ETC:",widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	660 widget.expandContent()
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	661 self.deepApply(_callExpandContent, leaves_first=False)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	662
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	663 def deepApply(self,visitorFunc, leaves_first = True):
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	664 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	665 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	666 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	667 visitorFunc(self)
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	668
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	669 def getAbsolutePos(self):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	670 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	671 Get absolute position on screen
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	672 """
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	673 absX = self.x
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	674 absY = self.y
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	675 parent = self.parent
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	676 while parent is not None:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	677 absX += parent.x
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	678 absY += parent.y
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	679 parent = parent.parent
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	680 return (absX, absY)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	681
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	682 def sizeChanged(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	683 pass
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	684
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	685 def __str__(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	686 return "%s(name='%s')" % (self.__class__.__name__,self.name)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	687
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	688 def __repr__(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	689 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	690
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	691 def _setSize(self,size):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	692 if isinstance(size,fife.Point):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	693 self.width, self.height = size.x, size.y
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	694 else:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	695 self.width, self.height = size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	696
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	697 def _getSize(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	698 return self.width, self.height
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 _setPosition(self,size):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	701 if isinstance(size,fife.Point):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	702 self.x, self.y = size.x, size.y
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	703 else:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	704 self.x, self.y = size
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	705
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	706 def _getPosition(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	707 return self.x, self.y
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 _setX(self,x):self.real_widget.setX(x)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	710 def _getX(self): return self.real_widget.getX()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	711 def _setY(self,y): self.real_widget.setY(y)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	712 def _getY(self): return self.real_widget.getY()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	713
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	714 def _setWidth(self,w):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	715 old_width = self.width
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	716 w = max(self.min_size[0],w)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	717 w = min(self.max_size[0],w)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	718 self.real_widget.setWidth(w)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	719 if w != old_width:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	720 self.sizeChanged()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	721
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	722 def _getWidth(self): return self.real_widget.getWidth()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	723 def _setHeight(self,h):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	724 old_height = self.height
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	725 h = max(self.min_size[1],h)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	726 h = min(self.max_size[1],h)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	727 self.real_widget.setHeight(h)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	728 if h != old_height:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	729 self.sizeChanged()
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 _getHeight(self): return self.real_widget.getHeight()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	732
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	733 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	734 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	735 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	736 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	737 def _setMinWidth(self,w):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	738 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	739 def _setMaxWidth(self,w):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	740 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	741 def _setMinHeight(self,h):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	742 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	743 def _setMaxHeight(self,h):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	744 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	745
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	746 def _setFont(self, font):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	747 self._font = font
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	748 self.real_font = get_manager().getFont(font)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	749 self.real_widget.setFont(self.real_font)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	750 def _getFont(self):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	751 return self._font
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	752
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	753 def _getBorderSize(self): return self.real_widget.getFrameSize()
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	754 def _setBorderSize(self,size): self.real_widget.setFrameSize(size)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	755
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	756 base_color = ColorProperty("BaseColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	757 background_color = ColorProperty("BackgroundColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	758 foreground_color = ColorProperty("ForegroundColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	759 selection_color = ColorProperty("SelectionColor")
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	760
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	761 def _getStyle(self): return self._style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	762 def _setStyle(self,style):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	763 self._style = style
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	764 get_manager().stylize(self,style)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	765 style = property(_getStyle,_setStyle)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	766
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	767 def _getParent(self): return self.__parent
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	768 def _setParent(self,parent):
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	769 if self.__parent is not parent:
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	770 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	771 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	772 self.__parent.removeChild(self)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	773 self.__parent = parent
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	774 parent = property(_getParent,_setParent)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	775
330 33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	776 def _setName(self,name):
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	777 self._name = name
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	778 if name != Widget.DEFAULT_NAME:
33dd55160a9d * Added a new method Widget.getNamedChildren phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 329 diff changeset	779 self.has_name = True
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	780 def _getName(self):
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	781 # __str__ relies on self.name
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	782 return getattr(self,'_name','__no_name_yet__')
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	783 name = property(_getName,_setName)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	784
253 6ab09eb765a1 * Added patch by MadMonk that exposes the guichan focus functions to pychan nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 249 diff changeset	785 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	786 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	787 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	788
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	789 x = property(_getX,_setX)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	790 y = property(_getY,_setY)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	791 width = property(_getWidth,_setWidth)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	792 height = property(_getHeight,_setHeight)
255 51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	793 min_width = property(_getMinWidth,_setMinWidth)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	794 min_height = property(_getMinHeight,_setMinHeight)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	795 max_width = property(_getMaxWidth,_setMaxWidth)
51cc05d862f2 Merged editor_rewrite branch to trunk. cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 253 diff changeset	796 max_height = property(_getMaxHeight,_setMaxHeight)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	797 size = property(_getSize,_setSize)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	798 position = property(_getPosition,_setPosition)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	799 font = property(_getFont,_setFont)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	800 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	801 is_focusable = property(_isFocusable,_setFocusable)
248 a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	802
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	803 def setEnterCallback(self, cb):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	804 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	805 DEPRECATED
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	806
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	807 Callback is called when mouse enters the area of Widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	808 callback should have form of function(button)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	809 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	810 if cb is None:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	811 self.capture(None, event_name = "mouseEntered" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	812 return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	813
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	814 def callback(widget=None):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	815 return cb(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	816 print "PyChan: You are using the DEPRECATED functionality: setEnterCallback."
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	817 self.capture(callback, event_name = "mouseEntered" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	818
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	819 def setExitCallback(self, cb):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	820 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	821 DEPRECATED
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	822
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	823 Callback is called when mouse exits the area of Widget
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	824 callback should have form of function(button)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	825 """
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	826 if cb is None:
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	827 self.capture(None, event_name = "mouseExited" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	828 return
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	829
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	830 def callback(widget=None):
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	831 return cb(widget)
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	832 print "PyChan: You are using the DEPRECATED functionality: setExitCallback."
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	833 self.capture(callback, event_name = "mouseExited" )
a2d5e2721489 widgets.py split up. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	834

Mercurial > fife-parpg

annotate engine/extensions/pychan/widgets/widget.py @ 331:48c99636453e