.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.StaticText:
==========================================================================================================================================
|phoenix_title| **wx.StaticText**
==========================================================================================================================================
A static text control displays one or more lines of read-only text.
:ref:`wx.StaticText` supports the three classic text alignments, label ellipsization i.e. replacing parts of the text with the ellipsis ("...") if the label doesn't fit into the provided space and also formatting markup with :meth:`wx.Control.SetLabelMarkup` .
.. _StaticText-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.ALIGN_LEFT``: Align the text to the left.
- ``wx.ALIGN_RIGHT``: Align the text to the right.
- ``wx.ALIGN_CENTRE_HORIZONTAL``: Center the text (horizontally).
- ``wx.ST_NO_AUTORESIZE``: By default, the control will adjust its size to exactly fit to the size of the text when :meth:`~wx.StaticText.SetLabel` is called. If this style flag is given, the control will not change its size (this style is especially useful with controls which also have the ``ALIGN_RIGHT`` or the ``ALIGN_CENTRE_HORIZONTAL`` style because otherwise they won't make sense any longer after a call to :meth:`~wx.StaticText.SetLabel`).
- ``wx.ST_ELLIPSIZE_START``: If the labeltext width exceeds the control width, replace the beginning of the label with an ellipsis; uses :meth:`wx.Control.Ellipsize` .
- ``wx.ST_ELLIPSIZE_MIDDLE``: If the label text width exceeds the control width, replace the middle of the label with an ellipsis; uses :meth:`wx.Control.Ellipsize` .
- ``wx.ST_ELLIPSIZE_END``: If the label text width exceeds the control width, replace the end of the label with an ellipsis; uses :meth:`wx.Control.Ellipsize` .
.. seealso:: :ref:`wx.StaticBitmap`, :ref:`wx.StaticBox`
|
|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>StaticText</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.StaticText_inheritance.svg" alt="Inheritance diagram of StaticText" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.StaticText.html" title="A static text control displays one or more lines of read-only text." alt="" coords="60,313,182,341"/> <area shape="rect" id="node2" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="69,236,174,265"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="66,159,177,188"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node6" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map>
</p>
</div>
|
|appearance| Control Appearance
===============================
|
.. container:: control-appearance-figures
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.statictext.png
:alt: wxMSW
:figclass: appearance-figure
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.statictext.png
:alt: wxMAC
:figclass: appearance-figure
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.statictext.png
:alt: wxGTK
:figclass: appearance-figure
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StaticText.__init__` Default constructor.
:meth:`~wx.StaticText.Create` Creation function, for two-step construction.
:meth:`~wx.StaticText.GetClassDefaultAttributes`
:meth:`~wx.StaticText.IsEllipsized` Returns ``True`` if the window styles for this control contains one of the ``ST_ELLIPSIZE_START`` , ``ST_ELLIPSIZE_MIDDLE`` or ``ST_ELLIPSIZE_END`` styles.
:meth:`~wx.StaticText.SetLabel` Change the label shown in the control.
:meth:`~wx.StaticText.Wrap` This functions wraps the controls label so that each of its lines becomes at most `width` pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long).
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StaticText(Control)
**Possible constructors**::
StaticText() -> None
StaticText(parent : Window, id: int=ID_ANY, label: str='', pos:
Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name:
str=StaticTextNameStr) -> None
A static text control displays one or more lines of read-only text.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
:rtype: `None`
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, parent : Window, id: int=ID_ANY, label: str='', pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str=StaticTextNameStr)`
Constructor, creating and showing a text control.
:param `parent`: Parent window. Should not be ``None``.
:type `parent`: wx.Window
:param `id`: Control identifier. A value of -1 denotes a default value.
:type `id`: wx.WindowID
:param `label`: Text label.
:type `label`: string
:param `pos`: Window position.
:type `pos`: wx.Point
:param `size`: Window size.
:type `size`: wx.Size
:param `style`: Window style. See :ref:`wx.StaticText`.
:type `style`: long
:param `name`: Window name.
:type `name`: string
:rtype: `None`
.. seealso:: :meth:`Create`
:html:`<hr class="overloadsep" /><br />`
.. method:: Create(self, parent : Window, id: int=ID_ANY, label: str='', pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str=StaticTextNameStr)
Creation function, for two-step construction.
For details see :ref:`wx.StaticText`.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `label`:
:type `label`: string
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: IsEllipsized(self)
Returns ``True`` if the window styles for this control contains one of the ``ST_ELLIPSIZE_START`` , ``ST_ELLIPSIZE_MIDDLE`` or ``ST_ELLIPSIZE_END`` styles.
:rtype: `bool`
.. method:: SetLabel(self, label : str)
Change the label shown in the control.
Notice that since wxWidgets 3.1.1 this function is guaranteed not to do anything if the label didn't really change, so there is no benefit to checking if the new label is different from the current one in the application code.
:param `label`:
:type `label`: string
:rtype: `None`
.. seealso:: :meth:`wx.Control.SetLabel`
.. method:: Wrap(self, width : int)
This functions wraps the controls label so that each of its lines becomes at most `width` pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long).
If `width` is negative, no wrapping is done. Note that this width is not necessarily the total width of the control, since a few pixels for the border (depending on the controls border style) may be added.
:param `width`:
:type `width`: int
:rtype: `None`
.. versionadded:: 2.6.2