WxPythonInAction/ChapterSixteen

在你的web浏览器中，你可能也注意到了一件事，那就是浏览器中不光只有显示窗口，还有标题栏和状态栏。通常，标题栏显示打开页面的标题，状态栏在鼠标位于链接上时显示链接信息。在wxPython中有两个便捷的方法来实现这些。图16.3对此作了展示。窗口显示的标题是基于web页面的标题的，状态栏文本也来自Html窗口。

例16.3是产生图16.3的代码。

图16.3 带有状态栏和标题栏的HTML窗口

attachment:w16.3.gif

例16.3 从一个web页载入HTMLWindow的内容

   1 #-*- encoding:UTF-8 -*- 
   2 import wx
   3 import wx.html
   4 
   5 class MyHtmlFrame(wx.Frame):
   6     def __init__(self, parent, title):
   7         wx.Frame.__init__(self, parent, -1, title, size=(600,400))
   8         self.CreateStatusBar()
   9         
  10         html = wx.html.HtmlWindow(self)
  11         if "gtk2" in wx.PlatformInfo:
  12             html.SetStandardFonts()
  13         html.SetRelatedFrame(self, self.GetTitle() + " -- %s") #关联HTML到框架
  14         html.SetRelatedStatusBar(0) #关联HTML到状态栏
  15 
  16         wx.CallAfter(
  17             html.LoadPage, "http://www.wxpython.org")
  18 
  19 app = wx.PySimpleApp()
  20 frm = MyHtmlFrame(None, "Simple HTML Browser")
  21 frm.Show()
  22 app.MainLoop()

要设置标题栏的关联，使用方法SetRelatedFrame(frame, format)。参数frame你想显示页面标题的框架。参数format是你想在框架的标题栏中显示的字符串。通常的格式是这样：“My wxPython Browser: %s”。:%s前面的字符串可以是你想要的任何字符串，%s将会被HTML页面的标题所取代。在窗口中，一个页面被载入时，框架的标题自动被新的页面的信息取代。

要设置状态栏，使用方法SetRelatedStatusBar(bar)。该方法必须在SetRelatedFrame()之后调用。参数bar是状态栏中用于显示状态信息的位置。通常它是0，但是如果状态栏中存在多个显示区域，那么bar可以有其它的值。如果bar的取值为－1,那么不显示任何信息。一旦与状态栏的关联被创建，那么当鼠标移动到显示的页面的链接上时，相关链接的URL将显示在状态栏中。

如何打印一个HTML页面？

一旦HTML被显示在屏幕上，接下来可能做的事就是打印该HTML。类wx.html.HtmlEasyPrinting就是用于此目的的。你可以使用下面的构造函数来创建wx.html.HtmlEasyPrinting的一个实例：

wx.html.HtmlEasyPrinting(name="Printing", parentWindow=None)

参数name只是一个用于显示在打印对话框中的字符串。参数parentWindow如果被指定了，那么parentWindow就是这些打印对话框的父窗口。如果parentWindow为None，那么对话框为顶级对话框。你只应该创建wx.html.HtmlEasyPrinting的一个实例。尽管wxPython系统没有强制要这样做，但是该类是被设计为独自存的。

使用wx.html.HtmlEasyPrinting的实例

从该类的名字可以看出，它应该是容易使用的。首先，通过使用PrinterSetup()和PageSetup()方法，你能够给用户显示用于打印设置的对话框。调用这些方法将导致相应的对话框显示给用户。实例将存储用户所做的设置，以备后用。如果你想访问这些设置数据，以用于你自己特定的处理，你可以使用方法GetPrintData()和GetPageSetupData()。GetPrintData()方法返回一个wx.PrintData对象，GetPageSetupData()方法返回一wx.PageSetupDialogData对象，我们将在第17章中更详细地讨论。

设置字体

你可以使用方法SetFonts(normal_face, fixed_face, sizes)来设置打印所使用的字体。这个方法的行为同用于HTML窗口的SetFonts()相同（在打印对象中的设置不会影响到HTML窗口中的设置）。你可以使用方法SetHeader(header, pg)和SetFooter(footer, pg)来页眉和页脚。参数header和footer是要显示的字符串。字符串中你可以使用点位符@PAGENUM@，占位符在执行时被打印的页号替代。你也可以使用@PAGENUM@占位符，它是打印的页面总数。参数pg的取值可以是这三个：wx.PAGE_ALL、wx.PAGE_EVEN或wx.PAGE_ODD。它控制页眉和页脚显示在哪个页上。通过对不同的pg参数多次调用该方法，可以为奇数页和偶数页设置单独的页眉和页脚。

输出预览

