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

Fix docstring references to wx.Colour

Browse Source
This commit is contained in:
Robin Dunn
2016-07-06 18:40:04 -07:00
parent 5279b48954
commit 4175d35105
40 changed files with 285 additions and 285 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
wx/lib/colourselect.py
View File

@@ -34,14 +34,14 @@
#
"""
Provides a :class:`ColourSelect` button that, when clicked, will display a
Provides a :class:`wx.ColourSelect` button that, when clicked, will display a
colour selection dialog.
Description
===========
This module provides a :class:`ColourSelect` button that, when clicked, will display a
This module provides a :class:`wx.ColourSelect` button that, when clicked, will display a
colour selection dialog. The selected colour is displayed on the button itself.
@@ -87,7 +87,7 @@ wxEVT_COMMAND_COLOURSELECT = wx.NewEventType()
class ColourSelectEvent(wx.PyCommandEvent):
"""
:class:`ColourSelectEvent` is a special subclassing of :class:`wx.CommandEvent`
:class:`wx.ColourSelectEvent` is a special subclassing of :class:`wx.CommandEvent`
and it provides for a custom event sent every time the user chooses a colour.
"""
@@ -108,7 +108,7 @@ class ColourSelectEvent(wx.PyCommandEvent):
"""
Returns the currently selected colour.
:rtype: :class:`Colour`
:rtype: :class:`wx.Colour`
"""
return self.value
@@ -174,7 +174,7 @@ class ColourSelect(wx.BitmapButton):
def GetColour(self):
"""
Returns the current colour set for the :class:`ColourSelect`.
Returns the current colour set for the :class:`wx.ColourSelect`.
:rtype: :class:`wx.Colour`
"""
@@ -184,7 +184,7 @@ class ColourSelect(wx.BitmapButton):
def GetValue(self):
"""
Returns the current colour set for the :class:`ColourSelect`.
Returns the current colour set for the :class:`wx.ColourSelect`.
:rtype: :class:`wx.Colour`
"""
@@ -194,9 +194,9 @@ class ColourSelect(wx.BitmapButton):
def SetValue(self, colour):
"""
Sets the current colour for :class:`ColourSelect`.
Sets the current colour for :class:`wx.ColourSelect`.
:param `colour`: the new colour for :class:`ColourSelect`.
:param `colour`: the new colour for :class:`wx.ColourSelect`.
:type `colour`: tuple or string or :class:`wx.Colour`
"""
@@ -205,9 +205,9 @@ class ColourSelect(wx.BitmapButton):
def SetColour(self, colour):
"""
Sets the current colour for :class:`ColourSelect`.
Sets the current colour for :class:`wx.ColourSelect`.
:param `colour`: the new colour for :class:`ColourSelect`.
:param `colour`: the new colour for :class:`wx.ColourSelect`.
:type `colour`: tuple or string or :class:`wx.Colour`
"""
@@ -218,9 +218,9 @@ class ColourSelect(wx.BitmapButton):
def SetLabel(self, label):
"""
Sets the new text label for :class:`ColourSelect`.
Sets the new text label for :class:`wx.ColourSelect`.
:param string `label`: the new text label for :class:`ColourSelect`.
:param string `label`: the new text label for :class:`wx.ColourSelect`.
"""
self.label = label
@@ -228,7 +228,7 @@ class ColourSelect(wx.BitmapButton):
def GetLabel(self):
"""
Returns the current text label for the :class:`ColourSelect`.
Returns the current text label for the :class:`wx.ColourSelect`.
:rtype: string
"""
@@ -290,7 +290,7 @@ class ColourSelect(wx.BitmapButton):
def OnClick(self, event):
"""
Handles the ``wx.EVT_BUTTON`` event for :class:`ColourSelect`.
Handles the ``wx.EVT_BUTTON`` event for :class:`wx.ColourSelect`.
:param `event`: a :class:`wx.CommandEvent` event to be processed.
"""