Module enthought.traits.ui.help

API Reference for Enthought Tool Suite 3.2.0

Defines the HTML help templates used for formatting Traits UI help pages.

Variables
Classes
Functions
Imported Names

Variables

GroupHelp

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>"""

GroupHTML

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>"""

ItemHelp

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>"""

ItemHTML

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>"""

Classes

HelpTemplate - Contains HTML templates for displaying help.

Function summary

help_template(template = None)

Functions

help_template(template = None)

Gets or sets the current HelpTemplate in use.

Imported Names

Local name	Refers to
HasStrictTraits	enthought.traits.has_traits.HasStrictTraits
Str	enthought.traits.trait_types.Str

Module enthought.​traits.​ui.​help_template

Variables

Classes

Function summary

Functions

Imported Names

Module enthought.traits.ui.help_template