diff --git a/wx/lib/agw/__init__.py b/wx/lib/agw/__init__.py index cb73616d..c05d9d17 100644 --- a/wx/lib/agw/__init__.py +++ b/wx/lib/agw/__init__.py @@ -22,7 +22,7 @@ an asterisk were already present in :mod:`lib` before: - ButtonPanel (*): a panel with gradient background shading with the possibility to add buttons and controls still respecting the gradient background; -- CubeColourDialog: an alternative implementation of :class:`ColourDialog`, it +- CubeColourDialog: an alternative implementation of :class:`wx.ColourDialog`, it offers different functionalities like colour wheel and RGB cube; - CustomTreeCtrl (*): mimics the behaviour of :class:`TreeCtrl`, with almost the same base functionalities plus a bunch of enhancements and goodies; diff --git a/wx/lib/agw/advancedsplash.py b/wx/lib/agw/advancedsplash.py index 3be9c9e2..5b599db0 100644 --- a/wx/lib/agw/advancedsplash.py +++ b/wx/lib/agw/advancedsplash.py @@ -215,7 +215,7 @@ class AdvancedSplash(wx.Frame): :type pos: tuple or :class:`Point` :type size: tuple or :class:`Size` :type bitmap: :class:`Bitmap` - :type shadowcolour: :class:`Colour` + :type shadowcolour: :class:`wx.Colour` :raise: `Exception` in the following cases: @@ -312,7 +312,7 @@ class AdvancedSplash(wx.Frame): :param `bmp`: the bitmap to which we want to apply the mask colour `shadowcolour`; :param `shadowcolour`: the mask colour for our bitmap. :type bmp: :class:`Bitmap` - :type shadowcolour: :class:`Colour` + :type shadowcolour: :class:`wx.Colour` :return: A masked version of the input bitmap, an instance of :class:`Bitmap`. """ @@ -466,7 +466,7 @@ class AdvancedSplash(wx.Frame): :param `colour`: the text colour to use while drawing the text on top of our bitmap. If `colour` is ``None``, then ``wx.BLACK`` is used. - :type colour: :class:`Colour` or ``None`` + :type colour: :class:`wx.Colour` or ``None`` """ if colour is None: @@ -481,7 +481,7 @@ class AdvancedSplash(wx.Frame): """ Gets the colour for the text in :class:`AdvancedSplash`. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._textcolour diff --git a/wx/lib/agw/aquabutton.py b/wx/lib/agw/aquabutton.py index b406192b..8e11ff36 100644 --- a/wx/lib/agw/aquabutton.py +++ b/wx/lib/agw/aquabutton.py @@ -246,11 +246,11 @@ class AquaButton(wx.Control): Return light contrast of `colour`. The colour returned is from the scale of `colour` ==> white. - :param `colour`: the input colour to be brightened, a valid instance of :class:`Colour`; + :param `colour`: the input colour to be brightened, a valid instance of :class:`wx.Colour`; :param integer `percent`: determines how light the colour will be. `percent` = ``100`` returns white, `percent` = ``0`` returns `colour`. - :return: A light contrast of the input `colour`, an instance of :class:`Colour`. + :return: A light contrast of the input `colour`, an instance of :class:`wx.Colour`. """ end_colour = wx.WHITE @@ -691,7 +691,7 @@ class AquaButton(wx.Control): """ Sets the :class:`AquaButton` background colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: Overridden from :class:`wx.Control`. """ @@ -705,7 +705,7 @@ class AquaButton(wx.Control): """ Returns the button colour when the mouse is not hovering on the button. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. :note: Overridden from :class:`wx.Control`. """ @@ -717,7 +717,7 @@ class AquaButton(wx.Control): """ Sets the button colour when the mouse is hovering on the button. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._hoverColour = colour @@ -728,7 +728,7 @@ class AquaButton(wx.Control): """ Returns the button colour when the mouse is hovering on the button. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._hoverColour @@ -738,7 +738,7 @@ class AquaButton(wx.Control): """ Sets the button colour when it is disabled. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._disableColour = colour @@ -749,7 +749,7 @@ class AquaButton(wx.Control): """ Returns the button colour when it is disabled. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._disableColour @@ -759,7 +759,7 @@ class AquaButton(wx.Control): """ Sets the button shadow colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. .. versionadded:: 0.9.7 """ @@ -772,7 +772,7 @@ class AquaButton(wx.Control): """ Returns the button shadow colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. .. versionadded:: 0.9.7 """ @@ -784,7 +784,7 @@ class AquaButton(wx.Control): """ Sets the button rectangular background colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. .. versionadded:: 0.9.7 """ @@ -797,7 +797,7 @@ class AquaButton(wx.Control): """ Returns the button rectangular background colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. .. versionadded:: 0.9.7 """ @@ -820,7 +820,7 @@ class AquaButton(wx.Control): """ Sets the :class:`AquaButton` foreground (text) colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: Overridden from :class:`wx.Control`. """ @@ -834,7 +834,7 @@ class AquaButton(wx.Control): """ Returns the text colour for :class:`AquaButton`. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. :note: Overridden from :class:`wx.Control`. """ @@ -846,7 +846,7 @@ class AquaButton(wx.Control): """ Sets the button colour when the button has focus. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._focusColour = colour @@ -857,7 +857,7 @@ class AquaButton(wx.Control): """ Returns the button colour when the button has focus. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._hoverColour diff --git a/wx/lib/agw/artmanager.py b/wx/lib/agw/artmanager.py index 5a53f2a2..95708075 100644 --- a/wx/lib/agw/artmanager.py +++ b/wx/lib/agw/artmanager.py @@ -81,8 +81,8 @@ class RendererBase(object): :param `dc`: an instance of :class:`DC`; :param Rect `rect`: the button's client rectangle; - :param `penColour`: a valid :class:`Colour` for the pen border; - :param `brushColour`: a valid :class:`Colour` for the brush. + :param `penColour`: a valid :class:`wx.Colour` for the pen border; + :param `brushColour`: a valid :class:`wx.Colour` for the brush. """ # Keep old pen and brush @@ -99,7 +99,7 @@ class RendererBase(object): :param `dc`: an instance of :class:`DC`; :param string `xpm_name`: a name of a XPM bitmap; :param Rect `rect`: the bitmap client rectangle; - :param `baseColour`: a valid :class:`Colour` for the bitmap background; + :param `baseColour`: a valid :class:`wx.Colour` for the bitmap background; :param bool `flipSide`: ``True`` to flip the gradient direction, ``False`` otherwise. """ @@ -124,8 +124,8 @@ class RendererBase(object): :param `dc`: an instance of :class:`DC`; :param Rect `rect`: the button's client rectangle; - :param `penColour`: a valid :class:`Colour` for the pen border; - :param `bitmapBorderUpperLeftPen`: a valid :class:`Colour` for the pen upper + :param `penColour`: a valid :class:`wx.Colour` for the pen border; + :param `bitmapBorderUpperLeftPen`: a valid :class:`wx.Colour` for the pen upper left border. """ @@ -147,7 +147,7 @@ class RendererBase(object): """ Returns the foreground colour for the menu. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return ArtManager.Get().LightColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_3DFACE), 80) @@ -157,7 +157,7 @@ class RendererBase(object): """ Returns the colour used for text colour when enabled. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return wx.BLACK @@ -167,7 +167,7 @@ class RendererBase(object): """ Returns the colour used for text colour when disabled. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return ArtManager.Get().LightColour(wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT), 30) @@ -244,7 +244,7 @@ class RendererXP(RendererBase): :param `dc`: an instance of :class:`DC`; :param Rect `rect`: the button's client rectangle; :param integer `state`: the button state; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ # switch according to the status @@ -326,7 +326,7 @@ class RendererXP(RendererBase): """ Returns the colour used for text colour when enabled. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return wx.BLACK @@ -347,7 +347,7 @@ class RendererMSOffice2007(RendererBase): def GetColoursAccordingToState(self, state): """ - Returns a :class:`Colour` according to the menu item state. + Returns a :class:`wx.Colour` according to the menu item state. :param integer `state`: one of the following bits: @@ -360,7 +360,7 @@ class RendererMSOffice2007(RendererBase): ``ControlNormal`` 3 Normal state ==================== ======= ========================== - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ # switch according to the status @@ -420,7 +420,7 @@ class RendererMSOffice2007(RendererBase): :param `dc`: an instance of :class:`DC`; :param Rect `rect`: the button's client rectangle; :param integer `state`: the button state; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ artMgr = ArtManager.Get() @@ -616,7 +616,7 @@ class RendererMSOffice2007(RendererBase): """ Returns the colour used for text colour when enabled. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return wx.Colour("MIDNIGHT BLUE") @@ -804,11 +804,11 @@ class ArtManager(wx.EvtHandler): Return light contrast of `colour`. The colour returned is from the scale of `colour` ==> white. - :param `colour`: the input colour to be brightened, an instance of :class:`Colour`; + :param `colour`: the input colour to be brightened, an instance of :class:`wx.Colour`; :param integer `percent`: determines how light the colour will be. `percent` = ``100`` returns white, `percent` = ``0`` returns `colour`. - :return: A light contrast of the input `colour`, an instance of :class:`Colour`. + :return: A light contrast of the input `colour`, an instance of :class:`wx.Colour`. """ end_colour = wx.WHITE @@ -830,11 +830,11 @@ class ArtManager(wx.EvtHandler): """ Like the :meth:`~ArtManager.LightColour` function, but create the colour darker by `percent`. - :param `colour`: the input colour to be darkened, an instance of :class:`Colour`; + :param `colour`: the input colour to be darkened, an instance of :class:`wx.Colour`; :param integer `percent`: determines how dark the colour will be. `percent` = ``100`` returns black, `percent` = ``0`` returns `colour`. - :return: A dark contrast of the input `colour`, an instance of :class:`Colour`. + :return: A dark contrast of the input `colour`, an instance of :class:`wx.Colour`. """ end_colour = wx.BLACK @@ -1105,7 +1105,7 @@ class ArtManager(wx.EvtHandler): """ Return the surrounding colour for a control. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return wx.SystemSettings.GetColour(wx.SYS_COLOUR_ACTIVECAPTION) @@ -1115,7 +1115,7 @@ class ArtManager(wx.EvtHandler): """ Returns the background colour of a control when not in focus. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self.LightColour(self.FrameColour(), 75) @@ -1125,7 +1125,7 @@ class ArtManager(wx.EvtHandler): """ Returns the background colour of a control when it is in focus. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self.LightColour(self.FrameColour(), 60) @@ -1135,12 +1135,12 @@ class ArtManager(wx.EvtHandler): """ Return mix of input colours. - :param `firstColour`: the first colour to be mixed, an instance of :class:`Colour`; - :param `secondColour`: the second colour to be mixed, an instance of :class:`Colour`; + :param `firstColour`: the first colour to be mixed, an instance of :class:`wx.Colour`; + :param `secondColour`: the second colour to be mixed, an instance of :class:`wx.Colour`; :param integer `percent`: the relative percentage of `firstColour` with respect to `secondColour`. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ # calculate gradient coefficients @@ -1156,7 +1156,7 @@ class ArtManager(wx.EvtHandler): """ Creates a random colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ r = random.randint(0, 255) # Random value betweem 0-255 @@ -1170,7 +1170,7 @@ class ArtManager(wx.EvtHandler): """ Returns whether a colour is dark or light. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. :return: ``True`` if the average RGB values are dark, ``False`` otherwise. """ @@ -1266,7 +1266,7 @@ class ArtManager(wx.EvtHandler): :param Rect `rect`: the button's client rectangle; :param string `theme`: the theme to use to draw the button; :param integer `state`: the button state; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ renderer = self._renderers[theme] @@ -1608,7 +1608,7 @@ class ArtManager(wx.EvtHandler): :param bool `enable`: ``True`` if the button is enabled, ``False`` otherwise; :param `font`: the font to use to draw the text, an instance of :class:`Font`; :param `fontColour`: the colour to use to draw the text, an instance of - :class:`Colour`; + :class:`wx.Colour`; :param `bitmap`: the bitmap associated with the button, an instance of :class:`Bitmap`; :param `grayBitmap`: a greyed-out version of the input `bitmap` representing a disabled bitmap, an instance of :class:`Bitmap`; @@ -1735,7 +1735,7 @@ class ArtManager(wx.EvtHandler): """ Returns the colour used for the menu foreground. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ renderer = self._renderers[self.GetMenuTheme()] @@ -1746,7 +1746,7 @@ class ArtManager(wx.EvtHandler): """ Returns the colour used for enabled menu items. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ renderer = self._renderers[self.GetMenuTheme()] @@ -1757,7 +1757,7 @@ class ArtManager(wx.EvtHandler): """ Returns the colour used for disabled menu items. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ renderer = self._renderers[self.GetMenuTheme()] @@ -1809,7 +1809,7 @@ class ArtManager(wx.EvtHandler): :param bool `useLightColours`: ``True`` to use light colours, ``False`` otherwise. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ if not useLightColours and not self.IsDark(self.FrameColour()): @@ -2043,7 +2043,7 @@ class ArtManager(wx.EvtHandler): """ Returns the menu bar face colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._menuBarBgColour @@ -2053,7 +2053,7 @@ class ArtManager(wx.EvtHandler): """ Returns the menu bar selection colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._menuBarSelColour diff --git a/wx/lib/agw/aui/auibar.py b/wx/lib/agw/aui/auibar.py index 137d21b8..44160038 100644 --- a/wx/lib/agw/aui/auibar.py +++ b/wx/lib/agw/aui/auibar.py @@ -777,7 +777,7 @@ class AuiDefaultToolBarArt(object): """ Sets the default colours, which are calculated from the given base colour. - :param `base_colour`: an instance of :class:`Colour`. If defaulted to ``None``, a colour + :param `base_colour`: an instance of :class:`wx.Colour`. If defaulted to ``None``, a colour is generated accordingly to the platform and theme. """ diff --git a/wx/lib/agw/aui/dockart.py b/wx/lib/agw/aui/dockart.py index 2739b5af..f6b0d41d 100644 --- a/wx/lib/agw/aui/dockart.py +++ b/wx/lib/agw/aui/dockart.py @@ -214,7 +214,7 @@ class AuiDefaultDockArt(object): """ Sets the default colours, which are calculated from the given base colour. - :param `base_colour`: an instance of :class:`Colour`. If defaulted to ``None``, a colour + :param `base_colour`: an instance of :class:`wx.Colour`. If defaulted to ``None``, a colour is generated accordingly to the platform and theme. """ @@ -336,7 +336,7 @@ class AuiDefaultDockArt(object): :param integer `id`: can be one of the colour values in `Metric Ordinals`; :param `colour`: the new value of the setting. - :type `colour`: :class:`Colour` or tuple or integer + :type `colour`: :class:`wx.Colour` or tuple or integer """ colour = wx.Colour(colour) diff --git a/wx/lib/agw/aui/tabart.py b/wx/lib/agw/aui/tabart.py index 1725ae47..7bb33ec7 100644 --- a/wx/lib/agw/aui/tabart.py +++ b/wx/lib/agw/aui/tabart.py @@ -178,7 +178,7 @@ class AuiDefaultTabArt(object): """ Sets a new base colour. - :param `base_colour`: an instance of :class:`Colour`. + :param `base_colour`: an instance of :class:`wx.Colour`. """ self._base_colour = base_colour @@ -190,7 +190,7 @@ class AuiDefaultTabArt(object): """ Sets the default colours, which are calculated from the given base colour. - :param `base_colour`: an instance of :class:`Colour`. If defaulted to ``None``, a colour + :param `base_colour`: an instance of :class:`wx.Colour`. If defaulted to ``None``, a colour is generated accordingly to the platform and theme. """ diff --git a/wx/lib/agw/balloontip.py b/wx/lib/agw/balloontip.py index ebd62dde..76d89ed4 100644 --- a/wx/lib/agw/balloontip.py +++ b/wx/lib/agw/balloontip.py @@ -957,7 +957,7 @@ class BalloonTip(object): """ Sets the :class:`BalloonTip` background colour. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ if colour is None: @@ -970,7 +970,7 @@ class BalloonTip(object): """ Returns the :class:`BalloonTip` background colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._ballooncolour @@ -1026,7 +1026,7 @@ class BalloonTip(object): """ Sets the colour for the top title. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ if colour is None: @@ -1039,7 +1039,7 @@ class BalloonTip(object): """ Returns the colour for the top title. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._balloontitlecolour @@ -1049,7 +1049,7 @@ class BalloonTip(object): """ Sets the colour for the tip message. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ if colour is None: @@ -1062,7 +1062,7 @@ class BalloonTip(object): """ Returns the colour for the tip message. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._balloonmsgcolour diff --git a/wx/lib/agw/buttonpanel.py b/wx/lib/agw/buttonpanel.py index fb5a27ce..3b165976 100644 --- a/wx/lib/agw/buttonpanel.py +++ b/wx/lib/agw/buttonpanel.py @@ -272,10 +272,10 @@ def BrightenColour(colour, factor): """ Brighten the input colour by a factor. - :param `colour`: a valid :class:`Colour` instance; + :param `colour`: a valid :class:`wx.Colour` instance; :param integer `factor`: the factor by which the input colour should be brightened. - :return: An instance of :class:`Colour`, a brightened version of the input `colour`. + :return: An instance of :class:`wx.Colour`, a brightened version of the input `colour`. """ val = colour.Red()*factor @@ -449,7 +449,7 @@ class BPArt(object): ``BP_SEPARATOR_COLOUR`` 9 Pen colour used to paint the separators ================================== ======= ===================================== - :return: An instance of :class:`Colour` for the input `id`. + :return: An instance of :class:`wx.Colour` for the input `id`. :raise: `Exception` if the `id` is not recognized. """ @@ -483,7 +483,7 @@ class BPArt(object): Sets the option value for the specified colour `id`. :param integer `id`: the identification bit for the colour value; - :param `colour`: the new value for the colour (a valid :class:`Colour` instance). + :param `colour`: the new value for the colour (a valid :class:`wx.Colour` instance). :raise: `Exception` if the `id` is not recognized. diff --git a/wx/lib/agw/cubecolourdialog.py b/wx/lib/agw/cubecolourdialog.py index 98df6925..c67e31f1 100644 --- a/wx/lib/agw/cubecolourdialog.py +++ b/wx/lib/agw/cubecolourdialog.py @@ -29,15 +29,15 @@ # --------------------------------------------------------------------------- # """ -:class:`~lib.agw.cubecolourdialog.CubeColourDialog` is an alternative implementation of :class:`ColourDialog`. +:class:`~lib.agw.cubecolourdialog.CubeColourDialog` is an alternative implementation of :class:`wx.ColourDialog`. Description =========== -The :class:`CubeColourDialog` is an alternative implementation of :class:`ColourDialog`, and it +The :class:`CubeColourDialog` is an alternative implementation of :class:`wx.ColourDialog`, and it offers different functionalities with respect to the default wxPython one. It -can be used as a replacement of :class:`ColourDialog` with exactly the same syntax and +can be used as a replacement of :class:`wx.ColourDialog` with exactly the same syntax and methods. Some features: @@ -1468,7 +1468,7 @@ def DrawCheckerBoard(dc, rect, checkColour, box=5): class Colour(wx.Colour): """ - This is a subclass of :class:`Colour`, which adds Hue, Saturation and Brightness + This is a subclass of :class:`wx.Colour`, which adds Hue, Saturation and Brightness capability to the base class. It contains also methods to convert RGB triplets into HSB triplets and vice-versa. """ @@ -1477,7 +1477,7 @@ class Colour(wx.Colour): """ Default class constructor. - :param `colour`: a standard :class:`Colour`. + :param `colour`: a standard :class:`wx.Colour`. """ wx.Colour.__init__(self) @@ -1592,7 +1592,7 @@ class Colour(wx.Colour): def GetPyColour(self): - """ Returns the wxPython :class:`Colour` associated with this instance. """ + """ Returns the wxPython :class:`wx.Colour` associated with this instance. """ return wx.Colour(self.r, self.g, self.b, self._alpha) @@ -2515,7 +2515,7 @@ class ColourPanel(wx.Panel): Used internally. Do not call it in your code! :param `parent`: the control parent window; - :param `style`: the :class:`ColourPanel` window style. + :param `style`: the :class:`wx.ColourPanel` window style. """ wx.Panel.__init__(self, parent, style=style) @@ -2530,7 +2530,7 @@ class ColourPanel(wx.Panel): def OnPaint(self, event): """ - Handles the ``wx.EVT_PAINT`` for :class:`ColourPanel`. + Handles the ``wx.EVT_PAINT`` for :class:`wx.ColourPanel`. :param `event`: a :class:`PaintEvent` event to be processed. """ @@ -2564,7 +2564,7 @@ class ColourPanel(wx.Panel): def OnEraseBackground(self, event): """ - Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`ColourPanel`. + Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`wx.ColourPanel`. :param `event`: a :class:`EraseEvent` event to be processed. @@ -2576,7 +2576,7 @@ class ColourPanel(wx.Panel): def OnSize(self, event): """ - Handles the ``wx.EVT_SIZE`` for :class:`ColourPanel`. + Handles the ``wx.EVT_SIZE`` for :class:`wx.ColourPanel`. :param `event`: a :class:`SizeEvent` event to be processed. """ @@ -2588,7 +2588,7 @@ class ColourPanel(wx.Panel): """ Refresh the panel after a colour/alpha change. - :param `colour`: the new background colour of :class:`ColourPanel`. + :param `colour`: the new background colour of :class:`wx.ColourPanel`. """ self._colour = colour @@ -2626,7 +2626,7 @@ class ColourPanel(wx.Panel): class CustomPanel(wx.Control): """ This panel displays a series of custom colours (chosen by the user) just like - the standard :class:`ColourDialog`. + the standard :class:`wx.ColourDialog`. """ def __init__(self, parent, colourData): @@ -2635,7 +2635,7 @@ class CustomPanel(wx.Control): Used internally. Do not call it in your code! :param `parent`: the control parent window; - :param `colourData`: an instance of :class:`ColourData`. + :param `colourData`: an instance of :class:`wx.ColourData`. """ wx.Control.__init__(self, parent, style=wx.NO_BORDER) @@ -2827,7 +2827,7 @@ class CustomPanel(wx.Control): """ Adds a user-chosen colour to the list of custom colours. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ self._colourSelection += 1 @@ -2849,7 +2849,7 @@ class CubeColourDialog(wx.Dialog): """ Default class constructor. - :param `colourData`: a standard :class:`ColourData` (as used in :class:`ColourDialog`); + :param `colourData`: a standard :class:`wx.ColourData` (as used in :class:`wx.ColourDialog`); :param `agwStyle`: can be either ``None`` or ``CCD_SHOW_ALPHA``, depending if you want to hide the alpha channel control or not. """ @@ -3474,7 +3474,7 @@ class CubeColourDialog(wx.Dialog): def GetColourData(self): - """ Returns a wxPython compatible :class:`ColourData`. """ + """ Returns a wxPython compatible :class:`wx.ColourData`. """ self._colourData.SetColour(self._colour.GetPyColour()) return self._colourData diff --git a/wx/lib/agw/customtreectrl.py b/wx/lib/agw/customtreectrl.py index d609266c..a9a243d5 100644 --- a/wx/lib/agw/customtreectrl.py +++ b/wx/lib/agw/customtreectrl.py @@ -838,9 +838,9 @@ class TreeItemAttr(object): Default class constructor. For internal use: do not call it in your code! - :param `colText`: the text colour, an instance of :class:`Colour`; - :param `colBack`: the tree item background colour, an instance of :class:`Colour`; - :param `colBorder`: the tree item border colour, an instance of :class:`Colour`; + :param `colText`: the text colour, an instance of :class:`wx.Colour`; + :param `colBack`: the tree item background colour, an instance of :class:`wx.Colour`; + :param `colBorder`: the tree item border colour, an instance of :class:`wx.Colour`; :param `font`: the tree item font, an instance of :class:`Font`. """ @@ -854,7 +854,7 @@ class TreeItemAttr(object): """ Sets the text colour attribute. - :param `colText`: an instance of :class:`Colour`. + :param `colText`: an instance of :class:`wx.Colour`. """ self._colText = colText @@ -864,7 +864,7 @@ class TreeItemAttr(object): """ Sets the item background colour attribute. - :param `colBack`: an instance of :class:`Colour`. + :param `colBack`: an instance of :class:`wx.Colour`. """ self._colBack = colBack @@ -874,7 +874,7 @@ class TreeItemAttr(object): """ Sets the item border colour attribute. - :param `colBack`: an instance of :class:`Colour`. + :param `colBack`: an instance of :class:`wx.Colour`. .. versionadded:: 0.9.6 """ @@ -940,7 +940,7 @@ class TreeItemAttr(object): """ Returns the attribute text colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._colText @@ -950,7 +950,7 @@ class TreeItemAttr(object): """ Returns the attribute background colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._colBack @@ -960,7 +960,7 @@ class TreeItemAttr(object): """ Returns the attribute border colour. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. .. versionadded:: 0.9.6 """ @@ -3070,7 +3070,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the colour for items in a disabled state. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ self._disabledColour = colour @@ -3081,7 +3081,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the colour for items in a disabled state. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._disabledColour @@ -3625,7 +3625,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param `item`: an instance of :class:`GenericTreeItem`. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return item.Attr().GetTextColour() @@ -3637,7 +3637,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param `item`: an instance of :class:`GenericTreeItem`. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return item.Attr().GetBackgroundColour() @@ -3802,7 +3802,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Sets the item text colour or separator horizontal line colour. :param `item`: an instance of :class:`GenericTreeItem`; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ item.Attr().SetTextColour(colour) @@ -3814,7 +3814,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Sets the item background colour. :param `item`: an instance of :class:`GenericTreeItem`; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ item.Attr().SetBackgroundColour(colour) @@ -3906,7 +3906,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the colour used to render a non-visited hypertext item. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. :note: This method is meaningful only for hypertext-like items. """ @@ -3919,7 +3919,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the colour used to render a non-visited hypertext item. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. :note: This method is meaningful only for hypertext-like items. """ @@ -3931,7 +3931,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the colour used to render a visited hypertext item. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. :note: This method is meaningful only for hypertext-like items. """ @@ -3944,7 +3944,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the colour used to render a visited hypertext item. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. :note: This method is meaningful only for hypertext-like items. """ @@ -3984,7 +3984,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the colour used to highlight focused selected items. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. :note: This is applied only if gradient and Windows Vista selection styles are disabled. @@ -3998,7 +3998,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the colour used to highlight unfocused selected items. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. :note: This is applied only if gradient and Windows Vista selection styles are disabled. @@ -4012,7 +4012,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the colour used to highlight focused selected items. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. :note: This is used only if gradient and Windows Vista selection styles are disabled. @@ -4025,7 +4025,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the colour used to highlight unfocused selected items. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. :note: This is used only if gradient and Windows Vista selection styles are disabled. @@ -4038,7 +4038,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the first gradient colour for gradient-style selections. - :param `colour`: if not ``None``, a valid :class:`Colour` instance. Otherwise, + :param `colour`: if not ``None``, a valid :class:`wx.Colour` instance. Otherwise, the colour is taken from the system value ``wx.SYS_COLOUR_HIGHLIGHT``. """ @@ -4054,7 +4054,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the second gradient colour for gradient-style selections. - :param `colour`: if not ``None``, a valid :class:`Colour` instance. Otherwise, + :param `colour`: if not ``None``, a valid :class:`wx.Colour` instance. Otherwise, the colour generated is a slightly darker version of the :class:`CustomTreeCtrl` background colour. """ @@ -4077,7 +4077,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the first gradient colour for gradient-style selections. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._firstcolour @@ -4087,7 +4087,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the second gradient colour for gradient-style selections. - :return: An instance of :class:`Colour`. + :return: An instance of :class:`wx.Colour`. """ return self._secondcolour @@ -4230,7 +4230,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the pen colour for separator-type items. - :param `colour`: a valid instance of :class:`Colour`. + :param `colour`: a valid instance of :class:`wx.Colour`. """ self._separatorPen = wx.Pen(colour, 1) @@ -4241,7 +4241,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the pen colour for separator-type items. - :return: An instance of :class:`Colour` representing the separator pen colour. + :return: An instance of :class:`wx.Colour` representing the separator pen colour. """ return self._separatorPen.GetColour() diff --git a/wx/lib/agw/flatmenu.py b/wx/lib/agw/flatmenu.py index f10a8c02..ae6648d4 100644 --- a/wx/lib/agw/flatmenu.py +++ b/wx/lib/agw/flatmenu.py @@ -493,7 +493,7 @@ class FMRenderer(object): """ Set the colour to highlight focus on the menu bar. - :param `colour`: a valid instance of :class:`Colour`. + :param `colour`: a valid instance of :class:`wx.Colour`. """ self.menuBarFocusFaceColour = colour @@ -506,7 +506,7 @@ class FMRenderer(object): """ Set the colour to highlight focus on the menu. - :param `colour`: a valid instance of :class:`Colour`. + :param `colour`: a valid instance of :class:`wx.Colour`. """ self.menuFocusFaceColour = colour @@ -517,7 +517,7 @@ class FMRenderer(object): def GetColoursAccordingToState(self, state): """ - Returns a :class:`Colour` according to the menu item state. + Returns a :class:`wx.Colour` according to the menu item state. :param integer `state`: one of the following bits: @@ -1044,7 +1044,7 @@ class FMRenderer(object): :param `dc`: an instance of :class:`DC`; :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; :param integer `state`: the button state; - :param `colour`: if not ``None``, an instance of :class:`Colour` to be used to draw + :param `colour`: if not ``None``, an instance of :class:`wx.Colour` to be used to draw the :class:`FlatMenuItem` background. """ @@ -1476,7 +1476,7 @@ class FMRendererMSOffice2007(FMRenderer): :param `dc`: an instance of :class:`DC`; :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; :param integer `state`: the button state; - :param `colour`: if not ``None``, an instance of :class:`Colour` to be used to draw + :param `colour`: if not ``None``, an instance of :class:`wx.Colour` to be used to draw the :class:`FlatMenuItem` background. """ @@ -1492,7 +1492,7 @@ class FMRendererMSOffice2007(FMRenderer): :param `dc`: an instance of :class:`DC`; :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; :param integer `state`: the button state; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ artMgr = ArtManager.Get() @@ -1710,7 +1710,7 @@ class FMRendererVista(FMRendererMSOffice2007): :param `dc`: an instance of :class:`DC`; :param `rect`: the an instance of :class:`Rect`, representing the button client rectangle; :param integer `state`: the button state; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ artMgr = ArtManager.Get() @@ -3131,7 +3131,7 @@ class FlatMenuBar(wx.Panel): """ Sets the menu bar background colour. - :param `colour`: a valid :class:`Colour`. + :param `colour`: a valid :class:`wx.Colour`. """ self.GetRenderer().menuBarFaceColour = colour @@ -5280,7 +5280,7 @@ class FlatMenuItem(object): """ Sets the :class:`FlatMenuItem` foreground colour for the menu label. - :param `colour`: an instance of a valid :class:`Colour`. + :param `colour`: an instance of a valid :class:`wx.Colour`. """ self._textColour = colour @@ -6861,7 +6861,7 @@ class FlatMenu(FlatMenuBase): Sets the :class:`FlatMenuItem` foreground text colour. :param integer `itemId`: the menu item identifier; - :param `colour`: an instance of a valid :class:`Colour`. + :param `colour`: an instance of a valid :class:`wx.Colour`. """ item = self.FindItem(itemId) diff --git a/wx/lib/agw/flatnotebook.py b/wx/lib/agw/flatnotebook.py index ea305dbd..d99cf2cc 100644 --- a/wx/lib/agw/flatnotebook.py +++ b/wx/lib/agw/flatnotebook.py @@ -779,7 +779,7 @@ def LightColour(colour, percent): """ Brighten the input colour by a percentage. - :param `colour`: a valid :class:`Colour` instance; + :param `colour`: a valid :class:`wx.Colour` instance; :param `percent`: the percentage by which the input colour should be brightened. """ @@ -801,13 +801,13 @@ def LightColour(colour, percent): def FormatColour(colour): """ - Convert the input `colour` into a valid :class:`Colour` instance, using whatever typemap + Convert the input `colour` into a valid :class:`wx.Colour` instance, using whatever typemap accepted by wxWidgets/wxPython. - :param `colour`: can be an instance of :class:`Colour`, a 3 or 4 integer tuple, a hex + :param `colour`: can be an instance of :class:`wx.Colour`, a 3 or 4 integer tuple, a hex string, a string representing the colour name or ``None``. - :returns: a valid instance of :class:`Colour` or ``None`` if the input `colour` was ``None`` + :returns: a valid instance of :class:`wx.Colour` or ``None`` if the input `colour` was ``None`` in the first place. """ @@ -878,7 +878,7 @@ def AdjustColour(colour, percent, alpha=wx.ALPHA_OPAQUE): """ Brighten/darken input colour by `percent` and adjust `alpha` channel if needed. - :param `colour`: colour object to adjust, an instance of :class:`Colour`; + :param `colour`: colour object to adjust, an instance of :class:`wx.Colour`; :param `percent`: percent to adjust ``+`` (brighten) or ``-`` (darken); :param `alpha`: amount to adjust the alpha channel. @@ -1229,7 +1229,7 @@ class PageInfo(object): """ Sets the tab text colour for this tab. - :param `colour`: an instance of :class:`Colour`. You can pass ``None`` or + :param `colour`: an instance of :class:`wx.Colour`. You can pass ``None`` or :class:`NullColour` to return to the default page text colour. """ @@ -1300,7 +1300,7 @@ class PageInfo(object): """ Sets the tab colour. - :param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `colour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). """ @@ -4149,7 +4149,7 @@ class FlatNotebook(wx.Panel): """ Sets the text colour for the active tab. - :param `textColour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `textColour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). """ @@ -4873,9 +4873,9 @@ class FlatNotebook(wx.Panel): """ Sets the gradient colours for the tab. - :param `fr`: the first gradient colour, an instance of :class:`Colour`; - :param `to`: the second gradient colour, an instance of :class:`Colour`; - :param `border`: the border colour, an instance of :class:`Colour`. + :param `fr`: the first gradient colour, an instance of :class:`wx.Colour`; + :param `to`: the second gradient colour, an instance of :class:`wx.Colour`; + :param `border`: the border colour, an instance of :class:`wx.Colour`. """ self._pages._colourFrom = fr @@ -4887,7 +4887,7 @@ class FlatNotebook(wx.Panel): """ Sets the starting colour for the gradient. - :param `fr`: the first gradient colour, an instance of :class:`Colour`. + :param `fr`: the first gradient colour, an instance of :class:`wx.Colour`. """ self._pages._colourFrom = fr @@ -4897,7 +4897,7 @@ class FlatNotebook(wx.Panel): """ Sets the ending colour for the gradient. - :param `to`: the second gradient colour, an instance of :class:`Colour`; + :param `to`: the second gradient colour, an instance of :class:`wx.Colour`; """ self._pages._colourTo = to @@ -4907,7 +4907,7 @@ class FlatNotebook(wx.Panel): """ Sets the tab border colour. - :param `border`: the border colour, an instance of :class:`Colour`. + :param `border`: the border colour, an instance of :class:`wx.Colour`. """ self._pages._colourBorder = border @@ -4999,7 +4999,7 @@ class FlatNotebook(wx.Panel): """ Sets the non active tabs text colour. - :param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `colour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). """ @@ -5021,7 +5021,7 @@ class FlatNotebook(wx.Panel): Sets the tab text colour individually. :param `page`: an integer specifying the page index; - :param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `colour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). You can pass ``None`` or :class:`NullColour` to return to the default page text colour. """ @@ -5033,7 +5033,7 @@ class FlatNotebook(wx.Panel): """ Sets the area behind the tabs colour. - :param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `colour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). """ @@ -5050,7 +5050,7 @@ class FlatNotebook(wx.Panel): """ Sets the active tab colour. - :param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `colour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). """ @@ -6064,7 +6064,7 @@ class PageContainer(wx.Panel): Sets the tab text colour individually. :param `page`: an integer specifying the page index; - :param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython + :param `colour`: a valid :class:`wx.Colour` object or any typemap supported by wxWidgets/wxPython to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). You can pass ``None`` or :class:`NullColour` to return to the default page text colour. """ diff --git a/wx/lib/agw/foldpanelbar.py b/wx/lib/agw/foldpanelbar.py index 3b8fbf2f..ad49f0d0 100644 --- a/wx/lib/agw/foldpanelbar.py +++ b/wx/lib/agw/foldpanelbar.py @@ -365,7 +365,7 @@ class CaptionBarStyle(object): """ Sets first colour for the caption bar. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: If this is not set, the colour property is undefined and will not be used. Use :meth:`~CaptionBarStyle.FirstColourUsed` to check if this style is used. @@ -400,7 +400,7 @@ class CaptionBarStyle(object): """ Sets second colour for the caption bar. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: If this is not set, the colour property is undefined and will not be used. Use :meth:`~CaptionBarStyle.SecondColourUsed` to check if this style is used. @@ -435,7 +435,7 @@ class CaptionBarStyle(object): """ Sets caption colour for the caption bar. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: If this is not set, the colour property is undefined and will not be used. Use :meth:`~CaptionBarStyle.CaptionColourUsed` to check if this style is used. @@ -1379,7 +1379,7 @@ class FoldPanelBar(wx.Panel): component. It can be used to separate groups of controls which belong to each other. - :param `colour`: the separator colour, an instance of :class:`Colour`; + :param `colour`: the separator colour, an instance of :class:`wx.Colour`; :param `spacing`: the separator to be added can be slightly indented from left and right so it is more visibly placed in the fold panel. Use `spacing` > 0 to give the control an y offset from the previous :class:`Window` added; @@ -1828,7 +1828,7 @@ class FoldPanelItem(wx.Panel): """ Adds a separator item to the list of items on this panel. - :param `colour`: the separator colour, an instance of :class:`Colour`; + :param `colour`: the separator colour, an instance of :class:`wx.Colour`; :param `spacing`: the separator to be added can be slightly indented from left and right so it is more visibly placed in the fold panel. Use `spacing` > 0 to give the control an y offset from the previous :class:`Window` added; diff --git a/wx/lib/agw/gradientbutton.py b/wx/lib/agw/gradientbutton.py index 9c571037..38aae16c 100644 --- a/wx/lib/agw/gradientbutton.py +++ b/wx/lib/agw/gradientbutton.py @@ -563,7 +563,7 @@ class GradientButton(wx.Control): """ Sets the top start colour for the gradient shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._topStartColour = colour @@ -580,7 +580,7 @@ class GradientButton(wx.Control): """ Sets the top end colour for the gradient shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._topEndColour = colour @@ -597,7 +597,7 @@ class GradientButton(wx.Control): """ Sets the top bottom colour for the gradient shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._bottomStartColour = colour @@ -614,7 +614,7 @@ class GradientButton(wx.Control): """ Sets the bottom end colour for the gradient shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._bottomEndColour = colour @@ -631,7 +631,7 @@ class GradientButton(wx.Control): """ Sets the pressed top start colour for the gradient shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._pressedTopColour = colour @@ -648,7 +648,7 @@ class GradientButton(wx.Control): """ Sets the pressed bottom start colour for the gradient shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._pressedBottomColour = colour @@ -665,7 +665,7 @@ class GradientButton(wx.Control): """ Sets the :class:`GradientButton` foreground (text) colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: Overridden from :class:`Control`. """ diff --git a/wx/lib/agw/hyperlink.py b/wx/lib/agw/hyperlink.py index 8389e3e5..79340046 100644 --- a/wx/lib/agw/hyperlink.py +++ b/wx/lib/agw/hyperlink.py @@ -451,11 +451,11 @@ class HyperLinkCtrl(StaticText): - Visited link: VIOLET - Rollover: BLUE - :param `link`: a valid :class:`Colour` to use as text foreground for new links + :param `link`: a valid :class:`wx.Colour` to use as text foreground for new links (default=RED); - :param `visited`: a valid :class:`Colour` to use as text foreground for visited + :param `visited`: a valid :class:`wx.Colour` to use as text foreground for visited links (default=VIOLET); - :param `rollover`: a valid :class:`Colour` to use as text foreground for links + :param `rollover`: a valid :class:`wx.Colour` to use as text foreground for links rollovers (default=BLUE). """ diff --git a/wx/lib/agw/hypertreelist.py b/wx/lib/agw/hypertreelist.py index 0f1146d2..d271cabc 100644 --- a/wx/lib/agw/hypertreelist.py +++ b/wx/lib/agw/hypertreelist.py @@ -413,7 +413,7 @@ class TreeListColumnInfo(object): :param `image`: an index within the normal image list assigned to :class:`HyperTreeList` specifying the image to use for the column; :param `shown`: ``True`` to show the column, ``False`` to hide it; - :param `colour`: a valid :class:`Colour`, representing the text foreground colour + :param `colour`: a valid :class:`wx.Colour`, representing the text foreground colour for the column; :param `edit`: ``True`` to set the column as editable, ``False`` otherwise. """ @@ -508,7 +508,7 @@ class TreeListColumnInfo(object): """ Sets the column text colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._colour = colour @@ -774,7 +774,7 @@ class TreeListHeaderWindow(wx.Window): Sets the column text colour. :param `column`: an integer specifying the column index; - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ if column < 0 or column >= self.GetColumnCount(): @@ -1158,7 +1158,7 @@ class TreeListHeaderWindow(wx.Window): :param `image`: an index within the normal image list assigned to :class:`HyperTreeList` specifying the image to use for the column; :param `shown`: ``True`` to show the column, ``False`` to hide it; - :param `colour`: a valid :class:`Colour`, representing the text foreground colour + :param `colour`: a valid :class:`wx.Colour`, representing the text foreground colour for the column; :param `edit`: ``True`` to set the column as editable, ``False`` otherwise. """ @@ -1218,7 +1218,7 @@ class TreeListHeaderWindow(wx.Window): :param `image`: an index within the normal image list assigned to :class:`HyperTreeList` specifying the image to use for the column; :param `shown`: ``True`` to show the column, ``False`` to hide it; - :param `colour`: a valid :class:`Colour`, representing the text foreground colour + :param `colour`: a valid :class:`wx.Colour`, representing the text foreground colour for the column; :param `edit`: ``True`` to set the column as editable, ``False`` otherwise. """ @@ -4471,7 +4471,7 @@ class HyperTreeList(wx.Control): :param `image`: an index within the normal image list assigned to :class:`HyperTreeList` specifying the image to use for the column; :param `shown`: ``True`` to show the column, ``False`` to hide it; - :param `colour`: a valid :class:`Colour`, representing the text foreground colour + :param `colour`: a valid :class:`wx.Colour`, representing the text foreground colour for the column; :param `edit`: ``True`` to set the column as editable, ``False`` otherwise. """ @@ -4519,7 +4519,7 @@ class HyperTreeList(wx.Control): :param `image`: an index within the normal image list assigned to :class:`HyperTreeList` specifying the image to use for the column; :param `shown`: ``True`` to show the column, ``False`` to hide it; - :param `colour`: a valid :class:`Colour`, representing the text foreground colour + :param `colour`: a valid :class:`wx.Colour`, representing the text foreground colour for the column; :param `edit`: ``True`` to set the column as editable, ``False`` otherwise. """ @@ -4659,7 +4659,7 @@ class HyperTreeList(wx.Control): Sets the column text colour. :param `column`: an integer specifying the column index; - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._header_win.SetColumn(column, self.GetColumn(column).SetColour(colour)) diff --git a/wx/lib/agw/infobar.py b/wx/lib/agw/infobar.py index 02256ede..18fbe818 100644 --- a/wx/lib/agw/infobar.py +++ b/wx/lib/agw/infobar.py @@ -212,7 +212,7 @@ def GetCloseButtonBitmap(win, size, colBg, flags=0): :param `win`: the window in which we wish to draw the close button (an instance of :class:`InfoBar`); :param tuple `size`: the close button size, a tuple of `(width, height)` dimensions in pixels; - :param `colBg`: the background colour of the parent window, an instance of :class:`Colour`; + :param `colBg`: the background colour of the parent window, an instance of :class:`wx.Colour`; :param integer `flags`: may have the ``wx.CONTROL_PRESSED``, ``wx.CONTROL_CURRENT`` or ``wx.CONTROL_ISDEFAULT`` bit set. """ diff --git a/wx/lib/agw/knobctrl.py b/wx/lib/agw/knobctrl.py index cdb4b3d5..ca59071f 100644 --- a/wx/lib/agw/knobctrl.py +++ b/wx/lib/agw/knobctrl.py @@ -488,7 +488,7 @@ class KnobCtrl(BufferedWindow): """ Sets the tags colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._tagscolour = colour @@ -505,7 +505,7 @@ class KnobCtrl(BufferedWindow): """ Sets the bounding circle colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._boundingcolour = colour @@ -522,7 +522,7 @@ class KnobCtrl(BufferedWindow): """ Sets the first gradient colour for shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._startcolour = colour @@ -539,7 +539,7 @@ class KnobCtrl(BufferedWindow): """ Sets the second gradient colour for shading. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._endcolour = colour @@ -695,7 +695,7 @@ class KnobCtrl(BufferedWindow): """ Changes the input colour by the `offset` value. Used internally. - :param `colour`: a valid :class:`Colour` object; + :param `colour`: a valid :class:`wx.Colour` object; :param `offset`: an integer value for offsetting the input colour. """ diff --git a/wx/lib/agw/labelbook.py b/wx/lib/agw/labelbook.py index 43915335..409e4f00 100644 --- a/wx/lib/agw/labelbook.py +++ b/wx/lib/agw/labelbook.py @@ -1982,7 +1982,7 @@ class LabelContainer(ImageContainerBase): ``INB_HILITE_TAB_COLOUR`` 105 The tab caption highlight text colour ================================== ======= ================================== - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._coloursMap[which] = colour @@ -2995,7 +2995,7 @@ class LabelBook(FlatBookBase): Sets the colour for the specified parameter. :param `which`: the colour key; - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. :see: :meth:`LabelContainer.SetColour() ` for a list of valid colour keys. """ diff --git a/wx/lib/agw/peakmeter.py b/wx/lib/agw/peakmeter.py index 57628573..505c67ac 100644 --- a/wx/lib/agw/peakmeter.py +++ b/wx/lib/agw/peakmeter.py @@ -202,7 +202,7 @@ def LightenColour(crColour, byIncreaseVal): """ Lightens a colour. - :param `crColour`: a valid :class:`Colour` object; + :param `crColour`: a valid :class:`wx.Colour` object; :param `byIncreaseVal`: an integer specifying the amount for which the input colour should be brightened. """ @@ -222,7 +222,7 @@ def DarkenColour(crColour, byReduceVal): """ Darkens a colour. - :param `crColour`: a valid :class:`Colour` object; + :param `crColour`: a valid :class:`wx.Colour` object; :param `byReduceVal`: an integer specifying the amount for which the input colour should be darkened. """ @@ -420,11 +420,11 @@ class PeakMeterCtrl(wx.Control): """ Set bands colour for :class:`PeakMeterCtrl`. - :param `colourNormal`: the colour for normal (low) bands, a valid :class:`Colour` + :param `colourNormal`: the colour for normal (low) bands, a valid :class:`wx.Colour` object; - :param `colourMedium`: the colour for medium bands, a valid :class:`Colour` + :param `colourMedium`: the colour for medium bands, a valid :class:`wx.Colour` object; - :param `colourHigh`: the colour for high bands, a valid :class:`Colour` + :param `colourHigh`: the colour for high bands, a valid :class:`wx.Colour` object. """ diff --git a/wx/lib/agw/persist/__init__.py b/wx/lib/agw/persist/__init__.py index 7032cc8b..c128a056 100644 --- a/wx/lib/agw/persist/__init__.py +++ b/wx/lib/agw/persist/__init__.py @@ -165,7 +165,7 @@ TODOs to `PersistenceManager` as :class:`grid.Grid` sets up arrays to store individual row and column sizes when non-default sizes are used. The memory requirements for this could become prohibitive if the grid is very large); -* Find a way to properly save and restore dialog data (:class:`ColourDialog`, :class:`FontDialog` etc...); +* Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...); * Add handlers for the remaining widgets not yet wrapped (mostly in :mod:`lib`). diff --git a/wx/lib/agw/persist/persist_handlers.py b/wx/lib/agw/persist/persist_handlers.py index ac2b8c9e..8823f6dd 100644 --- a/wx/lib/agw/persist/persist_handlers.py +++ b/wx/lib/agw/persist/persist_handlers.py @@ -1849,11 +1849,11 @@ class MediaCtrlHandler(AbstractHandler): class ColourPickerHandler(AbstractHandler): """ - Supports saving/restoring a :class:`ColourPickerCtrl` / :class:`lib.colourselect.ColourSelect` colour. + Supports saving/restoring a :class:`wx.ColourPickerCtrl` / :class:`lib.colourselect.ColourSelect` colour. This class handles the following wxPython widgets: - - :class:`ColourPickerCtrl`; + - :class:`wx.ColourPickerCtrl`; - :class:`lib.colourselect.ColourSelect`. """ @@ -2233,7 +2233,7 @@ class FindReplaceHandler(TLWHandler): - :class:`FindReplaceDialog`. - .. todo:: Find a way to properly save and restore dialog data (:class:`ColourDialog`, :class:`FontDialog` etc...). + .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...). """ @@ -2290,7 +2290,7 @@ class FontDialogHandler(TLWHandler): - :class:`FontDialog`. - .. todo:: Find a way to properly save and restore dialog data (:class:`ColourDialog`, :class:`FontDialog` etc...). + .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...). """ @@ -2348,15 +2348,15 @@ class FontDialogHandler(TLWHandler): class ColourDialogHandler(TLWHandler): """ - Supports saving/restoring a :class:`ColourDialog` data (colour, custom colours and full + Supports saving/restoring a :class:`wx.ColourDialog` data (colour, custom colours and full choice in the dialog). This class handles the following wxPython widgets: - - :class:`ColourDialog`; + - :class:`wx.ColourDialog`; - :class:`lib.agw.cubecolourdialog.CubeColourDialog`. - .. todo:: Find a way to properly save and restore dialog data (:class:`ColourDialog`, :class:`FontDialog` etc...). + .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...). """ diff --git a/wx/lib/agw/piectrl.py b/wx/lib/agw/piectrl.py index 4a315f4b..c09fb98e 100644 --- a/wx/lib/agw/piectrl.py +++ b/wx/lib/agw/piectrl.py @@ -274,7 +274,7 @@ class PieCtrlLegend(wx.Window): """ Sets the legend label colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._labelcolour = colour @@ -308,7 +308,7 @@ class PieCtrlLegend(wx.Window): """ Sets the legend background colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._backcolour = colour @@ -418,7 +418,7 @@ class PiePart(object): """ Sets the segment colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._colour = colour @@ -614,7 +614,7 @@ class PieCtrl(wx.Window): """ Sets the :class:`PieCtrl` background colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._backcolour = colour @@ -954,7 +954,7 @@ class ProgressPie(PieCtrl): """ Sets the colour that progressively fills the :class:`ProgressPie` . - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._filledcolour = colour @@ -966,7 +966,7 @@ class ProgressPie(PieCtrl): """ Sets the colour that is filled. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._unfilledcolour= colour diff --git a/wx/lib/agw/pygauge.py b/wx/lib/agw/pygauge.py index 6edc1ae3..7158d92c 100644 --- a/wx/lib/agw/pygauge.py +++ b/wx/lib/agw/pygauge.py @@ -182,7 +182,7 @@ class PyGauge(wx.Window): """ Sets the :class:`PyGauge` border colour. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ self._border_colour = colour @@ -201,7 +201,7 @@ class PyGauge(wx.Window): """ Sets the :class:`PyGauge` main bar colour. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ if type(colour) != type([]): diff --git a/wx/lib/agw/pyprogress.py b/wx/lib/agw/pyprogress.py index cf207e98..350443d1 100644 --- a/wx/lib/agw/pyprogress.py +++ b/wx/lib/agw/pyprogress.py @@ -204,7 +204,7 @@ class ProgressGauge(wx.Window): """ Sets the first gradient colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._firstGradient = colour @@ -221,7 +221,7 @@ class ProgressGauge(wx.Window): """ Sets the second gradient colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._secondGradient = colour @@ -238,7 +238,7 @@ class ProgressGauge(wx.Window): """ Sets the gauge background colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._background = wx.Brush(colour) @@ -636,7 +636,7 @@ class PyProgress(wx.Dialog): """ Sets the gauge first gradient colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._gauge.SetFirstGradientColour(colour) @@ -652,7 +652,7 @@ class PyProgress(wx.Dialog): """ Sets the gauge second gradient colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._gauge.SetSecondGradientColour(colour) @@ -668,7 +668,7 @@ class PyProgress(wx.Dialog): """ Sets the gauge background colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._gauge.SetGaugeBackground(colour) diff --git a/wx/lib/agw/rulerctrl.py b/wx/lib/agw/rulerctrl.py index 488ab9df..deeeb68f 100644 --- a/wx/lib/agw/rulerctrl.py +++ b/wx/lib/agw/rulerctrl.py @@ -518,7 +518,7 @@ class Indicator(object): """ Sets the indicator colour. - :param `colour`: the new indicator colour, an instance of :class:`Colour`. + :param `colour`: the new indicator colour, an instance of :class:`wx.Colour`. :note: Requires PIL (Python Imaging Library), which can be downloaded from http://www.pythonware.com/products/pil/ @@ -988,7 +988,7 @@ class RulerCtrl(wx.Panel): """ Sets the :class:`RulerCtrl` background colour. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. :note: Overridden from :class:`Panel`. """ @@ -1102,7 +1102,7 @@ class RulerCtrl(wx.Panel): """ Sets the pen colour to draw the ticks. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._tickpen = wx.Pen(colour) @@ -1113,7 +1113,7 @@ class RulerCtrl(wx.Panel): """ Sets the labels colour. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ self._textcolour = colour @@ -1191,7 +1191,7 @@ class RulerCtrl(wx.Panel): Sets the indicator colour. :param `id`: the indicator identifier; - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. :note: This method requires PIL to change the image palette. """ diff --git a/wx/lib/agw/shapedbutton.py b/wx/lib/agw/shapedbutton.py index ddb3becc..6867476a 100644 --- a/wx/lib/agw/shapedbutton.py +++ b/wx/lib/agw/shapedbutton.py @@ -330,7 +330,7 @@ class SButton(wx.Window): """ Sets the button colour, for all button states. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. :note: The original button images are greyscale with a lot of pixels with different colours. Changing smoothly the button colour in order to @@ -359,7 +359,7 @@ class SButton(wx.Window): """ Sets the button label colour. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ if colour is None: diff --git a/wx/lib/agw/speedmeter.py b/wx/lib/agw/speedmeter.py index 3df1aa25..41c23167 100644 --- a/wx/lib/agw/speedmeter.py +++ b/wx/lib/agw/speedmeter.py @@ -1308,7 +1308,7 @@ class SpeedMeter(BufferedWindow): """ Sets the ticks colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, the + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, the ticks colour will be set as blue. """ @@ -1328,7 +1328,7 @@ class SpeedMeter(BufferedWindow): """ Sets the background colour outside the :class:`SpeedMeter` control. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, the + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, the :class:`SpeedMeter` background will be taken from the system default. """ @@ -1348,7 +1348,7 @@ class SpeedMeter(BufferedWindow): """ Sets the hand (arrow indicator) colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, the arrow + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, the arrow indicator will be red. """ @@ -1368,7 +1368,7 @@ class SpeedMeter(BufferedWindow): """ Sets the external arc colour (thicker line). - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, the arc + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, the arc colour will be black. """ @@ -1388,7 +1388,7 @@ class SpeedMeter(BufferedWindow): """ Sets the hand's shadow colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, the shadow + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, the shadow colour will be light grey. """ @@ -1411,7 +1411,7 @@ class SpeedMeter(BufferedWindow): A circle corona near the ticks will be filled with this colour, from the starting value to the current value of :class:`SpeedMeter`. - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ if colour is None: @@ -1521,7 +1521,7 @@ class SpeedMeter(BufferedWindow): """ Sets the colour for the text in the middle. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, the text + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, the text in the middle will be painted in blue. """ @@ -1603,7 +1603,7 @@ class SpeedMeter(BufferedWindow): """ Sets the first gradient colour (near the ticks). - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ if colour is None: @@ -1622,7 +1622,7 @@ class SpeedMeter(BufferedWindow): """ Sets the second gradient colour (near the center). - :param `colour`: a valid :class:`Colour` object. + :param `colour`: a valid :class:`wx.Colour` object. """ if colour is None: diff --git a/wx/lib/agw/supertooltip.py b/wx/lib/agw/supertooltip.py index 2f86a254..9101061a 100644 --- a/wx/lib/agw/supertooltip.py +++ b/wx/lib/agw/supertooltip.py @@ -1179,7 +1179,7 @@ class SuperToolTip(object): """ Sets the top gradient colour for :class:`SuperToolTip`. - :param `colour`: the colour to use as top colour, a valid :class:`Colour` object. + :param `colour`: the colour to use as top colour, a valid :class:`wx.Colour` object. """ self._topColour = colour @@ -1191,7 +1191,7 @@ class SuperToolTip(object): """ Sets the middle gradient colour for :class:`SuperToolTip`. - :param `colour`: the colour to use as middle colour, a valid :class:`Colour` object. + :param `colour`: the colour to use as middle colour, a valid :class:`wx.Colour` object. """ self._middleColour = colour @@ -1203,7 +1203,7 @@ class SuperToolTip(object): """ Sets the bottom gradient colour for :class:`SuperToolTip`. - :param `colour`: the colour to use as bottom colour, a valid :class:`Colour` object. + :param `colour`: the colour to use as bottom colour, a valid :class:`wx.Colour` object. """ self._bottomColour = colour @@ -1215,7 +1215,7 @@ class SuperToolTip(object): """ Sets the text colour for :class:`SuperToolTip`. - :param `colour`: the colour to use as text colour, a valid :class:`Colour` object. + :param `colour`: the colour to use as text colour, a valid :class:`wx.Colour` object. """ self._textColour = colour diff --git a/wx/lib/agw/thumbnailctrl.py b/wx/lib/agw/thumbnailctrl.py index 9574f443..81e2a0c2 100644 --- a/wx/lib/agw/thumbnailctrl.py +++ b/wx/lib/agw/thumbnailctrl.py @@ -1377,7 +1377,7 @@ class ScrolledThumbnail(wx.ScrolledWindow): """ Sets the colour used to indicate a selected thumbnail. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, it + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, it will be taken from the system settings. """ diff --git a/wx/lib/agw/toasterbox.py b/wx/lib/agw/toasterbox.py index a15e2b7e..e252aad6 100644 --- a/wx/lib/agw/toasterbox.py +++ b/wx/lib/agw/toasterbox.py @@ -382,7 +382,7 @@ class ToasterBox(wx.Timer): """ Sets the :class:`ToasterBox` background colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, then + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, then the background colour will be white. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. @@ -400,7 +400,7 @@ class ToasterBox(wx.Timer): """ Sets the :class:`ToasterBox` foreground colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, then + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, then the background colour will be black. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. @@ -417,7 +417,7 @@ class ToasterBox(wx.Timer): """ Sets the :class:`ToasterBox` text font. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, then + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, then a simple generic font will be generated. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. @@ -950,7 +950,7 @@ class ToasterBoxWindow(wx.Frame): """ Sets the :class:`ToasterBox` text font. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, then + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, then a simple generic font will be generated. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. @@ -1009,7 +1009,7 @@ class ToasterBoxWindow(wx.Frame): """ Sets the :class:`ToasterBox` background colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, then + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, then the background colour will be white. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. @@ -1023,7 +1023,7 @@ class ToasterBoxWindow(wx.Frame): """ Sets the :class:`ToasterBox` foreground colour. - :param `colour`: a valid :class:`Colour` object. If defaulted to ``None``, then + :param `colour`: a valid :class:`wx.Colour` object. If defaulted to ``None``, then the background colour will be black. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. diff --git a/wx/lib/agw/ultimatelistctrl.py b/wx/lib/agw/ultimatelistctrl.py index 531c942a..d738fa16 100644 --- a/wx/lib/agw/ultimatelistctrl.py +++ b/wx/lib/agw/ultimatelistctrl.py @@ -779,7 +779,7 @@ class PyImageList(object): Adds a new image or images using a bitmap and a colour mask. :param `bitmap`: a valid :class:`Bitmap` object; - :param `colour`: an instance of :class:`Colour`, a colour indicating which parts + :param `colour`: an instance of :class:`wx.Colour`, a colour indicating which parts of the image are transparent. :return: The new zero-based image index. @@ -1183,7 +1183,7 @@ class UltimateListItemAttr(object): """ Sets a new text colour. - :param `colText`: an instance of :class:`Colour`. + :param `colText`: an instance of :class:`wx.Colour`. """ self._colText = colText @@ -1193,7 +1193,7 @@ class UltimateListItemAttr(object): """ Sets a new background colour. - :param `colBack`: an instance of :class:`Colour`. + :param `colBack`: an instance of :class:`wx.Colour`. """ self._colBack = colBack @@ -1223,7 +1223,7 @@ class UltimateListItemAttr(object): """ Sets a new footer item text colour. - :param `colText`: an instance of :class:`Colour`. + :param `colText`: an instance of :class:`wx.Colour`. """ self._footerColText = colText @@ -1233,7 +1233,7 @@ class UltimateListItemAttr(object): """ Sets a new footer item background colour. - :param `colBack`: an instance of :class:`Colour`. + :param `colBack`: an instance of :class:`wx.Colour`. """ self._footerColBack = colBack @@ -1618,7 +1618,7 @@ class UltimateListItem(wx.Object): """ Sets the text colour for the item. - :param `colText`: a valid :class:`Colour` object. + :param `colText`: a valid :class:`wx.Colour` object. """ self.Attributes().SetTextColour(colText) @@ -1628,7 +1628,7 @@ class UltimateListItem(wx.Object): """ Sets the background colour for the item. - :param `colBack`: a valid :class:`Colour` object. + :param `colBack`: a valid :class:`wx.Colour` object. """ self.Attributes().SetBackgroundColour(colBack) @@ -1648,7 +1648,7 @@ class UltimateListItem(wx.Object): """ Sets the text colour for the footer item. - :param `colText`: a valid :class:`Colour` object. + :param `colText`: a valid :class:`wx.Colour` object. """ self.Attributes().SetFooterTextColour(colText) @@ -1658,7 +1658,7 @@ class UltimateListItem(wx.Object): """ Sets the background colour for the footer item. - :param `colBack`: a valid :class:`Colour` object. + :param `colBack`: a valid :class:`wx.Colour` object. """ self.Attributes().SetFooterBackgroundColour(colBack) @@ -2638,7 +2638,7 @@ class UltimateListItemData(object): """ Sets the text colour for the item. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ if colour == wx.NullColour or colour == None: @@ -2671,7 +2671,7 @@ class UltimateListItemData(object): """ Sets the background colour for the item. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ if colour == wx.NullColour: @@ -4247,7 +4247,7 @@ class UltimateListLineData(object): Sets the text colour for the item. :param `index`: the index of the item; - :param `c`: an instance of :class:`Colour`. + :param `c`: an instance of :class:`wx.Colour`. """ item = self._items[index] @@ -9225,7 +9225,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the colour used to render a non-visited hypertext item. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ self._hypertextnewcolour = colour @@ -9242,7 +9242,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the colour used to render a visited hypertext item. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ self._hypertextvisitedcolour = colour @@ -10588,7 +10588,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the first gradient colour for gradient-style selections. - :param `colour`: if not ``None``, a valid :class:`Colour` instance. Otherwise, + :param `colour`: if not ``None``, a valid :class:`wx.Colour` instance. Otherwise, the colour is taken from the system value ``wx.SYS_COLOUR_HIGHLIGHT``. """ @@ -10604,7 +10604,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the second gradient colour for gradient-style selections. - :param `colour`: if not ``None``, a valid :class:`Colour` instance. Otherwise, + :param `colour`: if not ``None``, a valid :class:`wx.Colour` instance. Otherwise, the colour generated is a slightly darker version of the :class:`UltimateListCtrl` background colour. """ @@ -10749,7 +10749,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the items disabled colour. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ # Disabled items colour @@ -11622,7 +11622,7 @@ class UltimateListCtrl(wx.Control): Sets the item text colour. :param `item`: the index of the item; - :param `col`: a valid :class:`Colour` object. + :param `col`: a valid :class:`wx.Colour` object. """ info = UltimateListItem() @@ -11651,7 +11651,7 @@ class UltimateListCtrl(wx.Control): Sets the item background colour. :param `item`: the index of the item; - :param `col`: a valid :class:`Colour` object. + :param `col`: a valid :class:`wx.Colour` object. """ info = UltimateListItem() @@ -11719,7 +11719,7 @@ class UltimateListCtrl(wx.Control): """ Sets the :class:`UltimateListCtrl` foreground colour. - :param `col`: a valid :class:`Colour` object. + :param `col`: a valid :class:`wx.Colour` object. """ self.SetForegroundColour(col) @@ -12605,7 +12605,7 @@ class UltimateListCtrl(wx.Control): def OnGetItemTextColour(self, item, col): """ This function **must** be overloaded in the derived class for a control with - ``ULC_VIRTUAL`` style. It should return a :class:`Colour` object or ``None`` for + ``ULC_VIRTUAL`` style. It should return a :class:`wx.Colour` object or ``None`` for the default color. :param `item`: an integer specifying the item index; @@ -13126,7 +13126,7 @@ class UltimateListCtrl(wx.Control): """ Sets the first gradient colour for gradient-style selections. - :param `colour`: if not ``None``, a valid :class:`Colour` instance. Otherwise, + :param `colour`: if not ``None``, a valid :class:`wx.Colour` instance. Otherwise, the colour is taken from the system value ``wx.SYS_COLOUR_HIGHLIGHT``. """ @@ -13137,7 +13137,7 @@ class UltimateListCtrl(wx.Control): """ Sets the second gradient colour for gradient-style selections. - :param `colour`: if not ``None``, a valid :class:`Colour` instance. Otherwise, + :param `colour`: if not ``None``, a valid :class:`wx.Colour` instance. Otherwise, the colour generated is a slightly darker version of the :class:`UltimateListCtrl` background colour. """ @@ -13261,7 +13261,7 @@ class UltimateListCtrl(wx.Control): """ Sets the items disabled colour. - :param `colour`: an instance of :class:`Colour`. + :param `colour`: an instance of :class:`wx.Colour`. """ self._mainWin.SetDisabledTextColour(colour) @@ -13293,7 +13293,7 @@ class UltimateListCtrl(wx.Control): """ Sets the colour used to render a non-visited hypertext item. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ self._mainWin.SetHyperTextNewColour(colour) @@ -13309,7 +13309,7 @@ class UltimateListCtrl(wx.Control): """ Sets the colour used to render a visited hypertext item. - :param `colour`: a valid :class:`Colour` instance. + :param `colour`: a valid :class:`wx.Colour` instance. """ self._mainWin.SetHyperTextVisitedColour(colour) diff --git a/wx/lib/agw/zoombar.py b/wx/lib/agw/zoombar.py index 760340eb..13134cd4 100644 --- a/wx/lib/agw/zoombar.py +++ b/wx/lib/agw/zoombar.py @@ -644,7 +644,7 @@ class ImageBar(object): """ Sets the background button bar colour. - :param `colour`: an instance of :class:`Colour`; + :param `colour`: an instance of :class:`wx.Colour`; :param `xSize`: if not ``None``, the new :class:`ImageBar` width; :param `ySize`: if not ``None``, the new :class:`ImageBar` height. """ @@ -976,7 +976,7 @@ class ZoomBar(wx.Control): """ Sets the background button bar colour. - :param `colour`: an instance of :class:`Colour`; + :param `colour`: an instance of :class:`wx.Colour`; """ self._imgBar.SetBarColour(colour) diff --git a/wx/lib/colourdb.py b/wx/lib/colourdb.py index 3ed16887..ab7869f7 100644 --- a/wx/lib/colourdb.py +++ b/wx/lib/colourdb.py @@ -12,15 +12,15 @@ #---------------------------------------------------------------------- """ -This module loads additional colour names/values into the :class:`ColourDatabase`. +This module loads additional colour names/values into the :class:`wx.ColourDatabase`. Description =========== -This module loads additional colour names/values into the :class:`ColourDatabase`. +This module loads additional colour names/values into the :class:`wx.ColourDatabase`. -The :mod:`colourdb` will update the wxPython :class:`wx.ColourDatabase` using a pre-defined +The :mod:`wx.Colourdb` will update the wxPython :class:`wx.ColourDatabase` using a pre-defined set of colour names/colour tuples, hard-coded in this module source code. diff --git a/wx/lib/colourselect.py b/wx/lib/colourselect.py index 091bdb2d..0c23828c 100644 --- a/wx/lib/colourselect.py +++ b/wx/lib/colourselect.py @@ -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. """ diff --git a/wx/lib/floatcanvas/FCObjects.py b/wx/lib/floatcanvas/FCObjects.py index f6c15acf..d38ad370 100644 --- a/wx/lib/floatcanvas/FCObjects.py +++ b/wx/lib/floatcanvas/FCObjects.py @@ -332,7 +332,7 @@ class DrawObject: Set the Color - this method is overridden in the subclasses :param `Color`: use one of the following values any valid entry from - :class:`ColourDatabase` + :class:`wx.ColourDatabase` - ``Green`` - ``White`` diff --git a/wx/lib/imageutils.py b/wx/lib/imageutils.py index 776de9f6..dd1901ef 100644 --- a/wx/lib/imageutils.py +++ b/wx/lib/imageutils.py @@ -20,7 +20,7 @@ Description This module contains a collection of functions for simple image manipulations. The 2 functions defined here (:func:`grayOut`, :func:`makeGray` and :func:`stepColour`) can be used to convert a given image into a grey-scale representation and to -darken/lighten a specific wxPython :class:`Colour`. +darken/lighten a specific wxPython :class:`wx.Colour`. Usage @@ -93,11 +93,11 @@ def makeGray(rgb, factor, maskColor): Make a pixel grayed-out. If the pixel matches the maskColor, it won't be changed. - :param tuple `rgb`: a tuple of red, green, blue integers, defining the pixel :class:`Colour`; + :param tuple `rgb`: a tuple of red, green, blue integers, defining the pixel :class:`wx.Colour`; :param float `factor`: the amount for which we want to grey out a pixel colour; :param `maskColor`: the mask colour. - :type `maskColor`: tuple or :class:`Colour`. + :type `maskColor`: tuple or :class:`wx.Colour`. :rtype: tuple :returns: An RGB tuple with the greyed out pixel colour. @@ -120,7 +120,7 @@ def stepColour(c, step): :param Colour `c`: the input colour to be modified (darkened or lightened); :param integer `step`: the step value. - :rtype: :class:`Colour` + :rtype: :class:`wx.Colour` :returns: A new colour, darkened or lightened depending on the input `step` value. """ diff --git a/wx/lib/ogl/basic.py b/wx/lib/ogl/basic.py index cfe7dd71..3818df6d 100644 --- a/wx/lib/ogl/basic.py +++ b/wx/lib/ogl/basic.py @@ -842,7 +842,7 @@ class Shape(ShapeEvtHandler): Set the colour for the specified text region. :param str `the_colour`: a valid colour name, - see :class:`ColourDatabase` + see :class:`wx.ColourDatabase` :param `regionId`: the region identifier """ @@ -3702,14 +3702,14 @@ class ShapeRegion(object): Set the colour. :param str `col`: a valid colour name, - see :class:`ColourDatabase` + see :class:`wx.ColourDatabase` """ self._textColour = col self._actualColourObject = col def GetActualColourObject(self): - """Get the actual colour object from the :class:`ColourDatabase`.""" + """Get the actual colour object from the :class:`wx.ColourDatabase`.""" self._actualColourObject = wx.TheColourDatabase.Find(self.GetColour()) return self._actualColourObject @@ -3718,7 +3718,7 @@ class ShapeRegion(object): Set the pen colour. :param str `col`: a valid colour name, - see :class:`ColourDatabase` + see :class:`wx.ColourDatabase` """ self._penColour = col diff --git a/wx/lib/platebtn.py b/wx/lib/platebtn.py index 63c43910..f590872b 100644 --- a/wx/lib/platebtn.py +++ b/wx/lib/platebtn.py @@ -666,7 +666,7 @@ class PlateButton(wx.Control): prevent this automatic color choices from happening either specify a color or None for the other params. - :param Colour `normal`: Label color for normal state (:class:`Colour`) + :param Colour `normal`: Label color for normal state (:class:`wx.Colour`) :keyword Colour `hlight`: Color for when mouse is hovering over """ @@ -705,7 +705,7 @@ class PlateButton(wx.Control): def SetPressColor(self, color): """Set the color used for highlighting the pressed state - :param Colour `color`: :class:`Colour` + :param Colour `color`: :class:`wx.Colour` ..note:: also resets all text colours as necessary