1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
#------------------------------------------------------------------------------
#
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
#
# Author: David C. Morrill
# Date: 10/21/2004
#
#------------------------------------------------------------------------------
""" Defines the HTML "editor" for the wxPython user interface toolkit.
HTML editors interpret and display HTML-formatted text, but do not
modify it.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
import os.path
import webbrowser
import wx.html as wh
from traits.api import Str
# FIXME: ToolkitEditorFactory is a proxy class defined here just for backward
# compatibility. The class has been moved to the
# traitsui.editors.html_editor file.
from traitsui.editors.html_editor import ToolkitEditorFactory
from editor import Editor
#-------------------------------------------------------------------------------
# URLResolvingHtmlWindow class:
#-------------------------------------------------------------------------------
class URLResolvingHtmlWindow( wh.HtmlWindow ):
""" Overrides OnOpeningURL method of HtmlWindow to append the base URL
local links.
"""
def __init__( self, parent, open_externally, base_url ):
wh.HtmlWindow.__init__( self, parent )
self.open_externally = open_externally
self.base_url = base_url
def OnLinkClicked ( self, link_info ):
""" Handle the base url and opening in a new browser window for links.
"""
if self.open_externally:
url = link_info.GetHref()
if (self.base_url and
not url.startswith( ( 'http://', 'https://' ) )):
url = self.base_url + url
if not url.startswith( ( 'file://', 'http://', 'https://' ) ):
url = 'file://' + url
webbrowser.open_new( url )
def OnOpeningURL( self, url_type, url ):
""" According to the documentation, this method is supposed to be called
for both images and link clicks, but it appears to only be called
for image loading, hence the base url handling code in
OnLinkClicked.
"""
if (self.base_url and not os.path.isabs(url) and
not url.startswith( ( 'http://', 'https://', self.base_url ) )):
return self.base_url + url
else:
return wh.HTML_OPEN
#-------------------------------------------------------------------------------
# 'SimpleEditor' class:
#-------------------------------------------------------------------------------
class SimpleEditor ( Editor ):
""" Simple style of editor for HTML, which displays interpreted HTML.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Is the HTML editor scrollable? This values override the default.
scrollable = True
# External objects referenced in the HTML are relative to this URL
base_url = Str
#---------------------------------------------------------------------------
# Finishes initializing the editor by creating the underlying toolkit
# widget:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.control = URLResolvingHtmlWindow( parent ,
self.factory.open_externally,
self.base_url )
self.control.SetBorders( 2 )
self.base_url = self.factory.base_url
self.sync_value( self.factory.base_url_name, 'base_url', 'from' )
#---------------------------------------------------------------------------
# Updates the editor when the object trait changes external to the editor:
#---------------------------------------------------------------------------
def update_editor ( self ):
""" Updates the editor when the object trait changes external to the
editor.
"""
text = self.str_value
if self.factory.format_text:
text = self.factory.parse_text( text )
self.control.SetPage( text )
#-- Event Handlers ---------------------------------------------------------
def _base_url_changed(self):
url = self.base_url
if not url.endswith( '/' ):
url += '/'
self.control.base_url = url
self.update_editor()
#--EOF-------------------------------------------------------------------------
|
