Docstring updates

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@34032 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2005-05-12 22:46:53 +00:00
parent 948ee5ea30
commit 4e5d278c12
9 changed files with 615 additions and 542 deletions

View File

@@ -18,18 +18,9 @@
"""
This module implements various forms of generic buttons, meaning that
they are not built on native controls but are self-drawn.
The GenButton is the base. It acts like a normal button but you
are able to better control how it looks, bevel width, colours, etc.
GenBitmapButton is a button with one or more bitmaps that show
the various states the button can be in.
GenToggleButton stays depressed when clicked, until clicked again.
GenBitmapToggleButton the same but with bitmaps.
they are not built on native controls but are self-drawn. They act
like normal buttons but you are able to better control how they look,
bevel width, colours, etc.
"""
import wx
@@ -39,6 +30,7 @@ import imageutils
#----------------------------------------------------------------------
class GenButtonEvent(wx.PyCommandEvent):
"""Event sent from the generic buttons when the button is activated. """
def __init__(self, eventType, ID):
wx.PyCommandEvent.__init__(self, eventType, ID)
self.isDown = False
@@ -60,6 +52,8 @@ class GenButtonEvent(wx.PyCommandEvent):
#----------------------------------------------------------------------
class GenButton(wx.PyControl):
"""A generic button, and base class for the other generic buttons."""
labelDelta = 1
def __init__(self, parent, ID, label,
@@ -356,6 +350,8 @@ class GenButton(wx.PyControl):
#----------------------------------------------------------------------
class GenBitmapButton(GenButton):
"""A generic bitmap button."""
def __init__(self, parent, ID, bitmap,
pos = wx.DefaultPosition, size = wx.DefaultSize,
style = 0, validator = wx.DefaultValidator,
@@ -429,7 +425,8 @@ class GenBitmapButton(GenButton):
#----------------------------------------------------------------------
class GenBitmapTextButton(GenBitmapButton): # generic bitmapped button with Text Label
class GenBitmapTextButton(GenBitmapButton):
"""A generic bitmapped button with text label"""
def __init__(self, parent, ID, bitmap, label,
pos = wx.DefaultPosition, size = wx.DefaultSize,
style = 0, validator = wx.DefaultValidator,
@@ -550,12 +547,15 @@ class __ToggleMixin:
class GenToggleButton(__ToggleMixin, GenButton):
"""A generic toggle button"""
pass
class GenBitmapToggleButton(__ToggleMixin, GenBitmapButton):
"""A generic toggle bitmap button"""
pass
class GenBitmapTextToggleButton(__ToggleMixin, GenBitmapTextButton):
"""A generic toggle bitmap button with text label"""
pass
#----------------------------------------------------------------------