如果在打印前，你想预览一下输出的结果，你可以使用PreviewFile(htmlfile)方法。在这种情况下，参数htmlfile是你本地的包含HTML的文件的文件名。另一是PreviewText(htmlText, basepath="")。参数htmlText是你实际想打印的HTML。basepath文件的路径或URL。如预览成功，这两个方法均返回True，否则返回False。如果出现了错误，那么全局方法wx.Printer.GetLastError()将得到更多的错误信息。关于该方法的更详细的信息将在第17章中讨论。

打印

现在你可能想知道如何简单地打印一个HTML页面。方法就是PrintFile(htmlfile)和PrintText(htmlText, basepath)。其中的参数同预览方法。所不同的是，这两个方法使用对话框中的设置直接让打印机打印。打印成功，则返回True。

拓展HTML窗口

在这一节，我们将给你展示如何处理HTML窗口中的HTML标记，如何创造你自己的标记，如何在HTML中嵌入wxPython控件，如何处理其它的文件格式，以及如何在你的应用程序中创建一个真实的HTML浏览器。

HTML解析器(parser)是如何工作的？

在wxPython中，HTML窗口有它自己内在的解析器。实际上，这里有两个解析器类，但是其中的一个是另一个的改进。通常，使用解析器工作仅在你想扩展wx.html.HtmlWindow自身的功能时有用。如果你正在使用Python编程，并基于其它的目的想使用一个HTML解析器，那么我们建议你使用随同Python发布的htmllib和HTMLParser这两个解析器模块之一，或一个外部的Python工具如“Beautiful Soup”。

两个解析器类分别是wx.html.HtmlParser，它是一个更通用的解析器，另一个是wx.html.HtmlWinParser，它是wx.html.HtmlParser的子类，增加了对在wx.html.HtmlWindow中显示文本的支持。由于我们所关注的基本上是HTML窗口，所以我们将重点关注wx.html.HtmlWinParser。

要创建一个HTML解析器，可以使用两个构造函数之一。其中基本的一个是wx.html.HtmlWinParser()，没有参数。wx.html.HtmlWinParser的父类wx.html.HtmlParser也有一个没有参数的构造函数。你可以使用另一个构造函数wx.html.HtmlWinParser(wnd)将一个wx.html.HtmlWinParser()与一个已有的wx.html.HtmlWindow联系在一起，参数wnd是HTML窗口的实例。

要使用解析器，最简单的方法是调用Parse(source)方法。参数source是要被处理的HTML字符串。返回值是已解析了的数据。对于一个wx.html.HtmlWinParser，返回值是类wx.html.HtmlCell的一个实例。

HTML解析器将HTML文本转换为一系列的单元，一个单元可以表示一些文本，一个图像，一个表，一个列表，或其它特定的元素。wx.html.HtmlCell的最重要的子类是wx.html.HtmlContainerCell，它是一个可以包含其它单元在其中的一个单元，如一个表或一个带有不同文本样式的段落。对于你解析的几乎任何文档，返回值都将是一个wx.html.HtmlContainerCell。每个单元都包含一个Draw(dc, x, y, view_y1, view_y2)方法，这使它可以在HTML窗口中自动绘制它的信息。

另一个重要的子类单元是wx.html.HtmlWidgetCell，它允许一个任意的wxPython控件像任何其它单元一样被插入到一个HTML文档中。除了可以包括用于格式化显示的静态文本，这也包括任何类型的用于管理HTML表单的控件。wx.html.HtmlWidgetCell的构造函数如下：

wx.html.HtmlWidgetCell(wnd, w=0) 

其中参数wnd是要被绘制的wxPython控件。参数w是一个浮动宽度。如果w不为0，那么它应该是介于1和100之间的一个整数，wnd控件的宽度则被动态地调整为相对于其父容器宽度的w%。

另外还有其它许多类型的用于显示HTML文档的部分的单元。更多的信息请参考wxWidget文档。

如何增加对新标记的支持？

被解析器返回的单元是被标记处理器内在的创建的，通过HTML标记，一个可插入的结构与HTML解析器单元的创建和处理相联系起来。你可以创建你自己的标记处理器，并将它与HTML标记相关联。使用这个机制，你可以扩展HTML窗口，以包括当前不支持的标准标记，或你自己发明的自定义的标记。图16.4显示了自定义HTML标记的用法。

图16.4

attachment:w16.4.gif

下例16.4是产生图16.4的代码。

