Phoenix Logo

phoenix_title wx.StaticText

A static text control displays one or more lines of read-only text.

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 wx.Control.SetLabelMarkup .

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 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 SetLabel).
  • wx.ST_ELLIPSIZE_START: If the labeltext width exceeds the control width, replace the beginning of the label with an ellipsis; uses 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 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 wx.Control.Ellipsize .

class_hierarchy Class Hierarchy

Inheritance diagram for class StaticText:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__ Default constructor.
Create Creation function, for two-step construction.
GetClassDefaultAttributes  
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.
SetLabel Change the label shown in the control.
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()

StaticText(parent, id=ID_ANY, label="", pos=DefaultPosition,
           size=DefaultSize, style=0, name=StaticTextNameStr)

A static text control displays one or more lines of read-only text.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__init__ (self, parent, id=ID_ANY, label=”“, pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr)

Constructor, creating and showing a text control.

Parameters:
  • parent (wx.Window) – Parent window. Should not be None.
  • id (wx.WindowID) – Control identifier. A value of -1 denotes a default value.
  • label (string) – Text label.
  • pos (wx.Point) – Window position.
  • size (wx.Size) – Window size.
  • style (long) – Window style. See wx.StaticText.
  • name (string) – Window name.

See also

Create





Create(self, parent, id=ID_ANY, label="", pos=DefaultPosition, size=DefaultSize, style=0, name=StaticTextNameStr)

Creation function, for two-step construction.

For details see wx.StaticText.

Parameters:
  • parent (wx.Window) –
  • id (wx.WindowID) –
  • label (string) –
  • pos (wx.Point) –
  • size (wx.Size) –
  • style (long) –
  • name (string) –
Return type:

bool



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters:variant (WindowVariant) –
Return type: wx.VisualAttributes


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.

Return type:bool


SetLabel(self, label)

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.

Parameters:label (string) –


Wrap(self, width)

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.

Parameters:width (int) –

New in version 2.6.2.