diff --git a/etg/bitmap.py b/etg/bitmap.py index 551efaa6..8086513f 100644 --- a/etg/bitmap.py +++ b/etg/bitmap.py @@ -188,7 +188,7 @@ def run(): isStatic=True, factory=True, doc="""\ - Creates a :class:`Bitmap` from in-memory data. The data and alpha + Creates a :class:`wx.Bitmap` from in-memory data. The data and alpha parameters must be a Python object that implements the buffer interface, such as a string, bytearray, etc. The data object is expected to contain a series of RGB bytes and be at least @@ -240,7 +240,7 @@ def run(): isStatic=True, factory=True, doc="""\ - Creates a :class:`Bitmap` from in-memory data. The data parameter + Creates a :class:`wx.Bitmap` from in-memory data. The data parameter must be a Python object that implements the buffer interface, such as a string, bytearray, etc. The data object is expected to contain a series of RGB bytes and be at least width*height*3 bytes long. @@ -264,8 +264,8 @@ def run(): """) module.addPyFunction('BitmapFromBuffer', '(width, height, dataBuffer, alphaBuffer=None)', - deprecated="Use :meth:`Bitmap.FromBuffer` or :meth:`Bitmap.FromBufferAndAlpha` instead.", - doc='A compatibility wrapper for :meth:`Bitmap.FromBuffer` and :meth:`Bitmap.FromBufferAndAlpha`', + deprecated="Use :meth:`wx.Bitmap.FromBuffer` or :meth:`wx.Bitmap.FromBufferAndAlpha` instead.", + doc='A compatibility wrapper for :meth:`wx.Bitmap.FromBuffer` and :meth:`wx.Bitmap.FromBufferAndAlpha`', body="""\ if alphaBuffer is not None: return Bitmap.FromBufferAndAlpha(width, height, dataBuffer, alphaBuffer) @@ -280,7 +280,7 @@ def run(): isStatic=True, factory=True, doc="""\ - Creates a :class:`Bitmap` from in-memory data. The data parameter + Creates a :class:`wx.Bitmap` from in-memory data. The data parameter must be a Python object that implements the buffer interface, such as a string, bytearray, etc. The data object is expected to contain a series of RGBA bytes and be at least width*height*4 bytes long. @@ -306,8 +306,8 @@ def run(): """) module.addPyFunction('BitmapFromBufferRGBA', '(width, height, dataBuffer)', - deprecated="Use :meth:`Bitmap.FromBufferRGBA` instead.", - doc='A compatibility wrapper for :meth:`Bitmap.FromBufferRGBA`', + deprecated="Use :meth:`wx.Bitmap.FromBufferRGBA` instead.", + doc='A compatibility wrapper for :meth:`wx.Bitmap.FromBufferRGBA`', body='return Bitmap.FromBufferRGBA(width, height, dataBuffer)') @@ -318,7 +318,7 @@ def run(): isStatic=True, factory=True, doc="""\ - Creates a new empty 32-bit :class:`Bitmap` where every pixel has been + Creates a new empty 32-bit :class:`wx.Bitmap` where every pixel has been initialized with the given RGBA values. """, body="""\ @@ -351,20 +351,20 @@ def run(): """) module.addPyFunction('EmptyBitmapRGBA', '(width, height, red=0, green=0, blue=0, alpha=0)', - deprecated="Use :meth:`Bitmap.FromRGBA` instead.", - doc='A compatibility wrapper for :meth:`Bitmap.FromRGBA`', + deprecated="Use :meth:`wx.Bitmap.FromRGBA` instead.", + doc='A compatibility wrapper for :meth:`wx.Bitmap.FromRGBA`', body='return Bitmap.FromRGBA(width, height, red, green, blue, alpha)') #----------------------------------------------------------------------- # For compatibility: module.addPyFunction('EmptyBitmap', '(width, height, depth=BITMAP_SCREEN_DEPTH)', - deprecated="Use :class:`Bitmap` instead", + deprecated="Use :class:`wx.Bitmap` instead", doc='A compatibility wrapper for the wx.Bitmap(width, height, depth) constructor', body='return Bitmap(width, height, depth)') module.addPyFunction('BitmapFromImage', '(image)', - deprecated="Use :class:`Bitmap` instead", + deprecated="Use :class:`wx.Bitmap` instead", doc='A compatibility wrapper for the wx.Bitmap(wx.Image) constructor', body='return Bitmap(image)') diff --git a/etg/image.py b/etg/image.py index ae00a86d..f3a005cc 100644 --- a/etg/image.py +++ b/etg/image.py @@ -350,7 +350,7 @@ def run(): c.addPyMethod('ConvertToBitmap', '(self, depth=-1)', doc="""\ ConvertToBitmap(depth=-1) -> Bitmap\n - Convert the image to a :class:`Bitmap`.""", + Convert the image to a :class:`wx.Bitmap`.""", body="""\ bmp = wx.Bitmap(self, depth) return bmp @@ -359,7 +359,7 @@ def run(): c.addPyMethod('ConvertToMonoBitmap', '(self, red, green, blue)', doc="""\ ConvertToMonoBitmap(red, green, blue) -> Bitmap\n - Creates a monochrome version of the image and returns it as a :class:`Bitmap`.""", + Creates a monochrome version of the image and returns it as a :class:`wx.Bitmap`.""", body="""\ mono = self.ConvertToMono( red, green, blue ) bmp = wx.Bitmap( mono, 1 ) @@ -490,7 +490,7 @@ def run(): module.addPyFunction('ImageFromBitmap', '(bitmap)', deprecated="Use bitmap.ConvertToImage instead.", - doc='Create a :class:`Image` from a :class:`Bitmap`', + doc='Create a :class:`Image` from a :class:`wx.Bitmap`', body='return bitmap.ConvertToImage()') module.addPyFunction('ImageFromStream', '(stream, type=BITMAP_TYPE_ANY, index=-1)', diff --git a/etg/rawbmp.py b/etg/rawbmp.py index f43ec4df..c2be700b 100644 --- a/etg/rawbmp.py +++ b/etg/rawbmp.py @@ -44,7 +44,7 @@ def run(): addPixelDataClass(module, 'wxNativePixelData', 'wxBitmap', bpp=24, doc="""\ - A class providing direct access to a :class:`Bitmap`'s + A class providing direct access to a :class:`wx.Bitmap`'s internal data without alpha channel (RGB). """) addPixelDataClass(module, 'wxAlphaPixelData', 'wxBitmap', bpp=32, diff --git a/wx/lib/agw/advancedsplash.py b/wx/lib/agw/advancedsplash.py index 5b599db0..795fec47 100644 --- a/wx/lib/agw/advancedsplash.py +++ b/wx/lib/agw/advancedsplash.py @@ -191,7 +191,7 @@ class AdvancedSplash(wx.Frame): the shape defined only by *non-transparent* pixels. If you use other file formats that does not supports transparency, you can obtain the same effect as above by masking a specific colour in - your :class:`Bitmap`. + your :class:`wx.Bitmap`. :param integer `timeout`: if you construct :class:`AdvancedSplash` using the style ``AS_TIMEOUT``, :class:`AdvancedSplash` will be destroyed after `timeout` milliseconds; :param integer `agwStyle`: this value specifies the :class:`AdvancedSplash` styles: @@ -214,14 +214,14 @@ class AdvancedSplash(wx.Frame): :type parent: :class:`Window` :type pos: tuple or :class:`Point` :type size: tuple or :class:`Size` - :type bitmap: :class:`Bitmap` + :type bitmap: :class:`wx.Bitmap` :type shadowcolour: :class:`wx.Colour` :raise: `Exception` in the following cases: - The ``AS_TIMEOUT`` style is set but `timeout` is not a positive integer; - The ``AS_SHADOW_BITMAP`` style is set but `shadowcolour` is not a valid wxPython colour; - - The :class:`AdvancedSplash` bitmap is an invalid :class:`Bitmap`. + - The :class:`AdvancedSplash` bitmap is an invalid :class:`wx.Bitmap`. """ @@ -311,10 +311,10 @@ 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 bmp: :class:`wx.Bitmap` :type shadowcolour: :class:`wx.Colour` - :return: A masked version of the input bitmap, an instance of :class:`Bitmap`. + :return: A masked version of the input bitmap, an instance of :class:`wx.Bitmap`. """ mask = wx.Mask(bmp, shadowcolour) diff --git a/wx/lib/agw/aquabutton.py b/wx/lib/agw/aquabutton.py index 8e11ff36..1bb7d549 100644 --- a/wx/lib/agw/aquabutton.py +++ b/wx/lib/agw/aquabutton.py @@ -234,7 +234,7 @@ class AquaButton(wx.Control): """ Sets the bitmap label for the button. - :param `bitmap`: the bitmap label to set, an instance of :class:`Bitmap`. + :param `bitmap`: the bitmap label to set, an instance of :class:`wx.Bitmap`. """ self._bitmap = bitmap diff --git a/wx/lib/agw/artmanager.py b/wx/lib/agw/artmanager.py index 95708075..847b684f 100644 --- a/wx/lib/agw/artmanager.py +++ b/wx/lib/agw/artmanager.py @@ -694,7 +694,7 @@ class ArtManager(wx.EvtHandler): :param `alpha`: a list of alpha values, the same size as the xpm bitmap. :type `alpha`: list of integers - :return: An instance of :class:`Bitmap`. + :return: An instance of :class:`wx.Bitmap`. """ if alpha is not None: @@ -1609,9 +1609,9 @@ class ArtManager(wx.EvtHandler): :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:`wx.Colour`; - :param `bitmap`: the bitmap associated with the button, an instance of :class:`Bitmap`; + :param `bitmap`: the bitmap associated with the button, an instance of :class:`wx.Bitmap`; :param `grayBitmap`: a greyed-out version of the input `bitmap` representing - a disabled bitmap, an instance of :class:`Bitmap`; + a disabled bitmap, an instance of :class:`wx.Bitmap`; :param integer `style`: the button style. :see: :meth:`~ArtManager.GetBitmapStartLocation` for a list of valid button styles. @@ -1696,7 +1696,7 @@ class ArtManager(wx.EvtHandler): Returns the best fit size for the supplied label & bitmap. :param string `label`: the button label; - :param `bmp`: the bitmap associated with the button, an instance of :class:`Bitmap`. + :param `bmp`: the bitmap associated with the button, an instance of :class:`wx.Bitmap`. :return: An instance of :class:`Size`, representing the best fit size for the supplied label & bitmap. """ @@ -2082,9 +2082,9 @@ class ArtManager(wx.EvtHandler): """ Creates a grey bitmap image from the input bitmap. - :param `bmp`: a valid :class:`Bitmap` object to be greyed out. + :param `bmp`: a valid :class:`wx.Bitmap` object to be greyed out. - :return: A greyed-out representation of the input bitmap, an instance of :class:`Bitmap`. + :return: A greyed-out representation of the input bitmap, an instance of :class:`wx.Bitmap`. """ img = bmp.ConvertToImage() diff --git a/wx/lib/agw/aui/auibook.py b/wx/lib/agw/aui/auibook.py index 4120f69e..e531de15 100644 --- a/wx/lib/agw/aui/auibook.py +++ b/wx/lib/agw/aui/auibook.py @@ -587,7 +587,7 @@ class TabNavigatorProps(object): # Accessors Icon = property(lambda self: self._icon, lambda self, icon: setattr(self, '_icon', icon), - doc='Sets/Gets the icon for the L{TabNavigatorWindow}, an instance of :class:`Bitmap`.') + doc='Sets/Gets the icon for the L{TabNavigatorWindow}, an instance of :class:`wx.Bitmap`.') Font = property(lambda self: self._font, lambda self, font: setattr(self, '_font', font), doc='Sets/Gets the font for the L{TabNavigatorWindow}, an instance of :class:`Font`.') diff --git a/wx/lib/agw/balloontip.py b/wx/lib/agw/balloontip.py index 76d89ed4..52b73339 100644 --- a/wx/lib/agw/balloontip.py +++ b/wx/lib/agw/balloontip.py @@ -501,7 +501,7 @@ class BalloonTip(object): :param `topicon`: an icon that will be displayed on the top-left part of the :class:`BalloonTip` frame. If set to ``None``, no icon will be displayed; - :type `topicon`: :class:`Bitmap` or ``None`` + :type `topicon`: :class:`wx.Bitmap` or ``None`` :param string `toptitle`: a title that will be displayed on the top part of the :class:`BalloonTip` frame. If set to an empty string, no title will be displayed; :param string `message`: the tip message that will be displayed. It can not be set to @@ -848,9 +848,9 @@ class BalloonTip(object): """ Sets the :class:`BalloonTip` top-left icon. - :param `icon`: an instance of :class:`Bitmap`. + :param `icon`: an instance of :class:`wx.Bitmap`. - :raise: `Exception` if the `icon` bitmap is not a valid :class:`Bitmap`. + :raise: `Exception` if the `icon` bitmap is not a valid :class:`wx.Bitmap`. """ if icon.IsOk(): @@ -863,7 +863,7 @@ class BalloonTip(object): """ Returns the :class:`BalloonTip` top-left icon. - :return: An instance of :class:`Bitmap`. + :return: An instance of :class:`wx.Bitmap`. """ return self._topicon diff --git a/wx/lib/agw/buttonpanel.py b/wx/lib/agw/buttonpanel.py index 3b165976..28d4b78a 100644 --- a/wx/lib/agw/buttonpanel.py +++ b/wx/lib/agw/buttonpanel.py @@ -305,9 +305,9 @@ def MakeDisabledBitmap(original): """ Creates a disabled-looking bitmap starting from the input one. - :param `original`: an instance of :class:`Bitmap` to be greyed-out. + :param `original`: an instance of :class:`wx.Bitmap` to be greyed-out. - :return: A greyed-out representation of the input bitmap, an instance of :class:`Bitmap`. + :return: A greyed-out representation of the input bitmap, an instance of :class:`wx.Bitmap`. """ img = original.ConvertToImage() @@ -1496,7 +1496,7 @@ class ButtonInfo(Control): """ Sets the bitmap associated with this instance of :class:`ButtonInfo`. - :param `bmp`: a valid :class:`Bitmap` object; + :param `bmp`: a valid :class:`wx.Bitmap` object; :param string `status`: the :class:`ButtonInfo` status ("Pressed", "Hover", "Normal", "Toggled", "Disabled"). """ @@ -1512,7 +1512,7 @@ class ButtonInfo(Control): :param string `status`: the :class:`ButtonInfo` status ("Pressed", "Hover", "Normal", "Toggled", "Disabled"). - :return: An instance of :class:`Bitmap`. + :return: An instance of :class:`wx.Bitmap`. """ if status is None: diff --git a/wx/lib/agw/customtreectrl.py b/wx/lib/agw/customtreectrl.py index a9a243d5..764435c1 100644 --- a/wx/lib/agw/customtreectrl.py +++ b/wx/lib/agw/customtreectrl.py @@ -546,9 +546,9 @@ def MakeDisabledBitmap(original): """ Creates a disabled-looking bitmap starting from the input one. - :param `original`: an instance of :class:`Bitmap` to be greyed-out. + :param `original`: an instance of :class:`wx.Bitmap` to be greyed-out. - :return: An instance of :class:`Bitmap`, containing a disabled-looking + :return: An instance of :class:`wx.Bitmap`, containing a disabled-looking representation of the original item image. """ @@ -2905,7 +2905,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `x`: the width of the bitmap; :param integer `y`: the height of the bitmap. - :return: An instance of :class:`Bitmap`, representing a native looking checkbox or radiobutton. + :return: An instance of :class:`wx.Bitmap`, representing a native looking checkbox or radiobutton. """ bmp = wx.Bitmap(x, y) @@ -4201,7 +4201,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the :class:`CustomTreeCtrl` background image. - :param `image`: if not ``None``, an instance of :class:`Bitmap`. + :param `image`: if not ``None``, an instance of :class:`wx.Bitmap`. :note: At present, the background image can only be used in "tile" mode. @@ -4216,7 +4216,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the :class:`CustomTreeCtrl` background image (if any). - :return: An instance of :class:`Bitmap` if a background image is present, ``None`` otherwise. + :return: An instance of :class:`wx.Bitmap` if a background image is present, ``None`` otherwise. :note: At present, the background image can only be used in "tile" mode. diff --git a/wx/lib/agw/flatmenu.py b/wx/lib/agw/flatmenu.py index ae6648d4..104bedcc 100644 --- a/wx/lib/agw/flatmenu.py +++ b/wx/lib/agw/flatmenu.py @@ -328,7 +328,7 @@ def ConvertToMonochrome(bmp): """ Converts a bitmap to monochrome colour. - :param `bmp`: a valid :class:`Bitmap` object. + :param `bmp`: a valid :class:`wx.Bitmap` object. """ mem_dc = wx.MemoryDC() @@ -762,7 +762,7 @@ class FMRenderer(object): :param integer `rightMarginX`: the right margin between the text and the menu border; :param bool `selected`: ``True`` if this menu item is currentl hovered by the mouse, ``False`` otherwise. - :param `backgroundImage`: if not ``None``, an instance of :class:`Bitmap` which will + :param `backgroundImage`: if not ``None``, an instance of :class:`wx.Bitmap` which will become the background image for this :class:`FlatMenu`. """ @@ -2311,7 +2311,7 @@ class MenuEntryInfo(object): """ Sets the associated menu bitmap. - :param `bmp`: a valid :class:`Bitmap` object. + :param `bmp`: a valid :class:`wx.Bitmap` object. """ self._textBmp = bmp @@ -2321,7 +2321,7 @@ class MenuEntryInfo(object): """ Sets the associated selected menu bitmap. - :param `bmp`: a valid :class:`Bitmap` object. + :param `bmp`: a valid :class:`wx.Bitmap` object. """ self._textSelectedBmp = bmp @@ -3689,7 +3689,7 @@ class FlatMenuBar(wx.Panel): toggled) or ``wx.ITEM_RADIO`` for a checkable tool which makes part of a radio group of tools each of which is automatically unchecked whenever another button in the group is checked; - :param `bitmap1`: the primary tool bitmap, an instance of :class:`Bitmap`; + :param `bitmap1`: the primary tool bitmap, an instance of :class:`wx.Bitmap`; :param `bitmap2`: the bitmap used when the tool is disabled. If it is equal to :class:`NullBitmap`, the disabled bitmap is automatically generated by greing out the normal one; @@ -3936,8 +3936,8 @@ class ShadowPopupWindow(wx.PopupWindow): class FlatMenuButton(object): """ - A nice small class that functions like :class:`BitmapButton`, the reason I did - not used :class:`BitmapButton` is that on Linux, it has some extra margins that + A nice small class that functions like :class:`wx.BitmapButton`, the reason I did + not used :class:`wx.BitmapButton` is that on Linux, it has some extra margins that I can't seem to be able to remove. """ @@ -3947,8 +3947,8 @@ class FlatMenuButton(object): :param `menu`: the parent menu associated with this button, an instance of :class:`FlatMenu`; :param bool `up`: ``True`` for up arrow or ``False`` for down arrow; - :param `normalBmp`: normal state bitmap, an instance of :class:`Bitmap`; - :param `disabledBmp`: disabled state bitmap, an instance of :class:`Bitmap`. + :param `normalBmp`: normal state bitmap, an instance of :class:`wx.Bitmap`; + :param `disabledBmp`: disabled state bitmap, an instance of :class:`wx.Bitmap`. """ self._normalBmp = normalBmp @@ -4545,7 +4545,7 @@ class FlatToolbarItem(object): Default class constructor. :param `controlType`: can be ``None`` for a toolbar separator, an instance - of :class:`Window` for a control or an instance of :class:`Bitmap` for a standard + of :class:`Window` for a control or an instance of :class:`wx.Bitmap` for a standard toolbar tool; :param integer `id`: the toolbar tool id. If set to ``wx.ID_ANY``, a new id is automatically assigned; @@ -4632,7 +4632,7 @@ class FlatToolbarItem(object): """ Sets the tool bitmap. - :param `bmp`: the new tool bitmap, a valid :class:`Bitmap` object. + :param `bmp`: the new tool bitmap, a valid :class:`wx.Bitmap` object. """ self._normalBmp = bmp @@ -4648,7 +4648,7 @@ class FlatToolbarItem(object): """ Sets the tool disabled bitmap. - :param `bmp`: the new tool disabled bitmap, a valid :class:`Bitmap` object. + :param `bmp`: the new tool disabled bitmap, a valid :class:`wx.Bitmap` object. """ self._disabledImg = bmp @@ -4825,11 +4825,11 @@ class FlatMenuItem(object): or ``wx.ITEM_RADIO``; :param `subMenu`: if not ``None``, the sub menu this item belongs to (an instance of :class:`FlatMenu`); :param `normalBmp`: normal bitmap to draw to the side of the text, this bitmap - is used when the menu is enabled (an instance of :class:`Bitmap`); + is used when the menu is enabled (an instance of :class:`wx.Bitmap`); :param `disabledBmp`: 'greyed' bitmap to draw to the side of the text, this - bitmap is used when the menu is disabled, if none supplied normal is used (an instance of :class:`Bitmap`); + bitmap is used when the menu is disabled, if none supplied normal is used (an instance of :class:`wx.Bitmap`); :param `hotBmp`: hot bitmap to draw to the side of the text, this bitmap is - used when the menu is hovered, if non supplied, normal is used (an instance of :class:`Bitmap`). + used when the menu is hovered, if non supplied, normal is used (an instance of :class:`wx.Bitmap`). """ self._text = label @@ -5033,7 +5033,7 @@ class FlatMenuItem(object): """ Sets the menu item normal bitmap. - :param `bmp`: an instance of :class:`Bitmap`. + :param `bmp`: an instance of :class:`wx.Bitmap`. """ self._normalBmp = bmp @@ -5043,7 +5043,7 @@ class FlatMenuItem(object): """ Sets the menu item disabled bitmap. - :param `bmp`: an instance of :class:`Bitmap`. + :param `bmp`: an instance of :class:`wx.Bitmap`. """ self._disabledBmp = bmp @@ -5053,7 +5053,7 @@ class FlatMenuItem(object): """ Sets the menu item hot bitmap. - :param `bmp`: an instance of :class:`Bitmap`. + :param `bmp`: an instance of :class:`wx.Bitmap`. """ self._hotBmp = bmp @@ -7103,7 +7103,7 @@ class FlatMenu(FlatMenuBase): """ Sets a background bitmap for this particular :class:`FlatMenu`. - :param `bitmap`: an instance of :class:`Bitmap`. Set `bitmap` to ``None`` if you + :param `bitmap`: an instance of :class:`wx.Bitmap`. Set `bitmap` to ``None`` if you wish to remove the background bitmap altogether. :note: the bitmap is rescaled to fit the menu width and height. diff --git a/wx/lib/agw/flatnotebook.py b/wx/lib/agw/flatnotebook.py index d99cf2cc..b526d0fc 100644 --- a/wx/lib/agw/flatnotebook.py +++ b/wx/lib/agw/flatnotebook.py @@ -1480,7 +1480,7 @@ class TabNavigatorWindow(wx.Dialog): Used internally. :param `parent`: the :class:`TabNavigatorWindow` parent window; - :param `icon`: a valid :class:`Bitmap` object representing the icon to be displayed + :param `icon`: a valid :class:`wx.Bitmap` object representing the icon to be displayed in the :class:`TabNavigatorWindow`. """ @@ -4572,7 +4572,7 @@ class FlatNotebook(wx.Panel): """ Set the icon used by the :class:`TabNavigatorWindow`. - :param `bmp`: a valid :class:`Bitmap` object. + :param `bmp`: a valid :class:`wx.Bitmap` object. """ if isinstance(bmp, wx.Bitmap) and bmp.IsOk(): diff --git a/wx/lib/agw/genericmessagedialog.py b/wx/lib/agw/genericmessagedialog.py index 2b55908a..d24fd1da 100644 --- a/wx/lib/agw/genericmessagedialog.py +++ b/wx/lib/agw/genericmessagedialog.py @@ -1308,7 +1308,7 @@ class GenericMessageDialog(wx.Dialog): def GetCustomOKBitmap(self): """ If a custom icon has been used for the ``OK`` button, this method will return - it as an instance of :class:`Bitmap`. Otherwise, the default one (as defined in + it as an instance of :class:`wx.Bitmap`. Otherwise, the default one (as defined in :meth:`~GenericMessageDialog.GetDefaultOKBitmap`) is returned. .. versionadded:: 0.9.3 @@ -1320,7 +1320,7 @@ class GenericMessageDialog(wx.Dialog): def GetCustomYesBitmap(self): """ If a custom icon has been used for the ``Yes`` button, this method will return - it as an instance of :class:`Bitmap`. Otherwise, the default one (as defined in + it as an instance of :class:`wx.Bitmap`. Otherwise, the default one (as defined in :meth:`~GenericMessageDialog.GetDefaultYesBitmap`) is returned. .. versionadded:: 0.9.3 @@ -1332,7 +1332,7 @@ class GenericMessageDialog(wx.Dialog): def GetCustomNoBitmap(self): """ If a custom icon has been used for the ``No`` button, this method will return - it as an instance of :class:`Bitmap`. Otherwise, the default one (as defined in + it as an instance of :class:`wx.Bitmap`. Otherwise, the default one (as defined in :meth:`~GenericMessageDialog.GetDefaultNoBitmap`) is returned. .. versionadded:: 0.9.3 @@ -1344,7 +1344,7 @@ class GenericMessageDialog(wx.Dialog): def GetCustomCancelBitmap(self): """ If a custom icon been used for the ``Cancel`` button, this method will return - it as an instance of :class:`Bitmap`. Otherwise, the default one (as defined in + it as an instance of :class:`wx.Bitmap`. Otherwise, the default one (as defined in :meth:`~GenericMessageDialog.GetDefaultCancelBitmap`) is returned. .. versionadded:: 0.9.3 @@ -1356,7 +1356,7 @@ class GenericMessageDialog(wx.Dialog): def GetCustomHelpBitmap(self): """ If a custom icon has been used for the ``Help`` button, this method will return - it as an instance of :class:`Bitmap`. Otherwise, the default one (as defined in + it as an instance of :class:`wx.Bitmap`. Otherwise, the default one (as defined in :meth:`~GenericMessageDialog.GetDefaultHelpBitmap`) is returned. .. versionadded:: 0.9.3 @@ -1370,8 +1370,8 @@ class GenericMessageDialog(wx.Dialog): """ Overrides the default icons of the ``Yes`` and ``No`` buttons. - :param `yesBitmap`: the new icon for the ``Yes`` button, an instance of :class:`Bitmap`; - :param `noBitmap`: the new icon for the ``No`` button, an instance of :class:`Bitmap`. + :param `yesBitmap`: the new icon for the ``Yes`` button, an instance of :class:`wx.Bitmap`; + :param `noBitmap`: the new icon for the ``No`` button, an instance of :class:`wx.Bitmap`. .. versionadded:: 0.9.3 """ @@ -1384,9 +1384,9 @@ class GenericMessageDialog(wx.Dialog): """ Overrides the default icons of the ``Yes`` and ``No`` buttons. - :param `yesBitmap`: the new icon for the ``Yes`` button, an instance of :class:`Bitmap`; - :param `noBitmap`: the new icon for the ``No`` button, an instance of :class:`Bitmap`; - :param `cancelBitmap`: the new icon for the ``Cancel`` button, an instance of :class:`Bitmap`. + :param `yesBitmap`: the new icon for the ``Yes`` button, an instance of :class:`wx.Bitmap`; + :param `noBitmap`: the new icon for the ``No`` button, an instance of :class:`wx.Bitmap`; + :param `cancelBitmap`: the new icon for the ``Cancel`` button, an instance of :class:`wx.Bitmap`. .. versionadded:: 0.9.3 """ @@ -1399,7 +1399,7 @@ class GenericMessageDialog(wx.Dialog): """ Overrides the default icon of the ``OK`` button. - :param `yesBitmap`: the new icon for the ``OK`` button, an instance of :class:`Bitmap`; + :param `yesBitmap`: the new icon for the ``OK`` button, an instance of :class:`wx.Bitmap`; .. versionadded:: 0.9.3 """ @@ -1412,8 +1412,8 @@ class GenericMessageDialog(wx.Dialog): """ Overrides the default icons of the ``OK`` and ``Cancel`` buttons. - :param `okBitmap`: the new icon for the ``OK`` button, an instance of :class:`Bitmap`; - :param `cancelBitmap`: the new icon for the ``Cancel`` button, an instance of :class:`Bitmap`. + :param `okBitmap`: the new icon for the ``OK`` button, an instance of :class:`wx.Bitmap`; + :param `cancelBitmap`: the new icon for the ``Cancel`` button, an instance of :class:`wx.Bitmap`. .. versionadded:: 0.9.3 """ @@ -1426,7 +1426,7 @@ class GenericMessageDialog(wx.Dialog): """ Overrides the default icon of the ``Help`` button. - :param `helpBitmap`: the new icon for the ``Help`` button, an instance of :class:`Bitmap`. + :param `helpBitmap`: the new icon for the ``Help`` button, an instance of :class:`wx.Bitmap`. .. versionadded:: 0.9.3 """ diff --git a/wx/lib/agw/gradientbutton.py b/wx/lib/agw/gradientbutton.py index 38aae16c..d2ca29d6 100644 --- a/wx/lib/agw/gradientbutton.py +++ b/wx/lib/agw/gradientbutton.py @@ -209,7 +209,7 @@ class GradientButton(wx.Control): """ Sets the bitmap label for the button. - :param `bitmap`: the bitmap label to set, an instance of :class:`Bitmap`. + :param `bitmap`: the bitmap label to set, an instance of :class:`wx.Bitmap`. """ self._bitmap = bitmap diff --git a/wx/lib/agw/infobar.py b/wx/lib/agw/infobar.py index 18fbe818..00ff314a 100644 --- a/wx/lib/agw/infobar.py +++ b/wx/lib/agw/infobar.py @@ -689,7 +689,7 @@ class InfoBar(wx.Control): this button will generate; :param string `label`: the label of the button. It may only be empty if `btnid` is one of the stock ids in which case the corresponding stock label will be used; - :param `bitmap`: if not equal to :class:`NullBitmap`, a valid :class:`Bitmap` image to show beside + :param `bitmap`: if not equal to :class:`NullBitmap`, a valid :class:`wx.Bitmap` image to show beside the button text. :note: diff --git a/wx/lib/agw/labelbook.py b/wx/lib/agw/labelbook.py index 409e4f00..911d5051 100644 --- a/wx/lib/agw/labelbook.py +++ b/wx/lib/agw/labelbook.py @@ -1550,7 +1550,7 @@ class LabelContainer(ImageContainerBase): """ Sets the background bitmap for the control. - :param `bmp`: a valid :class:`Bitmap` object. + :param `bmp`: a valid :class:`wx.Bitmap` object. """ self._skin = bmp diff --git a/wx/lib/agw/piectrl.py b/wx/lib/agw/piectrl.py index c09fb98e..4cbb3b31 100644 --- a/wx/lib/agw/piectrl.py +++ b/wx/lib/agw/piectrl.py @@ -496,7 +496,7 @@ class PieCtrl(wx.Window): """ Sets the :class:`PieCtrl` background image. - :param `bmp`: a valid :class:`Bitmap` object. + :param `bmp`: a valid :class:`wx.Bitmap` object. """ self._background = bmp diff --git a/wx/lib/agw/pybusyinfo.py b/wx/lib/agw/pybusyinfo.py index 1fdd7c95..b4a0a40c 100644 --- a/wx/lib/agw/pybusyinfo.py +++ b/wx/lib/agw/pybusyinfo.py @@ -147,7 +147,7 @@ class PyInfoFrame(wx.Frame): :param `parent`: the frame parent; :param `message`: the message to display in the :class:`PyBusyInfo`; :param `title`: the main :class:`PyBusyInfo` title; - :param `icon`: an icon to draw as the frame icon, an instance of :class:`Bitmap`. + :param `icon`: an icon to draw as the frame icon, an instance of :class:`wx.Bitmap`. """ wx.Frame.__init__(self, parent, wx.ID_ANY, title, wx.DefaultPosition, @@ -288,7 +288,7 @@ class PyBusyInfo(object): :param `parent`: the :class:`PyBusyInfo` parent; :param `message`: the message to display in the :class:`PyBusyInfo`; :param `title`: the main :class:`PyBusyInfo` title; - :param `icon`: an icon to draw as the frame icon, an instance of :class:`Bitmap`. + :param `icon`: an icon to draw as the frame icon, an instance of :class:`wx.Bitmap`. :note: If `parent` is not ``None`` you must ensure that it is not closed while the busy info is shown. diff --git a/wx/lib/agw/ribbon/buttonbar.py b/wx/lib/agw/ribbon/buttonbar.py index cde9b8bf..73d7f698 100644 --- a/wx/lib/agw/ribbon/buttonbar.py +++ b/wx/lib/agw/ribbon/buttonbar.py @@ -267,14 +267,14 @@ class RibbonButtonBar(RibbonControl): :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; - :param `bitmap_small`: small bitmap of the new button, an instance of :class:`Bitmap`. If left as :class:`NullBitmap`, + :param `bitmap_small`: small bitmap of the new button, an instance of :class:`wx.Bitmap`. If left as :class:`NullBitmap`, then a small bitmap will be automatically generated. Must be the same size as all other small bitmaps used on the button bar; - :param `bitmap_disabled`: large bitmap of the new button when it is disabled, an instance of :class:`Bitmap`. + :param `bitmap_disabled`: large bitmap of the new button when it is disabled, an instance of :class:`wx.Bitmap`. If left as :class:`NullBitmap`, then a bitmap will be automatically generated from `bitmap`; - :param `bitmap_small_disabled`: small bitmap of the new button when it is disabled, an instance of :class:`Bitmap`. + :param `bitmap_small_disabled`: small bitmap of the new button when it is disabled, an instance of :class:`wx.Bitmap`. If left as :class:`NullBitmap`, then a bitmap will be automatically generated from `bitmap_small`; :param integer `kind`: the kind of button to add, one of the following values: @@ -306,7 +306,7 @@ class RibbonButtonBar(RibbonControl): :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button; :param integer `kind`: the kind of button to add. @@ -329,14 +329,14 @@ class RibbonButtonBar(RibbonControl): :param integer `pos`: the position at which the new button must be inserted (zero-based); :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; - :param `bitmap_small`: small bitmap of the new button, an instance of :class:`Bitmap`. If left as :class:`NullBitmap`, + :param `bitmap_small`: small bitmap of the new button, an instance of :class:`wx.Bitmap`. If left as :class:`NullBitmap`, then a small bitmap will be automatically generated. Must be the same size as all other small bitmaps used on the button bar; - :param `bitmap_disabled`: large bitmap of the new button when it is disabled, an instance of :class:`Bitmap`. + :param `bitmap_disabled`: large bitmap of the new button when it is disabled, an instance of :class:`wx.Bitmap`. If left as :class:`NullBitmap`, then a bitmap will be automatically generated from `bitmap`; - :param `bitmap_small_disabled`: small bitmap of the new button when it is disabled, an instance of :class:`Bitmap`. + :param `bitmap_small_disabled`: small bitmap of the new button when it is disabled, an instance of :class:`wx.Bitmap`. If left as :class:`NullBitmap`, then a bitmap will be automatically generated from `bitmap_small`; :param integer `kind`: the kind of button to add; :param string `help_string`: the UI help string to associate with the new button; @@ -424,7 +424,7 @@ class RibbonButtonBar(RibbonControl): :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button. @@ -443,7 +443,7 @@ class RibbonButtonBar(RibbonControl): :param integer `pos`: the position at which the new button must be inserted (zero-based); :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button. @@ -463,7 +463,7 @@ class RibbonButtonBar(RibbonControl): :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button. @@ -482,7 +482,7 @@ class RibbonButtonBar(RibbonControl): :param integer `pos`: the position at which the new button must be inserted (zero-based); :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button. @@ -502,7 +502,7 @@ class RibbonButtonBar(RibbonControl): :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button. @@ -521,7 +521,7 @@ class RibbonButtonBar(RibbonControl): :param integer `pos`: the position at which the new button must be inserted (zero-based); :param integer `button_id`: id of the new button (used for event callbacks); :param string `label`: label of the new button; - :param `bitmap`: large bitmap of the new button, an instance of :class:`Bitmap`. Must be the same size as + :param `bitmap`: large bitmap of the new button, an instance of :class:`wx.Bitmap`. Must be the same size as all other large bitmaps used on the button bar; :param string `help_string`: the UI help string to associate with the new button. @@ -553,7 +553,7 @@ class RibbonButtonBar(RibbonControl): """ Resize and scale the `original` bitmap to the dimensions specified in `size`. - :param `original`: the original bitmap, an instance of :class:`Bitmap`; + :param `original`: the original bitmap, an instance of :class:`wx.Bitmap`; :param `size`: the size to which the input bitmap must be rescaled, an instance of :class:`Size`. :return: A scaled representation of the input bitmap. @@ -568,7 +568,7 @@ class RibbonButtonBar(RibbonControl): """ Converts the `original` bitmap into a visually-looking disabled one. - :param `original`: the original bitmap, an instance of :class:`Bitmap`. + :param `original`: the original bitmap, an instance of :class:`wx.Bitmap`. :return: A visually-looking disabled representation of the input bitmap. """ diff --git a/wx/lib/agw/ribbon/toolbar.py b/wx/lib/agw/ribbon/toolbar.py index 7803b4b6..c4bd26d6 100644 --- a/wx/lib/agw/ribbon/toolbar.py +++ b/wx/lib/agw/ribbon/toolbar.py @@ -773,7 +773,7 @@ class RibbonToolBar(RibbonControl): Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state. :param `tool_id`: id of the tool in question, as passed to :meth:`~RibbonToolBar.AddTool`; - :param `bitmap`: an instance of :class:`Bitmap`. + :param `bitmap`: an instance of :class:`wx.Bitmap`. .. versionadded:: 0.9.5 """ @@ -807,7 +807,7 @@ class RibbonToolBar(RibbonControl): Sets the bitmap to be used by the tool with the given ID when the tool is enabled. :param `tool_id`: id of the tool in question, as passed to :meth:`~RibbonToolBar.AddTool`; - :param `bitmap`: an instance of :class:`Bitmap`. + :param `bitmap`: an instance of :class:`wx.Bitmap`. .. versionadded:: 0.9.5 """ diff --git a/wx/lib/agw/rulerctrl.py b/wx/lib/agw/rulerctrl.py index deeeb68f..69964023 100644 --- a/wx/lib/agw/rulerctrl.py +++ b/wx/lib/agw/rulerctrl.py @@ -217,7 +217,7 @@ b'x\xda\x01x\x01\x87\xfe\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\n\x00\ def GetIndicatorBitmap(): - """ Returns the image indicator as a :class:`Bitmap`. """ + """ Returns the image indicator as a :class:`wx.Bitmap`. """ return wx.Bitmap(GetIndicatorImage()) diff --git a/wx/lib/agw/shapedbutton.py b/wx/lib/agw/shapedbutton.py index 6867476a..bba9344f 100644 --- a/wx/lib/agw/shapedbutton.py +++ b/wx/lib/agw/shapedbutton.py @@ -991,7 +991,7 @@ class SButton(wx.Window): class SBitmapButton(SButton): """ Subclass of :class:`SButton` which displays a bitmap, acting like a - :class:`BitmapButton`. + :class:`wx.BitmapButton`. """ def __init__(self, parent, id, bitmap, pos=wx.DefaultPosition, size=wx.DefaultSize): @@ -1044,7 +1044,7 @@ class SBitmapButton(SButton): """ Sets the bitmap to display when the button is disabled. - :param `bitmap`: a valid :class:`Bitmap` object. + :param `bitmap`: a valid :class:`wx.Bitmap` object. """ self._bmpdisabled = bitmap @@ -1054,7 +1054,7 @@ class SBitmapButton(SButton): """ Sets the bitmap to display when the button has the focus. - :param `bitmap`: a valid :class:`Bitmap` object. + :param `bitmap`: a valid :class:`wx.Bitmap` object. """ self._bmpfocus = bitmap @@ -1065,7 +1065,7 @@ class SBitmapButton(SButton): """ Sets the bitmap to display when the button is selected (pressed). - :param `bitmap`: a valid :class:`Bitmap` object. + :param `bitmap`: a valid :class:`wx.Bitmap` object. """ self._bmpselected = bitmap @@ -1076,7 +1076,7 @@ class SBitmapButton(SButton): Sets the bitmap to display normally. This is the only one that is required. - :param `bitmap`: a valid :class:`Bitmap` object; + :param `bitmap`: a valid :class:`wx.Bitmap` object; :param `createothers`: if set to ``True``, then the other bitmaps will be generated on the fly. Currently, only the disabled bitmap is generated. """ diff --git a/wx/lib/agw/shortcuteditor.py b/wx/lib/agw/shortcuteditor.py index 56268850..1429c3fa 100644 --- a/wx/lib/agw/shortcuteditor.py +++ b/wx/lib/agw/shortcuteditor.py @@ -1174,7 +1174,7 @@ class Shortcut(object): :param string `label`: the shortcut label string; :param string `accelerator`: the shortcut accelerator string; - :param `bitmap`: an instance of :class:`Bitmap`, to display along the shortcut `label` + :param `bitmap`: an instance of :class:`wx.Bitmap`, to display along the shortcut `label` in the interface tree; :param string `help`: the help string for this shortcut, to display in the interface tree; :param `menuItem`: if this :class:`Shortcut` is derived from a :class:`MenuItem`, the :class:`MenuItem` @@ -1262,7 +1262,7 @@ class Shortcut(object): """ Sets the bitmap associated with this :class:`Shortcut`. - :param `bitmap`: an instance of :class:`Bitmap` (can be invalid, i.e., :class:`NullBitmap`). + :param `bitmap`: an instance of :class:`wx.Bitmap` (can be invalid, i.e., :class:`NullBitmap`). """ self.bitmap = bitmap diff --git a/wx/lib/agw/speedmeter.py b/wx/lib/agw/speedmeter.py index 41c23167..0d8a4b27 100644 --- a/wx/lib/agw/speedmeter.py +++ b/wx/lib/agw/speedmeter.py @@ -1541,7 +1541,7 @@ class SpeedMeter(BufferedWindow): """ Sets the icon to be drawn near the center of :class:`SpeedMeter`. - :param `icon`: a valid :class:`Bitmap` object. + :param `icon`: a valid :class:`wx.Bitmap` object. """ if icon.IsOk(): diff --git a/wx/lib/agw/supertooltip.py b/wx/lib/agw/supertooltip.py index 9101061a..6f7b91ca 100644 --- a/wx/lib/agw/supertooltip.py +++ b/wx/lib/agw/supertooltip.py @@ -1033,7 +1033,7 @@ class SuperToolTip(object): """ Sets the header bitmap for :class:`SuperToolTip`. - :param `bmp`: the header bitmap, a valid :class:`Bitmap` object. + :param `bmp`: the header bitmap, a valid :class:`wx.Bitmap` object. """ self._headerBmp = bmp @@ -1088,7 +1088,7 @@ class SuperToolTip(object): """ Sets the main body bitmap for :class:`SuperToolTip`. - :param `bmp`: the body bitmap, a valid :class:`Bitmap` object. + :param `bmp`: the body bitmap, a valid :class:`wx.Bitmap` object. """ self._embeddedImage = bmp @@ -1125,7 +1125,7 @@ class SuperToolTip(object): """ Sets the footer bitmap for :class:`SuperToolTip`. - :param `bmp`: the footer bitmap, a valid :class:`Bitmap` object. + :param `bmp`: the footer bitmap, a valid :class:`wx.Bitmap` object. """ self._footerBmp = bmp diff --git a/wx/lib/agw/thumbnailctrl.py b/wx/lib/agw/thumbnailctrl.py index 81e2a0c2..ca40a763 100644 --- a/wx/lib/agw/thumbnailctrl.py +++ b/wx/lib/agw/thumbnailctrl.py @@ -193,7 +193,7 @@ o\xda\x84pB2\x1f\x81Fa\x8c\x9c\x08\x04Z{\xcf\xa72\xbcv\xfa\xc5\x08 \x80r\x80\ def GetMondrianBitmap(): - """ Returns a default image placeholder as a :class:`Bitmap`. """ + """ Returns a default image placeholder as a :class:`wx.Bitmap`. """ return wx.Bitmap(GetMondrianImage()) @@ -649,7 +649,7 @@ class Thumb(object): """ Sets the thumbnail bitmap. - :param `bmp`: a :class:`Bitmap` object. + :param `bmp`: a :class:`wx.Bitmap` object. """ self._bitmap = bmp diff --git a/wx/lib/agw/toasterbox.py b/wx/lib/agw/toasterbox.py index e252aad6..ff7059ec 100644 --- a/wx/lib/agw/toasterbox.py +++ b/wx/lib/agw/toasterbox.py @@ -453,7 +453,7 @@ class ToasterBox(wx.Timer): """ Sets the :class:`ToasterBox` background image. - :param `bitmap`: a valid :class:`Bitmap` object or filename. If defaulted + :param `bitmap`: a valid :class:`wx.Bitmap` object or filename. If defaulted to ``None``, then no background bitmap is used. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_SIMPLE`` style. @@ -816,7 +816,7 @@ class ToasterBoxWindow(wx.Frame): """ Sets the :class:`ToasterBox` background image. - :param `bitmap`: a valid :class:`Bitmap` object. If defaulted to ``None``, then + :param `bitmap`: a valid :class:`wx.Bitmap` object. If defaulted to ``None``, then no background bitmap is used. :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 d738fa16..f8d5bc5c 100644 --- a/wx/lib/agw/ultimatelistctrl.py +++ b/wx/lib/agw/ultimatelistctrl.py @@ -615,7 +615,7 @@ def MakeDisabledBitmap(original): """ Creates a disabled-looking bitmap starting from the input one. - :param `original`: an instance of :class:`Bitmap` to be greyed-out. + :param `original`: an instance of :class:`wx.Bitmap` to be greyed-out. """ img = original.ConvertToImage() @@ -647,7 +647,7 @@ D\x90\x1d\xef19_\xf5\xde5y\xb6+\xa7\xdeZ\xfbA\x9bu\x9f`\xffD\xafYn\xf6\x9eW\ def GetdragcursorBitmap(): - """ Returns the drag and drop cursor image as a :class:`Bitmap`. """ + """ Returns the drag and drop cursor image as a :class:`wx.Bitmap`. """ return wx.Bitmap(GetdragcursorImage()) @@ -719,7 +719,7 @@ class PyImageList(object): """ Adds a new image or images using a bitmap. - :param `bitmap`: a valid :class:`Bitmap` object. + :param `bitmap`: a valid :class:`wx.Bitmap` object. :return: The new zero-based image index. @@ -778,7 +778,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 `bitmap`: a valid :class:`wx.Bitmap` object; :param `colour`: an instance of :class:`wx.Colour`, a colour indicating which parts of the image are transparent. @@ -831,7 +831,7 @@ class PyImageList(object): :param `index`: the index at which the image should be replaced; :param `bitmap`: the new bitmap to add to the image list, an instance of - :class:`Bitmap`. + :class:`wx.Bitmap`. """ if index >= len(self._images): @@ -10697,7 +10697,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the :class:`UltimateListCtrl` background image. - :param `image`: if not ``None``, an instance of :class:`Bitmap`. + :param `image`: if not ``None``, an instance of :class:`wx.Bitmap`. :note: At present, the background image can only be used in "tile" mode. @@ -10725,7 +10725,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): Sets the :class:`UltimateListCtrl` watermark image to be displayed in the bottom right part of the window. - :param `watermark`: if not ``None``, an instance of :class:`Bitmap`. + :param `watermark`: if not ``None``, an instance of :class:`wx.Bitmap`. .. todo:: Better support for this is needed. """ @@ -13211,7 +13211,7 @@ class UltimateListCtrl(wx.Control): """ Sets the :class:`UltimateListCtrl` background image. - :param `image`: if not ``None``, an instance of :class:`Bitmap`. + :param `image`: if not ``None``, an instance of :class:`wx.Bitmap`. :note: At present, the background image can only be used in "tile" mode. @@ -13238,7 +13238,7 @@ class UltimateListCtrl(wx.Control): Sets the :class:`UltimateListCtrl` watermark image to be displayed in the bottom right part of the window. - :param `watermark`: if not ``None``, an instance of :class:`Bitmap`. + :param `watermark`: if not ``None``, an instance of :class:`wx.Bitmap`. .. todo:: Better support for this is needed. """ diff --git a/wx/lib/agw/zoombar.py b/wx/lib/agw/zoombar.py index 13134cd4..e027187f 100644 --- a/wx/lib/agw/zoombar.py +++ b/wx/lib/agw/zoombar.py @@ -330,7 +330,7 @@ def MakeDisabledBitmap(original): """ Creates a disabled-looking bitmap starting from the input one. - :param `original`: an instance of :class:`Bitmap` to be greyed-out. + :param `original`: an instance of :class:`wx.Bitmap` to be greyed-out. """ img = original.ConvertToImage() @@ -349,7 +349,7 @@ class ZoomBarImage(object): Default class constructor. :param `parent`: the main :class:`ZoomBar` window; - :param `bitmap`: the button bitmap, an instance of :class:`Bitmap`; + :param `bitmap`: the button bitmap, an instance of :class:`wx.Bitmap`; :param `disabledBmp`: the button bitmap when the button is in a disabled state; :param `label`: the button label. @@ -851,14 +851,14 @@ class ZoomBar(wx.Control): """ Adds a button to :class:`ZoomBar`. - :param `normalBmp`: the button main bitmap, an instance of :class:`Bitmap`; + :param `normalBmp`: the button main bitmap, an instance of :class:`wx.Bitmap`; :param `reflectionBmp`: a bitmap representing a reflection of the main bitmap, - an instance of :class:`Bitmap`; + an instance of :class:`wx.Bitmap`; :param `label`: the button label; :param `disabledBmp`: the button main bitmap when the button is in a disabled - state, an instance of :class:`Bitmap`; + state, an instance of :class:`wx.Bitmap`; :param `disabledReflectionBmp`: a bitmap representing a reflection of the main bitmap, - when the button is in a disabled state, an instance of :class:`Bitmap`. + when the button is in a disabled state, an instance of :class:`wx.Bitmap`. """ button = ZoomBarImage(self, normalBmp, disabledBmp, label) @@ -884,9 +884,9 @@ class ZoomBar(wx.Control): """ Adds a separator to :class:`ZoomBar`. - :param `normalBmp`: the separator main bitmap, an instance of :class:`Bitmap`; + :param `normalBmp`: the separator main bitmap, an instance of :class:`wx.Bitmap`; :param `reflectionBmp`: a bitmap representing a reflection of the main bitmap, - an instance of :class:`Bitmap`. + an instance of :class:`wx.Bitmap`. """ button = self.AddButton(normalBmp, reflectionBmp) diff --git a/wx/lib/floatcanvas/FloatCanvas.py b/wx/lib/floatcanvas/FloatCanvas.py index 4b225f0d..2edf7fcc 100644 --- a/wx/lib/floatcanvas/FloatCanvas.py +++ b/wx/lib/floatcanvas/FloatCanvas.py @@ -989,8 +989,8 @@ class FloatCanvas(wx.Panel): Saves the current image as an image file. :param string `filename`: the name of the image file - :param `ImageType`: format to use, see :ref:`BitmapType` and the note in - :meth:`Bitmap.SaveFile` + :param `ImageType`: format to use, see :ref:`wx.BitmapType` and the note in + :meth:`wx.Bitmap.SaveFile` """ diff --git a/wx/lib/imagebrowser.py b/wx/lib/imagebrowser.py index e0fb1d6d..5e97cb4d 100644 --- a/wx/lib/imagebrowser.py +++ b/wx/lib/imagebrowser.py @@ -128,7 +128,7 @@ def GetCheckeredBitmap(blocksize=8, ntiles=4, rgb0='\xFF', rgb1='\xCC'): :param `rbg0`: the first color, as 3-byte strings. :param `rgb1`: the second color, as 3-byte strings. If only 1 byte is provided, it is treated as a grey value. - :return: :class:`BitmapFromBuffer` + :return: :class:`wx.BitmapFromBuffer` """ size = blocksize*ntiles*2 diff --git a/wx/lib/ogl/bmpshape.py b/wx/lib/ogl/bmpshape.py index 49f7fe69..d6c901f7 100644 --- a/wx/lib/ogl/bmpshape.py +++ b/wx/lib/ogl/bmpshape.py @@ -17,7 +17,7 @@ from .basic import RectangleShape class BitmapShape(RectangleShape): - """The :class:`BitmapShape` class draws a bitmap (non-resizable).""" + """The :class:`wx.BitmapShape` class draws a bitmap (non-resizable).""" def __init__(self): """ Default class constructor. diff --git a/wx/lib/platebtn.py b/wx/lib/platebtn.py index f590872b..5db21adb 100644 --- a/wx/lib/platebtn.py +++ b/wx/lib/platebtn.py @@ -464,7 +464,7 @@ class PlateButton(wx.Control): def GetBitmapDisabled(self): """Get the bitmap of the disable state - :return: :class:`Bitmap` or None + :return: :class:`wx.Bitmap` or None """ return self.BitmapDisabled @@ -472,7 +472,7 @@ class PlateButton(wx.Control): def GetBitmapLabel(self): """Get the label bitmap - :return: :class:`Bitmap` or None + :return: :class:`wx.Bitmap` or None """ return self.BitmapLabel @@ -613,7 +613,7 @@ class PlateButton(wx.Control): def SetBitmap(self, bmp): """Set the bitmap displayed in the button - :param `bmp`: :class:`Bitmap` + :param `bmp`: :class:`wx.Bitmap` """ self._bmp['enable'] = bmp @@ -625,7 +625,7 @@ class PlateButton(wx.Control): def SetBitmapDisabled(self, bmp): """Set the bitmap for the disabled state - :param `bmp`: :class:`Bitmap` + :param `bmp`: :class:`wx.Bitmap` """ self._bmp['disable'] = bmp diff --git a/wx/lib/throbber.py b/wx/lib/throbber.py index c92da5f8..8d2bbdbb 100644 --- a/wx/lib/throbber.py +++ b/wx/lib/throbber.py @@ -70,7 +70,7 @@ class Throbber(wx.Panel): :param `parent`: parent window, must not be ``None`` :param integer `id`: window identifier. A value of -1 indicates a default value - :param `bitmap`: a :class:`Bitmap` to be used + :param `bitmap`: a :class:`wx.Bitmap` to be used :param `pos`: the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform :param `size`: the control size. A value of (-1, -1) indicates a default size, @@ -79,7 +79,7 @@ class Throbber(wx.Panel): :param `frames`: number of frames (only necessary for composite image) :param `frameWidth`: width of each frame (only necessary for composite image) :param string `label`: optional text to be displayed - :param `overlay`: optional :class:`Bitmap` to overlay on animation + :param `overlay`: optional :class:`wx.Bitmap` to overlay on animation :param boolean `reverse`: reverse direction at end of animation :param integer `style`: the underlying :class:`Control` style :param string `name`: the widget name.