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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
|
.. 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
.. _wx.propgrid.PGCell:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PGCell**
==========================================================================================================================================
Base class for :ref:`wx.propgrid.PropertyGrid` cell information.
|
|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>PGCell</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.propgrid.PGCell_inheritance.png" alt="Inheritance diagram of PGCell" 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.propgrid.PGCell.html" title="wx.propgrid.PGCell" alt="" coords="5,83,144,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="33,5,115,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.propgrid.PGChoiceEntry`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGCell.__init__`
:meth:`~wx.propgrid.PGCell.GetBgCol`
:meth:`~wx.propgrid.PGCell.GetBitmap`
:meth:`~wx.propgrid.PGCell.GetData`
:meth:`~wx.propgrid.PGCell.GetFgCol`
:meth:`~wx.propgrid.PGCell.GetFont` Returns font of the cell.
:meth:`~wx.propgrid.PGCell.GetText`
:meth:`~wx.propgrid.PGCell.HasText` Returns ``True`` if this cell has custom text stored within.
:meth:`~wx.propgrid.PGCell.MergeFrom` Merges valid data from srcCell into this.
:meth:`~wx.propgrid.PGCell.SetBgCol`
:meth:`~wx.propgrid.PGCell.SetBitmap`
:meth:`~wx.propgrid.PGCell.SetFgCol`
:meth:`~wx.propgrid.PGCell.SetFont` Sets font of the cell.
:meth:`~wx.propgrid.PGCell.SetText`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PGCell.BgCol` See :meth:`~wx.propgrid.PGCell.GetBgCol` and :meth:`~wx.propgrid.PGCell.SetBgCol`
:attr:`~wx.propgrid.PGCell.Bitmap` See :meth:`~wx.propgrid.PGCell.GetBitmap` and :meth:`~wx.propgrid.PGCell.SetBitmap`
:attr:`~wx.propgrid.PGCell.Data` See :meth:`~wx.propgrid.PGCell.GetData`
:attr:`~wx.propgrid.PGCell.FgCol` See :meth:`~wx.propgrid.PGCell.GetFgCol` and :meth:`~wx.propgrid.PGCell.SetFgCol`
:attr:`~wx.propgrid.PGCell.Font` See :meth:`~wx.propgrid.PGCell.GetFont` and :meth:`~wx.propgrid.PGCell.SetFont`
:attr:`~wx.propgrid.PGCell.Text` See :meth:`~wx.propgrid.PGCell.GetText` and :meth:`~wx.propgrid.PGCell.SetText`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGCell(Object)
**Possible constructors**::
PGCell()
PGCell(other)
PGCell(text, bitmap=NullBitmap, fgCol=NullColour, bgCol=NullColour)
Base class for PropertyGrid cell information.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, other)`
:param `other`:
:type `other`: wx.propgrid.PGCell
**~~~**
**__init__** `(self, text, bitmap=NullBitmap, fgCol=NullColour, bgCol=NullColour)`
:param `text`:
:type `text`: string
:param `bitmap`:
:type `bitmap`: wx.Bitmap
:param `fgCol`:
:type `fgCol`: wx.Colour
:param `bgCol`:
:type `bgCol`: wx.Colour
**~~~**
.. method:: GetBgCol(self)
:rtype: :ref:`Colour`
.. method:: GetBitmap(self)
:rtype: :ref:`Bitmap`
.. method:: GetData(self)
:rtype: :ref:`wx.propgrid.PGCellData`
.. method:: GetFgCol(self)
:rtype: :ref:`Colour`
.. method:: GetFont(self)
Returns font of the cell.
If no specific font is set for this cell, then the font will be invalid.
:rtype: :ref:`Font`
.. method:: GetText(self)
:rtype: `string`
.. method:: HasText(self)
Returns ``True`` if this cell has custom text stored within.
:rtype: `bool`
.. method:: MergeFrom(self, srcCell)
Merges valid data from srcCell into this.
:param `srcCell`:
:type `srcCell`: wx.propgrid.PGCell
.. method:: SetBgCol(self, col)
:param `col`:
:type `col`: wx.Colour
.. method:: SetBitmap(self, bitmap)
:param `bitmap`:
:type `bitmap`: wx.Bitmap
.. method:: SetFgCol(self, col)
:param `col`:
:type `col`: wx.Colour
.. method:: SetFont(self, font)
Sets font of the cell.
:param `font`:
:type `font`: wx.Font
.. note::
Because :ref:`wx.propgrid.PropertyGrid` does not support rows of different height, it makes little sense to change size of the font. Therefore it is recommended to use return value of :meth:`wx.propgrid.PropertyGrid.GetFont` or :meth:`wx.propgrid.PropertyGrid.GetCaptionFont` as a basis for the font that, after modifications, is passed to this member function.
.. method:: SetText(self, text)
:param `text`:
:type `text`: string
.. attribute:: BgCol
See :meth:`~wx.propgrid.PGCell.GetBgCol` and :meth:`~wx.propgrid.PGCell.SetBgCol`
.. attribute:: Bitmap
See :meth:`~wx.propgrid.PGCell.GetBitmap` and :meth:`~wx.propgrid.PGCell.SetBitmap`
.. attribute:: Data
See :meth:`~wx.propgrid.PGCell.GetData`
.. attribute:: FgCol
See :meth:`~wx.propgrid.PGCell.GetFgCol` and :meth:`~wx.propgrid.PGCell.SetFgCol`
.. attribute:: Font
See :meth:`~wx.propgrid.PGCell.GetFont` and :meth:`~wx.propgrid.PGCell.SetFont`
.. attribute:: Text
See :meth:`~wx.propgrid.PGCell.GetText` and :meth:`~wx.propgrid.PGCell.SetText`
|