例16.4 定义并使用自定义的标记处理器

   1 import wx
   2 import wx.html
   3 
   4 page = """ html  body 
   5 
   6 This silly example shows how custom tags can be defined and used in a
   7 wx.HtmlWindow.  We've defined a new tag,  blue  that will change
   8 the  blue foreground color /blue  of the portions of the document that
   9 it encloses to some shade of blue.  The tag handler can also use
  10 parameters specifed in the tag, for example:
  11 
  12  ul 
  13  li   blue shade='sky' Sky Blue /blue 
  14  li   blue shade='midnight' Midnight Blue /blue 
  15  li   blue shade='dark' Dark Blue /blue 
  16  li   blue shade='navy' Navy Blue /blue 
  17  /ul 
  18 
  19  /body  /html 
  20 """
  21 
  22 
  23 class BlueTagHandler(wx.html.HtmlWinTagHandler):#声明标记处理器
  24     def __init__(self):
  25         wx.html.HtmlWinTagHandler.__init__(self)
  26 
  27     def GetSupportedTags(self):#定义要处理的标记
  28         return "BLUE"
  29 
  30     def HandleTag(self, tag):#处理标记
  31         old = self.GetParser().GetActualColor()
  32         clr = "#0000FF"
  33         if tag.HasParam("SHADE"):
  34             shade = tag.GetParam("SHADE")
  35             if shade.upper() == "SKY":
  36                 clr = "#3299CC"
  37             if shade.upper() == "MIDNIGHT":
  38                 clr = "#2F2F4F"
  39             elif shade.upper() == "DARK":
  40                 clr = "#00008B"
  41             elif shade.upper == "NAVY":
  42                 clr = "#23238E"
  43 
  44         self.GetParser().SetActualColor(clr)
  45         self.GetParser().GetContainer().InsertCell(wx.html.HtmlColourCell(clr))
  46         
  47         self.ParseInner(tag)
  48 
  49         self.GetParser().SetActualColor(old)
  50         self.GetParser().GetContainer().InsertCell(wx.html.HtmlColourCell(old))
  51 
  52         return True
  53     
  54 
  55 wx.html.HtmlWinParser_AddTagHandler(BlueTagHandler)
  56 
  57 
  58 
  59 class MyHtmlFrame(wx.Frame):
  60     def __init__(self, parent, title):
  61         wx.Frame.__init__(self, parent, -1, title)
  62         html = wx.html.HtmlWindow(self)
  63         if "gtk2" in wx.PlatformInfo:
  64             html.SetStandardFonts()
  65         html.SetPage(page)
  66                 
  67 
  68 app = wx.PySimpleApp()
  69 frm = MyHtmlFrame(None, "Custom HTML Tag Handler")
  70 frm.Show()
  71 app.MainLoop()

标记内在的由类wx.Html.Tag的方法来表现，标记的实例由HTML解析器来创建，通常，你不需要自己创建。表16.4显示了wx.Html.Tag类的方法，它们有用于检索标记的信息。

表16.4 wx.Html.Tag的一些方法

用于扩展HTML窗口的标记处理器都是wx.html.HtmlWinTagHandler的子类。你的子类需要覆盖两个方法，并且你需要知道进一步的方法。需要覆盖的第一个方法是GetSupportedTags()。该方法返回由处理器管理的标记的列表。标记必需是大写的，并且标记之间以逗号分隔，中间不能有空格，如下所示：

   1 GetSupportedTags(self): 
   2     return "MYTAG,MYTAGPARAM"

第二个你需要覆盖的方法是HandleTag(tag)。在HandleTag(tag)方法中，你通过增加新的单元元素到解析器来处理标记（或者交替地改变解析器已经打开的容器单元）。你可以通过调用标记处理器的GetParser()方法来得到解析器。

要写一个HandleTag(tag)方法，你应该像下面这样做：

1、得到解析器。 2、对你的标记的参数做必要的处理，可能要改变或创建一个新的单元。 3、如果被解析的标记包括着内在的文本，那么解析标记之间的文本。 4、执行对于解析器所需要的任何清理工作。

如上所述，你使用GetParser()方法得解析器。要添加或编辑解析器中的单元，你有三个可选方案。第一个，如果你想添加另一个单元到容器中，你可以工作于当前的容器。第二个，你可以调用解析器的Container()方法，然后创建你的wx.html.HTMLCell子类实例，并通过调用容器的InsertCell(cell)方法将它添加到容器。

有时，你可能想在当前打开的容器中创建一个附属的或内嵌的容器。例如内嵌于表的一行中的一个单元格。要实现这个，你需要调用解析器的OpenContainer()方法。这个方法返回你的新的容器单元，你可以使用InsertCell(cell)方法来插入显示单元到你的新的容器单元中。对于每个在你的标记处理器中打开的容器，你应该使用CloseContainer()方法来关闭它。如果你没有成对的使用OpenContainer()和CloseContainer()，那么这将导致解析器解析余下的HTML文本时出现混乱。

第三个方案是创建一个与解析器的当前容器同级的容器，意思是不是嵌入的。例如一个新的段落——它不是前一段的一部分，也不附属于前一段；它是该页中的一个新的实体。为了在解析器中实现这个方案，你需要关闭现存的容器，再打一个新的容器，如下所示：

parser = self.GetParser() 
parser.CloseContainer()#关闭现存的容器
parser.OpenContainer()#打一个新的容器


