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
|
#------------------------------------------------------------------------------
#
# 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/25/2004
#
#------------------------------------------------------------------------------
""" Defines the HTML help templates used for formatting Traits UI help pages.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.api import HasStrictTraits, Str
#-------------------------------------------------------------------------------
# Constants:
#-------------------------------------------------------------------------------
# Default HTML for a single Item's help window
ItemHTML = """
<HTML>
<BODY BGCOLOR="#E8E5D4">
<TABLE CELLPADDING="0">
<TR>
<TD BGCOLOR="#000000">
<TABLE CELLSPACING = "1">
<TR>
<TD WIDTH="20%%" VALIGN="TOP" BGCOLOR="#9DB8F4"><B>%s</B></TD>
<TD WIDTH="80%%" VALIGN="TOP" BGCOLOR="#C1D2F9">%s</TD>
</TR>
</TABLE>
</TD>
</TR>
</TABLE>
</BODY>
</HTML>"""
# Default HTML for a complete Group's help window
GroupHTML = """
<HTML>
<BODY BGCOLOR="#E8E5D4">%s
<TABLE CELLPADDING="0">
<TR>
<TD BGCOLOR="#000000">
<TABLE CELLSPACING="1">%s</TABLE>
</TD>
</TR>
</TABLE>
</BODY>
</HTML>"""
# Default HTML for a single Item within a Group
ItemHelp = """
<TR>
<TD WIDTH="20%%" VALIGN="TOP" BGCOLOR="#9DB8F4"><B>%s</B>:</TD>
<TD WIDTH="80%%" VALIGN="TOP" BGCOLOR="#C1D2F9">%s</TD>
</TR>"""
# Default HTML for formatting a Group's 'help' trait
GroupHelp = """
<TABLE WIDTH="100%%" CELLPADDING="0">
<TR>
<TD BGCOLOR="#000000">
<TABLE CELLSPACING="1">
<TR>
<TD BGCOLOR="#CDCDB6">%s</TD>
</TR>
</TABLE>
</TD>
</TR>
</TABLE>"""
#-------------------------------------------------------------------------------
# 'HelpTemplate' class:
#-------------------------------------------------------------------------------
class HelpTemplate ( HasStrictTraits ):
""" Contains HTML templates for displaying help.
"""
item_html = Str( ItemHTML ) # Item popup help window HTML document
group_html = Str( GroupHTML ) # Group help window HTML document
item_help = Str( ItemHelp ) # Single group item HTML
group_help = Str( GroupHelp ) # Group level help HTML
no_group_help = Str( '' ) # Missing group level help HTML
#-------------------------------------------------------------------------------
# Gets/Sets the current HelpTemplate in use:
#-------------------------------------------------------------------------------
_help_template = HelpTemplate()
def help_template ( template = None ):
""" Gets or sets the current HelpTemplate in use.
"""
global _help_template
if template is not None:
_help_template = template
return _help_template
|
