wx.lib.agw.xlsgrid.XLSRichText

This is a class which holds information about the cell content, in terms of actual cell value, font, text colour, alignment and formatting. In addition to what XLSText does, this class attempts to handle cells with rich text content.

Class Hierarchy

Inheritance diagram for class XLSRichText:

Known Superclasses

wx.lib.agw.xlsgrid.XLSText

Methods Summary

__init__	Default class constructor.
BuildChunks	Splits the cell content accordingly to their rich text format index.
Draw	Actually draws all the chunks of text on a grid cell, one by one.
Measure	Convenience method to measure the maximum height and total width of all

Class API

class XLSRichText(XLSText)

This is a class which holds information about the cell content, in terms of actual cell value, font, text colour, alignment and formatting. In addition to what XLSText does, this class attempts to handle cells with rich text content.

Methods

__init__(self, book, cell, xf_index, display_text=None, hyperlink=None, rich_text=None, default_width=10)

Default class constructor.

Parameters:

• book – an instance of the xlrd.Book class;

• cell – an instance of xlrd.sheet.Cell class;

• xf_index – an index into xlrd.Book.xf_list, which holds a reference to the xlrd.sheet.Cell class (the actual cell for xlrd);

• display_text – if Mark Hammonds’ pywin32 package is available, this is the WYSIWYG cell content;

• hyperlink – if this cell contains a hyperlink, it will be displayed accordingly;

• rich_text – if this cell contains text in rich text format, XLSGrid will do its best to render the text as rich text;

• default_width – this is the default width of the text in 1/256 of the width of the zero character, using default Excel font (first FONT record in the Excel file).

Note

If you are using version 0.7.1 or lower for xlrd, the hyperlink parameter will always be None as this feature is available only in xlrd 0.7.2 (SVN).

Note

If you are using version 0.7.1 or lower for xlrd, this class will note be used by XLSGrid.

Warning

This class currently supports only single-line non-rotated text, and it discards properties like shrink-to-fit and wrapping.

---

BuildChunks(self, book, xf_index, rich_text)

Splits the cell content accordingly to their rich text format index.

Parameters:

• book – an instance of the xlrd.Book class;

• xf_index – an index into xlrd.Book.xf_list, which holds a reference to the xlrd.sheet.Cell class (the actual cell for xlrd);

• rich_text – if this cell contains text in rich text format, XLSGrid will do its best to render the text as rich text.

---

Draw(self, dc, rect)

Actually draws all the chunks of text on a grid cell, one by one.

Parameters:

• dc – an instance of wx.DC;

• rect – an instance of wx.Rect, representing the cell rectangle.

---

Measure(self, dc)

Convenience method to measure the maximum height and total width of all the chunks of text composing our rich text string.

Parameters:

dc – an instance of wx.DC.