Thuban/UI/common.py

# Copyright (c) 2001, 2003 by Intevation GmbH
# Authors:
# Jonathan Coles <[email protected]>
#
# This program is free software under the GPL (>=v2)
# Read the file COPYING coming with Thuban for details.

"""Miscellaneous UI related functions"""

__version__ = "$Revision$"
# $Source$
# $Id$


from Thuban.Model.color import Color
from wxPython.wx import wxColour, \
     wxBeginBusyCursor, wxEndBusyCursor, wxSafeYield

def Color2wxColour(color):
    """Return a wxColor object for the Thuban color object color"""
    assert(color is not None)
    assert(isinstance(color, Color))
    return wxColour(color.red   * 255,
                    color.green * 255,
                    color.blue  * 255)

def wxColour2Color(colour):
    """Return a Thuban color object for the wxColor object color"""
    assert(colour is not None)
    # this doesn't work because colour is really a wxColourPtr!
    #assert(isinstance(colour, wxColour))
    return Color(colour.Red()   / 255.0,
                 colour.Green() / 255.0,
                 colour.Blue()  / 255.0)

def ThubanBeginBusyCursor():
    """Thuban wrapper for wxBeginBusyCursor

    In addition to calling wxBeginBusyCursor this function also calls
    wxSafeYield to make sure that the cursor change takes effect. wxGTK
    2.4 at least doesn't do that automatically.

    This function and the corresponding ThubanEndBusyCursor function are
    the functions to use in Thuban to set a busy cursor.
    """
    wxBeginBusyCursor()
    wxSafeYield()

def ThubanEndBusyCursor():
    """Thuban wrapper for wxEndBusyCursor

    This function doesn't do anything more than calling wxEndBusyCursor
    yet, but please use this whereever you use ThubanBeginBusyCursor.
    """
    wxEndBusyCursor()
1	bh	1541	# Copyright (c) 2001, 2003 by Intevation GmbH
2	jonathan	438	# Authors:
3			# Jonathan Coles <[email protected]>
4			#
5			# This program is free software under the GPL (>=v2)
6			# Read the file COPYING coming with Thuban for details.
7
8	bh	1541	"""Miscellaneous UI related functions"""
9
10			__version__ = "$Revision$"
11			# $Source$
12			# $Id$
13
14
15	jonathan	438	from Thuban.Model.color import Color
16	jonathan	1284	from wxPython.wx import wxColour, \
17			wxBeginBusyCursor, wxEndBusyCursor, wxSafeYield
18	jonathan	438
19			def Color2wxColour(color):
20	bh	1541	"""Return a wxColor object for the Thuban color object color"""
21	jonathan	438	assert(color is not None)
22			assert(isinstance(color, Color))
23			return wxColour(color.red * 255,
24			color.green * 255,
25			color.blue * 255)
26
27			def wxColour2Color(colour):
28	bh	1541	"""Return a Thuban color object for the wxColor object color"""
29	jonathan	438	assert(colour is not None)
30			# this doesn't work because colour is really a wxColourPtr!
31			#assert(isinstance(colour, wxColour))
32			return Color(colour.Red() / 255.0,
33			colour.Green() / 255.0,
34			colour.Blue() / 255.0)
35
36	jonathan	1275	def ThubanBeginBusyCursor():
37	bh	1541	"""Thuban wrapper for wxBeginBusyCursor
38
39			In addition to calling wxBeginBusyCursor this function also calls
40			wxSafeYield to make sure that the cursor change takes effect. wxGTK
41			2.4 at least doesn't do that automatically.
42
43			This function and the corresponding ThubanEndBusyCursor function are
44			the functions to use in Thuban to set a busy cursor.
45			"""
46	jonathan	1275	wxBeginBusyCursor()
47	jonathan	1284	wxSafeYield()
48	jonathan	1275
49			def ThubanEndBusyCursor():
50	bh	1541	"""Thuban wrapper for wxEndBusyCursor
51
52			This function doesn't do anything more than calling wxEndBusyCursor
53			yet, but please use this whereever you use ThubanBeginBusyCursor.
54			"""
55	jonathan	1275	wxEndBusyCursor()
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision