Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2026-01-06 12:00:13 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Porting of wx.lib: improve the docstrings for wx.lib.stattext.py.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@72078 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Andrea Gavana
2012-07-14 20:03:07 +00:00
parent d888f0d24d
commit 5845cc1caa
1 changed files with 133 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
wx/lib/stattext.py
View File

@@ -17,6 +17,54 @@
# o Untested.
#
"""
:class:`GenStaticText` is a generic implementation of :class:`StaticText`.
Description
===========
:class:`GenStaticText` is a generic implementation of :class:`StaticText`.
Some of the platforms supported by wxPython (most notably GTK), do not consider
:class:`StaticText` as a separate widget; instead, the label is just drawn on its
parent window. This essentially bars the use of almost all mouse events (such as
detection of mouse motions, mouse clicks and so on).
Moreover, these platforms do not allow the developer to change the widget's background
colour.
Using :class:`GenStaticText` will overcome all the problems described above, as it
is a generic widget and a real window on its own.
Usage
=====
Sample usage::
import wx
import wx.lib.stattext as ST
app = wx.App(0)
frame = wx.Frame(None, -1, "wx.lib.stattext Test")
panel = wx.Panel(frame)
st1 = ST.GenStaticText(panel, -1, "This is an example of static text", (20, 10))
st2 = ST.GenStaticText(panel, -1, "Is this yellow?", (20, 70), (120, -1))
st2.SetBackgroundColour('Yellow')
ST.GenStaticText(panel, -1, "align center", (160, 70), (120, -1), wx.ALIGN_CENTER)
ST.GenStaticText(panel, -1, "align right", (300, 70), (120, -1), wx.ALIGN_RIGHT)
frame.Show()
app.MainLoop()
"""
import wx
BUFFERED = 0 # In unbuffered mode we can let the theme shine through,
@@ -28,12 +76,31 @@ if wx.Platform == "__WXMAC__":
#----------------------------------------------------------------------
class GenStaticText(wx.Control):
""" :class:`GenStaticText` is a generic implementation of :class:`StaticText`. """
labelDelta = 1
def __init__(self, parent, ID=-1, label="",
pos=wx.DefaultPosition, size=wx.DefaultSize,
style=0,
name="genstattext"):
"""
Default class constructor.
:param `parent`: parent window, must not be ``None``;
:param integer `ID`: window identifier. A value of -1 indicates a default value;
:param string `label`: the static text label (i.e., its text label);
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param integer `style`: the underlying :class:`Control` style;
:param string `name`: the widget name.
:type parent: :class:`Window`
:type pos: tuple or :class:`Point`
:type size: tuple or :class:`Size`
"""
wx.Control.__init__(self, parent, ID, pos, size, style|wx.NO_BORDER,
wx.DefaultValidator, name)
@@ -54,7 +121,10 @@ class GenStaticText(wx.Control):
"""
Sets the static text label and updates the control's size to exactly
fit the label unless the control has wx.ST_NO_AUTORESIZE flag.
:param string `label`: the static text label (i.e., its text label).
"""
wx.Control.SetLabel(self, label)
style = self.GetWindowStyleFlag()
self.InvalidateBestSize()
@@ -67,7 +137,11 @@ class GenStaticText(wx.Control):
"""
Sets the static text font and updates the control's size to exactly
fit the label unless the control has wx.ST_NO_AUTORESIZE flag.
:param Font `font`: a valid font instance, which will be the new font used
to display the text.
"""
wx.Control.SetFont(self, font)
style = self.GetWindowStyleFlag()
self.InvalidateBestSize()
@@ -80,7 +154,10 @@ class GenStaticText(wx.Control):
"""
Overridden base class virtual. Determines the best size of
the control based on the label size and the current font.
:note: Overridden from :class:`Control`.
"""
label = self.GetLabel()
font = self.GetFont()
if not font:
@@ -102,19 +179,51 @@ class GenStaticText(wx.Control):
def Enable(self, enable=True):
"""Overridden Enable() method to properly refresh the widget. """
wx.Control.Enable(self, enable)
"""
Enable or disable the widget for user input.
:param bool `enable`: If ``True``, enables the window for input. If ``False``, disables the window.
:returns: ``True`` if the window has been enabled or disabled, ``False`` if nothing was
done, i.e. if the window had already been in the specified state.
:note: Note that when a parent window is disabled, all of its children are disabled as
well and they are reenabled again when the parent is.
:note: Overridden from :class:`Control`.
"""
retVal = wx.Control.Enable(self, enable)
self.Refresh()
return retVal
def Disable(self):
"""Overridden Disable() method to properly refresh the widget. """
wx.Control.Disable(self)
"""
Disables the control.
:returns: ``True`` if the window has been disabled, ``False`` if it had been
already disabled before the call to this function.
:note: This is functionally equivalent of calling :meth:`~Control.Enable` with a ``False`` flag.
:note: Overridden from :class:`Control`.
"""
retVal = wx.Control.Disable(self)
self.Refresh()
return retVal
def AcceptsFocus(self):
"""Overridden base class virtual."""
"""
Can this window be given focus by mouse click?
:note: Overridden from :class:`Control`.
"""
return False
@@ -122,6 +231,8 @@ class GenStaticText(wx.Control):
"""
Overridden base class virtual. By default we should use
the same font/colour attributes as the native StaticText.
:note: Overridden from :class:`Control`.
"""
return wx.StaticText.GetClassDefaultAttributes()
@@ -130,11 +241,19 @@ class GenStaticText(wx.Control):
"""
Overridden base class virtual. If the parent has non-default
colours then we want this control to inherit them.
:note: Overridden from :class:`Control`.
"""
return True
def OnPaint(self, event):
"""
Handles the ``wx.EVT_PAINT`` for :class:`GenStaticText`.
:param `event`: a :class:`PaintEvent` event to be processed.
"""
if BUFFERED:
dc = wx.BufferedPaintDC(self)
else:
@@ -177,11 +296,16 @@ class GenStaticText(wx.Control):
def OnEraseBackground(self, event):
"""
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`GenStaticText`.
:param `event`: a :class:`EraseEvent` event to be processed.
:note: This is intentionally empty to reduce flicker.
"""
pass
#----------------------------------------------------------------------