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

annotate engine/extensions/pychan/widgets/widget.py @ 377:fe6fb0e0ed23

Adding freebsd8 build support. Thanks to varnie.

author	prock@33b003aa-7bff-0310-803a-e67f0ece8222
date	Wed, 09 Dec 2009 17:01:52 +0000
parents	dfd48d49c044
children

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

Mercurial > fife-parpg

annotate engine/extensions/pychan/widgets/widget.py @ 377:fe6fb0e0ed23