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
136
137
138
139
140
141
142
143
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.xlsgrid
.. highlight:: python
.. _wx.lib.agw.xlsgrid.XLSRichText:
==========================================================================================================================================
|phoenix_title| **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 :class:`XLSText` does, this class attempts to handle cells with rich text
content.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>XLSRichText</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.xlsgrid.XLSRichText_inheritance.png" alt="Inheritance diagram of XLSRichText" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.xlsgrid.XLSRichText.html" title="wx.lib.agw.xlsgrid.XLSRichText" alt="" coords="5,83,213,112"/> <area shape="rect" id="node2" href="wx.lib.agw.xlsgrid.XLSText.html" title="wx.lib.agw.xlsgrid.XLSText" alt="" coords="18,5,200,35"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.xlsgrid.XLSText`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.xlsgrid.XLSRichText.__init__` Default class constructor.
:meth:`~wx.lib.agw.xlsgrid.XLSRichText.BuildChunks` Splits the cell content accordingly to their rich text format index.
:meth:`~wx.lib.agw.xlsgrid.XLSRichText.Draw` Actually draws all the chunks of text on a grid cell, one by one.
:meth:`~wx.lib.agw.xlsgrid.XLSRichText.Measure` Convenience method to measure the maximum height and total width of all
================================================================================ ================================================================================
|
|api| 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 :class:`XLSText` does, this class attempts to handle cells with rich text
content.
.. method:: __init__(self, book, cell, xf_index, display_text=None, hyperlink=None, rich_text=None, default_width=10)
Default class constructor.
:param `book`: an instance of the `xlrd.Book` class;
:param `cell`: an instance of `xlrd.sheet.Cell` class;
:param `xf_index`: an index into `xlrd.Book.xf_list`, which holds a
reference to the `xlrd.sheet.Cell` class (the actual cell for `xlrd`);
:param `display_text`: if Mark Hammonds' `pywin32` package is available,
this is the WYSIWYG cell content;
:param `hyperlink`: if this cell contains a hyperlink, it will be displayed
accordingly;
:param `rich_text`: if this cell contains text in rich text format, :class:`XLSGrid`
will do its best to render the text as rich text;
:param `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 :class:`XLSGrid`.
.. warning::
This class currently supports only single-line non-rotated text,
and it discards properties like `shrink-to-fit` and `wrapping`.
.. method:: BuildChunks(self, book, xf_index, rich_text)
Splits the cell content accordingly to their rich text format index.
:param `book`: an instance of the `xlrd.Book` class;
:param `xf_index`: an index into `xlrd.Book.xf_list`, which holds a
reference to the `xlrd.sheet.Cell` class (the actual cell for `xlrd`);
:param `rich_text`: if this cell contains text in rich text format, :class:`XLSGrid`
will do its best to render the text as rich text.
.. method:: Draw(self, dc, rect)
Actually draws all the chunks of text on a grid cell, one by one.
:param `dc`: an instance of :class:`wx.DC`;
:param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle.
.. method:: Measure(self, dc)
Convenience method to measure the maximum height and total width of all
the chunks of text composing our rich text string.
:param `dc`: an instance of :class:`wx.DC`.
|