# 添加或编辑解析器中的单元 

parser.CloseContainer() 
parser.OpenContainer() 

如何支持其他的文件格式？

默认情况下，HTML窗口可以处理带有MIME类型text/html, text/txt, 和image/*（假设wxPython图像处理器已经被装载）的文件。当碰上一个不是图像或HTML文件的文件时，该HTML窗口试图以纯文本的方式显示它。这可以不是你想要的行为。如果有一些文件你想以自定义的方式显示它的话，你可以创建一个wx.html.HtmlFilter来处理它。比如，你可能想以源代码树的方式显示XML文件，或使用语法着色来显示Python源代码文件。

要创建一个筛选器（filter），你必须建造wx.html.HtmlFilter的一个子类。wx.html.HtmlFilter类有两个方法，你必须都覆盖它们。这第一个方法是CanRead(file)。参数file是wx.FSFile（一个打开的文件的wxPython表示）的一个实例。类wx.FSFile有两个属性，你可以用来决定你的筛选器是否能够读该文件。方法GetMimeType()以一个字符串的形式返回该文件的MIME类型。MIME类型通常由文件的后缀所定义。方法GetLocation()返回带有相关文件位置的绝对路径或URL的一个字符串。如果筛选器会处理该文件的话，CanRead()方法应该返回True，否则返回False。处理Python源文件的CanRead()的一个示例如下：

   1 CanRead(self, file): 
   2     return file.GetLocation().endswith('.py') 

第二个你需要覆盖的方法是ReadFile(file)。这个方法要求一个同样的file参数，并返回该文件内容的一个字符串的HTML表达。如果你不想使用wxWidgets C++的文件机制来读该文件的话，你可以通过简单地打开位于file.GetLocation()的文件来使用Python的文件机制。

一旦筛选器被创建了，那么它必须被注册到wx.html.HtmlWindow，使用wx.html.HtmlWindow窗口的AddFilter(filter)静态方法来实现。参数filter是你的新的wx.html.HtmlFilter类的一个实例。一旦注册了筛选器，那么该窗口就可以使用筛选器来管理通过了CanRead()测试的文件对象。

如何得到一个性能更加完整的HTML控件？

尽管wx.html.HtmlWindow不是一个完整特性的浏览器面板，但是这儿有一对用于嵌入更加完整特性的HTML表现窗口的选择。如果你是在Windows平台上，你可以使用类wx.lib.iewin.IEHtmlWindow，它是Internet Explorer ActiveX控件的封装。这使得你能够直接将ie窗口嵌入到你的应用程序中。

使用IE控件比较简单，类似于使用内部的wxPython的HTML窗口。它的构造函数如下：

   1 wx.lib.iewin.IEHtmlWindow(self, parent, ID=-1, 
   2         pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, 
   3         name='IEHtmlWindow') 

其中参数parent是父窗口，ID是wxPython ID。对于IE窗口，这儿没有可用的样式标记。要装载HTML到IE组件中，可以使用方法LoadString(html)，其中参数html是要显示的一个HTML字符串。你可以使用方法LoadStream(stream)装载自一个打开的文件，或一个Python文件对象；或使用LoadString(URL)方法装载自一个URL。你能够使用GetText(asHTML)来获取当前显示的文本。参数asHTML是布尔值。如果为True，则返回HTML形式的文本，否则仅返回一个文本字符串。

在其它平台上，你可以尝试一下wxMozilla项目(http://wxmozilla.sourceforge.net)，该项目尝试创建一个Mozilla Gecko表现器的wxPython封装。目前该项目仍在测试阶段。wxMozilla有用于Windows和Linux的安装包，对Mac OS X的支持正在开发中。

本章小结

1、HTML不再是只用于Internet了。在wxPython中，你可以使用一个HTML窗口来显示带有HTML标记的简单子集的文本。该HTML窗口属于wx.html.HtmlWindow类。除了HTML文本，该HTML窗口还可以管理任一的图像（图像处理器已装载的情况下）。

2、你可以让HTML窗口显示一个字符串，一个本地文件或一个URL的信息。你可以像通常的超文本浏览器的方式显示用户的敲击，或使用它自定义的响应。你也可以将HTML窗口与它的框架相连接起来，以便标题和状态信息自动地显示在适当的地方。HTML窗口维护着一个历史列表，你可以对它进行访问和处理。你可以使用类wx.Html.HtmlEasyPrinting来直接打印你的页面。

3、在wxPython中有一个HTML解析器，你可以用来创建用于你自己窗口的自定义标记。你也可以配置自定义的文件筛选器来在一个HTML窗口中表现其它的文件格式。

4、最后，如果你对HTML窗口的局限性不太满意的话，那么你可以使用一个对IE控件的wxPython封闭。如果你不在Windows上的话，这儿也有一个对Mozilla Gecko HTML表现器的wxPython的封装。