diff --git a/wx/lib/agw/__init__.py b/wx/lib/agw/__init__.py index c05d9d17..3e4060c0 100644 --- a/wx/lib/agw/__init__.py +++ b/wx/lib/agw/__init__.py @@ -27,7 +27,7 @@ an asterisk were already present in :mod:`lib` before: - CustomTreeCtrl (*): mimics the behaviour of :class:`TreeCtrl`, with almost the same base functionalities plus a bunch of enhancements and goodies; - FlatMenu: as the name implies, it is a generic menu implementation, - offering the same :class:`MenuBar` / :class:`Menu` / :class:`ToolBar` capabilities and much more; + offering the same :class:`wx.MenuBar` / :class:`wx.Menu` / :class:`ToolBar` capabilities and much more; - FlatNotebook (*): a full implementation of the :class:`Notebook`, and designed to be a drop-in replacement for :class:`Notebook` with enhanced capabilities; - FloatSpin: this class implements a floating point spinctrl, cabable (in diff --git a/wx/lib/agw/advancedsplash.py b/wx/lib/agw/advancedsplash.py index 795fec47..65a2cac7 100644 --- a/wx/lib/agw/advancedsplash.py +++ b/wx/lib/agw/advancedsplash.py @@ -183,7 +183,7 @@ class AdvancedSplash(wx.Frame): chosen by either the windowing system or wxPython, depending on platform; :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :param integer `style`: the underlying :class:`Frame` style; + :param integer `style`: the underlying :class:`wx.Frame` style; :param `bitmap`: this must be a valid bitmap, that you may construct using whatever image file format supported by wxPython. If the file you load already supports mask/transparency (like png), the transparent areas @@ -211,9 +211,9 @@ class AdvancedSplash(wx.Frame): ``AS_SHADOW_BITMAP``, here you can specify the colour that will be masked on your input bitmap. This has to be a valid wxPython colour. - :type parent: :class:`Window` - :type pos: tuple or :class:`Point` - :type size: tuple or :class:`Size` + :type parent: :class:`wx.Window` + :type pos: tuple or :class:`wx.Point` + :type size: tuple or :class:`wx.Size` :type bitmap: :class:`wx.Bitmap` :type shadowcolour: :class:`wx.Colour` @@ -295,7 +295,7 @@ class AdvancedSplash(wx.Frame): """ Sets :class:`AdvancedSplash` shape using the region created from the bitmap. - :param `event`: a :class:`WindowCreateEvent` event (GTK only, as GTK supports setting + :param `event`: a :class:`wx.WindowCreateEvent` event (GTK only, as GTK supports setting the window shape only during window creation). """ @@ -433,7 +433,7 @@ class AdvancedSplash(wx.Frame): :param `font`: the font to use while drawing the text on top of our bitmap. If `font` is ``None``, a simple generic font is generated. - :type font: :class:`Font` or ``None`` + :type font: :class:`wx.Font` or ``None`` """ if font is None: @@ -453,7 +453,7 @@ class AdvancedSplash(wx.Frame): """ Gets the font for the text in :class:`AdvancedSplash`. - :return: An instance of :class:`Font` to draw the text and a :class:`Size` object containing + :return: An instance of :class:`wx.Font` to draw the text and a :class:`wx.Size` object containing the text width an height, in pixels. """ diff --git a/wx/lib/agw/aquabutton.py b/wx/lib/agw/aquabutton.py index 1bb7d549..b64f42a2 100644 --- a/wx/lib/agw/aquabutton.py +++ b/wx/lib/agw/aquabutton.py @@ -161,18 +161,18 @@ class AquaButton(wx.Control): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; - :param Bitmap `bitmap`: the button bitmap (if any); + :param wx.Bitmap `bitmap`: the button bitmap (if any); :param string `label`: the button text label; :param `pos`: the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `style`: the button style (unused); - :param Validator `validator`: the validator associated to the button; + :param wx.Validator `validator`: the validator associated to the button; :param string `name`: the button name. """ @@ -380,7 +380,7 @@ class AquaButton(wx.Control): Returns a rounded :class:`GraphicsPath` rectangle. :param `gc`: an instance of :class:`GraphicsContext`; - :param Rect `rc`: a client rectangle; + :param wx.Rect `rc`: a client rectangle; :param float `r`: the radius of the rounded part of the rectangle. :return: A rounded rectangle, an instance of :class:`GraphicsPath`. @@ -397,7 +397,7 @@ class AquaButton(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`AquaButton`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Invalidate() @@ -565,7 +565,7 @@ class AquaButton(wx.Control): Given the current font and bezel width settings, calculate and set a good size. - :param `size`: an instance of :class:`Size` or ``None``, in which case the wxWidgets + :param `size`: an instance of :class:`wx.Size` or ``None``, in which case the wxWidgets :class:`DefaultSize` is used instead. """ @@ -653,7 +653,7 @@ class AquaButton(wx.Control): Overridden base class virtual. Determines the best size of the button based on the label and bezel size. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. :note: Overridden from :class:`wx.Control`. """ @@ -878,7 +878,7 @@ class AquaButton(wx.Control): :note: Under Windows, only dialog box buttons respond to this function. As normal under Windows and Motif, pressing return causes the default button to be depressed - when the return key is pressed. See also :meth:`Window.SetFocus` which sets the + when the return key is pressed. See also :meth:`wx.Window.SetFocus` which sets the keyboard focus for windows and text panel items, and :meth:`TopLevelWindow.SetDefaultItem`. :note: Note that under Motif, calling this function immediately after creation of a button diff --git a/wx/lib/agw/artmanager.py b/wx/lib/agw/artmanager.py index 847b684f..0d4b9054 100644 --- a/wx/lib/agw/artmanager.py +++ b/wx/lib/agw/artmanager.py @@ -46,7 +46,7 @@ class DCSaver(object): """ Default class constructor. - :param `pdc`: an instance of :class:`DC`. + :param `pdc`: an instance of :class:`wx.DC`. """ self._pdc = pdc @@ -79,8 +79,8 @@ class RendererBase(object): """ Draws borders for buttons. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param `penColour`: a valid :class:`wx.Colour` for the pen border; :param `brushColour`: a valid :class:`wx.Colour` for the brush. """ @@ -96,9 +96,9 @@ class RendererBase(object): """ Draws the area below a bitmap and the bitmap itself using a gradient shading. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param string `xpm_name`: a name of a XPM bitmap; - :param Rect `rect`: the bitmap client rectangle; + :param wx.Rect `rect`: the bitmap client rectangle; :param `baseColour`: a valid :class:`wx.Colour` for the bitmap background; :param bool `flipSide`: ``True`` to flip the gradient direction, ``False`` otherwise. """ @@ -122,8 +122,8 @@ class RendererBase(object): """ Draws borders for a bitmap. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param `penColour`: a valid :class:`wx.Colour` for the pen border; :param `bitmapBorderUpperLeftPen`: a valid :class:`wx.Colour` for the pen upper left border. @@ -177,7 +177,7 @@ class RendererBase(object): """ Returns the font used for text. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. """ return wx.SystemSettings.GetFont(wx.SYS_DEFAULT_GUI_FONT) @@ -200,8 +200,8 @@ class RendererXP(RendererBase): """ Draws a button using the XP theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param integer `state`: the button state; :param `input`: a flag used to call the right method. """ @@ -216,8 +216,8 @@ class RendererXP(RendererBase): """ Draws a button using the XP theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param integer `state`: the button state; :param bool `useLightColours`: ``True`` to use light colours, ``False`` otherwise. """ @@ -241,8 +241,8 @@ class RendererXP(RendererBase): """ Draws a button using the XP theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param integer `state`: the button state; :param `colour`: a valid :class:`wx.Colour` instance. """ @@ -266,8 +266,8 @@ class RendererXP(RendererBase): """ Draws the menu bar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the menu bar's client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the menu bar's client rectangle. """ # For office style, we simple draw a rectangle with a gradient colouring @@ -296,8 +296,8 @@ class RendererXP(RendererBase): """ Draws the toolbar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the toolbar's client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the toolbar's client rectangle. """ artMgr = ArtManager.Get() @@ -404,8 +404,8 @@ class RendererMSOffice2007(RendererBase): """ Draws a button using the MS Office 2007 theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param integer `state`: the button state; :param bool `useLightColours`: ``True`` to use light colours, ``False`` otherwise. """ @@ -417,8 +417,8 @@ class RendererMSOffice2007(RendererBase): """ Draws a button using the MS Office 2007 theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button's client rectangle; :param integer `state`: the button state; :param `colour`: a valid :class:`wx.Colour` instance. """ @@ -468,8 +468,8 @@ class RendererMSOffice2007(RendererBase): """ Draws the menu bar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the menu bar's client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the menu bar's client rectangle. """ # Keep old pen and brush @@ -538,8 +538,8 @@ class RendererMSOffice2007(RendererBase): """ Draws the toolbar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the toolbar's client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the toolbar's client rectangle. """ artMgr = ArtManager.Get() @@ -857,10 +857,10 @@ class ArtManager(wx.EvtHandler): Paint the rectangle with gradient colouring; the gradient lines are either horizontal or vertical. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with gradient shading; - :param Colour `startColour`: the first colour of the gradient shading; - :param Colour `endColour`: the second colour of the gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with gradient shading; + :param wx.Colour `startColour`: the first colour of the gradient shading; + :param wx.Colour `endColour`: the second colour of the gradient shading; :param bool `vertical`: ``True`` for gradient colouring in the vertical direction, ``False`` for horizontal shading. """ @@ -884,11 +884,11 @@ class ArtManager(wx.EvtHandler): """ Paint a region with gradient colouring. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `region`: a region to be filled with gradient shading (an instance of :class:`Region`); - :param Colour `startColour`: the first colour of the gradient shading; - :param Colour `endColour`: the second colour of the gradient shading; + :param wx.Colour `startColour`: the first colour of the gradient shading; + :param wx.Colour `endColour`: the second colour of the gradient shading; :param bool `vertical`: ``True`` for gradient colouring in the vertical direction, ``False`` for horizontal shading. @@ -934,10 +934,10 @@ class ArtManager(wx.EvtHandler): Paint rectangle with gradient colouring; the gradient lines are diagonal and may start from the upper left corner or from the upper right corner. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with gradient shading; - :param Colour `startColour`: the first colour of the gradient shading; - :param Colour `endColour`: the second colour of the gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with gradient shading; + :param wx.Colour `startColour`: the first colour of the gradient shading; + :param wx.Colour `endColour`: the second colour of the gradient shading; :param bool `startAtUpperLeft`: ``True`` to start the gradient lines at the upper left corner of the rectangle, ``False`` to start at the upper right corner; :param bool `trimToSquare`: ``True`` to trim the gradient lines in a square. @@ -1076,10 +1076,10 @@ class ArtManager(wx.EvtHandler): Paint a region with gradient colouring. The gradient is in crescent shape which fits the 2007 style. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with gradient shading; - :param Colour `startColour`: the first colour of the gradient shading; - :param Colour `endColour`: the second colour of the gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with gradient shading; + :param wx.Colour `startColour`: the first colour of the gradient shading; + :param wx.Colour `endColour`: the second colour of the gradient shading; :param bool `concave`: ``True`` for a concave effect, ``False`` for a convex one. """ @@ -1189,7 +1189,7 @@ class ArtManager(wx.EvtHandler): into the given width it is truncated to fit. The format of the fixed text is ``truncate text ...``. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param string `text`: the text to be (eventually) truncated; :param integer `maxWidth`: the maximum width allowed for the text. @@ -1228,8 +1228,8 @@ class ArtManager(wx.EvtHandler): """ Colour rectangle according to the theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with gradient shading; :param string `theme`: the theme to use to draw the button; :param integer `state`: the button state; :param `input`: a flag used to call the right method. @@ -1245,8 +1245,8 @@ class ArtManager(wx.EvtHandler): """ Draws a button using the appropriate theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.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 bool `useLightColours`: ``True`` to use light colours, ``False`` otherwise. @@ -1262,8 +1262,8 @@ class ArtManager(wx.EvtHandler): """ Draws a button using the appropriate theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.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:`wx.Colour` instance. @@ -1347,8 +1347,8 @@ class ArtManager(wx.EvtHandler): """ Draws a shadow using background bitmap. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the bitmap's client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the bitmap's client rectangle; :param integer `where`: where to draw the shadow. This can be any combination of the following bits: @@ -1448,9 +1448,9 @@ class ArtManager(wx.EvtHandler): """ Returns the top left `x` and `y` cordinates of the bitmap drawing. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the bitmap's client rectangle; - :param Bitmap `bitmap`: the bitmap associated with the button; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the bitmap's client rectangle; + :param wx.Bitmap `bitmap`: the bitmap associated with the button; :param string `text`: the button label; :param integer `style`: the button style. This can be one of the following bits: @@ -1538,9 +1538,9 @@ class ArtManager(wx.EvtHandler): In case the text is too long, the text is being fixed (the text is cut and a '...' mark is added in the end). - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the text's client rectangle; - :param Bitmap `bitmap`: the bitmap associated with the button; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the text's client rectangle; + :param wx.Bitmap `bitmap`: the bitmap associated with the button; :param string `text`: the button label; :param integer `style`: the button style. @@ -1602,11 +1602,11 @@ class ArtManager(wx.EvtHandler): """ Draws the text & bitmap on the input dc. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the text and bitmap client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the text and bitmap client rectangle; :param string `text`: the button label; :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 `font`: the font to use to draw the text, an instance of :class:`wx.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:`wx.Bitmap`; @@ -1698,7 +1698,7 @@ class ArtManager(wx.EvtHandler): :param string `label`: the button label; :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. + :return: An instance of :class:`wx.Size`, representing the best fit size for the supplied label & bitmap. """ if "__WXMSW__" in wx.Platform: @@ -1768,7 +1768,7 @@ class ArtManager(wx.EvtHandler): """ Returns the font used by this theme. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. """ renderer = self._renderers[self.GetMenuTheme()] @@ -1934,7 +1934,7 @@ class ArtManager(wx.EvtHandler): """ Draws resize sash. - :param Rect `rect`: the sash client rectangle. + :param wx.Rect `rect`: the sash client rectangle. """ dc = wx.ScreenDC() @@ -1953,8 +1953,8 @@ class ArtManager(wx.EvtHandler): """ Takes a screenshot of the screen at given position & size (rect). - :param Rect `rect`: the screen rectangle we wish to capture; - :param Bitmap `bmp`: currently unused. + :param wx.Rect `rect`: the screen rectangle we wish to capture; + :param wx.Bitmap `bmp`: currently unused. """ # Create a DC for the whole screen area @@ -1992,8 +1992,8 @@ class ArtManager(wx.EvtHandler): """ Draws the toolbar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the toolbar's client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the toolbar's client rectangle. """ renderer = self._renderers[self.GetMenuTheme()] @@ -2006,8 +2006,8 @@ class ArtManager(wx.EvtHandler): """ Draws the menu bar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the menubar's client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the menubar's client rectangle. """ renderer = self._renderers[self.GetMenuTheme()] diff --git a/wx/lib/agw/aui/aui_utilities.py b/wx/lib/agw/aui/aui_utilities.py index 22a0baf4..cdcbf8e4 100644 --- a/wx/lib/agw/aui/aui_utilities.py +++ b/wx/lib/agw/aui/aui_utilities.py @@ -40,8 +40,8 @@ def BlendColour(fg, bg, alpha): Blends the two colour component `fg` and `bg` into one colour component, adding an optional alpha channel. - :param Colour `fg`: the first colour component; - :param Colour `bg`: the second colour component; + :param wx.Colour `fg`: the first colour component; + :param wx.Colour `bg`: the second colour component; :param integer `alpha`: an optional transparency value. """ @@ -59,7 +59,7 @@ def StepColour(c, ialpha): """ Darken/lighten the input colour `c`. - :param Colour `c`: a colour to darken/lighten; + :param wx.Colour `c`: a colour to darken/lighten; :param integer `ialpha`: a transparency value. """ @@ -98,7 +98,7 @@ def LightContrastColour(c): """ Creates a new, lighter colour based on the input colour `c`. - :param Colour `c`: the input colour to analyze. + :param wx.Colour `c`: the input colour to analyze. """ amount = 120 @@ -116,7 +116,7 @@ def ChopText(dc, text, max_size): Chops the input `text` if its size does not fit in `max_size`, by cutting the text and adding ellipsis at the end. - :param `dc`: a :class:`DC` device context; + :param `dc`: a :class:`wx.DC` device context; :param string `text`: the text to chop; :param integer `max_size`: the maximum size in which the text should fit. """ @@ -151,7 +151,7 @@ def BitmapFromBits(bits, w, h, colour): :param string `bits`: the raw bits of the bitmap; :param integer `w`: the bitmap width; :param integer `h`: the bitmap height; - :param Colour `colour`: the colour which will replace all white pixels in the + :param wx.Colour `colour`: the colour which will replace all white pixels in the raw bitmap. """ @@ -166,7 +166,7 @@ def IndentPressedBitmap(rect, button_state): """ Indents the input rectangle `rect` based on the value of `button_state`. - :param Rect `rect`: the button bitmap rectangle; + :param wx.Rect `rect`: the button bitmap rectangle; :param integer `button_state`: the button state. """ @@ -211,7 +211,7 @@ def MakeDisabledBitmap(bitmap): """ Convert the given image (in place) to a grayed-out version, appropriate for a 'disabled' appearance. - :param Bitmap `bitmap`: the bitmap to gray-out. + :param wx.Bitmap `bitmap`: the bitmap to gray-out. """ return bitmap.ConvertToDisabled() @@ -233,7 +233,7 @@ def LightColour(colour, percent): """ Brighten input `colour` by `percent`. - :param Colour `colour`: the colour to be brightened; + :param wx.Colour `colour`: the colour to be brightened; :param integer `percent`: brightening percentage. """ @@ -276,8 +276,8 @@ def DrawMACCloseButton(colour, backColour=None): """ Draws the wxMAC tab close button using :class:`GraphicsContext`. - :param Colour `colour`: the colour to use to draw the circle; - :param Colour `backColour`: the optional background colour for the circle. + :param wx.Colour `colour`: the colour to use to draw the circle; + :param wx.Colour `backColour`: the optional background colour for the circle. """ bmp = wx.Bitmap.FromRGBA(16, 16) @@ -315,9 +315,9 @@ def DarkenBitmap(bmp, caption_colour, new_colour): """ Darkens the input bitmap on wxMAC using the input colour. - :param Bitmap `bmp`: the bitmap to be manipulated; - :param Colour `caption_colour`: the colour of the pane caption; - :param Colour `new_colour`: the colour used to darken the bitmap. + :param wx.Bitmap `bmp`: the bitmap to be manipulated; + :param wx.Colour `caption_colour`: the colour of the pane caption; + :param wx.Colour `new_colour`: the colour used to darken the bitmap. """ image = bmp.ConvertToImage() @@ -332,10 +332,10 @@ def DrawGradientRectangle(dc, rect, start_colour, end_colour, direction, offset= """ Draws a gradient-shaded rectangle. - :param `dc`: a :class:`DC` device context; - :param Rect `rect`: the rectangle in which to draw the gradient; - :param Colour `start_colour`: the first colour of the gradient; - :param Colour `end_colour`: the second colour of the gradient; + :param `dc`: a :class:`wx.DC` device context; + :param wx.Rect `rect`: the rectangle in which to draw the gradient; + :param wx.Colour `start_colour`: the first colour of the gradient; + :param wx.Colour `end_colour`: the second colour of the gradient; :param integer `direction`: the gradient direction (horizontal or vertical). """ @@ -350,7 +350,7 @@ def FindFocusDescendant(ancestor): Find a window with the focus, that is also a descendant of the given window. This is used to determine the window to initially send commands to. - :param Window `ancestor`: the window to check for ancestry. + :param wx.Window `ancestor`: the window to check for ancestry. """ # Process events starting with the window with the focus, if any. @@ -521,7 +521,7 @@ def TakeScreenShot(rect): """ Takes a screenshot of the screen at given position and size (`rect`). - :param Rect `rect`: the screen rectangle for which we want to take a screenshot. + :param wx.Rect `rect`: the screen rectangle for which we want to take a screenshot. """ # Create a DC for the whole screen area @@ -561,7 +561,7 @@ def RescaleScreenShot(bmp, thumbnail_size=200): """ Rescales a bitmap to be `thumbnail_size` pixels wide (or tall) at maximum. - :param Bitmap `bmp`: the bitmap to rescale; + :param wx.Bitmap `bmp`: the bitmap to rescale; :param integer `thumbnail_size`: the maximum size of every page thumbnail. """ @@ -611,8 +611,8 @@ def GetSlidingPoints(rect, size, direction): """ Returns the point at which the sliding in and out of a minimized pane begins. - :param Rect `rect`: the :class:`~lib.agw.aui.auibar.AuiToolBar` tool screen rectangle; - :param Size `size`: the pane window size; + :param wx.Rect `rect`: the :class:`~lib.agw.aui.auibar.AuiToolBar` tool screen rectangle; + :param wx.Size `size`: the pane window size; :param integer `direction`: the pane docking direction. """ diff --git a/wx/lib/agw/aui/auibar.py b/wx/lib/agw/aui/auibar.py index 44160038..bb56b51d 100644 --- a/wx/lib/agw/aui/auibar.py +++ b/wx/lib/agw/aui/auibar.py @@ -105,7 +105,7 @@ class CommandToolBarEvent(wx.PyCommandEvent): """ Sets the clicking point. - :param Point `p`: the location of the mouse click. + :param wx.Point `p`: the location of the mouse click. """ self.click_pt = p @@ -121,7 +121,7 @@ class CommandToolBarEvent(wx.PyCommandEvent): """ Sets the :class:`AuiToolBarItem` rectangle. - :param Rect `r`: the toolbar item rectangle. + :param wx.Rect `r`: the toolbar item rectangle. """ self.rect = r @@ -242,14 +242,14 @@ class ToolbarCommandCapture(wx.EvtHandler): 1. If the object is disabled (via a call to :meth:`~EvtHandler.SetEvtHandlerEnabled`) the function skips to step (6). - 2. If the object is a :class:`Window`, :meth:`ProcessEvent` is recursively called on the window's - :class:`Validator`. If this returns ``True``, the function exits. + 2. If the object is a :class:`wx.Window`, :meth:`ProcessEvent` is recursively called on the window's + :class:`wx.Validator`. If this returns ``True``, the function exits. 3. wxWidgets `SearchEventTable` is called for this event handler. If this fails, the base class table is tried, and so on until no more tables exist or an appropriate function was found, in which case the function exits. 4. The search is applied down the entire chain of event handlers (usually the chain has a length of one). If this succeeds, the function exits. - 5. If the object is a :class:`Window` and the event is a :class:`CommandEvent`, :meth:`ProcessEvent` is + 5. If the object is a :class:`wx.Window` and the event is a :class:`CommandEvent`, :meth:`ProcessEvent` is recursively applied to the parent window's event handler. If this returns ``True``, the function exits. 6. Finally, :meth:`ProcessEvent` is called on the :class:`App` object. @@ -352,7 +352,7 @@ class AuiToolBarItem(object): """ Assigns a window to the toolbar item. - :param Window `w`: associate this window `w` to the :class:`AuiToolBarItem`. + :param wx.Window `w`: associate this window `w` to the :class:`AuiToolBarItem`. """ self.window = w @@ -448,7 +448,7 @@ class AuiToolBarItem(object): """ Associates a sizer item to this toolbar item. - :param `s`: an instance of :class:`SizerItem`. + :param `s`: an instance of :class:`wx.SizerItem`. """ self.sizer_item = s @@ -480,7 +480,7 @@ class AuiToolBarItem(object): """ Sets the toolbar item bitmap. - :param Bitmap `bmp`: the image associated with this :class:`AuiToolBarItem`. + :param wx.Bitmap `bmp`: the image associated with this :class:`AuiToolBarItem`. """ self.bitmap = bmp @@ -496,7 +496,7 @@ class AuiToolBarItem(object): """ Sets the toolbar item disabled bitmap. - :param Bitmap `bmp`: the disabled image associated with this :class:`AuiToolBarItem`. + :param wx.Bitmap `bmp`: the disabled image associated with this :class:`AuiToolBarItem`. """ self.disabled_bitmap = bmp @@ -512,7 +512,7 @@ class AuiToolBarItem(object): """ Sets the toolbar item hover bitmap. - :param Bitmap `bmp`: the hover image associated with this :class:`AuiToolBarItem`. + :param wx.Bitmap `bmp`: the hover image associated with this :class:`AuiToolBarItem`. """ self.hover_bitmap = bmp @@ -606,7 +606,7 @@ class AuiToolBarItem(object): """ Sets the toolbar item minimum size. - :param Size `s`: the toolbar item minimum size. + :param wx.Size `s`: the toolbar item minimum size. """ self.min_size = wx.Size(*s) @@ -721,7 +721,7 @@ class AuiToolBarItem(object): """ Sets the toolbar item alignment. - :param integer `align`: the item alignment, which can be one of the available :class:`Sizer` + :param integer `align`: the item alignment, which can be one of the available :class:`wx.Sizer` alignments. """ @@ -840,7 +840,7 @@ class AuiDefaultToolBarArt(object): """ Sets the :class:`AuiDefaultToolBarArt` font. - :param Font `font`: the font used for displaying toolbar item labels. + :param wx.Font `font`: the font used for displaying toolbar item labels. """ self._font = font @@ -903,9 +903,9 @@ class AuiDefaultToolBarArt(object): """ Draws a toolbar background with a gradient shading. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; - :param Rect `_rect`: the :class:`AuiToolBarItem` rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; + :param wx.Rect `_rect`: the :class:`AuiToolBarItem` rectangle; :param bool `horizontal`: ``True`` if the toolbar is horizontal, ``False`` if it is vertical. """ @@ -939,9 +939,9 @@ class AuiDefaultToolBarArt(object): it within a control that has margin between the borders and the toolbar (example: put :class:`AuiToolBar` within a :class:`StaticBoxSizer` that has a plain background). - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; - :param Rect `_rect`: the :class:`AuiToolBarItem` rectangle. + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; + :param wx.Rect `_rect`: the :class:`AuiToolBarItem` rectangle. """ rect = wx.Rect(*_rect) @@ -955,10 +955,10 @@ class AuiDefaultToolBarArt(object): """ Draws a toolbar item label. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; :param `item`: an instance of :class:`AuiToolBarItem`; - :param Rect `rect`: the :class:`AuiToolBarItem` rectangle. + :param wx.Rect `rect`: the :class:`AuiToolBarItem` rectangle. """ dc.SetFont(self._font) @@ -997,10 +997,10 @@ class AuiDefaultToolBarArt(object): """ Draws a toolbar item button. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; :param `item`: an instance of :class:`AuiToolBarItem`; - :param Rect `rect`: the :class:`AuiToolBarItem` rectangle. + :param wx.Rect `rect`: the :class:`AuiToolBarItem` rectangle. """ bmp_rect, text_rect = self.GetToolsPosition(dc, item, rect) @@ -1059,10 +1059,10 @@ class AuiDefaultToolBarArt(object): """ Draws a toolbar dropdown button. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; :param `item`: an instance of :class:`AuiToolBarItem`; - :param Rect `rect`: the :class:`AuiToolBarItem` rectangle. + :param wx.Rect `rect`: the :class:`AuiToolBarItem` rectangle. """ dropbmp_x = dropbmp_y = 0 @@ -1146,10 +1146,10 @@ class AuiDefaultToolBarArt(object): """ Draws a label for a toolbar control. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; :param `item`: an instance of :class:`AuiToolBarItem`; - :param Rect `rect`: the :class:`AuiToolBarItem` rectangle. + :param wx.Rect `rect`: the :class:`AuiToolBarItem` rectangle. """ label_size = GetLabelSize(dc, item.GetLabel(), item.GetOrientation() != AUI_TBTOOL_HORIZONTAL) @@ -1182,8 +1182,8 @@ class AuiDefaultToolBarArt(object): """ Returns the label size for a toolbar item. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; :param `item`: an instance of :class:`AuiToolBarItem`. """ @@ -1197,8 +1197,8 @@ class AuiDefaultToolBarArt(object): """ Returns the toolbar item size. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; :param `item`: an instance of :class:`AuiToolBarItem`. """ @@ -1251,9 +1251,9 @@ class AuiDefaultToolBarArt(object): """ Draws a toolbar separator. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; - :param Rect `_rect`: the :class:`AuiToolBarItem` rectangle. + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; + :param wx.Rect `_rect`: the :class:`AuiToolBarItem` rectangle. """ horizontal = True @@ -1287,9 +1287,9 @@ class AuiDefaultToolBarArt(object): """ Draws the toolbar gripper. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; - :param Rect `rect`: the :class:`AuiToolBarItem` rectangle. + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; + :param wx.Rect `rect`: the :class:`AuiToolBarItem` rectangle. """ i = 0 @@ -1326,9 +1326,9 @@ class AuiDefaultToolBarArt(object): """ Draws the overflow button for the :class:`AuiToolBar`. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` derived window; - :param Rect `rect`: the :class:`AuiToolBarItem` rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` derived window; + :param wx.Rect `rect`: the :class:`AuiToolBarItem` rectangle; :param integer `state`: the overflow button state. """ @@ -1412,7 +1412,7 @@ class AuiDefaultToolBarArt(object): """ Shows the drop down window menu for overflow items. - :param `wnd`: an instance of :class:`Window`; + :param `wnd`: an instance of :class:`wx.Window`; :param list `items`: a list of the overflow toolbar items. """ @@ -1478,9 +1478,9 @@ class AuiDefaultToolBarArt(object): """ Returns the bitmap and text rectangles for a toolbar item. - :param `dc`: a :class:`DC` device context; + :param `dc`: a :class:`wx.DC` device context; :param `item`: an instance of :class:`AuiToolBarItem`; - :param Rect `rect`: the tool rectangle. + :param wx.Rect `rect`: the tool rectangle. """ text_width = text_height = 0 @@ -1537,11 +1537,11 @@ class AuiToolBar(wx.Control): """ Default class constructor. - :param Window `parent`: the :class:`AuiToolBar` parent; + :param wx.Window `parent`: the :class:`AuiToolBar` parent; :param integer `id`: an identifier for the control: a value of -1 is taken to mean a default; - :param Point `pos`: the control position. A value of (-1, -1) indicates a default position, + :param wx.Point `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 `size`: the control size. A value of (-1, -1) indicates a default size, + :param wx.Size `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the control window style; :param integer `agwStyle`: the AGW-specific window style. This can be a combination of the @@ -1639,7 +1639,7 @@ class AuiToolBar(wx.Control): creation and that `Refresh` might need to be be called after changing the others for the change to take place immediately. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ wx.Control.SetWindowStyleFlag(self, style|wx.BORDER_NONE) @@ -1741,7 +1741,7 @@ class AuiToolBar(wx.Control): :param integer `tool_id`: an integer by which the tool may be identified in subsequent operations; :param string `label`: the toolbar tool label; - :param Bitmap `bitmap`: the primary tool bitmap; + :param wx.Bitmap `bitmap`: the primary tool bitmap; :param string `short_help_string`: this string is used for the tools tooltip; :param integer `kind`: the item kind. Can be one of the following: @@ -1769,8 +1769,8 @@ class AuiToolBar(wx.Control): Adds a toggle tool to the toolbar. :param integer `tool_id`: an integer by which the tool may be identified in subsequent operations; - :param Bitmap `bitmap`: the primary tool bitmap; - :param Bitmap `disabled_bitmap`: the bitmap to use when the tool is disabled. If it is equal to + :param wx.Bitmap `bitmap`: the primary tool bitmap; + :param wx.Bitmap `disabled_bitmap`: the bitmap to use when the tool is disabled. If it is equal to :class:`NullBitmap`, the disabled bitmap is automatically generated by greing the normal one; :param PyObject `client_data`: whatever Python object to associate with the toolbar item; :param string `short_help_string`: this string is used for the tools tooltip; @@ -1788,8 +1788,8 @@ class AuiToolBar(wx.Control): :param integer `tool_id`: an integer by which the tool may be identified in subsequent operations; :param string `label`: the toolbar tool label; - :param Bitmap `bitmap`: the primary tool bitmap; - :param Bitmap `disabled_bitmap`: the bitmap to use when the tool is disabled. If it is equal to + :param wx.Bitmap `bitmap`: the primary tool bitmap; + :param wx.Bitmap `disabled_bitmap`: the bitmap to use when the tool is disabled. If it is equal to :class:`NullBitmap`, the disabled bitmap is automatically generated by greing the normal one; :param integer `kind`: the item kind. Can be one of the following: @@ -1880,7 +1880,7 @@ class AuiToolBar(wx.Control): """ Adds any control to the toolbar, typically e.g. a :class:`ComboBox`. - :param Window `control`: the control to be added; + :param wx.Window `control`: the control to be added; :param string `label`: the label which appears if the control goes into the overflow items in the toolbar. """ @@ -2214,7 +2214,7 @@ class AuiToolBar(wx.Control): """ Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels. - :param Size `size`: the size of the bitmaps in the toolbar. + :param wx.Size `size`: the size of the bitmaps in the toolbar. :note: This should be called to tell the toolbar what the tool bitmap size is. Call it before you add tools. @@ -2472,7 +2472,7 @@ class AuiToolBar(wx.Control): """ Set the values to be used as margins for the toolbar. - :param Size `size`: the margin size (an instance of :class:`Size`). + :param wx.Size `size`: the margin size (an instance of :class:`wx.Size`). """ self.SetMargins(size.x, size.x, size.y, size.y) @@ -2538,9 +2538,9 @@ class AuiToolBar(wx.Control): """ Sets the :class:`AuiToolBar` font. - :param Font `font`: the new toolbar font. + :param wx.Font `font`: the new toolbar font. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ res = wx.Control.SetFont(self, font) @@ -2774,7 +2774,7 @@ class AuiToolBar(wx.Control): Sets the tool bitmap for the tool identified by `tool_id`. :param integer `tool_id`: the tool identifier; - :param Bitmap `bitmap`: the new bitmap for the toolbar item. + :param wx.Bitmap `bitmap`: the new bitmap for the toolbar item. """ tool = self.FindTool(tool_id) @@ -2787,7 +2787,7 @@ class AuiToolBar(wx.Control): Sets the tool bitmap for the tool identified by `tool_id`. :param integer `tool_id`: the tool identifier; - :param Bitmap `bitmap`: the new bitmap for the toolbar item. + :param wx.Bitmap `bitmap`: the new bitmap for the toolbar item. """ self.SetToolBitmap(tool_id, bitmap) @@ -2798,7 +2798,7 @@ class AuiToolBar(wx.Control): Sets the tool disabled bitmap for the tool identified by `tool_id`. :param integer `tool_id`: the tool identifier; - :param Bitmap `bitmap`: the new disabled bitmap for the toolbar item. + :param wx.Bitmap `bitmap`: the new disabled bitmap for the toolbar item. """ tool = self.FindTool(tool_id) @@ -2852,7 +2852,7 @@ class AuiToolBar(wx.Control): This sets the alignment for all of the tools within the toolbar (only has an effect when the toolbar is expanded). - :param integer `alignment`: :class:`Sizer` alignment value + :param integer `alignment`: :class:`wx.Sizer` alignment value (``wx.ALIGN_CENTER_HORIZONTAL`` or ``wx.ALIGN_CENTER_VERTICAL``). """ @@ -3319,7 +3319,7 @@ class AuiToolBar(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`AuiToolBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ x, y = self.GetClientSize() @@ -3393,7 +3393,7 @@ class AuiToolBar(wx.Control): for MSW and ignored elsewhere currently) =================================== ====================================== - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ parent_size = self.GetParent().GetClientSize() @@ -3422,7 +3422,7 @@ class AuiToolBar(wx.Control): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._absolute_min_size @@ -3955,9 +3955,9 @@ class AuiToolBar(wx.Control): """ Handles custom render for single :class:`AuiToolBar` items. - :param `dc`: a :class:`DC` device context; + :param `dc`: a :class:`wx.DC` device context; :param `item`: an instance of :class:`AuiToolBarItem`; - :param Rect `rect`: the toolbar item rect. + :param wx.Rect `rect`: the toolbar item rect. :note: This method must be overridden to provide custom rendering of items. """ diff --git a/wx/lib/agw/aui/auibook.py b/wx/lib/agw/aui/auibook.py index e531de15..cbb721a1 100644 --- a/wx/lib/agw/aui/auibook.py +++ b/wx/lib/agw/aui/auibook.py @@ -590,10 +590,10 @@ class TabNavigatorProps(object): 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`.') + doc='Sets/Gets the font for the L{TabNavigatorWindow}, an instance of :class:`wx.Font`.') MinSize = property(lambda self: self._minsize, lambda self, size: setattr(self, '_minsize', size), - doc='Sets/Gets the minimum size for the L{TabNavigatorWindow}, an instance of :class:`Size`.') + doc='Sets/Gets the minimum size for the L{TabNavigatorWindow}, an instance of :class:`wx.Size`.') # ---------------------------------------------------------------------------- # # Class TabNavigatorWindow @@ -845,7 +845,7 @@ class AuiTabContainer(object): the :class:`AuiNotebook`, where it is disadvantageous to have separate windows for each tab control in the case of "docked tabs". - A derived class, :class:`AuiTabCtrl`, is an actual :class:`Window` - derived window + A derived class, :class:`AuiTabCtrl`, is an actual :class:`wx.Window` - derived window which can be used as a tab control in the normal sense. """ @@ -973,7 +973,7 @@ class AuiTabContainer(object): """ Sets the normal font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their normal, un-selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their normal, un-selected state. """ self._art.SetNormalFont(font) @@ -983,7 +983,7 @@ class AuiTabContainer(object): """ Sets the selected tab font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their selected state. """ self._art.SetSelectedFont(font) @@ -993,7 +993,7 @@ class AuiTabContainer(object): """ Sets the font for calculating text measurements. - :param Font `font`: the new font to use to measure tab label text extents. + :param wx.Font `font`: the new font to use to measure tab label text extents. """ self._art.SetMeasuringFont(font) @@ -1003,7 +1003,7 @@ class AuiTabContainer(object): """ Sets the tab area rectangle. - :param Rect `rect`: the available area for :class:`AuiTabContainer`. + :param wx.Rect `rect`: the available area for :class:`AuiTabContainer`. """ self._rect = rect @@ -1017,7 +1017,7 @@ class AuiTabContainer(object): """ Adds a page to the tab control. - :param Window `page`: the window associated with this tab; + :param wx.Window `page`: the window associated with this tab; :param `info`: an instance of :class:`AuiNotebookPage`. """ @@ -1038,7 +1038,7 @@ class AuiTabContainer(object): """ Inserts a page in the tab control in the position specified by `idx`. - :param Window `page`: the window associated with this tab; + :param wx.Window `page`: the window associated with this tab; :param `info`: an instance of :class:`AuiNotebookPage`; :param integer `idx`: the page insertion index. """ @@ -1063,7 +1063,7 @@ class AuiTabContainer(object): """ Moves a page in a new position specified by `new_idx`. - :param Window `page`: the window associated with this tab; + :param wx.Window `page`: the window associated with this tab; :param integer `new_idx`: the new page position. """ @@ -1087,7 +1087,7 @@ class AuiTabContainer(object): """ Removes a page from the tab control. - :param `wnd`: an instance of :class:`Window`, a window associated with this tab. + :param `wnd`: an instance of :class:`wx.Window`, a window associated with this tab. """ minMaxTabWidth = self._auiNotebook.GetMinMaxTabWidth() @@ -1110,7 +1110,7 @@ class AuiTabContainer(object): """ Sets the :class:`AuiNotebook` active page. - :param `wndOrInt`: an instance of :class:`Window` or an integer specifying a tab index. + :param `wndOrInt`: an instance of :class:`wx.Window` or an integer specifying a tab index. """ if type(wndOrInt) in six.integer_types: @@ -1169,7 +1169,7 @@ class AuiTabContainer(object): """ Returns the tab index based on the window `wnd` associated with it. - :param `wnd`: an instance of :class:`Window`. + :param `wnd`: an instance of :class:`wx.Window`. """ for indx, page in enumerate(self._pages): @@ -1249,8 +1249,8 @@ class AuiTabContainer(object): ============================== ================================= :param integer `location`: the button location. Can be ``wx.LEFT`` or ``wx.RIGHT``; - :param Bitmap `normal_bitmap`: the bitmap for an enabled tab; - :param Bitmap `disabled_bitmap`: the bitmap for a disabled tab; + :param wx.Bitmap `normal_bitmap`: the bitmap for an enabled tab; + :param wx.Bitmap `disabled_bitmap`: the bitmap for a disabled tab; :param string `name`: the button name. """ @@ -1322,13 +1322,13 @@ class AuiTabContainer(object): def Render(self, raw_dc, wnd): """ - Renders the tab catalog to the specified :class:`DC`. + Renders the tab catalog to the specified :class:`wx.DC`. It is a virtual function and can be overridden to provide custom drawing capabilities. - :param `raw_dc`: a :class:`DC` device context; - :param `wnd`: an instance of :class:`Window`. + :param `raw_dc`: a :class:`wx.DC` device context; + :param `wnd`: an instance of :class:`wx.Window`. """ if not raw_dc or not raw_dc.IsOk(): @@ -1595,8 +1595,8 @@ class AuiTabContainer(object): :param integer `tabPage`: the tab index; :param integer `tabOffset`: the tab offset; - :param `dc`: a :class:`DC` device context; - :param `wnd`: an instance of :class:`Window` derived window. + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: an instance of :class:`wx.Window` derived window. """ if not dc or not dc.IsOk(): @@ -1706,7 +1706,7 @@ class AuiTabContainer(object): Make the tab visible if it wasn't already. :param integer `tabPage`: the tab index; - :param `win`: an instance of :class:`Window` derived window. + :param `win`: an instance of :class:`wx.Window` derived window. """ dc = wx.ClientDC(win) @@ -1796,7 +1796,7 @@ class AuiTabContainer(object): class AuiTabCtrl(wx.Control, AuiTabContainer): """ - This is an actual :class:`Window` - derived window which can be used as a tab control in the normal sense. + This is an actual :class:`wx.Window` - derived window which can be used as a tab control in the normal sense. """ def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, @@ -1807,9 +1807,9 @@ class AuiTabCtrl(wx.Control, AuiTabContainer): :param `parent`: the :class:`AuiNotebook` parent; :param integer `id`: an identifier for the control: a value of -1 is taken to mean a default; - :param Point `pos`: the control position. A value of (-1, -1) indicates a default position, + :param wx.Point `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 `size`: the control size. A value of (-1, -1) indicates a default size, + :param wx.Size `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the window style. """ @@ -1891,7 +1891,7 @@ class AuiTabCtrl(wx.Control, AuiTabContainer): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return wx.Size(self._rect.width, self._rect.height) @@ -1901,7 +1901,7 @@ class AuiTabCtrl(wx.Control, AuiTabContainer): """ Handles the ``wx.EVT_SIZE`` event for :class:`AuiTabCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ s = event.GetSize() @@ -2325,7 +2325,7 @@ class AuiTabCtrl(wx.Control, AuiTabContainer): """ Returns the page at which the mouse is pointing (if any). - :rtype: :class:`Window`. + :rtype: :class:`wx.Window`. """ screen_pt = wx.GetMousePosition() @@ -2338,7 +2338,7 @@ class AuiTabCtrl(wx.Control, AuiTabContainer): Starts a timer: when it fires, a tooltip will be shown on the notebook tab the mouse is pointing at. - :param Window `wnd`: the window pointed by the mouse. + :param wx.Window `wnd`: the window pointed by the mouse. """ self._tooltip_wnd = wnd @@ -2705,7 +2705,7 @@ class TabFrame(wx.Window): for MSW and ignored elsewhere currently) =================================== ====================================== - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ self._rect = wx.Rect(x, y, max(1, width), max(1, height)) @@ -2716,7 +2716,7 @@ class TabFrame(wx.Window): """ Returns the window size. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._rect.width, self._rect.height @@ -2726,7 +2726,7 @@ class TabFrame(wx.Window): """ Returns the window client size. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._rect.width, self._rect.height @@ -2740,7 +2740,7 @@ class TabFrame(wx.Window): :note: - Overridden from :class:`Control`, this method always returns ``False`` as + Overridden from :class:`wx.Control`, this method always returns ``False`` as :class:`TabFrame` should never be phisically shown on screen. """ @@ -2821,7 +2821,7 @@ class TabFrame(wx.Window): nothing happens if nothing has been invalidated (i.e. marked as requiring a redraw). Use `Refresh` first if you want to immediately redraw the window unconditionally. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ # does nothing @@ -2849,11 +2849,11 @@ class AuiNotebook(wx.Panel): """ Default class constructor. - :param Window `parent`: the :class:`AuiNotebook` parent; + :param wx.Window `parent`: the :class:`AuiNotebook` parent; :param integer `id`: an identifier for the control: a value of -1 is taken to mean a default; - :param Point `pos`: the control position. A value of (-1, -1) indicates a default position, + :param wx.Point `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 `size`: the control size. A value of (-1, -1) indicates a default size, + :param wx.Size `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the underlying :class:`Panel` window style; :param integer `agwStyle`: the AGW-specific window style. This can be a combination of the following bits: @@ -3241,7 +3241,7 @@ class AuiNotebook(wx.Panel): large bitmap is added, the tab control's height will automatically increase to accommodate the larger bitmap. - :param Size `size`: the tab bitmap size. + :param wx.Size `size`: the tab bitmap size. """ self._requested_bmp_size = wx.Size(*size) @@ -3423,12 +3423,12 @@ class AuiNotebook(wx.Panel): Adds a page. If the `select` parameter is ``True``, calling this will generate a page change event. - :param Window `page`: the page to be added; + :param wx.Window `page`: the page to be added; :param string `caption`: specifies the text for the new page; :param bool `select`: specifies whether the page should be selected; - :param Bitmap `bitmap`: the bitmap to display in the enabled tab; - :param Bitmap `disabled_bitmap`: the bitmap to display in the disabled tab; - :param Window `control`: almost any :class:`Window` -derived instance to be located + :param wx.Bitmap `bitmap`: the bitmap to display in the enabled tab; + :param wx.Bitmap `disabled_bitmap`: the bitmap to display in the disabled tab; + :param wx.Window `control`: almost any :class:`wx.Window` -derived instance to be located inside a tab; :param string `tooltip`: the tooltip to display when the mouse hovers over the tab. """ @@ -3442,12 +3442,12 @@ class AuiNotebook(wx.Panel): This is similar to :meth:`AddPage`, but allows the ability to specify the insert location. :param integer `page_idx`: specifies the position for the new page; - :param Window `page`: the page to be added; + :param wx.Window `page`: the page to be added; :param string `caption`: specifies the text for the new page; :param bool `select`: specifies whether the page should be selected; - :param Bitmap `bitmap`: the bitmap to display in the enabled tab; - :param Bitmap `disabled_bitmap`: the bitmap to display in the disabled tab; - :param Window `control`: almost any :class:`Window` -derived instance to be located + :param wx.Bitmap `bitmap`: the bitmap to display in the enabled tab; + :param wx.Bitmap `disabled_bitmap`: the bitmap to display in the disabled tab; + :param wx.Window `control`: almost any :class:`wx.Window` -derived instance to be located inside a ; :param string `tooltip`: the tooltip to display when the mouse hovers over the tab. """ @@ -3733,7 +3733,7 @@ class AuiNotebook(wx.Panel): Returns the page index for the specified window. If the window is not found in the notebook, ``wx.NOT_FOUND`` is returned. - :param Window `page_wnd`: the window we are looking for. + :param wx.Window `page_wnd`: the window we are looking for. """ return self._tabs.GetIdxFromWindow(page_wnd) @@ -3793,7 +3793,7 @@ class AuiNotebook(wx.Panel): Sets the tab bitmap for the page. :param integer `page_idx`: the page index; - :param Bitmap `bitmap`: the bitmap to display on the page tab. + :param wx.Bitmap `bitmap`: the bitmap to display on the page tab. """ if page_idx >= self._tabs.GetPageCount(): @@ -3879,7 +3879,7 @@ class AuiNotebook(wx.Panel): """ Sets the image list for the :class:`AuiNotebook` control. - :param ImageList `imageList`: the bitmap image list to associate to :class:`AuiNotebook`. + :param wx.ImageList `imageList`: the bitmap image list to associate to :class:`AuiNotebook`. """ self._imageList = imageList @@ -3889,7 +3889,7 @@ class AuiNotebook(wx.Panel): """ Sets the image list for the :class:`AuiNotebook` control. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self.SetImageList(imageList) @@ -3959,7 +3959,7 @@ class AuiNotebook(wx.Panel): Sets the tab text colour for the page. :param integer `page_idx`: the page index; - :param Colour `colour`: the new tab label text colour. + :param wx.Colour `colour`: the new tab label text colour. """ if page_idx >= self._tabs.GetPageCount(): @@ -4006,7 +4006,7 @@ class AuiNotebook(wx.Panel): Adds a control inside a tab (not in the tab area). :param integer `page_idx`: the page index; - :param Window `control`: almost any :class:`Window` -derived instance to be located + :param wx.Window `control`: almost any :class:`wx.Window` -derived instance to be located inside a tab. """ @@ -4222,7 +4222,7 @@ class AuiNotebook(wx.Panel): """ Sets the selection based on the input window `win`. - :param `win`: a :class:`Window` derived window. + :param `win`: a :class:`wx.Window` derived window. """ idx = self._tabs.GetIdxFromWindow(win) @@ -4548,7 +4548,7 @@ class AuiNotebook(wx.Panel): """ Reparents a control added inside a tab. - :param Window `control`: almost any :class:`Window` -derived instance to be located + :param wx.Window `control`: almost any :class:`wx.Window` -derived instance to be located inside a tab; :param `dest_tabs`: the destination :class:`AuiTabCtrl`. """ @@ -4563,7 +4563,7 @@ class AuiNotebook(wx.Panel): :param `part`: an UI part representing the sash; :param integer `sash_size`: the sash size; - :param Point `pos`: the double-click mouse position. + :param wx.Point `pos`: the double-click mouse position. .. warning:: @@ -4666,7 +4666,7 @@ class AuiNotebook(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`AuiNotebook`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.UpdateHintWindowSize() @@ -5280,7 +5280,7 @@ class AuiNotebook(wx.Panel): """ Returns the tab control at the specified point. - :param Point `pt`: the mouse location. + :param wx.Point `pt`: the mouse location. """ # if we've just removed the last tab from the source @@ -5322,7 +5322,7 @@ class AuiNotebook(wx.Panel): """ Returns the tab frame associated with a window. - :param Window `wnd`: the window for which we want to locate the :class:`TabFrame`. + :param wx.Window `wnd`: the window for which we want to locate the :class:`TabFrame`. """ all_panes = self._mgr.GetAllPanes() @@ -5413,7 +5413,7 @@ class AuiNotebook(wx.Panel): """ Sets the icon used by the :class:`TabNavigatorWindow`. - :param Bitmap `bmp`: the new bitmap for the :class:`TabNavigatorWindow`. + :param wx.Bitmap `bmp`: the new bitmap for the :class:`TabNavigatorWindow`. """ if isinstance(bmp, wx.Bitmap) and bmp.IsOk(): @@ -5694,7 +5694,7 @@ class AuiNotebook(wx.Panel): """ Sets the normal font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their normal, un-selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their normal, un-selected state. """ self._normal_font = font @@ -5705,7 +5705,7 @@ class AuiNotebook(wx.Panel): """ Sets the selected tab font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their selected state. """ self._selected_font = font @@ -5716,7 +5716,7 @@ class AuiNotebook(wx.Panel): """ Sets the font for calculating text measurements. - :param Font `font`: the new font to use to measure tab label text extents. + :param wx.Font `font`: the new font to use to measure tab label text extents. """ self.GetArtProvider().SetMeasuringFont(font) @@ -5726,7 +5726,7 @@ class AuiNotebook(wx.Panel): """ Sets the tab font. - :param Font `font`: the new font to use to draw tab labels in their normal, un-selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their normal, un-selected state. :note: Overridden from :class:`Panel`. """ @@ -5871,8 +5871,8 @@ class AuiNotebook(wx.Panel): ============================== ================================= :param integer `location`: the button location. Can be ``wx.LEFT`` or ``wx.RIGHT``; - :param Bitmap `normal_bitmap`: the bitmap for an enabled tab; - :param Bitmap `disabled_bitmap`: the bitmap for a disabled tab; + :param wx.Bitmap `normal_bitmap`: the bitmap for an enabled tab; + :param wx.Bitmap `disabled_bitmap`: the bitmap for a disabled tab; :param string `name`: the button name. """ diff --git a/wx/lib/agw/aui/dockart.py b/wx/lib/agw/aui/dockart.py index f6b0d41d..65b744e9 100644 --- a/wx/lib/agw/aui/dockart.py +++ b/wx/lib/agw/aui/dockart.py @@ -389,7 +389,7 @@ class AuiDefaultDockArt(object): Sets a font setting. :param integer `id`: must be ``AUI_DOCKART_CAPTION_FONT``; - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ if id == AUI_DOCKART_CAPTION_FONT: @@ -413,10 +413,10 @@ class AuiDefaultDockArt(object): """ Draws a sash between two windows. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param integer `orient`: the sash orientation; - :param Rect `rect`: the sash rectangle. + :param wx.Rect `rect`: the sash rectangle. """ # AG: How do we make this work?!? @@ -438,10 +438,10 @@ class AuiDefaultDockArt(object): """ Draws a background. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param integer `orient`: the gradient (if any) orientation; - :param Rect `rect`: the background rectangle. + :param wx.Rect `rect`: the background rectangle. """ dc.SetPen(wx.TRANSPARENT_PEN) @@ -460,9 +460,9 @@ class AuiDefaultDockArt(object): """ Draws the pane border. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; - :param Rect `rect`: the border rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; + :param wx.Rect `rect`: the border rectangle; :param `pane`: the pane for which the border is drawn. """ @@ -499,8 +499,8 @@ class AuiDefaultDockArt(object): """ Draws the text caption background in the pane. - :param `dc`: a :class:`DC` device context; - :param Rect `rect`: the text caption rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param wx.Rect `rect`: the text caption rectangle; :param `pane`: the pane for which the text background is drawn. """ @@ -546,8 +546,8 @@ class AuiDefaultDockArt(object): """ Draws the icon in the pane caption area. - :param `dc`: a :class:`DC` device context; - :param Rect `rect`: the pane caption rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which the icon is drawn. """ @@ -564,10 +564,10 @@ class AuiDefaultDockArt(object): """ Draws the text in the pane caption. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param string `text`: the text to be displayed; - :param Rect `rect`: the pane caption rectangle; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which the text is drawn. """ @@ -615,10 +615,10 @@ class AuiDefaultDockArt(object): """ Requests the user attention by intermittently highlighting the pane caption. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param string `text`: the text to be displayed; - :param Rect `rect`: the pane caption rectangle; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which we want to attract the user attention. """ @@ -644,9 +644,9 @@ class AuiDefaultDockArt(object): """ Draws a gripper on the pane. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; - :param Rect `rect`: the pane caption rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which the gripper is drawn. """ @@ -691,11 +691,11 @@ class AuiDefaultDockArt(object): """ Draws a pane button in the pane caption area. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param integer `button`: the button to be drawn; :param integer `button_state`: the pane button state; - :param Rect `_rect`: the pane caption rectangle; + :param wx.Rect `_rect`: the pane caption rectangle; :param `pane`: the pane for which the button is drawn. """ @@ -779,9 +779,9 @@ class AuiDefaultDockArt(object): """ Draws a sash gripper on a sash between two windows. - :param `dc`: a :class:`DC` device context; + :param `dc`: a :class:`wx.DC` device context; :param integer `orient`: the sash orientation; - :param Rect `rect`: the sash rectangle. + :param wx.Rect `rect`: the sash rectangle. """ dc.SetBrush(self._gripper_brush) @@ -864,7 +864,7 @@ class AuiDefaultDockArt(object): """ Sets a custom button bitmap for the pane button. - :param Bitmap `bmp`: the actual bitmap to set; + :param wx.Bitmap `bmp`: the actual bitmap to set; :param integer `button`: the button identifier; :param bool `active`: whether it is the bitmap for the active button or not; :param bool `maximize`: used to distinguish between the maximize and restore bitmaps. @@ -913,7 +913,7 @@ if _ctypes: _fields_ = [('left', ctypes.c_ulong),('top', ctypes.c_ulong),('right', ctypes.c_ulong),('bottom', ctypes.c_ulong)] def dump(self): - """ Dumps `self` as a :class:`Rect`. """ + """ Dumps `self` as a :class:`wx.Rect`. """ return list(map(int, (self.left, self.top, self.right, self.bottom))) @@ -937,7 +937,7 @@ class ModernDockArt(AuiDefaultDockArt): """ Default class constructor. - :param Window `win`: the window managed by :class:`~lib.agw.aui.framemanager.AuiManager`. + :param wx.Window `win`: the window managed by :class:`~lib.agw.aui.framemanager.AuiManager`. """ AuiDefaultDockArt.__init__(self) @@ -982,10 +982,10 @@ class ModernDockArt(AuiDefaultDockArt): """ Draws the text in the pane caption. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param string `text`: the text to be displayed; - :param Rect `rect`: the pane caption rectangle; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which the text is drawn. """ @@ -1040,8 +1040,8 @@ class ModernDockArt(AuiDefaultDockArt): """ Draws the text caption background in the pane. - :param `dc`: a :class:`DC` device context; - :param Rect `rect`: the text caption rectangle; + :param `dc`: a :class:`wx.DC` device context; + :param wx.Rect `rect`: the text caption rectangle; :param `pane`: the pane for which we are drawing the caption background. """ @@ -1080,10 +1080,10 @@ class ModernDockArt(AuiDefaultDockArt): """ Requests the user attention by intermittently highlighting the pane caption. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param string `text`: the text to be displayed; - :param Rect `rect`: the pane caption rectangle; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which the text is drawn. """ @@ -1109,11 +1109,11 @@ class ModernDockArt(AuiDefaultDockArt): """ Draws a pane button in the pane caption area. - :param `dc`: a :class:`DC` device context; - :param `window`: an instance of :class:`Window`; + :param `dc`: a :class:`wx.DC` device context; + :param `window`: an instance of :class:`wx.Window`; :param integer `button`: the button to be drawn; :param integer `button_state`: the pane button state; - :param Rect `rect`: the pane caption rectangle; + :param wx.Rect `rect`: the pane caption rectangle; :param `pane`: the pane for which the button is drawn. """ diff --git a/wx/lib/agw/aui/framemanager.py b/wx/lib/agw/aui/framemanager.py index 67d5040d..48e09b20 100644 --- a/wx/lib/agw/aui/framemanager.py +++ b/wx/lib/agw/aui/framemanager.py @@ -35,7 +35,7 @@ Description `framemanager.py` is the central module of the AUI class framework. -:class:`AuiManager` manages the panes associated with it for a particular :class:`Frame`, using +:class:`AuiManager` manages the panes associated with it for a particular :class:`wx.Frame`, using a pane's :class:`AuiPaneInfo` information to determine each pane's docking and floating behavior. AuiManager uses wxPython' sizer mechanism to plan the layout of each frame. It uses a replaceable dock art class to do all drawing, so all drawing is localized @@ -386,9 +386,9 @@ class AuiManagerEvent(wx.PyCommandEvent): def SetDC(self, pdc): """ - Associates a :class:`DC` device context to this event. + Associates a :class:`wx.DC` device context to this event. - :param `pdc`: a :class:`DC` device context object. + :param `pdc`: a :class:`wx.DC` device context object. """ self.dc = pdc @@ -421,7 +421,7 @@ class AuiManagerEvent(wx.PyCommandEvent): def GetDC(self): - """ Returns the associated :class:`DC` device context (if any). """ + """ Returns the associated :class:`wx.DC` device context (if any). """ return self.dc @@ -866,13 +866,13 @@ class AuiPaneInfo(object): def Window(self, w): """ - Associate a :class:`Window` derived window to this pane. + Associate a :class:`wx.Window` derived window to this pane. This normally does not need to be specified, as the window pointer is automatically assigned to the :class:`AuiPaneInfo` structure as soon as it is added to the manager. - :param `w`: a :class:`Window` derived window. + :param `w`: a :class:`wx.Window` derived window. """ self.window = w @@ -1045,9 +1045,9 @@ class AuiPaneInfo(object): Sets the minimum size of the pane. This method is split in 2 versions depending on the input type. If `arg1` is - a :class:`Size` object, then :meth:`~AuiPaneInfo.MinSize1` is called. Otherwise, :meth:`~AuiPaneInfo.MinSize2` is called. + a :class:`wx.Size` object, then :meth:`~AuiPaneInfo.MinSize1` is called. Otherwise, :meth:`~AuiPaneInfo.MinSize2` is called. - :param `arg1`: a :class:`Size` object, a (x, y) tuple or or a `x` coordinate. + :param `arg1`: a :class:`wx.Size` object, a (x, y) tuple or or a `x` coordinate. :param `arg2`: a `y` coordinate (only if `arg1` is a `x` coordinate, otherwise unused). """ @@ -1089,9 +1089,9 @@ class AuiPaneInfo(object): Sets the maximum size of the pane. This method is split in 2 versions depending on the input type. If `arg1` is - a :class:`Size` object, then :meth:`~AuiPaneInfo.MaxSize1` is called. Otherwise, :meth:`~AuiPaneInfo.MaxSize2` is called. + a :class:`wx.Size` object, then :meth:`~AuiPaneInfo.MaxSize1` is called. Otherwise, :meth:`~AuiPaneInfo.MaxSize2` is called. - :param `arg1`: a :class:`Size` object, a (x, y) tuple or a `x` coordinate. + :param `arg1`: a :class:`wx.Size` object, a (x, y) tuple or a `x` coordinate. :param `arg2`: a `y` coordinate (only if `arg1` is a `x` coordinate, otherwise unused). """ @@ -1135,9 +1135,9 @@ class AuiPaneInfo(object): this size as much as possible when docking or floating the pane. This method is split in 2 versions depending on the input type. If `arg1` is - a :class:`Size` object, then :meth:`BestSize1` is called. Otherwise, :meth:`BestSize2` is called. + a :class:`wx.Size` object, then :meth:`BestSize1` is called. Otherwise, :meth:`BestSize2` is called. - :param `arg1`: a :class:`Size` object, a (x, y) tuple or a `x` coordinate. + :param `arg1`: a :class:`wx.Size` object, a (x, y) tuple or a `x` coordinate. :param `arg2`: a `y` coordinate (only if `arg1` is a `x` coordinate, otherwise unused). """ @@ -1179,7 +1179,7 @@ class AuiPaneInfo(object): """ Sets the position of the floating pane. - :param `pos`: a :class:`Point` or a tuple indicating the pane floating position. + :param `pos`: a :class:`wx.Point` or a tuple indicating the pane floating position. """ self.floating_pos = wx.Point(*pos) @@ -1190,7 +1190,7 @@ class AuiPaneInfo(object): """ Sets the size of the floating pane. - :param `size`: a :class:`Size` or a tuple indicating the pane floating size. + :param `size`: a :class:`wx.Size` or a tuple indicating the pane floating size. """ self.floating_size = wx.Size(*size) @@ -1887,9 +1887,9 @@ class AuiDockingGuide(wx.Frame): :param `parent`: the :class:`AuiManager` parent; :param integer `id`: the window identifier. It may take a value of -1 to indicate a default value. :param string `title`: the caption to be displayed on the frame's title bar. - :param Point `pos`: the window position. A value of (-1, -1) indicates a default position, + :param wx.Point `pos`: the window position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform. - :param Size `size`: the window size. A value of (-1, -1) indicates a default size, chosen by + :param wx.Size `size`: the window size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform. :param integer `style`: the window style. :param string `name`: the name of the window. This parameter is used to associate a name with the @@ -1936,7 +1936,7 @@ class AuiDockingGuideWindow(wx.Window): Default class constructor. Used internally, do not call it in your code! :param `parent`: the :class:`AuiManager` parent; - :param Rect `rect`: the window rect; + :param wx.Rect `rect`: the window rect; :param integer `direction`: one of ``wx.TOP``, ``wx.BOTTOM``, ``wx.LEFT``, ``wx.RIGHT``, ``wx.CENTER``; :param bool `center`: whether the calling class is a :class:`AuiCenterDockingGuide`; @@ -1992,7 +1992,7 @@ class AuiDockingGuideWindow(wx.Window): """ Draws the docking guide background. - :param `dc`: a :class:`DC` device context object. + :param `dc`: a :class:`wx.DC` device context object. """ rect = self.GetClientRect() @@ -2031,8 +2031,8 @@ class AuiDockingGuideWindow(wx.Window): """ Draws a dotted line (not used if the docking guide images are ok). - :param `dc`: a :class:`DC` device context object; - :param `point`: a :class:`Point` where to start drawing the dotted line; + :param `dc`: a :class:`wx.DC` device context object; + :param `point`: a :class:`wx.Point` where to start drawing the dotted line; :param integer `length`: the length of the dotted line; :param bool `vertical`: whether it is a vertical docking guide window or not. """ @@ -2049,7 +2049,7 @@ class AuiDockingGuideWindow(wx.Window): """ Draws the docking guide icon (not used if the docking guide images are ok). - :param `dc`: a :class:`DC` device context object. + :param `dc`: a :class:`wx.DC` device context object. """ rect = wx.Rect(*self.GetClientRect()) @@ -2119,7 +2119,7 @@ class AuiDockingGuideWindow(wx.Window): """ Draws the docking guide arrow icon (not used if the docking guide images are ok). - :param `dc`: a :class:`DC` device context object. + :param `dc`: a :class:`wx.DC` device context object. """ rect = self.GetClientRect() @@ -2176,7 +2176,7 @@ class AuiDockingGuideWindow(wx.Window): """ Draws the whole docking guide window (not used if the docking guide images are ok). - :param `dc`: a :class:`DC` device context object. + :param `dc`: a :class:`wx.DC` device context object. """ self.DrawBackground(dc) @@ -2192,7 +2192,7 @@ class AuiDockingGuideWindow(wx.Window): images if the mouse is inside the docking guide or unfocused images if it is outside. - :param `pos`: a :class:`Point` mouse position. + :param `pos`: a :class:`wx.Point` mouse position. """ inside = self.GetScreenRect().Contains(pos) @@ -2301,7 +2301,7 @@ class AuiSingleDockingGuide(AuiDockingGuide): """ Moves the docking window to the new position. Overridden in children classes. - :param Point `pos`: the new docking guide position. + :param wx.Point `pos`: the new docking guide position. """ pass @@ -2311,7 +2311,7 @@ class AuiSingleDockingGuide(AuiDockingGuide): """ Sets the correct shape for the docking guide window. - :param `event`: on wxGTK, a :class:`WindowCreateEvent` event to process. + :param `event`: on wxGTK, a :class:`wx.WindowCreateEvent` event to process. """ self.SetShape(self.region) @@ -2363,7 +2363,7 @@ class AuiSingleDockingGuide(AuiDockingGuide): images if the mouse is inside the docking guide or unfocused images if it is outside. - :param Point `pos`: the mouse position. + :param wx.Point `pos`: the mouse position. """ self.target.UpdateDockGuide(pos) @@ -2518,7 +2518,7 @@ class AuiCenterDockingGuide(AuiDockingGuide): """ Sets the correct shape for the docking guide window. - :param `event`: on wxGTK, a :class:`WindowCreateEvent` event to process. + :param `event`: on wxGTK, a :class:`wx.WindowCreateEvent` event to process. """ self.SetShape(self.region) @@ -2535,7 +2535,7 @@ class AuiCenterDockingGuide(AuiDockingGuide): images if the mouse is inside the docking guide or unfocused images if it is outside. - :param Point `pos`: the mouse position. + :param wx.Point `pos`: the mouse position. """ if not self._useAero: @@ -2613,7 +2613,7 @@ class AuiCenterDockingGuide(AuiDockingGuide): """ Moves the docking guide window to the new position. - :param Point `pos`: the new docking guide position. + :param wx.Point `pos`: the new docking guide position. """ if not self._useAero: @@ -2702,9 +2702,9 @@ class AuiDockingHintWindow(wx.Frame): :param `parent`: the :class:`AuiManager` parent; :param integer `id`: the window identifier. It may take a value of -1 to indicate a default value. :param string `title`: the caption to be displayed on the frame's title bar; - :param Point `pos`: the window position. A value of (-1, -1) indicates a default position, + :param wx.Point `pos`: the window position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform; - :param Size `size`: the window size. A value of (-1, -1) indicates a default size, chosen by + :param wx.Size `size`: the window size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the window style; :param string `name`: the name of the window. This parameter is used to associate a name with the @@ -2826,7 +2826,7 @@ class AuiDockingHintWindow(wx.Frame): """ Handles the ``wx.EVT_SIZE`` event for :class:`AuiDockingHintWindow`. - :param `event`: a :class:`SizeEvent` to be processed. + :param `event`: a :class:`wx.SizeEvent` to be processed. """ if self._blindMode or not self.CanSetTransparent(): @@ -3087,7 +3087,7 @@ class AuiFloatingFrame(wx.MiniFrame): """ Handles the ``wx.EVT_SIZE`` event for :class:`AuiFloatingFrame`. - :param `event`: a :class:`SizeEvent` to be processed. + :param `event`: a :class:`wx.SizeEvent` to be processed. """ if self._owner_mgr and self._send_size: @@ -3292,7 +3292,7 @@ class AuiFloatingFrame(wx.MiniFrame): """ The user is moving the floating pane. - :param Rect `rect`: the pane client rectangle; + :param wx.Rect `rect`: the pane client rectangle; :param integer `direction`: the direction in which the pane is moving, can be one of ``wx.NORTH``, ``wx.SOUTH``, ``wx.EAST`` or ``wx.WEST``. @@ -3445,7 +3445,7 @@ def DrawResizeHint(dc, rect): """ Draws a resize hint while a sash is dragged. - :param Rect `rect`: a rectangle which specifies the sash dimensions. + :param wx.Rect `rect`: a rectangle which specifies the sash dimensions. """ if wx.Platform == "__WXMSW__" and wx.App.GetComCtl32Version() >= 600: @@ -3710,7 +3710,7 @@ def FindPaneInDock(dock, window): If found, the corresponding :class:`AuiDockInfo` pointer is returned, otherwise ``None``. :param `dock`: a :class:`AuiDockInfo` structure; - :param Window `window`: the window associated to the pane we are seeking. + :param wx.Window `window`: the window associated to the pane we are seeking. """ for p in dock.panes: @@ -3754,7 +3754,7 @@ def GetInternalFrameRect(window, docks): """ Returns the window rectangle excluding toolbars. - :param `window`: a :class:`Window` derived window; + :param `window`: a :class:`wx.Window` derived window; :param `docks`: a list of :class:`AuiDockInfo` structures. """ @@ -3778,8 +3778,8 @@ def CheckOutOfWindow(window, pt): """ Checks if a point is outside the window rectangle. - :param `window`: a :class:`Window` derived window; - :param `pt`: a :class:`Point` object. + :param `window`: a :class:`wx.Window` derived window; + :param `pt`: a :class:`wx.Point` object. """ auiWindowMargin = 30 @@ -3793,9 +3793,9 @@ def CheckEdgeDrop(window, docks, pt): """ Checks on which edge of a window the drop action has taken place. - :param `window`: a :class:`Window` derived window; + :param `window`: a :class:`wx.Window` derived window; :param `docks`: a list of :class:`AuiDockInfo` structures; - :param `pt`: a :class:`Point` object. + :param `pt`: a :class:`wx.Point` object. """ screenPt = window.ClientToScreen(pt) @@ -4023,7 +4023,7 @@ def GetManager(window): """ This function will return the aui manager for a given window. - :param Window `window`: this parameter should be any child window or grand-child + :param wx.Window `window`: this parameter should be any child window or grand-child window (and so on) of the frame/window managed by :class:`AuiManager`. The window does not need to be managed by the manager itself, nor does it even need to be a child or sub-child of a managed window. It must however be inside @@ -4048,7 +4048,7 @@ def GetManager(window): class AuiManager(wx.EvtHandler): """ - AuiManager manages the panes associated with it for a particular :class:`Frame`, + AuiManager manages the panes associated with it for a particular :class:`wx.Frame`, using a pane's :class:`AuiManager` information to determine each pane's docking and floating behavior. :class:`AuiManager` uses wxPython's sizer mechanism to plan the layout of each frame. It uses a replaceable dock art class to do all drawing, @@ -4109,7 +4109,7 @@ class AuiManager(wx.EvtHandler): """ Default class constructor. - :param Window `managed_window`: specifies the window which should be managed; + :param wx.Window `managed_window`: specifies the window which should be managed; :param integer `agwFlags`: specifies options which allow the frame management behavior to be modified. `agwFlags` can be a combination of the following style bits: @@ -4238,7 +4238,7 @@ class AuiManager(wx.EvtHandler): """ Creates a floating frame for the windows. - :param Window `parent`: the floating frame parent; + :param wx.Window `parent`: the floating frame parent; :param `pane_info`: the :class:`AuiPaneInfo` class with all the pane's information. """ @@ -4265,7 +4265,7 @@ class AuiManager(wx.EvtHandler): """ This version of :meth:`GetPane` looks up a pane based on a 'pane window'. - :param `window`: a :class:`Window` derived window. + :param `window`: a :class:`wx.Window` derived window. :see: :meth:`~AuiManager.GetPane` """ @@ -4302,7 +4302,7 @@ class AuiManager(wx.EvtHandler): The pane info's structure may then be modified. Once a pane's info is modified, :meth:`Update` must be called to realize the changes in the UI. - :param `item`: either a pane name or a :class:`Window`. + :param `item`: either a pane name or a :class:`wx.Window`. """ if isinstance(item, six.string_types): @@ -4321,7 +4321,7 @@ class AuiManager(wx.EvtHandler): """ Shows or hides a pane based on the window passed as input. - :param Window `window`: any subclass or derivation of :class:`Window`; + :param wx.Window `window`: any subclass or derivation of :class:`wx.Window`; :param bool `show`: ``True`` to show the pane, ``False`` otherwise. """ @@ -4384,7 +4384,7 @@ class AuiManager(wx.EvtHandler): input point belongs to. :param `panes`: a list of :class:`AuiPaneInfo` instances; - :param Point `pt`: the mouse position. + :param wx.Point `pt`: the mouse position. """ for paneInfo in panes: @@ -4459,7 +4459,7 @@ class AuiManager(wx.EvtHandler): Frame management is not restricted to just frames. Child windows or custom controls are also allowed. - :param Window `managed_window`: specifies the window which should be managed by + :param wx.Window `managed_window`: specifies the window which should be managed by the AUI manager. """ @@ -4511,7 +4511,7 @@ class AuiManager(wx.EvtHandler): Frame management is not restricted to just frames. Child windows or custom controls are also allowed. - :param Window `managed_window`: specifies the window which should be managed by + :param wx.Window `managed_window`: specifies the window which should be managed by the AUI manager. .. deprecated:: 0.6 @@ -4582,7 +4582,7 @@ class AuiManager(wx.EvtHandler): def UnInit(self): """ Uninitializes the framework and should be called before a managed frame or - window is destroyed. :meth:`UnInit` is usually called in the managed :class:`Frame` / :class:`Window` + window is destroyed. :meth:`UnInit` is usually called in the managed :class:`wx.Frame` / :class:`wx.Window` destructor. It is necessary to call this function before the managed frame or window is @@ -4698,9 +4698,9 @@ class AuiManager(wx.EvtHandler): In your code, simply call :meth:`AddPane`. - :param Window `window`: the child window to manage; + :param wx.Window `window`: the child window to manage; :param `arg1`: a :class:`AuiPaneInfo` or an integer value (direction); - :param `arg2`: a :class:`AuiPaneInfo` or a :class:`Point` (drop position); + :param `arg2`: a :class:`AuiPaneInfo` or a :class:`wx.Point` (drop position); :param `target`: a :class:`AuiPaneInfo` to be turned into a notebook and new pane added to it as a page. (additionally, target can be any pane in an existing notebook) @@ -4891,7 +4891,7 @@ class AuiManager(wx.EvtHandler): `insert_level` parameter is used to disambiguate this. The parameter `insert_level` can take a value of ``AUI_INSERT_PANE``, ``AUI_INSERT_ROW`` or ``AUI_INSERT_DOCK``. - :param Window `window`: the window to be inserted and managed; + :param wx.Window `window`: the window to be inserted and managed; :param `pane_info`: the insert location for the new window; :param integer `insert_level`: the insertion level of the new pane. """ @@ -4950,7 +4950,7 @@ class AuiManager(wx.EvtHandler): by `window`. The window, if in a floated frame, is reparented to the frame managed by :class:`AuiManager`. - :param Window `window`: the window to be un-managed. + :param wx.Window `window`: the window to be un-managed. """ for p in self._panes: @@ -5159,7 +5159,7 @@ class AuiManager(wx.EvtHandler): """ Activates the pane to which `window` is associated. - :param `window`: a :class:`Window` derived window. + :param `window`: a :class:`wx.Window` derived window. """ if self.GetAGWFlags() & AUI_MGR_ALLOW_ACTIVE_PANE: @@ -5611,7 +5611,7 @@ class AuiManager(wx.EvtHandler): """ Adds a pane into the existing layout (in an existing dock). - :param `cont`: a :class:`Sizer` object; + :param `cont`: a :class:`wx.Sizer` object; :param `dock`: the :class:`AuiDockInfo` structure in which to add the pane; :param `pane`: the :class:`AuiPaneInfo` instance to add to the dock; :param `uiparts`: a list of UI parts in the interface; @@ -5800,7 +5800,7 @@ class AuiManager(wx.EvtHandler): """ Adds a dock into the existing layout. - :param `cont`: a :class:`Sizer` object; + :param `cont`: a :class:`wx.Sizer` object; :param `dock`: the :class:`AuiDockInfo` structure to add to the layout; :param `uiparts`: a list of UI parts in the interface; :param bool `spacer_only`: whether to add a simple spacer or a real window. @@ -6875,7 +6875,7 @@ class AuiManager(wx.EvtHandler): def DoFrameLayout(self): """ - This is an internal function which invokes :meth:`Sizer.Layout() ` + This is an internal function which invokes :meth:`wx.Sizer.Layout() ` on the frame's main sizer, then measures all the various UI items and updates their internal rectangles. @@ -6924,7 +6924,7 @@ class AuiManager(wx.EvtHandler): pane specified. This allows the caller to get the exact rectangle of the pane in question, including decorations like caption and border. - :param Window `wnd`: the window to which the pane border belongs to. + :param wx.Window `wnd`: the window to which the pane border belongs to. """ for part in self._uiparts: @@ -7554,8 +7554,8 @@ class AuiManager(wx.EvtHandler): :param `docks`: a list of :class:`AuiDockInfo` classes; :param `panes`: a list of :class:`AuiPaneInfo` instances; - :param Point `pt`: a mouse position to check for a drop operation; - :param Point `offset`: a possible offset from the input point `pt`. + :param wx.Point `pt`: a mouse position to check for a drop operation; + :param wx.Point `offset`: a possible offset from the input point `pt`. """ if target.IsToolbar(): @@ -7608,8 +7608,8 @@ class AuiManager(wx.EvtHandler): :param `docks`: a list of :class:`AuiDockInfo` classes; :param `panes`: a list of :class:`AuiPaneInfo` instances; :param `target`: the target pane containing the toolbar, an instance of :class:`AuiPaneInfo`; - :param Point `pt`: a mouse position to check for a drop operation; - :param Point `offset`: a possible offset from the input point `pt`. + :param wx.Point `pt`: a mouse position to check for a drop operation; + :param wx.Point `offset`: a possible offset from the input point `pt`. """ drop = self.CopyTarget(target) @@ -7736,7 +7736,7 @@ class AuiManager(wx.EvtHandler): :param `panes`: a list of :class:`AuiPaneInfo` instances; :param `target`: the target pane containing the window, an instance of :class:`AuiPaneInfo`; - :param Point `pt`: a mouse position to check for a drop operation. + :param wx.Point `pt`: a mouse position to check for a drop operation. """ screenPt = self._frame.ClientToScreen(pt) @@ -7856,7 +7856,7 @@ class AuiManager(wx.EvtHandler): :param `docks`: a list of :class:`AuiDockInfo` classes; :param `panes`: a list of :class:`AuiPaneInfo` instances; :param `target`: the target pane containing the toolbar, an instance of :class:`AuiPaneInfo`; - :param Point `pt`: a mouse position to check for a drop operation. + :param wx.Point `pt`: a mouse position to check for a drop operation. """ screenPt = self._frame.ClientToScreen(pt) @@ -8086,7 +8086,7 @@ class AuiManager(wx.EvtHandler): """ Shows the AUI hint window. - :param Rect `rect`: the hint rect calculated in advance. + :param wx.Rect `rect`: the hint rect calculated in advance. """ if rect == self._last_hint: @@ -8190,9 +8190,9 @@ class AuiManager(wx.EvtHandler): """ Draws a pane button in the caption (convenience function). - :param `dc`: a :class:`DC` device context object; + :param `dc`: a :class:`wx.DC` device context object; :param `part`: the UI part to analyze, an instance of :class:`AuiDockUIPart`; - :param Point `pt`: the mouse location. + :param wx.Point `pt`: the mouse location. """ if not self.IsPaneButtonVisible(part): @@ -8247,9 +8247,9 @@ class AuiManager(wx.EvtHandler): specified drop point, the the rectangle hint will be returned in screen coordinates. Otherwise, an empty rectangle is returned. - :param Window `pane_window`: it is the window pointer of the pane being dragged; - :param Point `pt`: is the mouse position, in client coordinates; - :param Point `offset`: describes the offset that the mouse is from the upper-left + :param wx.Window `pane_window`: it is the window pointer of the pane being dragged; + :param wx.Point `pt`: is the mouse position, in client coordinates; + :param wx.Point `offset`: describes the offset that the mouse is from the upper-left corner of the item being dragged. """ @@ -8341,9 +8341,9 @@ class AuiManager(wx.EvtHandler): rectangle, it shows it by calling :meth:`ShowHint`, otherwise it hides any hint rectangle currently shown. - :param Window `pane_window`: it is the window pointer of the pane being dragged; - :param Point `pt`: is the mouse position, in client coordinates; - :param Point `offset`: describes the offset that the mouse is from the upper-left + :param wx.Window `pane_window`: it is the window pointer of the pane being dragged; + :param wx.Point `pt`: is the mouse position, in client coordinates; + :param wx.Point `offset`: describes the offset that the mouse is from the upper-left corner of the item being dragged. """ @@ -8431,8 +8431,8 @@ class AuiManager(wx.EvtHandler): """ Handles the resizing of a floating pane. - :param Window `wnd`: the window managed by the pane; - :param Size `size`: the new pane floating size. + :param wx.Window `wnd`: the window managed by the pane; + :param wx.Size `size`: the new pane floating size. """ # try to find the pane @@ -8453,7 +8453,7 @@ class AuiManager(wx.EvtHandler): """ Handles the close event of a floating pane. - :param Window `wnd`: the window managed by the pane; + :param wx.Window `wnd`: the window managed by the pane; :param `event`: a :class:`CloseEvent` to be processed. """ @@ -8485,7 +8485,7 @@ class AuiManager(wx.EvtHandler): """ Handles the activation event of a floating pane. - :param Window `wnd`: the window managed by the pane. + :param wx.Window `wnd`: the window managed by the pane. """ pane = self.GetPane(wnd) @@ -8502,8 +8502,8 @@ class AuiManager(wx.EvtHandler): """ Handles the move event of a floating pane. - :param Window `wnd`: the window managed by the pane; - :param `eventOrPt`: a :class:`MoveEvent` to be processed or an instance of :class:`Point`. + :param wx.Window `wnd`: the window managed by the pane; + :param `eventOrPt`: a :class:`MoveEvent` to be processed or an instance of :class:`wx.Point`. """ pane = self.GetPane(wnd) @@ -8528,8 +8528,8 @@ class AuiManager(wx.EvtHandler): Snaps a floating pane to one of the main frame sides. :param `pane`: a :class:`AuiPaneInfo` instance; - :param Point `pane_pos`: the new pane floating position; - :param Size `pane_size`: the new pane floating size; + :param wx.Point `pane_pos`: the new pane floating position; + :param wx.Size `pane_size`: the new pane floating size; :param bool `toSnap`: a bool variable to check if :meth:`SnapPane` was called from a move event. """ @@ -8577,8 +8577,8 @@ class AuiManager(wx.EvtHandler): Repositions a pane after the main frame has been moved/resized. :param `pane`: a :class:`AuiPaneInfo` instance; - :param Point `wnd_pos`: the main frame position; - :param Size `wnd_size`: the main frame size. + :param wx.Point `wnd_pos`: the main frame position; + :param wx.Size `wnd_size`: the main frame size. """ pane_pos = pane.floating_pos @@ -8606,9 +8606,9 @@ class AuiManager(wx.EvtHandler): """ Handles the mouse click on the pane gripper. - :param Window `pane_window`: the window managed by the pane; - :param Point `start`: the mouse-click position; - :param Point `offset`: an offset point from the `start` position. + :param wx.Window `pane_window`: the window managed by the pane; + :param wx.Point `start`: the mouse-click position; + :param wx.Point `offset`: an offset point from the `start` position. """ # try to find the pane @@ -8743,7 +8743,7 @@ class AuiManager(wx.EvtHandler): Default behavior can be invoked in the overridden function by calling :meth:`OnRender`. - :param `dc`: a :class:`DC` device context object. + :param `dc`: a :class:`wx.DC` device context object. """ e = AuiManagerEvent(wxEVT_AUI_RENDER) @@ -8756,7 +8756,7 @@ class AuiManager(wx.EvtHandler): """ Handles the mouse double click on the pane caption. - :param Window `pane_window`: the window managed by the pane. + :param wx.Window `pane_window`: the window managed by the pane. """ # try to find the pane @@ -8849,7 +8849,7 @@ class AuiManager(wx.EvtHandler): """ Handles the ``wx.EVT_SIZE`` event for :class:`AuiManager`. - :param `event`: a :class:`SizeEvent` to be processed. + :param `event`: a :class:`wx.SizeEvent` to be processed. """ skipped = False @@ -10338,8 +10338,8 @@ class AuiManager(wx.EvtHandler): Animates the minimization/docking of a pane a la Eclipse, using a :class:`ScreenDC` to draw a "moving docking rectangle" on the screen. - :param Rect `win_rect`: the original pane screen rectangle; - :param Rect `pane_rect`: the newly created toolbar/pane screen rectangle. + :param wx.Rect `win_rect`: the original pane screen rectangle; + :param wx.Rect `pane_rect`: the newly created toolbar/pane screen rectangle. :note: This functionality is not available on wxMAC as this platform doesn't have the ability to use :class:`ScreenDC` to draw on-screen and on Windows > Vista. @@ -10522,7 +10522,7 @@ class AuiManager(wx.EvtHandler): """ Requests the user attention by intermittently highlighting the pane caption. - :param Window `pane_window`: the window managed by the pane; + :param wx.Window `pane_window`: the window managed by the pane; """ # try to find the pane diff --git a/wx/lib/agw/aui/tabart.py b/wx/lib/agw/aui/tabart.py index 7bb33ec7..30a6faf5 100644 --- a/wx/lib/agw/aui/tabart.py +++ b/wx/lib/agw/aui/tabart.py @@ -87,14 +87,14 @@ class AuiCommandCapture(wx.EvtHandler): 1. If the object is disabled (via a call to :meth:`EvtHandler.SetEvtHandlerEnabled`) the function skips to step (6). - 2. If the object is a :class:`Window`, :meth:`ProcessEvent` is recursively called on the window's - :class:`Validator`. If this returns ``True``, the function exits. + 2. If the object is a :class:`wx.Window`, :meth:`ProcessEvent` is recursively called on the window's + :class:`wx.Validator`. If this returns ``True``, the function exits. 3. wxWidgets `SearchEventTable` is called for this event handler. If this fails, the base class table is tried, and so on until no more tables exist or an appropriate function was found, in which case the function exits. 4. The search is applied down the entire chain of event handlers (usually the chain has a length of one). If this succeeds, the function exits. - 5. If the object is a :class:`Window` and the event is a :class:`CommandEvent`, :meth:`ProcessEvent` is + 5. If the object is a :class:`wx.Window` and the event is a :class:`CommandEvent`, :meth:`ProcessEvent` is recursively applied to the parent window's event handler. If this returns ``True``, the function exits. 6. Finally, :meth:`ProcessEvent` is called on the :class:`App` object. @@ -281,7 +281,7 @@ class AuiDefaultTabArt(object): """ Sets the tab sizing information. - :param Size `tab_ctrl_size`: the size of the tab control area; + :param wx.Size `tab_ctrl_size`: the size of the tab control area; :param integer `tab_count`: the number of tabs; :param tuple `minMaxTabWidth`: a tuple containing the minimum and maximum tab widths to be used when the ``AUI_NB_TAB_FIXED_WIDTH`` style is active. @@ -322,9 +322,9 @@ class AuiDefaultTabArt(object): """ Draws the tab area background. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; - :param Rect `rect`: the tab control rectangle. + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; + :param wx.Rect `rect`: the tab control rectangle. """ self._buttonRect = wx.Rect() @@ -363,10 +363,10 @@ class AuiDefaultTabArt(object): """ Draws a single tab. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param `page`: the tab control page associated with the tab; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param integer `close_button_state`: the state of the close button on the tab; :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`. """ @@ -632,7 +632,7 @@ class AuiDefaultTabArt(object): :param integer `bitmap_id`: the button identifier; :param integer `button_state`: the button state; - :param Bitmap `bmp`: the custom bitmap to use for the button. + :param wx.Bitmap `bmp`: the custom bitmap to use for the button. """ if bitmap_id == AUI_BUTTON_CLOSE: @@ -678,13 +678,13 @@ class AuiDefaultTabArt(object): """ Returns the tab size for the given caption, bitmap and button state. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param string `caption`: the tab text caption; - :param Bitmap `bitmap`: the bitmap displayed on the tab; + :param wx.Bitmap `bitmap`: the bitmap displayed on the tab; :param bool `active`: whether the tab is selected or not; :param integer `close_button_state`: the state of the close button on the tab; - :param Window `control`: a :class:`Window` instance inside a tab (or ``None``). + :param wx.Window `control`: a :class:`wx.Window` instance inside a tab (or ``None``). """ dc.SetFont(self._measuring_font) @@ -724,9 +724,9 @@ class AuiDefaultTabArt(object): """ Draws a button on the tab or on the tab area, depending on the button identifier. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param `button`: an instance of the button class; :param integer `orientation`: the tab orientation. """ @@ -800,9 +800,9 @@ class AuiDefaultTabArt(object): """ Draws the focus rectangle on a tab. - :param `dc`: a :class:`DC` device context; + :param `dc`: a :class:`wx.DC` device context; :param `page`: the page associated with the tab; - :param `wnd`: a :class:`Window` instance object; + :param `wnd`: a :class:`wx.Window` instance object; :param string `draw_text`: the text that has been drawn on the tab; :param integer `text_offset`: the text offset on the tab; :param integer `bitmap_offset`: the bitmap offset on the tab; @@ -842,9 +842,9 @@ class AuiDefaultTabArt(object): """ Returns the best tab control size. - :param `wnd`: a :class:`Window` instance object; + :param `wnd`: a :class:`wx.Window` instance object; :param list `pages`: the pages associated with the tabs; - :param Size `required_bmp_size`: the size of the bitmap on the tabs. + :param wx.Size `required_bmp_size`: the size of the bitmap on the tabs. """ dc = wx.ClientDC(wnd) @@ -886,7 +886,7 @@ class AuiDefaultTabArt(object): """ Sets the normal font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their normal, un-selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their normal, un-selected state. """ self._normal_font = font @@ -896,7 +896,7 @@ class AuiDefaultTabArt(object): """ Sets the selected tab font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their selected state. """ self._selected_font = font @@ -906,7 +906,7 @@ class AuiDefaultTabArt(object): """ Sets the font for calculating text measurements. - :param Font `font`: the new font to use to measure tab labels text extents. + :param wx.Font `font`: the new font to use to measure tab labels text extents. """ self._measuring_font = font @@ -934,7 +934,7 @@ class AuiDefaultTabArt(object): """ Shows the drop-down window menu on the tab area. - :param `wnd`: a :class:`Window` derived window instance; + :param `wnd`: a :class:`wx.Window` derived window instance; :param list `pages`: the pages associated with the tabs; :param integer `active_idx`: the active tab index. """ @@ -1109,7 +1109,7 @@ class AuiSimpleTabArt(object): """ Sets the tab sizing information. - :param Size `tab_ctrl_size`: the size of the tab control area; + :param wx.Size `tab_ctrl_size`: the size of the tab control area; :param integer `tab_count`: the number of tabs; :param tuple `minMaxTabWidth`: a tuple containing the minimum and maximum tab widths to be used when the ``AUI_NB_TAB_FIXED_WIDTH`` style is active. @@ -1149,9 +1149,9 @@ class AuiSimpleTabArt(object): """ Draws the tab area background. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; - :param Rect `rect`: the tab control rectangle. + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; + :param wx.Rect `rect`: the tab control rectangle. """ # draw background @@ -1168,10 +1168,10 @@ class AuiSimpleTabArt(object): """ Draws a single tab. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param `page`: the tab control page associated with the tab; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param integer `close_button_state`: the state of the close button on the tab; :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`. """ @@ -1346,10 +1346,10 @@ class AuiSimpleTabArt(object): """ Convenience method to draw tab buttons. - :param `dc`: a :class:`DC` device context; - :param Rect `_rect`: the tab rectangle; - :param Bitmap `bmp`: the tab bitmap; - :param Colour `bkcolour`: the tab background colour; + :param `dc`: a :class:`wx.DC` device context; + :param wx.Rect `_rect`: the tab rectangle; + :param wx.Bitmap `bmp`: the tab bitmap; + :param wx.Colour `bkcolour`: the tab background colour; :param integer `button_state`: the state of the tab button. """ @@ -1380,13 +1380,13 @@ class AuiSimpleTabArt(object): """ Returns the tab size for the given caption, bitmap and button state. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param string `caption`: the tab text caption; - :param Bitmap `bitmap`: the bitmap displayed on the tab; + :param wx.Bitmap `bitmap`: the bitmap displayed on the tab; :param bool `active`: whether the tab is selected or not; :param integer `close_button_state`: the state of the close button on the tab; - :param Window `control`: a :class:`Window` instance inside a tab (or ``None``). + :param wx.Window `control`: a :class:`wx.Window` instance inside a tab (or ``None``). """ dc.SetFont(self._measuring_font) @@ -1414,9 +1414,9 @@ class AuiSimpleTabArt(object): """ Draws a button on the tab or on the tab area, depending on the button identifier. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param `button`: an instance of the button class; :param integer `orientation`: the tab orientation. """ @@ -1481,7 +1481,7 @@ class AuiSimpleTabArt(object): """ Shows the drop-down window menu on the tab area. - :param `wnd`: a :class:`Window` derived window instance; + :param `wnd`: a :class:`wx.Window` derived window instance; :param list `pages`: the pages associated with the tabs; :param integer `active_idx`: the active tab index. """ @@ -1538,9 +1538,9 @@ class AuiSimpleTabArt(object): """ Returns the best tab control size. - :param `wnd`: a :class:`Window` instance object; + :param `wnd`: a :class:`wx.Window` instance object; :param list `pages`: the pages associated with the tabs; - :param Size `required_bmp_size`: the size of the bitmap on the tabs. + :param wx.Size `required_bmp_size`: the size of the bitmap on the tabs. """ dc = wx.ClientDC(wnd) @@ -1565,7 +1565,7 @@ class AuiSimpleTabArt(object): """ Sets the normal font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their normal, un-selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their normal, un-selected state. """ self._normal_font = font @@ -1575,7 +1575,7 @@ class AuiSimpleTabArt(object): """ Sets the selected tab font for drawing tab labels. - :param Font `font`: the new font to use to draw tab labels in their selected state. + :param wx.Font `font`: the new font to use to draw tab labels in their selected state. """ self._selected_font = font @@ -1585,7 +1585,7 @@ class AuiSimpleTabArt(object): """ Sets the font for calculating text measurements. - :param Font `font`: the new font to use to measure tab labels text extents. + :param wx.Font `font`: the new font to use to measure tab labels text extents. """ self._measuring_font = font @@ -1615,7 +1615,7 @@ class AuiSimpleTabArt(object): :param integer `bitmap_id`: the button identifier; :param integer `button_state`: the button state; - :param Bitmap `bmp`: the custom bitmap to use for the button. + :param wx.Bitmap `bmp`: the custom bitmap to use for the button. """ if bitmap_id == AUI_BUTTON_CLOSE: @@ -1676,10 +1676,10 @@ class VC71TabArt(AuiDefaultTabArt): """ Draws a single tab. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param `page`: the tab control page associated with the tab; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param integer `close_button_state`: the state of the close button on the tab; :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`. """ @@ -1896,13 +1896,13 @@ class FF2TabArt(AuiDefaultTabArt): """ Returns the tab size for the given caption, bitmap and button state. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param string `caption`: the tab text caption; - :param Bitmap `bitmap`: the bitmap displayed on the tab; + :param wx.Bitmap `bitmap`: the bitmap displayed on the tab; :param bool `active`: whether the tab is selected or not; :param integer `close_button_state`: the state of the close button on the tab; - :param Window `control`: a :class:`Window` instance inside a tab (or ``None``). + :param wx.Window `control`: a :class:`wx.Window` instance inside a tab (or ``None``). """ tab_size, x_extent = AuiDefaultTabArt.GetTabSize(self, dc, wnd, caption, bitmap, @@ -1920,10 +1920,10 @@ class FF2TabArt(AuiDefaultTabArt): """ Draws a single tab. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param `page`: the tab control page associated with the tab; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param integer `close_button_state`: the state of the close button on the tab; :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`. """ @@ -2112,8 +2112,8 @@ class FF2TabArt(AuiDefaultTabArt): Draws the tab background for the Firefox 2 style. This is more consistent with :class:`~lib.agw.flatnotebook.FlatNotebook` than before. - :param `dc`: a :class:`DC` device context; - :param Rect `rect`: rectangle the tab should be confined to; + :param `dc`: a :class:`wx.DC` device context; + :param wx.Rect `rect`: rectangle the tab should be confined to; :param bool `focus`: whether the tab has focus or not; :param bool `upperTabs`: whether the style is ``AUI_NB_TOP`` or ``AUI_NB_BOTTOM``. """ @@ -2191,7 +2191,7 @@ class VC8TabArt(AuiDefaultTabArt): """ Sets the tab sizing information. - :param Size `tab_ctrl_size`: the size of the tab control area; + :param wx.Size `tab_ctrl_size`: the size of the tab control area; :param integer `tab_count`: the number of tabs; :param tuple `minMaxTabWidth`: a tuple containing the minimum and maximum tab widths to be used when the ``AUI_NB_TAB_FIXED_WIDTH`` style is active. @@ -2212,13 +2212,13 @@ class VC8TabArt(AuiDefaultTabArt): """ Returns the tab size for the given caption, bitmap and button state. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param string `caption`: the tab text caption; - :param Bitmap `bitmap`: the bitmap displayed on the tab; + :param wx.Bitmap `bitmap`: the bitmap displayed on the tab; :param bool `active`: whether the tab is selected or not; :param integer `close_button_state`: the state of the close button on the tab; - :param Window `control`: a :class:`Window` instance inside a tab (or ``None``). + :param wx.Window `control`: a :class:`wx.Window` instance inside a tab (or ``None``). """ tab_size, x_extent = AuiDefaultTabArt.GetTabSize(self, dc, wnd, caption, bitmap, @@ -2241,10 +2241,10 @@ class VC8TabArt(AuiDefaultTabArt): """ Draws a single tab. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param `page`: the tab control page associated with the tab; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param integer `close_button_state`: the state of the close button on the tab; :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`. """ @@ -2451,8 +2451,8 @@ class VC8TabArt(AuiDefaultTabArt): """ Fills the tab with the Visual Studio 2005 gradient background. - :param `dc`: a :class:`DC` device context; - :param list `tabPoints`: a list of :class:`Point` objects describing the tab shape; + :param `dc`: a :class:`wx.DC` device context; + :param list `tabPoints`: a list of :class:`wx.Point` objects describing the tab shape; :param bool `active`: whether the tab is selected or not. """ @@ -2591,7 +2591,7 @@ class ChromeTabArt(AuiDefaultTabArt): """ Sets the tab sizing information. - :param Size `tab_ctrl_size`: the size of the tab control area; + :param wx.Size `tab_ctrl_size`: the size of the tab control area; :param integer `tab_count`: the number of tabs; :param tuple `minMaxTabWidth`: a tuple containing the minimum and maximum tab widths to be used when the ``AUI_NB_TAB_FIXED_WIDTH`` style is active. @@ -2612,13 +2612,13 @@ class ChromeTabArt(AuiDefaultTabArt): """ Returns the tab size for the given caption, bitmap and button state. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param string `caption`: the tab text caption; - :param Bitmap `bitmap`: the bitmap displayed on the tab; + :param wx.Bitmap `bitmap`: the bitmap displayed on the tab; :param bool `active`: whether the tab is selected or not; :param integer `close_button_state`: the state of the close button on the tab; - :param Window `control`: a :class:`Window` instance inside a tab (or ``None``). + :param wx.Window `control`: a :class:`wx.Window` instance inside a tab (or ``None``). """ tab_size, x_extent = AuiDefaultTabArt.GetTabSize(self, dc, wnd, caption, bitmap, @@ -2639,10 +2639,10 @@ class ChromeTabArt(AuiDefaultTabArt): """ Draws a single tab. - :param `dc`: a :class:`DC` device context; - :param `wnd`: a :class:`Window` instance object; + :param `dc`: a :class:`wx.DC` device context; + :param `wnd`: a :class:`wx.Window` instance object; :param `page`: the tab control page associated with the tab; - :param Rect `in_rect`: rectangle the tab should be confined to; + :param wx.Rect `in_rect`: rectangle the tab should be confined to; :param integer `close_button_state`: the state of the close button on the tab; :param bool `paint_control`: whether to draw the control inside a tab (if any) on a :class:`MemoryDC`. """ diff --git a/wx/lib/agw/balloontip.py b/wx/lib/agw/balloontip.py index 52b73339..1b2ddf1b 100644 --- a/wx/lib/agw/balloontip.py +++ b/wx/lib/agw/balloontip.py @@ -336,7 +336,7 @@ class BalloonFrame(wx.Frame): """ Sets the balloon shape. - :param `event`: on wxGTK, a :class:`WindowCreateEvent` event to process. + :param `event`: on wxGTK, a :class:`wx.WindowCreateEvent` event to process. """ size = self.GetSize() @@ -572,7 +572,7 @@ class BalloonTip(object): """ Sets the target control/window for the :class:`BalloonTip`. - :param `widget`: any subclass of :class:`Window`. + :param `widget`: any subclass of :class:`wx.Window`. """ self._widget = widget @@ -592,7 +592,7 @@ class BalloonTip(object): """ Returns the target window for the :class:`BalloonTip`. - :return: An instance of :class:`Window`. + :return: An instance of :class:`wx.Window`. :raise: `Exception` if the :meth:`~BalloonTip.SetTarget` method has not previously called. """ @@ -980,7 +980,7 @@ class BalloonTip(object): """ Sets the font for the top title. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. """ if font is None: @@ -993,7 +993,7 @@ class BalloonTip(object): """ Returns the font for the top title. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. """ return self._balloontitlefont @@ -1003,7 +1003,7 @@ class BalloonTip(object): """ Sets the font for the tip message. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. """ if font is None: @@ -1016,7 +1016,7 @@ class BalloonTip(object): """ Returns the font for the tip message. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. """ return self._balloonmsgfont @@ -1073,7 +1073,7 @@ class BalloonTip(object): Handles the target destruction, specifically handling the ``wx.EVT_WINDOW_DESTROY`` event. - :param `event`: a :class:`WindowDestroyEvent` event to be processed. + :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed. """ if hasattr(self, "BalloonFrame"): diff --git a/wx/lib/agw/buttonpanel.py b/wx/lib/agw/buttonpanel.py index 28d4b78a..aae5f3cb 100644 --- a/wx/lib/agw/buttonpanel.py +++ b/wx/lib/agw/buttonpanel.py @@ -532,7 +532,7 @@ class BPArt(object): ``BP_BUTTONTEXT_FONT`` 11 Text font for the buttons with text ============================== ======= ===================================== - :return: An instance of :class:`Font` for the input `id`. + :return: An instance of :class:`wx.Font` for the input `id`. :raise: `Exception` if the `id` is not recognized. """ @@ -550,7 +550,7 @@ class BPArt(object): Sets the option value for the specified font `id`. :param integer `id`: the identification bit for the font value; - :param `colour`: the new value for the font (a valid :class:`Font` instance). + :param `colour`: the new value for the font (a valid :class:`wx.Font` instance). :raise: `Exception` if the `id` is not recognized. @@ -598,8 +598,8 @@ class BPArt(object): """ Draws a separator in :class:`ButtonPanel`. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the separator client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the separator client rectangle; :param bool `isVertical`: ``True`` if :class:`ButtonPanel` is in vertical orientation, ``False`` otherwise. """ @@ -622,8 +622,8 @@ class BPArt(object): """ Draws the main caption text in :class:`ButtonPanel`. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the main caption text rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the main caption text rectangle; :param string `captionText`: the caption text string. """ @@ -642,9 +642,9 @@ class BPArt(object): """ Draws a button in :class:`ButtonPanel`, together with its text (if any). - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the button client rectangle; - :param Bitmap `buttonBitmap`: the bitmap associated with the button; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the button client rectangle; + :param wx.Bitmap `buttonBitmap`: the bitmap associated with the button; :param bool `isVertical`: ``True`` if :class:`ButtonPanel` is in vertical orientation, ``False`` otherwise; :param string `buttonStatus`: one of "Normal", "Toggled", "Pressed", "Disabled" or "Hover"; @@ -733,7 +733,7 @@ class BPArt(object): """ Draws the label for a button. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param string `text`: the button label; :param bool `isEnabled`: ``True`` if the button is enabled, ``False`` otherwise; :param integer `xpos`: the text `x` position inside the button; @@ -752,8 +752,8 @@ class BPArt(object): """ Paint the :class:`ButtonPanel`'s background. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the :class:`ButtonPanel` client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the :class:`ButtonPanel` client rectangle; :param integer `style`: the :class:`ButtonPanel` window style. """ @@ -774,8 +774,8 @@ class BPArt(object): """ Gradient fill from colour 1 to colour 2 with top to bottom or left to right. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the :class:`ButtonPanel` client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the :class:`ButtonPanel` client rectangle. """ if rect.height < 1 or rect.width < 1: @@ -841,10 +841,10 @@ class Control(wx.EvtHandler): """ Default class constructor. - :param Window `parent`: the control parent object. Must not be ``None``; + :param wx.Window `parent`: the control parent object. Must not be ``None``; :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `id`: window identifier. A value of -1 indicates a default value. """ @@ -910,7 +910,7 @@ class Control(wx.EvtHandler): the size returned by this function will be the same as the size the window would have had after calling `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ return self._size @@ -982,7 +982,7 @@ class Control(wx.EvtHandler): """ Handles the drawing of the control. - :param Rect `rect`: the control client rectangle. + :param wx.Rect `rect`: the control client rectangle. """ pass @@ -990,8 +990,8 @@ class Control(wx.EvtHandler): class Sizer(object): """ - This is a mix-in class to add pseudo support to :class:`Sizer`. Just create - a new class that derives from this class and :class:`Sizer` and intercepts + This is a mix-in class to add pseudo support to :class:`wx.Sizer`. Just create + a new class that derives from this class and :class:`wx.Sizer` and intercepts any methods that add to the wx sizer. """ @@ -1019,7 +1019,7 @@ class Sizer(object): """ This functions returns the best acceptable minimal size for the sizer object. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ # this should be handled by the wx.Sizer based class @@ -1050,8 +1050,8 @@ class BoxSizer(Sizer, wx.BoxSizer): """ Appends a child item to the sizer. - :param `item`: the item to be added to :class:`BoxSizer`. Can be an instance of :class:`Window`, - :class:`Sizer` or a spacer; + :param `item`: the item to be added to :class:`BoxSizer`. Can be an instance of :class:`wx.Window`, + :class:`wx.Sizer` or a spacer; :param integer `proportion`: this parameter is used in :class:`BoxSizer` to indicate if a child of a sizer can change its size in the main orientation of the :class:`BoxSizer` - where 0 stands for not changeable and a value of more than zero is interpreted relative @@ -1083,8 +1083,8 @@ class BoxSizer(Sizer, wx.BoxSizer): | ``wx.SHAPED`` | The item will be expanded as much as possible while also | | | maintaining its aspect ratio | +---------------------------------------------------------------------+-----------------------------------------------------------------------------+ - | ``wx.FIXED_MINSIZE`` | Normally :class:`Sizer` will use | - | | :meth:`Window.GetEffectiveMinSize` to | + | ``wx.FIXED_MINSIZE`` | Normally :class:`wx.Sizer` will use | + | | :meth:`wx.Window.GetEffectiveMinSize` to | | | determine what the minimal size of window items should be, and will use that| | | size to calculate the layout. This allows layouts to adjust when an item | | | changes and its best size becomes different. If you would rather have a | @@ -1254,7 +1254,7 @@ class Separator(Control): """ Returns the separator best size. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ # 10 is completely arbitrary, but it works anyhow @@ -1268,8 +1268,8 @@ class Separator(Control): """ Draws the separator. Actually the drawing is done in :class:`BPArt`. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the separator client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the separator client rectangle. """ if not self.IsShown(): @@ -1323,7 +1323,7 @@ class ButtonPanelText(Control): def CreateDC(self): - """ Convenience function to create a :class:`DC`. """ + """ Convenience function to create a :class:`wx.DC`. """ dc = wx.ClientDC(self._parent) textFont = self._parent._art.GetFont(BP_TEXT_FONT) @@ -1336,7 +1336,7 @@ class ButtonPanelText(Control): """ Returns the best size for the main caption in :class:`ButtonPanel`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ if self._text == "": @@ -1356,8 +1356,8 @@ class ButtonPanelText(Control): """ Draws the main caption. Actually the drawing is done in :class:`BPArt`. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the main caption text client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the main caption text client rectangle. """ if not self.IsShown(): @@ -1386,7 +1386,7 @@ class ButtonInfo(Control): :param `parent`: the parent window (:class:`ButtonPanel`); :param integer `id`: the button id; - :param Bitmap `bmp`: the associated bitmap; + :param wx.Bitmap `bmp`: the associated bitmap; :param string `status`: button status ("Pressed", "Hover", "Normal", "Toggled", "Disabled"); :param string `text`: text to be displayed either below of to the right of the button; :param integer `kind`: button kind, may be ``wx.ITEM_NORMAL`` for standard buttons or @@ -1423,7 +1423,7 @@ class ButtonInfo(Control): """ Returns the best size for the button. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ xsize = self.GetBitmap().GetWidth() @@ -1460,8 +1460,8 @@ class ButtonInfo(Control): """ Draws the button on :class:`ButtonPanel`. Actually the drawing is done in :class:`BPArt`. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the main caption text client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the main caption text client rectangle. """ if not self.IsShown(): @@ -1534,7 +1534,7 @@ class ButtonInfo(Control): """ Returns the :class:`ButtonInfo` client rectangle. - :return: An instance of :class:`Rect`. + :return: An instance of :class:`wx.Rect`. """ return self._rect @@ -1565,7 +1565,7 @@ class ButtonInfo(Control): """ Sets the :class:`ButtonInfo` client rectangle. - :param `rect`: an instance of :class:`Rect`. + :param `rect`: an instance of :class:`wx.Rect`. """ self._rect = rect @@ -1658,7 +1658,7 @@ class ButtonInfo(Control): - Toggled. :param string `name`: the new status name; - :param Bitmap `bmp`: the bitmap associated with the new status. + :param wx.Bitmap `bmp`: the bitmap associated with the new status. """ self._bitmaps.update({name: bmp}) @@ -1796,7 +1796,7 @@ class ButtonPanel(wx.Panel): """ Default class constructor. - :param Window `parent`: the parent window. Must not be ``None``; + :param wx.Window `parent`: the parent window. Must not be ``None``; :param integer `id`: window identifier. If ``wx.ID_ANY``, will automatically create an identifier; :param string `text`: the main caption text for :class:`ButtonPanel`; :param integer `agwStyle`: the AGW-specific window style (one of ``BP_DEFAULT_STYLE``, ``BP_USE_GRADIENT``); @@ -1964,7 +1964,7 @@ class ButtonPanel(wx.Panel): """ Adds a wxPython control to :class:`ButtonPanel`. - :param `control`: an instance of :class:`Window`; + :param `control`: an instance of :class:`wx.Window`; :param integer `proportion`: the control proportion (0 for fixed-size, 1 or more for a stretchable one); :param integer `flag`: one of the :class:`BoxSizer` flags; @@ -2191,7 +2191,7 @@ class ButtonPanel(wx.Panel): the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. :note: Overridden from :class:`Panel`. """ @@ -2278,7 +2278,7 @@ class ButtonPanel(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`ButtonPanel`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. .. todo:: @@ -2345,7 +2345,7 @@ class ButtonPanel(wx.Panel): :param bool `isVertical`: ``True`` if :class:`ButtonPanel` is in vertical orientation, ``False`` otherwise. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ if item.GetUserData(): @@ -2702,7 +2702,7 @@ class ButtonPanel(wx.Panel): """ HitTest method for :class:`ButtonPanel`. - :param `pt`: the mouse position, an instance of :class:`Point`. + :param `pt`: the mouse position, an instance of :class:`wx.Point`. :returns: an instance of :class:`ButtonInfo` and the hit flag ``BP_HT_BUTTON`` if a button client rectangle contains the input point `pt`, or ``wx.NOT_FOUND`` and ``BP_HT_NONE``. diff --git a/wx/lib/agw/cubecolourdialog.py b/wx/lib/agw/cubecolourdialog.py index c67e31f1..d007e31b 100644 --- a/wx/lib/agw/cubecolourdialog.py +++ b/wx/lib/agw/cubecolourdialog.py @@ -1256,8 +1256,8 @@ def Slope(pt1, pt2): """ Calculates the slope of the line connecting 2 points. - :param `pt1`: an instance of :class:`Point`; - :param `pt2`: another instance of :class:`Point`. + :param `pt1`: an instance of :class:`wx.Point`; + :param `pt2`: another instance of :class:`wx.Point`. """ y = float(pt2.y - pt1.y) @@ -1371,8 +1371,8 @@ def Distance(pt1, pt2): """ Returns the distance between 2 points. - :param `pt1`: an instance of :class:`Point`; - :param `pt2`: another instance of :class:`Point`. + :param `pt1`: an instance of :class:`wx.Point`; + :param `pt2`: another instance of :class:`wx.Point`. """ distance = sqrt((pt1.x - pt2.x)**2.0 + (pt1.y - pt2.y)**2.0) @@ -1384,7 +1384,7 @@ def AngleFromPoint(pt, center): Returns the angle between the x-axis and the line connecting the center and the point `pt`. - :param `pt`: an instance of :class:`Point`; + :param `pt`: an instance of :class:`wx.Point`; :param `center`: a float value representing the center. """ @@ -1424,12 +1424,12 @@ def PtFromAngle(angle, sat, center): def RestoreOldDC(dc, oldPen, oldBrush, oldMode): """ - Restores the old settings for a :class:`DC`. + Restores the old settings for a :class:`wx.DC`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `oldPen`: an instance of :class:`Pen`; :param `oldBrush`: an instance of :class:`Brush`; - :param `oldMode`: the :class:`DC` drawing mode bit. + :param `oldMode`: the :class:`wx.DC` drawing mode bit. """ dc.SetPen(oldPen) @@ -1439,9 +1439,9 @@ def RestoreOldDC(dc, oldPen, oldBrush, oldMode): def DrawCheckerBoard(dc, rect, checkColour, box=5): """ - Draws a checkerboard on a :class:`DC`. + Draws a checkerboard on a :class:`wx.DC`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the client rectangle on which to draw the checkerboard; :param `checkColour`: the colour used for the dark checkerboards; :param `box`: the checkerboards box sizes. @@ -1684,7 +1684,7 @@ class BasePyControl(wx.Control): """ Draws the markers on top of the background bitmap. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. :note: This method must be overridden in derived classes. """ @@ -1696,7 +1696,7 @@ class BasePyControl(wx.Control): """ Draws the lines connecting the markers on top of the background bitmap. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. :note: This method must be overridden in derived classes. """ @@ -1713,7 +1713,7 @@ class BasePyControl(wx.Control): :note: This method always returns ``False`` as we do not accept focus from the keyboard. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return False @@ -1726,7 +1726,7 @@ class BasePyControl(wx.Control): :note: This method always returns ``False`` as we do not accept focus from mouse click. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return False @@ -1772,7 +1772,7 @@ class BasePyControl(wx.Control): """ Handles the ``wx.EVT_SIZE`` for :class:`BasePyControl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -1783,7 +1783,7 @@ class BasePyControl(wx.Control): Overridden base class virtual. Determines the best size of the control based on the bitmap size. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return wx.Size(self._bitmap.GetWidth(), self._bitmap.GetHeight()) @@ -1813,7 +1813,7 @@ class RGBCube(BasePyControl): """ Draws the markers on top of the background bitmap. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if dc is None: @@ -1850,7 +1850,7 @@ class RGBCube(BasePyControl): """ Draws the lines connecting the markers on top of the background bitmap. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ cuboid = self._mainDialog._cuboid @@ -2020,7 +2020,7 @@ class HSVWheel(BasePyControl): """ Draws the markers on top of the background bitmap. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if dc is None: @@ -2082,7 +2082,7 @@ class HSVWheel(BasePyControl): """ Returns whether a point is inside the HSV wheel or not. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ return Distance(pt, self._mainDialog._centre) <= RADIUS @@ -2092,7 +2092,7 @@ class HSVWheel(BasePyControl): """ Track a mouse event inside the HSV colour wheel. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ if not self._mouseIn: @@ -2206,7 +2206,7 @@ class BaseLineCtrl(wx.Control): """ Handles the ``wx.EVT_SIZE`` for :class:`BaseLineCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -2216,7 +2216,7 @@ class BaseLineCtrl(wx.Control): """ Overridden base class virtual. Determines the best size of the control. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return wx.Size(24, 208) @@ -2243,7 +2243,7 @@ class BaseLineCtrl(wx.Control): :note: This method always returns ``False`` as we do not accept focus from the keyboard. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return False @@ -2256,7 +2256,7 @@ class BaseLineCtrl(wx.Control): :note: This method always returns ``False`` as we do not accept focus from mouse click. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return False @@ -2322,7 +2322,7 @@ class BrightCtrl(BaseLineCtrl): """ Tracks a mouse action inside the palette control. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ brightRect = self.BuildRect() @@ -2353,7 +2353,7 @@ class BrightCtrl(BaseLineCtrl): """ Draws square markers used with mouse gestures. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if dc is None: @@ -2434,7 +2434,7 @@ class AlphaCtrl(BaseLineCtrl): """ Draws the alpha shading on top of the checkerboard. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the :class:`AlphaCtrl` client rectangle. """ @@ -2460,7 +2460,7 @@ class AlphaCtrl(BaseLineCtrl): """ Tracks a mouse action inside the Alpha channel control. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ alphaRect = self.BuildRect() @@ -2481,7 +2481,7 @@ class AlphaCtrl(BaseLineCtrl): """ Draws square markers used with mouse gestures. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if dc is None: @@ -2578,7 +2578,7 @@ class ColourPanel(wx.Panel): """ Handles the ``wx.EVT_SIZE`` for :class:`wx.ColourPanel`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -2679,7 +2679,7 @@ class CustomPanel(wx.Control): """ Overridden base class virtual. Determines the best size of the control. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._customColourRect.width+4, self._customColourRect.height+4 @@ -2716,7 +2716,7 @@ class CustomPanel(wx.Control): """ Handles the ``wx.EVT_SIZE`` for :class:`CustomPanel`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -2750,7 +2750,7 @@ class CustomPanel(wx.Control): """ Draws all the 16 subpanels with their custom colours. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ for i in range(2): @@ -2772,7 +2772,7 @@ class CustomPanel(wx.Control): """ Highlight the current custom colour selection (if any). - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `draw`: whether to draw a thin black border around the selected custom colour or not. """ @@ -2804,7 +2804,7 @@ class CustomPanel(wx.Control): """ Paints a newly added custom colour subpanel. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `selX`: the x coordinate of the custom colour subpanel; :param `selY`: the y coordinate of the custom colour subpanel. """ @@ -3192,7 +3192,7 @@ class CubeColourDialog(wx.Dialog): """ Draws the markers for all the controls. - :param `dc`: an instance of :class:`DC`. If `dc` is ``None``, a :class:`ClientDC` is + :param `dc`: an instance of :class:`wx.DC`. If `dc` is ``None``, a :class:`ClientDC` is created on the fly. """ diff --git a/wx/lib/agw/customtreectrl.py b/wx/lib/agw/customtreectrl.py index 764435c1..f2bbe561 100644 --- a/wx/lib/agw/customtreectrl.py +++ b/wx/lib/agw/customtreectrl.py @@ -561,9 +561,9 @@ def DrawTreeItemButton(win, dc, rect, flags): """ Draw the expanded/collapsed icon for a tree control item. - :param `win`: an instance of :class:`Window`; - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the client rectangle where to draw the tree item button; + :param `win`: an instance of :class:`wx.Window`; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the client rectangle where to draw the tree item button; :param integer `flags`: contains ``wx.CONTROL_EXPANDED`` bit for expanded tree items. :note: This is a simple replacement of :meth:`RendererNative.DrawTreeItemButton`. @@ -626,7 +626,7 @@ def ChopText(dc, text, max_size): Chops the input `text` if its size does not fit in `max_size`, by cutting the text and adding ellipsis at the end. - :param `dc`: a :class:`DC` device context; + :param `dc`: a :class:`wx.DC` device context; :param `text`: the text to chop; :param `max_size`: the maximum size in which the text should fit. @@ -841,7 +841,7 @@ class TreeItemAttr(object): :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`. + :param `font`: the tree item font, an instance of :class:`wx.Font`. """ self._colText = colText @@ -886,7 +886,7 @@ class TreeItemAttr(object): """ Sets the item font attribute. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ self._font = font @@ -972,7 +972,7 @@ class TreeItemAttr(object): """ Returns the attribute font. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. """ return self._font @@ -1002,7 +1002,7 @@ class CommandTreeEvent(wx.CommandEvent): :param integer `evtId`: the event identifier; :param `item`: an instance of :class:`GenericTreeItem`; :param integer `evtKey`: a character ordinal; - :param `point`: an instance of :class:`Point`; + :param `point`: an instance of :class:`wx.Point`; :param string `label`: a :class:`GenericTreeItem` text label. """ @@ -1063,7 +1063,7 @@ class CommandTreeEvent(wx.CommandEvent): (for ``EVT_TREE_BEGIN_DRAG`` and ``EVT_TREE_BEGIN_RDRAG`` events only) or the click position. - :return: An instance of :class:`Point`. + :return: An instance of :class:`wx.Point`. """ return self._pointDrag @@ -1075,7 +1075,7 @@ class CommandTreeEvent(wx.CommandEvent): (for ``EVT_TREE_BEGIN_DRAG`` and ``EVT_TREE_BEGIN_RDRAG`` events only) or the click position. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ self._pointDrag = pt @@ -1205,7 +1205,7 @@ class TreeEvent(CommandTreeEvent): :param integer `evtId`: the event identifier; :param `item`: an instance of :class:`GenericTreeItem`; :param integer `evtKey`: a character ordinal; - :param `point`: an instance of :class:`Point`; + :param `point`: an instance of :class:`wx.Point`; :param string `label`: a :class:`GenericTreeItem` text label. """ @@ -1306,7 +1306,7 @@ class TreeTextCtrl(ExpandoTextCtrl): :param `item`: an instance of :class:`GenericTreeItem`. :raise: `Exception` when the item has an associated image but the parent - :class:`CustomTreeCtrl` does not have a :class:`ImageList` assigned. + :class:`CustomTreeCtrl` does not have a :class:`wx.ImageList` assigned. """ self._owner = owner @@ -1573,7 +1573,7 @@ class GenericTreeItem(object): =============== ========================================= :param `wnd`: if not ``None``, a non-toplevel window to be displayed next to - the item, an instance of :class:`Window`; + the item, an instance of :class:`wx.Window`; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -1726,7 +1726,7 @@ class GenericTreeItem(object): ================================= ======================== :return: An integer index that can be used to retrieve the item image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. """ return self._images[which] @@ -1749,7 +1749,7 @@ class GenericTreeItem(object): ================================= ======================== :return: An integer index that can be used to retrieve the item check image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. :note: This method is meaningful only for radio & check items. """ @@ -1763,7 +1763,7 @@ class GenericTreeItem(object): leftmost part of the client area of :class:`CustomTreeCtrl`. :return: An integer index that can be used to retrieve the item leftmost image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. """ return self._leftimage @@ -1914,7 +1914,7 @@ class GenericTreeItem(object): Sets the window associated to the item. :param `wnd`: a non-toplevel window to be displayed next to the item, any - subclass of :class:`Window`. + subclass of :class:`wx.Window`. :raise: `Exception` if the input `item` is a separator and `wnd` is not ``None``. """ @@ -1952,7 +1952,7 @@ class GenericTreeItem(object): """ Returns the window associated to the item (if any). - :return: An instance of any :class:`Window` derived class, excluding top-level windows. + :return: An instance of any :class:`wx.Window` derived class, excluding top-level windows. """ return self._wnd @@ -2477,7 +2477,7 @@ class GenericTreeItem(object): """ :meth:`~GenericTreeItem.HitTest` method for an item. Called from the main window :meth:`CustomTreeCtrl.HitTest() `. - :param `point`: the point to test for the hit (an instance of :class:`Point`); + :param `point`: the point to test for the hit (an instance of :class:`wx.Point`); :param `theCtrl`: the main :class:`CustomTreeCtrl` tree; :param integer `flags`: a bitlist of hit locations; :param integer `level`: the item's level inside the tree hierarchy. @@ -2573,7 +2573,7 @@ class GenericTreeItem(object): Returns the current item image. :return: An integer index that can be used to retrieve the item image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. """ image = _NO_IMAGE @@ -2608,7 +2608,7 @@ class GenericTreeItem(object): Returns the current item check image. :return: An integer index that can be used to retrieve the item check image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. """ if self._type == 0: @@ -2649,14 +2649,14 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `style`: the underlying :class:`ScrolledWindow` style; :param integer `agwStyle`: the AGW-specific window style for :class:`CustomTreeCtrl`. It can be a combination of the following bits: @@ -2687,7 +2687,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): ``TR_TOOLTIP_ON_LONG_ITEMS`` 0x100000 Flag used to show tooltips on long items when the horizontal space for :class:`CustomTreeCtrl` is low. ============================== =========== ================================================== - :param Validator `validator`: window validator; + :param wx.Validator `validator`: window validator; :param string `name`: window name. """ @@ -2878,7 +2878,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`CustomTreeCtrl`. - :param `event`: a :class:`WindowDestroyEvent` event to be processed. + :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed. """ # Here there may be something I miss... do I have to destroy @@ -3408,7 +3408,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): from the parent window. The base class version returns ``False``, but this method is overridden in - :class:`Control` where it returns ``True``. + :class:`wx.Control` where it returns ``True``. :class:`CustomTreeCtrl` does not inherit colours from anyone. """ @@ -3583,7 +3583,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): ================================= ======================== :return: An integer index that can be used to retrieve the item image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. """ return item.GetImage(which) @@ -3597,7 +3597,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param `item`: an instance of :class:`GenericTreeItem`. :return: An integer index that can be used to retrieve the item leftmost image inside - a :class:`ImageList`. + a :class:`wx.ImageList`. """ return item.GetLeftImage() @@ -3649,7 +3649,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param `item`: an instance of :class:`GenericTreeItem`. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. """ font = item.Attr().GetFont() @@ -3838,7 +3838,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Sets the item font. :param `item`: an instance of :class:`GenericTreeItem`; - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. """ item.Attr().SetFont(font) @@ -3849,7 +3849,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the :class:`CustomTreeCtrl` font. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. :note: Overridden from :class:`ScrolledWindow`. """ @@ -3881,7 +3881,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the font used to render hypertext items. - :return: An instance of :class:`Font`. + :return: An instance of :class:`wx.Font`. :note: This method is meaningful only for hypertext-like items. """ @@ -3893,7 +3893,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the font used to render hypertext items. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. :note: This method is meaningful only for hypertext-like items. """ @@ -4263,7 +4263,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param `item`: an instance of :class:`GenericTreeItem`. - :return: An instance of :class:`Window` if the item has an associated window, ``None`` otherwise. + :return: An instance of :class:`wx.Window` if the item has an associated window, ``None`` otherwise. """ return item.GetWindow() @@ -4860,7 +4860,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `ct_type`: the item type (see :meth:`~CustomTreeCtrl.SetItemType` for a list of valid item types); :param `wnd`: if not ``None``, a non-toplevel window to show next to the item, any - subclass of :class:`Window` except top-level windows; + subclass of :class:`wx.Window` except top-level windows; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -4927,7 +4927,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `ct_type`: the item type (see :meth:`~CustomTreeCtrl.SetItemType` for a list of valid item types); :param `wnd`: if not ``None``, a non-toplevel window to show next to the item, - any subclass of :class:`Window` except top-level windows; + any subclass of :class:`wx.Window` except top-level windows; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -4998,7 +4998,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `ct_type`: the item type (see :meth:`~CustomTreeCtrl.SetItemType` for a list of valid item types); :param `wnd`: if not ``None``, a non-toplevel window to show next to the item, any - subclass of :class:`Window` except top-level windows; + subclass of :class:`wx.Window` except top-level windows; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -5027,7 +5027,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `ct_type`: the item type (see :meth:`~CustomTreeCtrl.SetItemType` for a list of valid item types); :param `wnd`: if not ``None``, a non-toplevel window to show next to the item, - any subclass of :class:`Window`; + any subclass of :class:`wx.Window`; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -5071,7 +5071,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `ct_type`: the item type (see :meth:`~CustomTreeCtrl.SetItemType` for a list of valid item types); :param `wnd`: if not ``None``, a non-toplevel window to show next to the item, - any subclass of :class:`Window`; + any subclass of :class:`wx.Window`; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -5122,7 +5122,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `ct_type`: the item type (see :meth:`~CustomTreeCtrl.SetItemType` for a list of valid item types); :param `wnd`: if not ``None``, a non-toplevel window to show next to the item, - any subclass of :class:`Window`; + any subclass of :class:`wx.Window`; :param integer `image`: an index within the normal image list specifying the image to use for the item in unselected state; :param integer `selImage`: an index within the normal image list specifying the image to @@ -5943,7 +5943,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the normal image list associated with :class:`CustomTreeCtrl`. - :return: An instance of :class:`ImageList`. + :return: An instance of :class:`wx.ImageList`. """ return self._imageListNormal @@ -5954,7 +5954,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Returns the buttons image list associated with :class:`CustomTreeCtrl` (from which application-defined button images are taken). - :return: An instance of :class:`ImageList`. + :return: An instance of :class:`wx.ImageList`. """ return self._imageListButtons @@ -5965,7 +5965,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Returns the state image list associated with :class:`CustomTreeCtrl` (from which application-defined state images are taken). - :return: An instance of :class:`ImageList`. + :return: An instance of :class:`wx.ImageList`. """ return self._imageListState @@ -5975,7 +5975,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Returns the image list used to build the check/radio buttons in :class:`CustomTreeCtrl`. - :return: An instance of :class:`ImageList`. + :return: An instance of :class:`wx.ImageList`. """ return self._imageListCheck @@ -5987,7 +5987,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): the leftmost part of the client area. Any item can have a leftmost image associated with it. - :return: An instance of :class:`ImageList`. + :return: An instance of :class:`wx.ImageList`. """ return self._imageListLeft @@ -6065,7 +6065,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Sets the normal image list for :class:`CustomTreeCtrl`. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ if self._ownsImageListNormal: @@ -6096,7 +6096,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): the leftmost part of the client area. Any item can have a leftmost image associated with it. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self._imageListLeft = imageList @@ -6123,7 +6123,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Sets the state image list for :class:`CustomTreeCtrl` (from which application-defined state images are taken). - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ if self._ownsImageListState: @@ -6138,7 +6138,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Sets the buttons image list for :class:`CustomTreeCtrl` (from which application-defined button images are taken). - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ if self._ownsImageListButtons: @@ -6156,7 +6156,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param integer `sizex`: the width of the bitmaps in the `imglist`, in pixels; :param integer `sizey`: the height of the bitmaps in the `imglist`, in pixels; - :param `imglist`: an instance of :class:`ImageList`. + :param `imglist`: an instance of :class:`wx.ImageList`. """ # Image list to hold disabled versions of each control @@ -6234,7 +6234,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Assigns the normal image list. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self.SetImageList(imageList) @@ -6245,7 +6245,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Assigns the state image list. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self.SetStateImageList(imageList) @@ -6256,7 +6256,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Assigns the button image list. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self.SetButtonsImageList(imageList) @@ -6269,7 +6269,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): the leftmost part of the client area. Any item can have a leftmost image associated with it. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self.SetLeftImageList(imageList) @@ -6316,8 +6316,8 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Gradient fill from colour 1 to colour 2 from top to bottom. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with the gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with the gradient shading; :param bool `hasfocus`: ``True`` if the main :class:`CustomTreeCtrl` has focus, ``False`` otherwise. """ @@ -6363,8 +6363,8 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Gradient fill from colour 1 to colour 2 from left to right. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with the gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with the gradient shading; :param bool `hasfocus`: ``True`` if the main :class:`CustomTreeCtrl` has focus, ``False`` otherwise. """ @@ -6411,8 +6411,8 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Draws the selected item(s) with the Windows Vista style. - :param `dc`: an instance of :class:`DC`; - :param Rect `rect`: the rectangle to be filled with the gradient shading; + :param `dc`: an instance of :class:`wx.DC`; + :param wx.Rect `rect`: the rectangle to be filled with the gradient shading; :param bool `hasfocus`: ``True`` if the main :class:`CustomTreeCtrl` has focus, ``False`` otherwise. """ @@ -6476,7 +6476,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Actually draws an item. :param `item`: an instance of :class:`GenericTreeItem`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `level`: the item level in the tree hierarchy; :param integer `align`: an integer specifying the alignment type: @@ -6766,7 +6766,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Paint a level in the hierarchy of :class:`CustomTreeCtrl`. :param `item`: an instance of :class:`GenericTreeItem`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `level`: the item level in the tree hierarchy; :param integer `y`: the current vertical position in the :class:`ScrolledWindow`; :param integer `align`: an integer specifying the alignment type: @@ -7030,7 +7030,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Handles the ``wx.EVT_SIZE`` event for :class:`CustomTreeCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ if self.HasAGWFlag(TR_ELLIPSIZE_LONG_ITEMS): @@ -7076,7 +7076,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): """ Tiles the background image to fill all the available area. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. .. todo:: Support background images also in stretch and centered modes. """ @@ -7425,7 +7425,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Calculates which (if any) item is under the given point, returning the tree item at this point plus extra information flags. - :param `point`: an instance of :class:`Point`, a point to test for hits; + :param `point`: an instance of :class:`wx.Point`, a point to test for hits; :param integer `flags`: a bitlist of the following values: ================================== =============== ================================= @@ -7494,7 +7494,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): :param bool `textOnly`: if ``True``, only the rectangle around the item's label will be returned, otherwise the item's image is also taken into account. - :return: An instance of :class:`Rect`. + :return: An instance of :class:`wx.Rect`. :note: The rectangle coordinates are logical, not physical ones. So, for example, the `x` coordinate may be negative if the tree has a horizontal scrollbar and its @@ -7987,7 +7987,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): application defining an `OnIdle` handler in a derived class. This method may be used to do delayed painting, for example, and most - implementations call :meth:`Window.UpdateWindowUI` in order to send update events + implementations call :meth:`wx.Window.UpdateWindowUI` in order to send update events to the window in idle time. """ @@ -8024,7 +8024,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Calculates overall position and size of an item. :param `item`: an instance of :class:`GenericTreeItem`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `level`: the item level in the tree hierarchy; :param integer `align`: an integer specifying the alignment type: @@ -8113,7 +8113,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): Calculates the level of an item inside the tree hierarchy. :param `item`: an instance of :class:`GenericTreeItem`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `level`: the item level in the tree hierarchy; :param integer `y`: the current vertical position inside the :class:`ScrolledWindow`; :param integer `align`: an integer specifying the alignment type: @@ -8344,7 +8344,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): event handler function under Windows and automatically under GTK. :note: Setting the background colour does not cause an immediate refresh, so - you may wish to call :meth:`Window.ClearBackground` or :meth:`Window.Refresh` after + you may wish to call :meth:`wx.Window.ClearBackground` or :meth:`wx.Window.Refresh` after calling this function. :note: Overridden from :class:`ScrolledWindow`. @@ -8402,7 +8402,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. :note: Overridden from :class:`ScrolledWindow`. """ @@ -8504,7 +8504,7 @@ class CustomTreeCtrl(wx.ScrolledWindow): colour, if the field doesn't make sense as is the case for `colBg` for the controls with themed background. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ attr = wx.VisualAttributes() diff --git a/wx/lib/agw/flatmenu.py b/wx/lib/agw/flatmenu.py index 104bedcc..d34934d8 100644 --- a/wx/lib/agw/flatmenu.py +++ b/wx/lib/agw/flatmenu.py @@ -601,8 +601,8 @@ class FMRenderer(object): Draws the menu left margin. :param `item`: an instance of :class:`FlatMenuItem`; - :param `dc`: an instance of :class:`DC`; - :param `menuRect`: an instance of :class:`Rect`, representing the menu client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `menuRect`: an instance of :class:`wx.Rect`, representing the menu client rectangle. """ raise Exception("This style doesn't support Drawing a Left Margin") @@ -612,8 +612,8 @@ class FMRenderer(object): """ Draws a separator inside the toolbar in :class:`FlatMenuBar`. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the bitmap client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the bitmap client rectangle. """ # Place a separator bitmap @@ -646,8 +646,8 @@ class FMRenderer(object): """ Draws a shadow using background bitmap. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the bitmap client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the bitmap client rectangle; :param integer `where`: where to draw the shadow. This can be any combination of the following bits: @@ -705,8 +705,8 @@ class FMRenderer(object): """ Draws the toolbar background - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the toolbar client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the toolbar client rectangle. """ if not self.raiseToolbar: @@ -728,7 +728,7 @@ class FMRenderer(object): """ Draws a separator inside a :class:`FlatMenu`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `xCoord`: the current x position where to draw the separator; :param integer `yCoord`: the current y position where to draw the separator; :param integer `textX`: the menu item label x position; @@ -752,7 +752,7 @@ class FMRenderer(object): Draws the menu item. :param `item`: a :class:`FlatMenuItem` instance; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `xCoord`: the current x position where to draw the menu; :param integer `yCoord`: the current y position where to draw the menu; :param integer `imageMarginX`: the spacing between the image and the menu border; @@ -939,8 +939,8 @@ class FMRenderer(object): """ Draws the highlight on a :class:`FlatMenuBar`. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state. """ @@ -962,8 +962,8 @@ class FMRenderer(object): """ Draws the highlight on a FlatMenu - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state. """ @@ -985,8 +985,8 @@ class FMRenderer(object): """ Draws the scroll button - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state. """ @@ -1041,8 +1041,8 @@ class FMRenderer(object): """ Draws a button. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state; :param `colour`: if not ``None``, an instance of :class:`wx.Colour` to be used to draw the :class:`FlatMenuItem` background. @@ -1082,8 +1082,8 @@ class FMRenderer(object): """ Draws the menu bar background colour according to the menubar.GetBackgroundColour - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the menubar client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the menubar client rectangle. """ dcsaver = DCSaver(dc) @@ -1101,7 +1101,7 @@ class FMRenderer(object): Draws everything for :class:`FlatMenuBar`. :param `menubar`: an instance of :class:`FlatMenuBar`. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ #artMgr = ArtManager.Get() @@ -1297,7 +1297,7 @@ class FMRenderer(object): Draws the menu. :param `flatmenu`: the :class:`FlatMenu` instance we need to paint; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ menuRect = flatmenu.GetClientRect() @@ -1420,8 +1420,8 @@ class FMRendererMSOffice2007(FMRenderer): Draws the menu left margin. :param `item`: the :class:`FlatMenuItem` to paint; - :param `dc`: an instance of :class:`DC`; - :param `menuRect`: an instance of :class:`Rect`, representing the menu client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `menuRect`: an instance of :class:`wx.Rect`, representing the menu client rectangle. """ # Construct the margin rectangle @@ -1449,8 +1449,8 @@ class FMRendererMSOffice2007(FMRenderer): """ Draws the highlight on a :class:`FlatMenu`. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state. """ @@ -1461,8 +1461,8 @@ class FMRendererMSOffice2007(FMRenderer): """ Draws the highlight on a :class:`FlatMenuBar`. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state. """ @@ -1473,8 +1473,8 @@ class FMRendererMSOffice2007(FMRenderer): """ Draws a button using the Office 2007 theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state; :param `colour`: if not ``None``, an instance of :class:`wx.Colour` to be used to draw the :class:`FlatMenuItem` background. @@ -1489,8 +1489,8 @@ class FMRendererMSOffice2007(FMRenderer): """ Draws a button using the Office 2007 theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state; :param `colour`: a valid :class:`wx.Colour` instance. """ @@ -1540,8 +1540,8 @@ class FMRendererMSOffice2007(FMRenderer): """ Draws the menu bar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the menubar client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the menubar client rectangle. """ # Keep old pen and brush @@ -1610,8 +1610,8 @@ class FMRendererMSOffice2007(FMRenderer): """ Draws the toolbar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the toolbar client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the toolbar client rectangle. """ artMgr = ArtManager.Get() @@ -1707,8 +1707,8 @@ class FMRendererVista(FMRendererMSOffice2007): """ Draws a button using the Vista theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: the an instance of :class:`Rect`, representing the button client rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: the an instance of :class:`wx.Rect`, representing the button client rectangle; :param integer `state`: the button state; :param `colour`: a valid :class:`wx.Colour` instance. """ @@ -1779,8 +1779,8 @@ class FMRendererXP(FMRenderer): Draws the menu left margin. :param `item`: the :class:`FlatMenuItem` to paint; - :param `dc`: an instance of :class:`DC`; - :param `menuRect`: an instance of :class:`Rect`, representing the menu client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `menuRect`: an instance of :class:`wx.Rect`, representing the menu client rectangle. """ # Construct the margin rectangle @@ -1799,8 +1799,8 @@ class FMRendererXP(FMRenderer): """ Draws the menu bar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the menubar client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the menubar client rectangle. """ # For office style, we simple draw a rectangle with a gradient colouring @@ -1829,8 +1829,8 @@ class FMRendererXP(FMRenderer): """ Draws the toolbar background according to the active theme. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the toolbar client rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the toolbar client rectangle. """ artMgr = ArtManager.Get() @@ -2209,7 +2209,7 @@ class MenuEntryInfo(object): Used internally. Do not call it in your code! :param `titleOrMenu`: if it is a string, it represents the new menu label, - otherwise it is another instance of :class:`MenuEntryInfo` from which the attributes + otherwise it is another instance of :class:`wx.MenuEntryInfo` from which the attributes are copied; :param `menu`: the associated :class:`FlatMenu` object; :param integer `state`: the menu item state. This can be one of the following: @@ -2266,7 +2266,7 @@ class MenuEntryInfo(object): """ Sets the associated menu client rectangle. - :param `rect`: an instance of :class:`Rect`, representing the menu client rectangle. + :param `rect`: an instance of :class:`wx.Rect`, representing the menu client rectangle. """ self._rect = rect @@ -2650,8 +2650,8 @@ class FlatMenuBar(wx.Panel): """ Draws the toolbar (if present). - :param `dc`: an instance of :class:`DC`; - :param `rect`: the toolbar client rectangle, an instance of :class:`Rect`. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: the toolbar client rectangle, an instance of :class:`wx.Rect`. """ highlight_width = self._tbIconSize + self._toolbarSpacer @@ -2783,7 +2783,7 @@ class FlatMenuBar(wx.Panel): def GetMoreMenuButtonRect(self): - """ Returns a rectangle region, as an instance of :class:`Rect`, surrounding the menu button. """ + """ Returns a rectangle region, as an instance of :class:`wx.Rect`, surrounding the menu button. """ clientRect = self.GetClientRect() rect = wx.Rect(*clientRect) @@ -2799,10 +2799,10 @@ class FlatMenuBar(wx.Panel): """ Draws 'more' button to the right side of the menu bar. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `state`: the 'more' button state. - :see: :meth:`MenuEntryInfo.SetState() ` for a list of valid menu states. + :see: :meth:`wx.MenuEntryInfo.SetState() ` for a list of valid menu states. """ if (not self._showCustomize) and self.GetInvisibleMenuItemCount() < 1 and self.GetInvisibleToolbarItemCount() < 1: @@ -2838,7 +2838,7 @@ class FlatMenuBar(wx.Panel): """ HitTest method for :class:`FlatMenuBar`. - :param `pt`: an instance of :class:`Point`, specifying the hit test position. + :param `pt`: an instance of :class:`wx.Point`, specifying the hit test position. :return: A tuple representing one of the following combinations: @@ -2896,7 +2896,7 @@ class FlatMenuBar(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`FlatMenuBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.ClearBitmaps(0) @@ -2989,7 +2989,7 @@ class FlatMenuBar(wx.Panel): This function is called from child menus, this allow a child menu to pass the mouse movement event to the menu bar. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ idx, where = self.HitTest(pt) @@ -3001,7 +3001,7 @@ class FlatMenuBar(wx.Panel): """ Handles mouse move event. - :param `pt`: an instance of :class:`Point`; + :param `pt`: an instance of :class:`wx.Point`; :param bool `leftIsDown`: ``True`` is the left mouse button is down, ``False`` otherwise. """ @@ -3252,11 +3252,11 @@ class FlatMenuBar(wx.Panel): """ Draws a toolbar item button. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `idx`: the tool index in the toolbar; :param integer `state`: the button state. - :see: :meth:`MenuEntryInfo.SetState() ` for a list of valid menu states. + :see: :meth:`wx.MenuEntryInfo.SetState() ` for a list of valid menu states. """ if idx >= len(self._tbButtons) or idx < 0: @@ -3290,7 +3290,7 @@ class FlatMenuBar(wx.Panel): """ Activates a menu. - :param `menuInfo`: an instance of :class:`MenuEntryInfo`. + :param `menuInfo`: an instance of :class:`wx.MenuEntryInfo`. """ # first make sure all other menus are not popedup @@ -3712,7 +3712,7 @@ class FlatMenuBar(wx.Panel): """ Adds any control to the toolbar, typically e.g. a combobox. - :param `control`: the control to be added, a subclass of :class:`Window` (but no :class:`TopLevelWindow`). + :param `control`: the control to be added, a subclass of :class:`wx.Window` (but no :class:`TopLevelWindow`). """ self._tbButtons.append(ToolBarItem(FlatToolbarItem(control), wx.Rect(), ControlNormal)) @@ -3993,7 +3993,7 @@ class FlatMenuButton(object): """ Draws self at rect using dc. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ rect = wx.Rect(self._pos, self._size) @@ -4008,7 +4008,7 @@ class FlatMenuButton(object): """ Handles left down mouse events. - :param `pt`: an instance of :class:`Point` where the left mouse button was pressed. + :param `pt`: an instance of :class:`wx.Point` where the left mouse button was pressed. """ if not self.Contains(pt): @@ -4030,7 +4030,7 @@ class FlatMenuButton(object): """ Handles left up mouse events. - :param `pt`: an instance of :class:`Point` where the left mouse button was released. + :param `pt`: an instance of :class:`wx.Point` where the left mouse button was released. """ # always stop the timer @@ -4050,7 +4050,7 @@ class FlatMenuButton(object): Handles mouse motion events. This is called any time the mouse moves in the parent menu, so we must check to see if the mouse is over the button. - :param `pt`: an instance of :class:`Point` where the mouse pointer was moved. + :param `pt`: an instance of :class:`wx.Point` where the mouse pointer was moved. """ if not self.Contains(pt): @@ -4091,7 +4091,7 @@ class FlatMenuButton(object): """ Moves :class:`FlatMenuButton` to the specified position. - :param `input1`: if it is an instance of :class:`Point`, it represents the :class:`FlatMenuButton` + :param `input1`: if it is an instance of :class:`wx.Point`, it represents the :class:`FlatMenuButton` position and the `input2` parameter is not used. Otherwise it is an integer representing the button `x` position; :param `input2`: if not ``None``, it is an integer representing the button `y` position. @@ -4107,7 +4107,7 @@ class FlatMenuButton(object): """ Sets the size for :class:`FlatMenuButton`. - :param `input1`: if it is an instance of :class:`Size`, it represents the :class:`FlatMenuButton` + :param `input1`: if it is an instance of :class:`wx.Size`, it represents the :class:`FlatMenuButton` size and the `input2` parameter is not used. Otherwise it is an integer representing the button width; :param `input2`: if not ``None``, it is an integer representing the button height. @@ -4269,10 +4269,10 @@ class FlatMenuBase(ShadowPopupWindow): """ Popups menu at the specified point. - :param `pt`: an instance of :class:`Point`, assumed to be in screen coordinates. However, + :param `pt`: an instance of :class:`wx.Point`, assumed to be in screen coordinates. However, if `parent` is not ``None``, `pt` is translated into the screen coordinates using `parent.ClientToScreen()`; - :param `parent`: if not ``None``, an instance of :class:`Window`. + :param `parent`: if not ``None``, an instance of :class:`wx.Window`. """ # some controls update themselves from OnIdle() call - let them do it @@ -4344,7 +4344,7 @@ class FlatMenuBase(ShadowPopupWindow): """ Adjusts position so the menu will be fully visible on screen. - :param `pos`: an instance of :class:`Point` specifying the menu position. + :param `pos`: an instance of :class:`wx.Point` specifying the menu position. """ # Check that the menu can fully appear in the screen @@ -4518,10 +4518,10 @@ class ToolBarItem(object): Default class constructor. :param `tbItem`: an instance of :class:`FlatToolbarItem`; - :param `rect`: the client rectangle for the toolbar item, an instance of :class:`Rect`; + :param `rect`: the client rectangle for the toolbar item, an instance of :class:`wx.Rect`; :param integer `state`: the toolbar item state. - :see: :meth:`MenuEntryInfo.SetState() ` for a list of valid item states. + :see: :meth:`wx.MenuEntryInfo.SetState() ` for a list of valid item states. """ self._tbItem = tbItem @@ -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:`wx.Bitmap` for a standard + of :class:`wx.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; @@ -5102,7 +5102,7 @@ class FlatMenuItem(object): """ Sets the menu item client rectangle. - :param `rect`: the menu item client rectangle, an instance of :class:`Rect`. + :param `rect`: the menu item client rectangle, an instance of :class:`wx.Rect`. """ self._rect = rect @@ -5261,7 +5261,7 @@ class FlatMenuItem(object): """ Sets the :class:`FlatMenuItem` font. - :param `font`: an instance of a valid :class:`Font`. + :param `font`: an instance of a valid :class:`wx.Font`. """ self._font = font @@ -5397,7 +5397,7 @@ class FlatMenu(FlatMenuBase): Pops up the menu. :param `pt`: the point at which the menu should be popped up (an instance - of :class:`Point`); + of :class:`wx.Point`); :param `owner`: the owner of the menu. The owner does not necessarly mean the menu parent, it can also be the window that popped up it; :param `parent`: the menu parent window. @@ -5493,7 +5493,7 @@ class FlatMenu(FlatMenuBase): """ Adds a pull-right submenu to the end of the menu. - This function is added to duplicate the API of :class:`Menu`. + This function is added to duplicate the API of :class:`wx.Menu`. :see: :meth:`~FlatMenu.AppendMenu` for an explanation of the input parameters. """ @@ -5822,7 +5822,7 @@ class FlatMenu(FlatMenuBase): """ Redraws the menu. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param integer `oldSelection`: if non-negative, the index representing the previous selected menu item. """ @@ -6059,7 +6059,7 @@ class FlatMenu(FlatMenuBase): """ HitTest method for :class:`FlatMenu`. - :param `pos`: an instance of :class:`Point`, a point to test for hits. + :param `pos`: an instance of :class:`wx.Point`, a point to test for hits. :return: A tuple representing one of the following combinations: @@ -6205,7 +6205,7 @@ class FlatMenu(FlatMenuBase): Processes mouse right clicks. :param `pos`: the position at which the mouse right button was pressed, - an instance of :class:`Point`. + an instance of :class:`wx.Point`. """ rect = self.GetClientRect() @@ -6274,7 +6274,7 @@ class FlatMenu(FlatMenuBase): Processes mouse left clicks. :param `pos`: the position at which the mouse left button was pressed, - an instance of :class:`Point`. + an instance of :class:`wx.Point`. """ rect = self.GetClientRect() @@ -6311,7 +6311,7 @@ class FlatMenu(FlatMenuBase): Processes mouse left clicks. :param `pos`: the position at which the mouse left button was pressed, - an instance of :class:`Point`. + an instance of :class:`wx.Point`. """ self.ProcessMouseLClick(pos) @@ -6338,7 +6338,7 @@ class FlatMenu(FlatMenuBase): """ Processes mouse movements. - :param `pos`: the position at which the mouse was moved, an instance of :class:`Point`. + :param `pos`: the position at which the mouse was moved, an instance of :class:`wx.Point`. """ rect = self.GetClientRect() @@ -6838,7 +6838,7 @@ class FlatMenu(FlatMenuBase): Sets the :class:`FlatMenuItem` font. :param integer `itemId`: the menu item identifier; - :param `font`: an instance of a valid :class:`Font`. + :param `font`: an instance of a valid :class:`wx.Font`. """ item = self.FindItem(itemId) diff --git a/wx/lib/agw/flatnotebook.py b/wx/lib/agw/flatnotebook.py index b526d0fc..48513912 100644 --- a/wx/lib/agw/flatnotebook.py +++ b/wx/lib/agw/flatnotebook.py @@ -831,7 +831,7 @@ def PaintStraightGradientBox(dc, rect, startColour, endColour, vertical=True): """ Draws a gradient coloured box from `startColour` to `endColour`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the rectangle to fill with the gradient shading; :param `startColour`: the first colour in the gradient shading; :param `endColour`: the last colour in the gradient shading; @@ -913,7 +913,7 @@ def DrawButton(dc, rect, focus, upperTabs): """ Draws a :class:`FlatNotebook` tab. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the tab's client rectangle; :param `focus`: ``True`` if the tab has focus, ``False`` otherwise; :param `upperTabs`: ``True`` if the tabs are at the top, ``False`` if they are @@ -1116,7 +1116,7 @@ class PageInfo(object): :param `caption`: the tab caption; :param `imageindex`: the tab image index based on the assigned (set) - :class:`ImageList` (if any); + :class:`wx.ImageList` (if any); :param `tabangle`: the tab angle (only on standard tabs, from 0 to 15 degrees); :param `enabled`: sets the tab as enabled or disabled. @@ -1155,7 +1155,7 @@ class PageInfo(object): """ Sets the tab position. - :param `value`: an instance of :class:`Point`. + :param `value`: an instance of :class:`wx.Point`. """ self._pos = value @@ -1171,7 +1171,7 @@ class PageInfo(object): """ Sets the tab size. - :param `value`: an instance of :class:`Size`. + :param `value`: an instance of :class:`wx.Size`. """ self._size = value @@ -1261,7 +1261,7 @@ class PageInfo(object): """ Sets the tab region. - :param `points`: a Python list of :class:`Point` + :param `points`: a Python list of :class:`wx.Point` """ self._region = wx.Region(points) @@ -1277,7 +1277,7 @@ class PageInfo(object): """ Sets the button 'X' area rect. - :param `xrect`: an instance of :class:`Rect`, specifying the client rectangle + :param `xrect`: an instance of :class:`wx.Rect`, specifying the client rectangle of the 'X' button. """ @@ -1835,7 +1835,7 @@ class FNBRenderer(object): """ Draws the left and right scrolling arrows. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `pc`: an instance of :class:`FlatNotebook`; :param `rect`: the client rectangle containing the scrolling arrows. """ @@ -1849,7 +1849,7 @@ class FNBRenderer(object): Draws the left navigation arrow. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -1893,7 +1893,7 @@ class FNBRenderer(object): Draws the right navigation arrow. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -1938,7 +1938,7 @@ class FNBRenderer(object): Draws the drop-down arrow in the navigation area. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -1974,7 +1974,7 @@ class FNBRenderer(object): Draw the 'X' navigation button in the navigation area. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -2011,7 +2011,7 @@ class FNBRenderer(object): Draws the 'X' in the selected tab. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the current tab client rectangle; :param `tabIdx`: the index of the current tab; :param `btnStatus`: the status of the 'X' button in the current tab. @@ -2050,7 +2050,7 @@ class FNBRenderer(object): Draws a line over the tabs. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `selTabX1`: first x coordinate of the tab line; :param `selTabX2`: second x coordinate of the tab line. """ @@ -2225,7 +2225,7 @@ class FNBRenderer(object): Actually draws the tabs in :class:`FlatNotebook`. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -2396,7 +2396,7 @@ class FNBRenderer(object): """ Draws a focus rectangle like the native :class:`Notebook`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `pageContainer`: an instance of :class:`FlatNotebook`; :param `page`: an instance of :class:`PageInfo`, representing a page in the notebook. """ @@ -2558,7 +2558,7 @@ class FNBRendererDefault(FNBRenderer): Draws a tab using the `Standard` style. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `posx`: the x position of the tab; :param `tabIdx`: the index of the tab; :param `tabWidth`: the tab's width; @@ -2693,7 +2693,7 @@ class FNBRendererFirefox2(FNBRenderer): Draws a tab using the `Firefox 2` style. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `posx`: the x position of the tab; :param `tabIdx`: the index of the tab; :param `tabWidth`: the tab's width; @@ -2807,7 +2807,7 @@ class FNBRendererVC71(FNBRenderer): Draws a tab using the `VC71` style. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `posx`: the x position of the tab; :param `tabIdx`: the index of the tab; :param `tabWidth`: the tab's width; @@ -2932,7 +2932,7 @@ class FNBRendererFancy(FNBRenderer): Draws a tab using the `Fancy` style, similar to the `VC71` one but with gradients. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `posx`: the x position of the tab; :param `tabIdx`: the index of the tab; :param `tabWidth`: the tab's width; @@ -3050,7 +3050,7 @@ class FNBRendererVC8(FNBRenderer): Draws all the tabs using `VC8` style. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -3203,7 +3203,7 @@ class FNBRendererVC8(FNBRenderer): Draws a tab using the `VC8` style. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `posx`: the x position of the tab; :param `tabIdx`: the index of the tab; :param `tabWidth`: the tab's width; @@ -3350,8 +3350,8 @@ class FNBRendererVC8(FNBRenderer): Fills a tab with a gradient shading. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; - :param `tabPoints`: a Python list of :class:`Point` representing the tab outline; + :param `dc`: an instance of :class:`wx.DC`; + :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline; :param `bSelectedTab`: ``True`` if the tab is selected, ``False`` otherwise; :param `tabIdx`: the index of the tab; """ @@ -3442,7 +3442,7 @@ class FNBRendererVC8(FNBRenderer): """ Returns the `x` start position of a tab. - :param `tabPoints`: a Python list of :class:`Point` representing the tab outline; + :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline; :param `y`: the y start position of the tab; :param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top). """ @@ -3507,7 +3507,7 @@ class FNBRendererVC8(FNBRenderer): """ Returns the `x` end position of a tab. - :param `tabPoints`: a Python list of :class:`Point` representing the tab outline; + :param `tabPoints`: a Python list of :class:`wx.Point` representing the tab outline; :param `y`: the y end position of the tab; :param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top). """ @@ -3681,7 +3681,7 @@ class FNBRendererRibbonTabs(FNBRenderer): Draws a tab using the `Ribbon Tabs` style. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `posx`: the x position of the tab; :param `tabIdx`: the index of the tab; :param `tabWidth`: the tab's width; @@ -3761,7 +3761,7 @@ class FNBRendererRibbonTabs(FNBRenderer): Actually draws the tabs in :class:`FlatNotebook`. :param `pageContainer`: an instance of :class:`FlatNotebook`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pc = pageContainer @@ -4092,7 +4092,7 @@ class FlatNotebook(wx.Panel): """ Sets a custom panel to show when there are no pages left in :class:`FlatNotebook`. - :param `panel`: any subclass of :class:`Window` will do, as long as it is suitable + :param `panel`: any subclass of :class:`wx.Window` will do, as long as it is suitable to be used as a notebook page. Examples include :class:`Panel`, :class:`ScrolledWindow`, and so on. """ @@ -4270,7 +4270,7 @@ class FlatNotebook(wx.Panel): """ Sets the image list for the page control. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self._pages.SetImageList(imageList) @@ -4280,7 +4280,7 @@ class FlatNotebook(wx.Panel): """ Assigns the image list for the page control. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self._pages.AssignImageList(imageList) @@ -4534,7 +4534,7 @@ class FlatNotebook(wx.Panel): """ Returns the index at which the window is found. - :param `win`: an instance of :class:`Window`. + :param `win`: an instance of :class:`wx.Window`. """ try: @@ -4853,7 +4853,7 @@ class FlatNotebook(wx.Panel): """ Sets the popup menu associated to a right click on a tab. - :param `menu`: an instance of :class:`Menu`. + :param `menu`: an instance of :class:`wx.Menu`. """ self._pages._pRightClickMenu = menu @@ -5260,7 +5260,7 @@ class PageContainer(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`PageContainer`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ # When resizing the control, try to fit to screen as many tabs as we can @@ -5507,7 +5507,7 @@ class PageContainer(wx.Panel): """ HitTest method for :class:`PageContainer`. - :param `pt`: an instance of :class:`Point`, to test for hits. + :param `pt`: an instance of :class:`wx.Point`, to test for hits. :return: The hit test flag (if any) and the hit page index (if any). The return value can be one of the following bits: @@ -6466,7 +6466,7 @@ class PageContainer(wx.Panel): """ Handles the ``wx.EVT_MENU`` event for :class:`PageContainer`. - :param `event`: a :class:`MenuEvent` event to be processed. + :param `event`: a :class:`wx.MenuEvent` event to be processed. """ selection = event.GetId() - 1 @@ -6510,7 +6510,7 @@ class PageContainer(wx.Panel): """ Sets the image list for the :class:`PageContainer`. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self._ImageList = imglist @@ -6520,7 +6520,7 @@ class PageContainer(wx.Panel): """ Assigns the image list for the :class:`PageContainer`. - :param `imageList`: an instance of :class:`ImageList`. + :param `imageList`: an instance of :class:`wx.ImageList`. """ self._ImageList = imglist diff --git a/wx/lib/agw/floatspin.py b/wx/lib/agw/floatspin.py index 7b623ad1..dae2105d 100644 --- a/wx/lib/agw/floatspin.py +++ b/wx/lib/agw/floatspin.py @@ -32,7 +32,7 @@ Description =========== :class:`FloatSpin` implements a floating point :class:`SpinCtrl`. It is built using a custom -:class:`Control`, composed by a :class:`TextCtrl` and a :class:`SpinButton`. In order to +:class:`wx.Control`, composed by a :class:`TextCtrl` and a :class:`SpinButton`. In order to correctly handle floating points numbers without rounding errors or non-exact floating point representations, :class:`FloatSpin` uses the great :class:`FixedPoint` class from Tim Peters. @@ -284,7 +284,7 @@ class FloatTextCtrl(wx.TextCtrl): """ Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`FloatTextCtrl`. - :param `event`: a :class:`WindowDestroyEvent` event to be processed. + :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed. :note: This method tries to correctly handle the control destruction under MSW. """ @@ -329,7 +329,7 @@ class FloatTextCtrl(wx.TextCtrl): class FloatSpin(wx.Control): """ :class:`FloatSpin` implements a floating point :class:`SpinCtrl`. It is built using a custom - :class:`Control`, composed by a :class:`TextCtrl` and a :class:`SpinButton`. In order to + :class:`wx.Control`, composed by a :class:`TextCtrl` and a :class:`SpinButton`. In order to correctly handle floating points numbers without rounding errors or non-exact floating point representations, :class:`FloatSpin` uses the great :class:`FixedPoint` class from Tim Peters. @@ -506,7 +506,7 @@ class FloatSpin(wx.Control): """ Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`FloatSpin`. - :param `event`: a :class:`WindowDestroyEvent` event to be processed. + :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed. :note: This method tries to correctly handle the control destruction under MSW. """ @@ -527,7 +527,7 @@ class FloatSpin(wx.Control): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if self._spinctrl_bestsize.x == -999: @@ -743,7 +743,7 @@ class FloatSpin(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`FloatSpin`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. :note: This method resizes the text control and reposition the spin button when resized. @@ -1118,7 +1118,7 @@ class FloatSpin(wx.Control): """ Sets the underlying :class:`TextCtrl` font. - :param `font`: a valid instance of :class:`Font`. + :param `font`: a valid instance of :class:`wx.Font`. """ if font is None: diff --git a/wx/lib/agw/foldpanelbar.py b/wx/lib/agw/foldpanelbar.py index ad49f0d0..883d692a 100644 --- a/wx/lib/agw/foldpanelbar.py +++ b/wx/lib/agw/foldpanelbar.py @@ -72,7 +72,7 @@ The :class:`FoldPanelBar` is a control that contains multiple panels (of type the :class:`FoldPanelBar` can be customized by setting it to a horizontal gradient style, vertical gradient style, a single colour, a rectangle or filled rectangle. The `FoldPanel` items can be collapsed in place or to the -bottom of the control. :class:`Window` derived controls can be added +bottom of the control. :class:`wx.Window` derived controls can be added dynamically, and separated by separator lines. @@ -280,7 +280,7 @@ FPB_VERTICAL = 0x0010 FPB_ALIGN_LEFT = 0 """ Aligns left instead of fitting the width of the child window to be added. Use either this one or ``FPB_ALIGN_WIDTH``. """ FPB_ALIGN_WIDTH = 1 -""" The :class:`Window` to be added will be aligned to fit the width of the FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes. """ +""" The :class:`wx.Window` to be added will be aligned to fit the width of the FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes. """ FPB_DEFAULT_LEFTSPACING = 5 FPB_DEFAULT_RIGHTSPACING = 10 @@ -330,7 +330,7 @@ class CaptionBarStyle(object): """ Sets font for the caption bar. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. :note: If this is not set, the font property is undefined and will not be used. Use :meth:`~CaptionBarStyle.CaptionFontUsed` to check if this style is used. @@ -614,7 +614,7 @@ class CaptionBar(wx.Window): :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param `caption`: the string to be displayed in :class:`CaptionBar`; - :param `foldIcons`: an instance of :class:`ImageList` containing the icons to display + :param `foldIcons`: an instance of :class:`wx.ImageList` containing the icons to display next to the caption text; :param `cbstyle`: the :class:`CaptionBar` window style. Must be an instance of :class:`CaptionBarStyle`; @@ -860,7 +860,7 @@ class CaptionBar(wx.Window): Fills the background of the caption with either a gradient or a solid colour. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ style = self._style.GetCaptionStyle() @@ -966,7 +966,7 @@ class CaptionBar(wx.Window): Returns the best size for this panel, based upon the font assigned to this window, and the caption string. - :note: Overridden from :class:`Window`. + :note: Overridden from :class:`wx.Window`. """ if self.IsVertical(): @@ -989,7 +989,7 @@ class CaptionBar(wx.Window): """ Gradient fill from colour 1 to colour 2 from top to bottom. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the :class:`CaptionBar` client rectangle. """ @@ -1027,7 +1027,7 @@ class CaptionBar(wx.Window): """ Gradient fill from colour 1 to colour 2 from left to right. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the :class:`CaptionBar` client rectangle. """ @@ -1065,7 +1065,7 @@ class CaptionBar(wx.Window): """ Single colour fill for :class:`CaptionBar`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the :class:`CaptionBar` client rectangle. """ @@ -1083,7 +1083,7 @@ class CaptionBar(wx.Window): """ Single rectangle for :class:`CaptionBar`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the :class:`CaptionBar` client rectangle. """ @@ -1116,7 +1116,7 @@ class CaptionBar(wx.Window): """ Handles the ``wx.EVT_SIZE`` event for :class:`CaptionBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ if not self._controlCreated: @@ -1191,7 +1191,7 @@ class FoldPanelBar(wx.Panel): panel or sash window, and populate panels with :meth:`FoldPanelBar.AddFoldPanel() `. Then use the :meth:`FoldPanelBar.AddFoldPanelWindow() ` to add - :class:`Window` derived controls to the current fold panel. Use + :class:`wx.Window` derived controls to the current fold panel. Use :meth:`FoldPanelBar.AddFoldPanelSeparator() ` to put separators between the groups of controls that need a visual separator to group them together. After all is constructed, the user can fold the panels @@ -1261,7 +1261,7 @@ class FoldPanelBar(wx.Panel): :param `caption`: the caption to be displayed in the associated :class:`CaptionBar`; :param `collapsed`: if set to ``True``, the panel is collapsed initially; - :param `foldIcons`: an instance of :class:`ImageList` containing the icons to display + :param `foldIcons`: an instance of :class:`wx.ImageList` containing the icons to display next to the caption text; :param `cbstyle`: an instance of :class:`CaptionBarStyle`. @@ -1270,7 +1270,7 @@ class FoldPanelBar(wx.Panel): from the list. Use this foldpanel to add windows to it. :see: :meth:`~FoldPanelBar.AddFoldPanelWindow` and :meth:`~FoldPanelBar.AddFoldPanelSeparator` to see how to add - items derived from :class:`Window` to the panels. + items derived from :class:`wx.Window` to the panels. """ if cbstyle is None: @@ -1307,30 +1307,30 @@ class FoldPanelBar(wx.Panel): leftSpacing=FPB_DEFAULT_LEFTLINESPACING, rightSpacing=FPB_DEFAULT_RIGHTLINESPACING): """ - Adds a :class:`Window` derived instance to the referenced fold panel. + Adds a :class:`wx.Window` derived instance to the referenced fold panel. :param `panel`: an instance of :class:`FoldPanelItem`; :param `window`: the window we wish to add to the fold panel, an instance - of :class:`Window`; + of :class:`wx.Window`; :param `flags`: can be one of the following bits: ====================== ======= ==================================== Align Flag Value Description ====================== ======= ==================================== - ``FPB_ALIGN_WIDTH`` 1 The :class:`Window` to be added will be aligned to fit the width of the FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes. + ``FPB_ALIGN_WIDTH`` 1 The :class:`wx.Window` to be added will be aligned to fit the width of the FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes. ``FPB_ALIGN_LEFT`` 0 Aligns left instead of fitting the width of the child window to be added. Use either this one or ``FPB_ALIGN_WIDTH``. ====================== ======= ==================================== - :param `spacing`: the :class:`Window` to be added can be slightly indented from + :param `spacing`: the :class:`wx.Window` 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; - :param `leftSpacing`: give the :class:`Window` added a slight indent from the left; - :param `rightSpacing`: give the :class:`Window` added a slight indent from the right; + to give the control an y offset from the previous :class:`wx.Window` added; + :param `leftSpacing`: give the :class:`wx.Window` added a slight indent from the left; + :param `rightSpacing`: give the :class:`wx.Window` added a slight indent from the right; :note: Make the window be a child of the fold panel! The following example adds a FoldPanel to the :class:`FoldPanelBar` and - adds two :class:`Window` derived controls to the FoldPanel:: + adds two :class:`wx.Window` derived controls to the FoldPanel:: # Create the FoldPanelBar m_pnl = FoldPanelBar(self, wx.ID_ANY, wx.DefaultPosition, wx.DefaultSize, agwStyle=0x2) @@ -1382,7 +1382,7 @@ class FoldPanelBar(wx.Panel): :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; + to give the control an y offset from the previous :class:`wx.Window` added; :param `leftSpacing`: give the added separator a slight indent from the left; :param `rightSpacing`: give the added separator a slight indent from the right. """ @@ -1400,7 +1400,7 @@ class FoldPanelBar(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`FoldPanelBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ # skip all stuff when we are not initialised yet @@ -1726,7 +1726,7 @@ class FoldPanelItem(wx.Panel): :param `parent`: the :class:`FoldPanelItem` parent window; :param `id`: an identifier for the control: a value of -1 is taken to mean a default; :param `caption`: the string to be displayed in :class:`CaptionBar`; - :param `foldIcons`: an instance of :class:`ImageList` containing the icons to display + :param `foldIcons`: an instance of :class:`wx.ImageList` containing the icons to display next to the caption text; :param `collapsed`: ``True`` if the :class:`CaptionBar` should start in the collapsed state, ``False`` otherwise; @@ -1786,13 +1786,13 @@ class FoldPanelItem(wx.Panel): """ Adds a window item to the list of items on this panel. - :param `window`: an instance of :class:`Window`; + :param `window`: an instance of :class:`wx.Window`; :param `flags`: can be one of the following bits: ====================== ======= ==================================== Align Flag Value Description ====================== ======= ==================================== - ``FPB_ALIGN_WIDTH`` 1 The :class:`Window` to be added will be aligned to fit the width of the FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes. + ``FPB_ALIGN_WIDTH`` 1 The :class:`wx.Window` to be added will be aligned to fit the width of the FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes. ``FPB_ALIGN_LEFT`` 0 Aligns left instead of fitting the width of the child window to be added. Use either this one or ``FPB_ALIGN_WIDTH``. ====================== ======= ==================================== @@ -1831,7 +1831,7 @@ class FoldPanelItem(wx.Panel): :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; + to give the control an y offset from the previous :class:`wx.Window` added; :param `leftSpacing`: give the added separator a slight indent from the left; :param `rightSpacing`: give the added separator a slight indent from the right. """ @@ -2066,8 +2066,8 @@ class FoldPanelItem(wx.Panel): class FoldWindowItem(object): """ This class is a child sibling of the :class:`FoldPanelItem` class. It - will contain :class:`Window` that can be either a separator (a coloured - line simulated by a :class:`Window`) or a wxPython controls (such as a + will contain :class:`wx.Window` that can be either a separator (a coloured + line simulated by a :class:`wx.Window`) or a wxPython controls (such as a :class:`Button`, a :class:`ListCtrl` etc...). """ diff --git a/wx/lib/agw/fourwaysplitter.py b/wx/lib/agw/fourwaysplitter.py index 7c976db7..296722a7 100644 --- a/wx/lib/agw/fourwaysplitter.py +++ b/wx/lib/agw/fourwaysplitter.py @@ -402,7 +402,7 @@ class FourWaySplitter(wx.Panel): Add a new window to the splitter at the right side or bottom of the window stack. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. """ self.InsertWindow(len(self._windows), window) @@ -413,7 +413,7 @@ class FourWaySplitter(wx.Panel): Insert a new window into the splitter at the position given in `idx`. :param `idx`: the index at which the window will be inserted; - :param `window`: an instance of :class:`Window`; + :param `window`: an instance of :class:`wx.Window`; :param `sashPos`: the sash position after the window insertion. """ @@ -429,7 +429,7 @@ class FourWaySplitter(wx.Panel): Removes the window from the stack of windows managed by the splitter. The window will still exist so you should `Hide` or `Destroy` it as needed. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. """ assert window in self._windows, "Unknown window!" @@ -446,8 +446,8 @@ class FourWaySplitter(wx.Panel): splitter) with `newWindow`. The `oldWindow` window will still exist so you should `Hide` or `Destroy` it as needed. - :param `oldWindow`: an instance of :class:`Window`; - :param `newWindow`: another instance of :class:`Window`. + :param `oldWindow`: an instance of :class:`wx.Window`; + :param `newWindow`: another instance of :class:`wx.Window`. """ assert oldWindow in self._windows, "Unknown window!" @@ -462,8 +462,8 @@ class FourWaySplitter(wx.Panel): """ Trade the positions in the splitter of the two windows. - :param `window1`: an instance of :class:`Window`; - :param `window2`: another instance of :class:`Window`. + :param `window1`: an instance of :class:`wx.Window`; + :param `window2`: another instance of :class:`wx.Window`. """ assert window1 in self._windows, "Unknown window!" @@ -612,7 +612,7 @@ class FourWaySplitter(wx.Panel): Determines the split mode for :class:`FourWaySplitter`. :param `pt`: the point at which the mouse has been clicked, an instance of - :class:`Point`. + :class:`wx.Point`. :return: One of the following 3 split modes: @@ -859,7 +859,7 @@ class FourWaySplitter(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`FourWaySplitter`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ parent = wx.GetTopLevelParent(self) @@ -916,7 +916,7 @@ class FourWaySplitter(wx.Panel): """ Actually draws the sashes. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ backColour = self.GetBackgroundColour() diff --git a/wx/lib/agw/genericmessagedialog.py b/wx/lib/agw/genericmessagedialog.py index d24fd1da..7ae00513 100644 --- a/wx/lib/agw/genericmessagedialog.py +++ b/wx/lib/agw/genericmessagedialog.py @@ -1459,7 +1459,7 @@ class GenericMessageDialog(wx.Dialog): :param `message`: the original input message; :param `wrap`: wraps the string in `message` so that every line is at most `wrap` pixels long; - :param `font`: if not ``None``, it should be an instance of :class:`Font` to be + :param `font`: if not ``None``, it should be an instance of :class:`wx.Font` to be used to measure and then wrap the input `message`. :return: a new message wrapped at maximum `wrap` pixels wide. diff --git a/wx/lib/agw/gradientbutton.py b/wx/lib/agw/gradientbutton.py index d2ca29d6..b0635e6a 100644 --- a/wx/lib/agw/gradientbutton.py +++ b/wx/lib/agw/gradientbutton.py @@ -263,7 +263,7 @@ class GradientButton(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`GradientButton`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ event.Skip() @@ -506,7 +506,7 @@ class GradientButton(wx.Control): Given the current font and bezel width settings, calculate and set a good size. - :param `size`: an instance of :class:`Size`. + :param `size`: an instance of :class:`wx.Size`. """ if size is None: @@ -520,7 +520,7 @@ class GradientButton(wx.Control): """ Can this window be given focus by mouse click? - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self.IsShown() and self.IsEnabled() @@ -540,7 +540,7 @@ class GradientButton(wx.Control): Overridden base class virtual. Buttons usually don't inherit the parent's colours. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return False @@ -552,7 +552,7 @@ class GradientButton(wx.Control): :param `enable`: ``True`` to enable the button, ``False`` to disable it. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ wx.Control.Enable(self, enable) @@ -667,7 +667,7 @@ class GradientButton(wx.Control): :param `colour`: a valid :class:`wx.Colour` object. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ wx.Control.SetForegroundColour(self, colour) @@ -679,7 +679,7 @@ class GradientButton(wx.Control): Overridden base class virtual. Determines the best size of the button based on the label and bezel size. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ label = self.GetLabel() diff --git a/wx/lib/agw/hyperlink.py b/wx/lib/agw/hyperlink.py index 79340046..d1124b8a 100644 --- a/wx/lib/agw/hyperlink.py +++ b/wx/lib/agw/hyperlink.py @@ -182,7 +182,7 @@ class HyperLinkEvent(wx.CommandEvent): """ Sets the event position. - :param `pos`: an instance of :class:`Point`. + :param `pos`: an instance of :class:`wx.Point`. """ self._pos = pos @@ -384,7 +384,7 @@ class HyperLinkCtrl(StaticText): """ Handles the ``wx.EVT_MENU`` event for :class:`HyperLinkCtrl`. - :param `event`: a :class:`MenuEvent` event to be processed. + :param `event`: a :class:`wx.MenuEvent` event to be processed. :note: This method copies the data from the :class:`HyperLinkCtrl` to the clipboard. """ diff --git a/wx/lib/agw/hypertreelist.py b/wx/lib/agw/hypertreelist.py index d271cabc..bb023586 100644 --- a/wx/lib/agw/hypertreelist.py +++ b/wx/lib/agw/hypertreelist.py @@ -591,7 +591,7 @@ class TreeListColumnInfo(object): """ Sets the column text font. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ self._font = font @@ -813,10 +813,10 @@ class TreeListHeaderWindow(wx.Window): # scrollbar: this allows us to always use logical coords def AdjustDC(self, dc): """ - Shifts the :class:`DC` origin to match the position of the main window horizontal + Shifts the :class:`wx.DC` origin to match the position of the main window horizontal scrollbar: this allows us to always use logical coordinates. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ xpix, dummy = self._owner.GetScrollPixelsPerUnit() @@ -1116,7 +1116,7 @@ class TreeListHeaderWindow(wx.Window): Sends a :class:`ListEvent` for the parent window. :param `evtType`: the event type; - :param `pos`: an instance of :class:`Point`. + :param `pos`: an instance of :class:`wx.Point`. """ parent = self.GetParent() @@ -1381,7 +1381,7 @@ class TreeListItem(GenericTreeItem): """ HitTest method for an item. Called from the main window HitTest. - :param `point`: the point to test for the hit (an instance of :class:`Point`); + :param `point`: the point to test for the hit (an instance of :class:`wx.Point`); :param `theCtrl`: the main :class:`TreeListMainWindow` tree; :param `flags`: a bitlist of hit locations; :param `column`: an integer specifying the column index; @@ -2718,7 +2718,7 @@ class TreeListMainWindow(CustomTreeCtrl): Actually draws an item. :param `item`: an instance of :class:`TreeListItem`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ def _paintText(text, textrect, alignment): @@ -3047,7 +3047,7 @@ class TreeListMainWindow(CustomTreeCtrl): Paint a level in the hierarchy of :class:`TreeListMainWindow`. :param `item`: an instance of :class:`TreeListItem`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `level`: the item level in the tree hierarchy; :param `y`: the current vertical position in the :class:`ScrolledWindow`; :param `x_maincol`: the horizontal position of the main column. @@ -3296,7 +3296,7 @@ class TreeListMainWindow(CustomTreeCtrl): Calculates which (if any) item is under the given point, returning the tree item at this point plus extra information flags plus the item's column. - :param `point`: an instance of :class:`Point`, a point to test for hits; + :param `point`: an instance of :class:`wx.Point`, a point to test for hits; :param `flags`: a bitlist of the following values: ================================== =============== ================================= @@ -3780,7 +3780,7 @@ class TreeListMainWindow(CustomTreeCtrl): Calculates overall position and size of an item. :param `item`: an instance of :class:`TreeListItem`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ attr = item.GetAttributes() @@ -3845,7 +3845,7 @@ class TreeListMainWindow(CustomTreeCtrl): Calculates the level of an item inside the tree hierarchy. :param `item`: an instance of :class:`TreeListItem`; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `level`: the item level in the tree hierarchy; :param `y`: the current vertical position inside the :class:`ScrolledWindow`; :param `x_colstart`: the x coordinate at which the item's column starts. @@ -4226,7 +4226,7 @@ class HyperTreeList(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`HyperTreeList`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.DoHeaderLayout() @@ -4236,7 +4236,7 @@ class HyperTreeList(wx.Control): """ Sets the default font for the header window and the main window. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ if self._header_win: @@ -4254,7 +4254,7 @@ class HyperTreeList(wx.Control): """ Sets the default font for the header window.. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ if not self._header_win: @@ -4364,10 +4364,10 @@ class HyperTreeList(wx.Control): event handler function under Windows and automatically under GTK. :note: Setting the background colour does not cause an immediate refresh, so - you may wish to call :meth:`Window.ClearBackground` or :meth:`Window.Refresh` after + you may wish to call :meth:`wx.Window.ClearBackground` or :meth:`wx.Window.Refresh` after calling this function. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if not self._main_win: @@ -4383,7 +4383,7 @@ class HyperTreeList(wx.Control): :param `colour`: the colour to be used as the foreground colour, pass :class:`NullColour` to reset to the default colour. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if not self._main_win: @@ -4681,7 +4681,7 @@ class HyperTreeList(wx.Control): Sets the column text font. :param `column`: an integer specifying the column index; - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ self._header_win.SetColumn(column, self.GetColumn(column).SetFont(font)) @@ -4710,7 +4710,7 @@ class HyperTreeList(wx.Control): event loop iteration, if you need to update the window immediately you should use `Update` instead. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ self._main_win.Refresh(erase, rect) @@ -4741,7 +4741,7 @@ class HyperTreeList(wx.Control): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ # something is better than nothing... diff --git a/wx/lib/agw/infobar.py b/wx/lib/agw/infobar.py index 00ff314a..37ac3895 100644 --- a/wx/lib/agw/infobar.py +++ b/wx/lib/agw/infobar.py @@ -245,7 +245,7 @@ class AutoWrapStaticText(StaticText): """ Defsult class constructor. - :param Window parent: a subclass of :class:`Window`, must not be ``None``; + :param wx.Window parent: a subclass of :class:`wx.Window`, must not be ``None``; :param string `label`: the :class:`AutoWrapStaticText` text label. """ @@ -264,7 +264,7 @@ class AutoWrapStaticText(StaticText): """ Handles the ``wx.EVT_SIZE`` event for :class:`AutoWrapStaticText`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ event.Skip() @@ -311,7 +311,7 @@ class AutoWrapStaticText(StaticText): :param bool `wrapped`: ``True`` if this method was called by the developer using :meth:`~AutoWrapStaticText.SetLabel`, ``False`` if it comes from the :meth:`~AutoWrapStaticText.OnSize` event handler. - :note: Reimplemented from :class:`Control`. + :note: Reimplemented from :class:`wx.Control`. """ if not wrapped: @@ -341,10 +341,10 @@ class InfoBar(wx.Control): :param integer `id`: window identifier. A value of -1 indicates a default value; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `style`: the :class:`InfoBar` style (unused at present); :param string `name`: the control name. """ @@ -422,9 +422,9 @@ class InfoBar(wx.Control): :class:`InfoBar` overrides this method to use the font passed to it for its text message part. By default a larger and bold version of the standard font is used. - :param `font`: a valid instance of :class:`Font`. + :param `font`: a valid instance of :class:`wx.Font`. - :note: Reimplemented from :class:`Window`. + :note: Reimplemented from :class:`wx.Window`. """ if not wx.Control.SetFont(self, font): diff --git a/wx/lib/agw/knobctrl.py b/wx/lib/agw/knobctrl.py index ca59071f..bca54b57 100644 --- a/wx/lib/agw/knobctrl.py +++ b/wx/lib/agw/knobctrl.py @@ -270,7 +270,7 @@ class BufferedWindow(wx.Window): """ This method should be overridden when sub-classed. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pass @@ -295,7 +295,7 @@ class BufferedWindow(wx.Window): """ Handles the ``wx.EVT_SIZE`` event for :class:`BufferedWindow`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ # The Buffer init is done here, to make sure the buffer is always @@ -579,7 +579,7 @@ class KnobCtrl(BufferedWindow): Draws everything on the empty bitmap. Here all the chosen styles are applied. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ size = self.GetClientSize() @@ -601,7 +601,7 @@ class KnobCtrl(BufferedWindow): """ Draws the tags. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `size`: the control size. """ @@ -653,7 +653,7 @@ class KnobCtrl(BufferedWindow): """ Draw a shading of diagonal gradient to :class:`KnobCtrl`. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `size`: the control size. """ @@ -746,7 +746,7 @@ class KnobCtrl(BufferedWindow): """ Draws the small knob. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `pencolour`: the colour to use for drawing the inset circle. """ @@ -772,7 +772,7 @@ class KnobCtrl(BufferedWindow): """ Draws the :class:`KnobCtrl` bounding circle. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `size`: the control size. """ diff --git a/wx/lib/agw/labelbook.py b/wx/lib/agw/labelbook.py index 911d5051..59ce7de7 100644 --- a/wx/lib/agw/labelbook.py +++ b/wx/lib/agw/labelbook.py @@ -350,7 +350,7 @@ class ImageInfo(object): :param `strCaption`: the tab caption; :param `imageIndex`: the tab image index based on the assigned (set) - :class:`ImageList` (if any); + :class:`wx.ImageList` (if any); :param `enabled`: sets the tab as enabled or disabled. """ @@ -382,7 +382,7 @@ class ImageInfo(object): """ Sets the tab position. - :param `value`: the new tab position, an instance of :class:`Point`. + :param `value`: the new tab position, an instance of :class:`wx.Point`. """ self._pos = value @@ -398,7 +398,7 @@ class ImageInfo(object): """ Sets the tab size. - :param `value`: the new tab size, an instance of :class:`Size`. + :param `value`: the new tab size, an instance of :class:`wx.Size`. """ self._size = value @@ -430,7 +430,7 @@ class ImageInfo(object): """ Sets the client rectangle available for the tab text. - :param `rect`: the tab text client rectangle, an instance of :class:`Rect`. + :param `rect`: the tab text client rectangle, an instance of :class:`wx.Rect`. """ self._captionRect = rect @@ -566,9 +566,9 @@ class ImageContainerBase(wx.Panel): def AssignImageList(self, imglist): """ - Assigns an image list to the :class:`ImageContainerBase`. + Assigns an image list to the :class:`wx.ImageContainerBase`. - :param `imglist`: an instance of :class:`ImageList`. + :param `imglist`: an instance of :class:`wx.ImageList`. """ if imglist and imglist.GetImageCount() != 0: @@ -581,13 +581,13 @@ class ImageContainerBase(wx.Panel): def GetImageList(self): - """ Return the image list for :class:`ImageContainerBase`. """ + """ Return the image list for :class:`wx.ImageContainerBase`. """ return self._ImageList def GetImageSize(self): - """ Returns the image size inside the :class:`ImageContainerBase` image list. """ + """ Returns the image size inside the :class:`wx.ImageContainerBase` image list. """ return self._nImgSize @@ -598,7 +598,7 @@ class ImageContainerBase(wx.Panel): `maxWidth` value this function truncates it and appends two dots at the end. ("Long Long Long Text" might become "Long Long..."). - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `text`: the text to fix/truncate; :param `maxWidth`: the maximum allowed width for the text, in pixels. """ @@ -765,9 +765,9 @@ class ImageContainerBase(wx.Panel): def OnSize(self, event): """ - Handles the ``wx.EVT_SIZE`` event for :class:`ImageContainerBase`. + Handles the ``wx.EVT_SIZE`` event for :class:`wx.ImageContainerBase`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() # Call on paint @@ -776,7 +776,7 @@ class ImageContainerBase(wx.Panel): def OnEraseBackground(self, event): """ - Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`ImageContainerBase`. + Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`wx.ImageContainerBase`. :param `event`: a :class:`EraseEvent` event to be processed. @@ -791,7 +791,7 @@ class ImageContainerBase(wx.Panel): Returns the index of the tab at the specified position or ``wx.NOT_FOUND`` if ``None``, plus the flag style of :meth:`~ImageContainerBase.HitTest`. - :param `pt`: an instance of :class:`Point`, to test for hits. + :param `pt`: an instance of :class:`wx.Point`, to test for hits. :return: The index of the tab at the specified position plus the hit test flag, which can be one of the following bits: @@ -837,7 +837,7 @@ class ImageContainerBase(wx.Panel): """ Tests whether pt is located on the sash. - :param `pt`: an instance of :class:`Point`, to test for hits. + :param `pt`: an instance of :class:`wx.Point`, to test for hits. """ # Check if we are on a the sash border @@ -856,7 +856,7 @@ class ImageContainerBase(wx.Panel): def OnMouseLeftDown(self, event): """ - Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`ImageContainerBase`. + Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`wx.ImageContainerBase`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -893,7 +893,7 @@ class ImageContainerBase(wx.Panel): def OnMouseLeaveWindow(self, event): """ - Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`ImageContainerBase`. + Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`wx.ImageContainerBase`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -920,7 +920,7 @@ class ImageContainerBase(wx.Panel): def OnMouseLeftUp(self, event): """ - Handles the ``wx.EVT_LEFT_UP`` event for :class:`ImageContainerBase`. + Handles the ``wx.EVT_LEFT_UP`` event for :class:`wx.ImageContainerBase`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -973,7 +973,7 @@ class ImageContainerBase(wx.Panel): def OnMouseMove(self, event): """ - Handles the ``wx.EVT_MOTION`` event for :class:`ImageContainerBase`. + Handles the ``wx.EVT_MOTION`` event for :class:`wx.ImageContainerBase`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -1015,7 +1015,7 @@ class ImageContainerBase(wx.Panel): """ Draw a pin button, that allows collapsing of the image panel. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the pin button client rectangle; :param `downPin`: ``True`` if the pin button is facing downwards, ``False`` if it is facing leftwards. @@ -1122,9 +1122,9 @@ class ImageContainer(ImageContainerBase): def OnSize(self, event): """ - Handles the ``wx.EVT_SIZE`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_SIZE`` event for :class:`wx.ImageContainer`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ ImageContainerBase.OnSize(self, event) @@ -1133,7 +1133,7 @@ class ImageContainer(ImageContainerBase): def OnMouseLeftDown(self, event): """ - Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`wx.ImageContainer`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -1144,7 +1144,7 @@ class ImageContainer(ImageContainerBase): def OnMouseLeftUp(self, event): """ - Handles the ``wx.EVT_LEFT_UP`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_LEFT_UP`` event for :class:`wx.ImageContainer`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -1155,7 +1155,7 @@ class ImageContainer(ImageContainerBase): def OnEraseBackground(self, event): """ - Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`wx.ImageContainer`. :param `event`: a :class:`EraseEvent` event to be processed. """ @@ -1165,7 +1165,7 @@ class ImageContainer(ImageContainerBase): def OnMouseMove(self, event): """ - Handles the ``wx.EVT_MOTION`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_MOTION`` event for :class:`wx.ImageContainer`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -1176,7 +1176,7 @@ class ImageContainer(ImageContainerBase): def OnMouseLeaveWindow(self, event): """ - Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`wx.ImageContainer`. :param `event`: a :class:`MouseEvent` event to be processed. """ @@ -1196,7 +1196,7 @@ class ImageContainer(ImageContainerBase): def OnPaint(self, event): """ - Handles the ``wx.EVT_PAINT`` event for :class:`ImageContainer`. + Handles the ``wx.EVT_PAINT`` event for :class:`wx.ImageContainer`. :param `event`: a :class:`PaintEvent` event to be processed. """ @@ -1504,7 +1504,7 @@ class LabelContainer(ImageContainerBase): """ Handles the ``wx.EVT_SIZE`` event for :class:`LabelContainer`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ ImageContainerBase.OnSize(self, event) @@ -1687,7 +1687,7 @@ class LabelContainer(ImageContainerBase): """ Draws a bitmap as the background of the control. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ clientRect = self.GetClientRect() @@ -1762,7 +1762,7 @@ class LabelContainer(ImageContainerBase): """ Actually resizes the tab area. - :param `event`: an instance of :class:`SizeEvent`. + :param `event`: an instance of :class:`wx.SizeEvent`. """ # Resize our size @@ -1901,7 +1901,7 @@ class LabelContainer(ImageContainerBase): """ Draws a rounded rectangle around the current tab. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the current tab client rectangle. """ @@ -1945,7 +1945,7 @@ class LabelContainer(ImageContainerBase): """ Draws a web style hover effect (cursor set to hand & text is underlined). - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `caption`: the tab caption text; :param `xCoord`: the x position of the tab caption; :param `yCoord`: the y position of the tab caption; @@ -2022,11 +2022,11 @@ class LabelContainer(ImageContainerBase): """ Draws a label using the specified dc. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the text client rectangle; :param `text`: the actual text string; :param `bmp`: a bitmap to be drawn next to the text; - :param `imgInfo`: an instance of :class:`ImageInfo`; + :param `imgInfo`: an instance of :class:`wx.ImageInfo`; :param `orientationLeft`: ``True`` if the book has the ``INB_RIGHT`` or ``INB_LEFT`` style set; :param `imgIdx`: the tab image index; @@ -2587,7 +2587,7 @@ class FlatBookBase(wx.Panel): """ Assigns an image list to the control. - :param `imglist`: an instance of :class:`ImageList`. + :param `imglist`: an instance of :class:`wx.ImageList`. """ self._pages.AssignImageList(imglist) @@ -2609,7 +2609,7 @@ class FlatBookBase(wx.Panel): """ Select the window by the provided pointer. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. """ curSel = self.GetSelection() @@ -3019,7 +3019,7 @@ class LabelBook(FlatBookBase): """ Handles the ``wx.EVT_SIZE`` event for :class:`LabelBook`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self._pages.Refresh() diff --git a/wx/lib/agw/peakmeter.py b/wx/lib/agw/peakmeter.py index 505c67ac..1d536d7b 100644 --- a/wx/lib/agw/peakmeter.py +++ b/wx/lib/agw/peakmeter.py @@ -300,7 +300,7 @@ class PeakMeterCtrl(wx.Control): chosen by either the windowing system or wxPython, depending on platform; :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :param `style`: the underlying :class:`Control` window style; + :param `style`: the underlying :class:`wx.Control` window style; :param `agwStyle`: the AGW-specific window style, which can be one of the following bits: ======================== =========== ======================================================== @@ -405,10 +405,10 @@ class PeakMeterCtrl(wx.Control): event handler function under Windows and automatically under GTK. :note: Setting the background colour does not cause an immediate refresh, so - you may wish to call :meth:`Window.ClearBackground` or :meth:`Window.Refresh` after + you may wish to call :meth:`wx.Window.ClearBackground` or :meth:`wx.Window.Refresh` after calling this function. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ wx.Control.SetBackgroundColour(self, colourBgnd) @@ -650,7 +650,7 @@ class PeakMeterCtrl(wx.Control): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ # something is better than nothing... @@ -698,7 +698,7 @@ class PeakMeterCtrl(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`PeakMeterCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -719,7 +719,7 @@ class PeakMeterCtrl(wx.Control): """ Draws horizontal bands. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the horizontal bands client rectangle. .. todo:: Implement falloff effect for horizontal bands. @@ -799,7 +799,7 @@ class PeakMeterCtrl(wx.Control): """ Draws vertical bands. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the vertical bands client rectangle. """ @@ -879,7 +879,7 @@ class PeakMeterCtrl(wx.Control): """ Draws vertical bands inverted. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the vertical bands client rectangle. """ diff --git a/wx/lib/agw/persist/__init__.py b/wx/lib/agw/persist/__init__.py index c128a056..994497e8 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:`wx.ColourDialog`, :class:`FontDialog` etc...); +* Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`wx.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 8823f6dd..31162a08 100644 --- a/wx/lib/agw/persist/persist_handlers.py +++ b/wx/lib/agw/persist/persist_handlers.py @@ -86,11 +86,11 @@ def wxDate2PyDate(date): def CreateFont(font): """ - Creates a tuple of 7 :class:`Font` attributes from the `font` input parameter. + Creates a tuple of 7 :class:`wx.Font` attributes from the `font` input parameter. - :param `font`: a :class:`Font` instance. + :param `font`: a :class:`wx.Font` instance. - :returns: A tuple of 7 :class:`Font` attributes from the `font` input parameter. + :returns: A tuple of 7 :class:`wx.Font` attributes from the `font` input parameter. """ return font.GetPointSize(), font.GetFamily(), font.GetStyle(), font.GetWeight(), \ @@ -365,7 +365,7 @@ class TLWHandler(AUIHandler): This class handles the following wxPython widgets: - - All :class:`Frame` derived classes; + - All :class:`wx.Frame` derived classes; - All :class:`Dialog` derived classes. | @@ -1943,11 +1943,11 @@ class FileDirPickerHandler(AbstractHandler): class FontPickerHandler(AbstractHandler): """ - Supports saving/restoring a :class:`FontPickerCtrl` font. + Supports saving/restoring a :class:`wx.FontPickerCtrl` font. This class handles the following wxPython widgets: - - :class:`FontPickerCtrl`. + - :class:`wx.FontPickerCtrl`. """ @@ -2041,11 +2041,11 @@ class FileHistoryHandler(AbstractHandler): class MenuBarHandler(AbstractHandler): """ - Supports saving/restoring the :class:`MenuBar` and :class:`lib.agw.flatmenu.FlatMenuBar` items state. + Supports saving/restoring the :class:`wx.MenuBar` and :class:`lib.agw.flatmenu.FlatMenuBar` items state. This class handles the following wxPython widgets: - - :class:`MenuBar`; + - :class:`wx.MenuBar`; - :class:`lib.agw.flatmenu.FlatMenuBar`. """ @@ -2233,7 +2233,7 @@ class FindReplaceHandler(TLWHandler): - :class:`FindReplaceDialog`. - .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...). + .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`wx.FontDialog` etc...). """ @@ -2284,13 +2284,13 @@ class FindReplaceHandler(TLWHandler): class FontDialogHandler(TLWHandler): """ - Supports saving/restoring a :class:`FontDialog` data (effects, symbols, colour, font, help). + Supports saving/restoring a :class:`wx.FontDialog` data (effects, symbols, colour, font, help). This class handles the following wxPython widgets: - - :class:`FontDialog`. + - :class:`wx.FontDialog`. - .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...). + .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`wx.FontDialog` etc...). """ @@ -2356,7 +2356,7 @@ class ColourDialogHandler(TLWHandler): - :class:`wx.ColourDialog`; - :class:`lib.agw.cubecolourdialog.CubeColourDialog`. - .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`FontDialog` etc...). + .. todo:: Find a way to properly save and restore dialog data (:class:`wx.ColourDialog`, :class:`wx.FontDialog` etc...). """ diff --git a/wx/lib/agw/persist/persistencemanager.py b/wx/lib/agw/persist/persistencemanager.py index 6ca87fb1..a74e22cc 100644 --- a/wx/lib/agw/persist/persistencemanager.py +++ b/wx/lib/agw/persist/persistencemanager.py @@ -64,7 +64,7 @@ class PersistentObject(object): """ Default class constructor. - :param `window`: an instance of :class:`Window`; + :param `window`: an instance of :class:`wx.Window`; :param `persistenceHandler`: if not ``None``, this should a custom handler derived from :class:`~lib.agw.persist.persist_handlers.AbstractHandler`. """ @@ -439,7 +439,7 @@ class PersistenceManager(object): Checks if the object is registered and return the associated :class:`PersistentObject` if it is or ``None`` otherwise. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. """ if window: @@ -452,7 +452,7 @@ class PersistenceManager(object): """ Register an object with the manager. - :param `window`: an instance of :class:`Window`; + :param `window`: an instance of :class:`wx.Window`; :param `persistenceHandler`: if not ``None``, this should a custom handler derived from :class:`~lib.agw.persist.persist_handlers.AbstractHandler`. @@ -484,7 +484,7 @@ class PersistenceManager(object): Unregister the object, this is called by :class:`PersistenceManager` itself so there is usually no need to do it explicitly. - :param `window`: an instance of :class:`Window`, which must have been previously + :param `window`: an instance of :class:`wx.Window`, which must have been previously registered with :meth:`~PersistenceManager.Register`. :note: For the persistent windows this is done automatically (via :meth:`~PersistenceManager.SaveAndUnregister`) @@ -508,7 +508,7 @@ class PersistenceManager(object): """ Saves the state of an object. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. :note: This methods does nothing if :meth:`~PersistenceManager.DisableSaving` was called. """ @@ -529,7 +529,7 @@ class PersistenceManager(object): """ Restores the state of an object. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. :returns: ``True`` if the object properties were restored or ``False`` if nothing was found to restore or the saved settings were invalid. @@ -599,7 +599,7 @@ class PersistenceManager(object): """ Combines both :meth:`~PersistenceManager.Save` and :meth:`~PersistenceManager.Unregister` calls. - :param `window`: an instance of :class:`Window`. If it is ``None``, all the + :param `window`: an instance of :class:`wx.Window`. If it is ``None``, all the windows previously registered are saved and then unregistered. """ @@ -617,7 +617,7 @@ class PersistenceManager(object): """ Combines both :meth:`~PersistenceManager.Register` and :meth:`~PersistenceManager.Restore` calls. - :param `window`: an instance of :class:`Window`. + :param `window`: an instance of :class:`wx.Window`. """ return self.Register(window) and self.Restore(window) @@ -628,7 +628,7 @@ class PersistenceManager(object): Recursively registers and restore the state of the input `window` and of all of its children. - :param `window`: an instance of :class:`Window`; + :param `window`: an instance of :class:`wx.Window`; :param `children`: list of children of the input `window`, on first call it is equal to ``None``. """ @@ -657,7 +657,7 @@ class PersistenceManager(object): Recursively restore the state of the input `window` and of all of its children. - :param `window`: an instance of :class:`Window`; + :param `window`: an instance of :class:`wx.Window`; :param `children`: list of children of the input `window`, on first call it is equal to ``None``. """ diff --git a/wx/lib/agw/piectrl.py b/wx/lib/agw/piectrl.py index 4cbb3b31..55530409 100644 --- a/wx/lib/agw/piectrl.py +++ b/wx/lib/agw/piectrl.py @@ -216,7 +216,7 @@ class PieCtrlLegend(wx.Window): """ Recreates the legend background. - :param `parentdc`: an instance of :class:`DC`. + :param `parentdc`: an instance of :class:`wx.DC`. """ w, h = self.GetSize() @@ -291,7 +291,7 @@ class PieCtrlLegend(wx.Window): """ Sets the legend label font. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ self._labelfont = font @@ -513,7 +513,7 @@ class PieCtrl(wx.Window): """ Handles the ``wx.EVT_SIZE`` event for :class:`PieCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.RecreateCanvas() @@ -653,7 +653,7 @@ class PieCtrl(wx.Window): """ Draws the :class:`PieCtrl` external edges. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `cx`: the part `x` coordinate; :param `cy`: the part `y` coordinate; :param `w`: the control's width; @@ -695,7 +695,7 @@ class PieCtrl(wx.Window): """ Draws all the sectors of :class:`PieCtrl`. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ w, h = self.GetSize() diff --git a/wx/lib/agw/pybusyinfo.py b/wx/lib/agw/pybusyinfo.py index b4a0a40c..95fad2ef 100644 --- a/wx/lib/agw/pybusyinfo.py +++ b/wx/lib/agw/pybusyinfo.py @@ -198,7 +198,7 @@ class PyInfoFrame(wx.Frame): """ Sets :class:`PyInfoFrame` shape using the region created from the bitmap. - :param `event`: a :class:`WindowCreateEvent` event (GTK only, as GTK supports setting + :param `event`: a :class:`wx.WindowCreateEvent` event (GTK only, as GTK supports setting the window shape only during window creation). """ diff --git a/wx/lib/agw/pycollapsiblepane.py b/wx/lib/agw/pycollapsiblepane.py index 1ae15c3e..857d1309 100644 --- a/wx/lib/agw/pycollapsiblepane.py +++ b/wx/lib/agw/pycollapsiblepane.py @@ -36,7 +36,7 @@ itself!). :note: Note that because of its nature of control which can dynamically (and drastically) change its size at run-time under user-input, when putting :class:`PyCollapsiblePane` - inside a :class:`Sizer` you should be careful to add it with a proportion value of zero; + inside a :class:`wx.Sizer` you should be careful to add it with a proportion value of zero; this is because otherwise all other windows with non-null proportion values would automatically get resized each time the user expands or collapse the pane window resulting usually in a weird, flickering effect. @@ -232,7 +232,7 @@ class GTKExpander(wx.Control): """ Draws the :class:`GTKExpander` triangle. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ size = self.GetSize() @@ -262,7 +262,7 @@ class GTKExpander(wx.Control): """ Draws the :class:`GTKExpander` text label. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ size = self.GetSize() @@ -281,7 +281,7 @@ class GTKExpander(wx.Control): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ triangleWidth, triangleHeight = self._parent.GetExpanderDimensions() @@ -299,7 +299,7 @@ class GTKExpander(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`GTKExpander`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -478,7 +478,7 @@ class PyCollapsiblePane(wx.Panel): """ Handles the status changes (collapsing/expanding). - :param `sz`: an instance of :class:`Size`. + :param `sz`: an instance of :class:`wx.Size`. """ self.SetSize(sz) @@ -583,7 +583,7 @@ class PyCollapsiblePane(wx.Panel): def GetPane(self): """ - Returns a reference to the pane window. Use the returned :class:`Window` as + Returns a reference to the pane window. Use the returned :class:`wx.Window` as the parent of widgets to make them part of the collapsible area. """ @@ -622,7 +622,7 @@ class PyCollapsiblePane(wx.Panel): """ Sets the button font. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ self._pButton.SetFont(font) @@ -818,7 +818,7 @@ class PyCollapsiblePane(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`PyCollapsiblePane`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Layout() @@ -845,7 +845,7 @@ class PyCollapsiblePane(wx.Panel): """ Overridable method to draw the GTK-style expander. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ self._pButton.OnDrawGTKExpander(dc) @@ -855,7 +855,7 @@ class PyCollapsiblePane(wx.Panel): """ Overridable method to draw the :class:`PyCollapsiblePane` text in the expander. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ self._pButton.OnDrawGTKText(dc) diff --git a/wx/lib/agw/pygauge.py b/wx/lib/agw/pygauge.py index 7158d92c..8d1a89ac 100644 --- a/wx/lib/agw/pygauge.py +++ b/wx/lib/agw/pygauge.py @@ -134,7 +134,7 @@ class PyGauge(wx.Window): chosen by either the windowing system or wxPython, depending on platform; :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :param `style`: the underlying :class:`Window` window style. + :param `style`: the underlying :class:`wx.Window` window style. """ wx.Window.__init__(self, parent, id, pos, size, style) @@ -166,7 +166,7 @@ class PyGauge(wx.Window): the minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Window`. + :note: Overridden from :class:`wx.Window`. """ return wx.Size(self._size[0], self._size[1]) @@ -388,10 +388,10 @@ class PyGauge(wx.Window): If set to ``False`` nothing will be drawn and other parameters will be ignored; :param bool `drawPercent`: a boolean value which indicates that a percent should be drawn instead of value passed in :meth:`SetValue`; - :param Font `font`: a font with which indication should be drawn, if ``None``, then ``wx.NORMAL_FONT`` + :param wx.Font `font`: a font with which indication should be drawn, if ``None``, then ``wx.NORMAL_FONT`` will be used. Usually text would be displayed centered in the control, but if the text font is too large to be displayed (either in width or height) the corresponding coordinate will be set to zero; - :param Colour `colour`: the colour with which indication should be drawn, if ``None`` then ``wx.BLACK`` will be used; + :param wx.Colour `colour`: the colour with which indication should be drawn, if ``None`` then ``wx.BLACK`` will be used; :param string `formatString`: a string specifying format of the indication (should have one and only one number placeholder). If set to ``None``, will use ``{:.0f}`` format string for values and ``{:.0f}%`` format string for percentages. As described in http://docs.python.org/library/string.html#format-specification-mini-language. diff --git a/wx/lib/agw/pyprogress.py b/wx/lib/agw/pyprogress.py index 350443d1..99aa4e01 100644 --- a/wx/lib/agw/pyprogress.py +++ b/wx/lib/agw/pyprogress.py @@ -339,7 +339,7 @@ class ProgressGauge(wx.Window): """ Actually draws the sliding bar. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `xsize`: the width of the whole progress bar; :param `ysize`: the height of the whole progress bar; :param `increment`: a positive value if we are spinning from left to right, @@ -782,7 +782,7 @@ class PyProgress(wx.Dialog): """ Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`PyProgress`. - :param `event`: a :class:`WindowDestroyEvent` event to be processed. + :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed. """ if self.evtloop: wx.EventLoopBase.SetActive(None) @@ -818,7 +818,7 @@ class PyProgress(wx.Dialog): def ReenableOtherWindows(self): - """ Re-enables the other windows if using :class:`WindowDisabler`. """ + """ Re-enables the other windows if using :class:`wx.WindowDisabler`. """ if self._agwStyle & wx.PD_APP_MODAL: if hasattr(self, "_winDisabler"): diff --git a/wx/lib/agw/ribbon/bar.py b/wx/lib/agw/ribbon/bar.py index 6454a3c9..0e87fd31 100644 --- a/wx/lib/agw/ribbon/bar.py +++ b/wx/lib/agw/ribbon/bar.py @@ -225,17 +225,17 @@ class RibbonBar(RibbonControl): Default constructor. :param `parent`: pointer to a parent window, must not be ``None``; - :type `parent`: :class:`Window` + :type `parent`: :class:`wx.Window` :param integer `id`: window identifier. If ``wx.ID_ANY``, will automatically create an identifier; :param `pos`: window position. ``wx.DefaultPosition`` indicates that wxPython should generate a default position for the window; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: window size. ``wx.DefaultSize`` indicates that wxPython should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param `agwStyle`: the AGW-specific window style. This can be a combination of the following bits: @@ -254,7 +254,7 @@ class RibbonBar(RibbonControl): ========================================== =========== ========================================== :param `validator`: the window validator; - :type `validator`: :class:`Validator` + :type `validator`: :class:`wx.Validator` :param string `name`: the window name. """ @@ -954,7 +954,7 @@ class RibbonBar(RibbonControl): """ Does the initial painting of stuff from the :meth:`~RibbonBar.OnPaint` event. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ tabs = wx.Rect(0, 0, *self.GetSize()) @@ -966,7 +966,7 @@ class RibbonBar(RibbonControl): """ Handles the ``wx.EVT_SIZE`` event for :class:`RibbonBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.RecalculateTabSizes() @@ -988,7 +988,7 @@ class RibbonBar(RibbonControl): Hit test method for :class:`RibbonBar`, testing where the given (in client coordinates) point lies. - :param `position`: an instance of :class:`Point` in client coordinates. + :param `position`: an instance of :class:`wx.Point` in client coordinates. :return: a tuple containing the tab index and the :class:`~lib.agw.ribbon.page.RibbonPage` if the :meth:`~RibbonBar.HitTestTabs` successfully found such combination, or a tuple `(-1, None)` if no tab has been hit. @@ -1219,9 +1219,9 @@ class RibbonBar(RibbonControl): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ best = wx.Size(0, 0) diff --git a/wx/lib/agw/ribbon/buttonbar.py b/wx/lib/agw/ribbon/buttonbar.py index 73d7f698..4313e6ec 100644 --- a/wx/lib/agw/ribbon/buttonbar.py +++ b/wx/lib/agw/ribbon/buttonbar.py @@ -207,7 +207,7 @@ class RibbonButtonBarEvent(wx.PyCommandEvent): """ Display a popup menu as a result of this (dropdown clicked) event. - :param `menu`: an instance of :class:`Menu`. + :param `menu`: an instance of :class:`wx.Menu`. """ pos = wx.Point() @@ -231,17 +231,17 @@ class RibbonButtonBar(RibbonControl): Default class constructor. :param `parent`: pointer to a parent window, typically a :class:`~lib.agw.ribbon.panel.RibbonPanel`; - :type `parent`: :class:`Window` + :type `parent`: :class:`wx.Window` :param integer `id`: window identifier. If ``wx.ID_ANY``, will automatically create an identifier; :param `pos`: window position. ``wx.DefaultPosition`` indicates that wxPython should generate a default position for the window; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: window size. ``wx.DefaultSize`` indicates that wxPython should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `agwStyle`: the AGW-specific window style, currently unused. """ @@ -554,7 +554,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:`wx.Bitmap`; - :param `size`: the size to which the input bitmap must be rescaled, an instance of :class:`Size`. + :param `size`: the size to which the input bitmap must be rescaled, an instance of :class:`wx.Size`. :return: A scaled representation of the input bitmap. """ @@ -760,7 +760,7 @@ class RibbonButtonBar(RibbonControl): Controls which have non-continuous sizing must override this virtual function rather than :meth:`RibbonControl.GetNextSmallerSize() `. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ result = wx.Size(*_result) @@ -793,7 +793,7 @@ class RibbonButtonBar(RibbonControl): Controls which have non-continuous sizing must override this virtual function rather than :meth:`RibbonControl.GetNextLargerSize() `. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ nlayouts = i = len(self._layouts) @@ -866,7 +866,7 @@ class RibbonButtonBar(RibbonControl): """ Handles the ``wx.EVT_SIZE`` event for :class:`RibbonButtonBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ new_size = event.GetSize() @@ -891,7 +891,7 @@ class RibbonButtonBar(RibbonControl): This function sends one or more :class:`UpdateUIEvent` to the window. The particular implementation depends on the window; for example a :class:`ToolBar` will - send an update UI event for each toolbar button, and a :class:`Frame` will send an + send an update UI event for each toolbar button, and a :class:`wx.Frame` will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date @@ -978,7 +978,7 @@ class RibbonButtonBar(RibbonControl): This method normally just returns the value set by `SetMinSize`, but it can be overridden to do the calculation on demand. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. """ return wx.Size(*self._layouts[-1].overall_size) @@ -990,9 +990,9 @@ class RibbonButtonBar(RibbonControl): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return wx.Size(*self._layouts[0].overall_size) diff --git a/wx/lib/agw/ribbon/control.py b/wx/lib/agw/ribbon/control.py index 977180af..a5b9d339 100644 --- a/wx/lib/agw/ribbon/control.py +++ b/wx/lib/agw/ribbon/control.py @@ -43,19 +43,19 @@ class RibbonControl(wx.Control): """ Default class constructor. - :param Window `parent`: pointer to a parent window; + :param wx.Window `parent`: pointer to a parent window; :param integer `id`: window identifier. If ``wx.ID_ANY``, will automatically create an identifier; :param `pos`: window position. ``wx.DefaultPosition`` indicates that wxPython should generate a default position for the window; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: window size. ``wx.DefaultSize`` indicates that wxPython should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized; - :type `size`: tuple or :class:`Point` + :type `size`: tuple or :class:`wx.Point` :param integer `style`: the window style; - :param Validator `validator`: window validator; + :param wx.Validator `validator`: window validator; :param string `name`: window name. """ @@ -111,7 +111,7 @@ class RibbonControl(wx.Control): rather than :meth:`~RibbonControl.GetNextSmallerSize`. :param integer `direction`: the direction(s) in which the size should increase; - :param Size `size`: the size for which a larger size should be found. + :param wx.Size `size`: the size for which a larger size should be found. """ # Dummy implementation for code which doesn't check for IsSizingContinuous() == true @@ -133,7 +133,7 @@ class RibbonControl(wx.Control): rather than :meth:`~RibbonControl.GetNextLargerSize`. :param integer `direction`: the direction(s) in which the size should increase; - :param Size `size`: the size for which a larger size should be found. + :param wx.Size `size`: the size for which a larger size should be found. """ # Dummy implementation for code which doesn't check for IsSizingContinuous() == true @@ -151,7 +151,7 @@ class RibbonControl(wx.Control): is smaller than the given size. :param integer `direction`: The direction(s) in which the size should reduce; - :param Size `relative_to`: The size for which a smaller size should be found. + :param wx.Size `relative_to`: The size for which a smaller size should be found. :returns: if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as in the other direction (if any). @@ -171,7 +171,7 @@ class RibbonControl(wx.Control): is larger then the given size. :param integer `direction`: The direction(s) in which the size should reduce; - :param Size `relative_to`: The size for which a smaller size should be found. + :param wx.Size `relative_to`: The size for which a smaller size should be found. :returns: if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as in the other direction (if any). diff --git a/wx/lib/agw/ribbon/gallery.py b/wx/lib/agw/ribbon/gallery.py index ec7a1a9b..5113451b 100644 --- a/wx/lib/agw/ribbon/gallery.py +++ b/wx/lib/agw/ribbon/gallery.py @@ -483,7 +483,7 @@ class RibbonGallery(RibbonControl): :returns: ``True`` if the gallery scrolled at least one pixel in the given direction, ``False`` if it did not scroll. - :note: Reimplemented from :class:`Window`. + :note: Reimplemented from :class:`wx.Window`. """ if self._scroll_limit == 0 or self._art == None: @@ -611,7 +611,7 @@ class RibbonGallery(RibbonControl): """ Handles the ``wx.EVT_SIZE`` event for :class:`RibbonGallery`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Layout() @@ -773,9 +773,9 @@ class RibbonGallery(RibbonControl): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._best_size diff --git a/wx/lib/agw/ribbon/page.py b/wx/lib/agw/ribbon/page.py index cfbab690..9dba0410 100644 --- a/wx/lib/agw/ribbon/page.py +++ b/wx/lib/agw/ribbon/page.py @@ -271,7 +271,7 @@ class RibbonPage(RibbonControl): :returns: ``True`` if the page scrolled at least one pixel in the given direction, ``False`` if it did not scroll. - :note: Reimplemented from :class:`Window`. + :note: Reimplemented from :class:`wx.Window`. :see: :meth:`~RibbonPage.GetMajorAxis`, :meth:`~RibbonPage.ScrollPixels` """ @@ -445,7 +445,7 @@ class RibbonPage(RibbonControl): """ Handles the ``wx.EVT_SIZE`` event for :class:`RibbonPage`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ new_size = event.GetSize() @@ -892,9 +892,9 @@ class RibbonPage(RibbonControl): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ best = wx.Size(0, 0) diff --git a/wx/lib/agw/ribbon/panel.py b/wx/lib/agw/ribbon/panel.py index 563cbf29..3872dba2 100644 --- a/wx/lib/agw/ribbon/panel.py +++ b/wx/lib/agw/ribbon/panel.py @@ -232,7 +232,7 @@ class RibbonPanel(RibbonControl): """ Query if the panel would be minimised at a given size. - :param `at_size`: an instance of :class:`Size`, giving the size at which the + :param `at_size`: an instance of :class:`wx.Size`, giving the size at which the panel should be tested for minimisation. """ @@ -372,7 +372,7 @@ class RibbonPanel(RibbonControl): """ Handles the ``wx.EVT_SIZE`` event for :class:`RibbonPanel`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ if self.GetAutoLayout(): @@ -435,7 +435,7 @@ class RibbonPanel(RibbonControl): """ Query if the panel would be minimised at a given size. - :param `at_size`: an instance of :class:`Size`, giving the size at which the + :param `at_size`: an instance of :class:`wx.Size`, giving the size at which the panel should be tested for minimisation. """ @@ -752,9 +752,9 @@ class RibbonPanel(RibbonControl): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ # Ask sizer if present diff --git a/wx/lib/agw/ribbon/toolbar.py b/wx/lib/agw/ribbon/toolbar.py index c4bd26d6..ed51f87a 100644 --- a/wx/lib/agw/ribbon/toolbar.py +++ b/wx/lib/agw/ribbon/toolbar.py @@ -103,9 +103,9 @@ class RibbonToolBarEvent(wx.PyCommandEvent): If a menu item is selected, the corresponding menu event is generated and will be processed as usual. - :param `menu`: the menu to pop up, an instance of :class:`Menu`. + :param `menu`: the menu to pop up, an instance of :class:`wx.Menu`. - :note: Just before the menu is popped up, :meth:`Menu.UpdateUI` is called to ensure + :note: Just before the menu is popped up, :meth:`wx.Menu.UpdateUI` is called to ensure that the menu items are in the correct state. The menu does not get deleted by the window. """ @@ -1120,7 +1120,7 @@ class RibbonToolBar(RibbonControl): """ Handles the ``wx.EVT_SIZE`` event for :class:`RibbonToolBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ if self._art == None: @@ -1222,9 +1222,9 @@ class RibbonToolBar(RibbonControl): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :return: An instance of :class:`Size`. + :return: An instance of :class:`wx.Size`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self.GetMinSize() @@ -1417,7 +1417,7 @@ class RibbonToolBar(RibbonControl): This function sends one or more :class:`UpdateUIEvent` to the window. The particular implementation depends on the window; for example a :class:`ToolBar` will - send an update UI event for each toolbar button, and a :class:`Frame` will send an + send an update UI event for each toolbar button, and a :class:`wx.Frame` will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date diff --git a/wx/lib/agw/rulerctrl.py b/wx/lib/agw/rulerctrl.py index 69964023..3c4f2d99 100644 --- a/wx/lib/agw/rulerctrl.py +++ b/wx/lib/agw/rulerctrl.py @@ -223,7 +223,7 @@ def GetIndicatorBitmap(): def GetIndicatorImage(): - """ Returns the image indicator as a :class:`Image`. """ + """ Returns the image indicator as a :class:`wx.Image`. """ stream = six.BytesIO(GetIndicatorData()) return wx.Image(stream) @@ -247,9 +247,9 @@ def MakePalette(tr, tg, tb): def ConvertWXToPIL(bmp): """ - Converts a :class:`Image` into a PIL image. + Converts a :class:`wx.Image` into a PIL image. - :param `bmp`: an instance of :class:`Image`. + :param `bmp`: an instance of :class:`wx.Image`. :note: Requires PIL (Python Imaging Library), which can be downloaded from http://www.pythonware.com/products/pil/ @@ -264,7 +264,7 @@ def ConvertWXToPIL(bmp): def ConvertPILToWX(pil, alpha=True): """ - Converts a PIL image into a :class:`Image`. + Converts a PIL image into a :class:`wx.Image`. :param `pil`: a PIL image; :param `alpha`: ``True`` if the image contains alpha transparency, ``False`` @@ -499,7 +499,7 @@ class Indicator(object): """ Actually draws the indicator. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ xpos, ypos = self.GetPosition() @@ -691,7 +691,7 @@ class RulerCtrl(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`RulerCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ width, height = event.GetSize() @@ -778,7 +778,7 @@ class RulerCtrl(wx.Panel): """ Returns the indicator located at the mouse position `mousePos` (if any). - :param `mousePos`: the mouse position, an instance of :class:`Point`. + :param `mousePos`: the mouse position, an instance of :class:`wx.Point`. """ for indicator in self._indicators: @@ -1088,8 +1088,8 @@ class RulerCtrl(wx.Panel): """ Sets the fonts for minor and major tick labels. - :param `minorFont`: the font used to draw minor ticks, a valid :class:`Font` object; - :param `majorFont`: the font used to draw major ticks, a valid :class:`Font` object. + :param `minorFont`: the font used to draw minor ticks, a valid :class:`wx.Font` object; + :param `majorFont`: the font used to draw major ticks, a valid :class:`wx.Font` object. """ self._minorfont = minorFont @@ -1472,7 +1472,7 @@ class RulerCtrl(wx.Panel): """ Ticks a particular position. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `pos`: the label position; :param `d`: the current label value; :param `major`: ``True`` if it is a major ticks, ``False`` if it is a minor one. @@ -1578,7 +1578,7 @@ class RulerCtrl(wx.Panel): """ Updates all the ticks calculations. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ # This gets called when something has been changed @@ -1701,7 +1701,7 @@ class RulerCtrl(wx.Panel): """ Actually draws the whole :class:`RulerCtrl`. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if not self._valid: @@ -1781,7 +1781,7 @@ class RulerCtrl(wx.Panel): """ Sets the window to which :class:`RulerCtrl` draws a thin line over. - :param `dparent`: an instance of :class:`Window`, representing the window to + :param `dparent`: an instance of :class:`wx.Window`, representing the window to which :class:`RulerCtrl` draws a thin line over. """ diff --git a/wx/lib/agw/shapedbutton.py b/wx/lib/agw/shapedbutton.py index bba9344f..38d28a10 100644 --- a/wx/lib/agw/shapedbutton.py +++ b/wx/lib/agw/shapedbutton.py @@ -58,7 +58,7 @@ classes (`GenButton`, `GenBitmapButton`, `GenBitmapTextButton`, `GenToggleButton classes (with "Gen" replaced by "S"), with the same event handling, but they are rounded/elliptical buttons. -`ShapedButton` is based on a :class:`Window`, in which 2 images are drawn depending +`ShapedButton` is based on a :class:`wx.Window`, in which 2 images are drawn depending on the button state (pressed or not pressed). The 2 images have been stolen from Audacity (written with wxWidgets) and rearranged/reshaped/restyled using adobe PhotoShop. @@ -397,7 +397,7 @@ class SButton(wx.Window): """ Given the current font settings, calculate and set a good size. - :param `size`: if not ``None``, an instance of :class:`Size` to pass to + :param `size`: if not ``None``, an instance of :class:`wx.Size` to pass to `SetInitialSize`. """ @@ -412,7 +412,7 @@ class SButton(wx.Window): Overridden base class virtual. Determines the best size of the button based on the label size. - :note: Overridden from :class:`Window`. + :note: Overridden from :class:`wx.Window`. """ w, h, usemin = self._GetLabelSize() @@ -434,7 +434,7 @@ class SButton(wx.Window): """ Can this window be given focus by mouse click? - :note: Overridden from :class:`Window`. + :note: Overridden from :class:`wx.Window`. """ return self.IsShown() and self.IsEnabled() @@ -455,7 +455,7 @@ class SButton(wx.Window): :param `enable`: ``True`` to enable the button, ``False`` to disable it. - :note: Overridden from :class:`Window`. + :note: Overridden from :class:`wx.Window`. """ self._enabled = enable @@ -532,7 +532,7 @@ class SButton(wx.Window): """ Draws the main button, in whichever state it is. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `width`: the button width; :param `height`: the button height. """ @@ -612,7 +612,7 @@ class SButton(wx.Window): """ Draws the label on the button. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `width`: the button width; :param `height`: the button height; :param `dw`: width differential, to show a 3D effect; @@ -655,7 +655,7 @@ class SButton(wx.Window): drawn with a dotted-style pen, to let the user know which button has the focus. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `width`: the button width; :param `height`: the button height. """ @@ -685,7 +685,7 @@ class SButton(wx.Window): """ Handles the ``wx.EVT_SIZE`` event for :class:`SButton`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -902,9 +902,9 @@ class SButton(wx.Window): def ConvertWXToPIL(self, bmp): """ - Converts a :class:`Image` into a PIL image. + Converts a :class:`wx.Image` into a PIL image. - :param `bmp`: an instance of :class:`Image`. + :param `bmp`: an instance of :class:`wx.Image`. """ width = bmp.GetWidth() @@ -916,7 +916,7 @@ class SButton(wx.Window): def ConvertPILToWX(self, pil, alpha=True): """ - Converts a PIL image into a :class:`Image`. + Converts a PIL image into a :class:`wx.Image`. :param `pil`: a PIL image; :param `alpha`: ``True`` if the image contains alpha transparency, ``False`` @@ -1101,7 +1101,7 @@ class SBitmapButton(SButton): """ Draws the bitmap in the middle of the button. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `width`: the button width; :param `height`: the button height; :param `dw`: width differential, to show a 3D effect; @@ -1184,7 +1184,7 @@ class SBitmapTextButton(SBitmapButton): """ Draws the bitmap and the text label. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `width`: the button width; :param `height`: the button height; :param `dw`: width differential, to show a 3D effect; diff --git a/wx/lib/agw/shortcuteditor.py b/wx/lib/agw/shortcuteditor.py index 1429c3fa..0dfa679f 100644 --- a/wx/lib/agw/shortcuteditor.py +++ b/wx/lib/agw/shortcuteditor.py @@ -30,7 +30,7 @@ """ :class:`~lib.agw.shortcuteditor.ShortcutEditor` is a widget that allows the user to customize and change keyboard -shortcuts via a dialog. It can be used to edit :class:`MenuItem` shortcuts or accelerators +shortcuts via a dialog. It can be used to edit :class:`wx.MenuItem` shortcuts or accelerators defined in a :class:`AcceleratorTable`. .. note:: @@ -45,7 +45,7 @@ Description =========== :class:`ShortcutEditor` is a widget that allows the user to customize and change keyboard -shortcuts via a dialog. It can be used to edit :class:`MenuItem` shortcuts or accelerators +shortcuts via a dialog. It can be used to edit :class:`wx.MenuItem` shortcuts or accelerators defined in a :class:`AcceleratorTable`. The interface itself is very much inpired by the GIMP shortcut editor: @@ -58,12 +58,12 @@ although the behaviour should be pretty much equivalent. Various features: * Shortcuts are listed in a tree-like structure, pretty much reflecting a menu - hierarchy (as most of the time :class:`ShortcutEditor` is used to edit :class:`MenuItem` + hierarchy (as most of the time :class:`ShortcutEditor` is used to edit :class:`wx.MenuItem` shortcuts); * Accelerators defined via :class:`AcceleratorTable` are handled in a similar way; * Support for I18N; * Ability to restore default shortcuts/accelerators via a UI button; -* Possibility to send back the new/updated shortcuts to the original :class:`MenuBar` or +* Possibility to send back the new/updated shortcuts to the original :class:`wx.MenuBar` or the original :class:`AcceleratorTable`; * Filters on the shortcuts label (case-insensitive); * Basic help window with instructions (customizable via :meth:`~ShortcutEditor.SetHTMLHelpFile`), via @@ -141,7 +141,7 @@ There are basically three ways to populate the :class:`ShortcutEditor` dialog, d your needs. These approaches can be combined if needed. 1) Use the :meth:`~ShortcutEditor.FromMenuBar` method: if you need to give your user the ability to edit - the various :class:`MenuItem` shortcuts in your application, you can create :class:`ShortcutEditor` + the various :class:`wx.MenuItem` shortcuts in your application, you can create :class:`ShortcutEditor` in this way:: # Build your wx.MenuBar first!!! @@ -911,7 +911,7 @@ def FontFromFont(font): """ Creates a copy of the input `font`. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ new_font = wx.Font(font.GetPointSize(), font.GetFamily(), font.GetStyle(), @@ -927,7 +927,7 @@ def FontFromFont(font): class HTMLHelpWindow(wx.Frame): """ - A simple :class:`Frame` container for the basic help provided to :class:`ShortcutEditor`. + A simple :class:`wx.Frame` container for the basic help provided to :class:`ShortcutEditor`. The help page is actually straightly derived from: http://graphicssoft.about.com/od/gimptutorials/tp/keyboard-shortcut-editor.htm @@ -1177,7 +1177,7 @@ class Shortcut(object): :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` + :param `menuItem`: if this :class:`Shortcut` is derived from a :class:`wx.MenuItem`, the :class:`wx.MenuItem` to which it should be associated; :param integer `accelId`: if this :class:`Shortcut` is derived from an accelerator in a :class:`AcceleratorTable` or from a custom, developer-defined shortcut, it represents the ID it is associated with. @@ -1276,8 +1276,8 @@ class Shortcut(object): def IsTop(self): """ - Returns ``True`` if this :class:`Shortcut` is associated with a top-level :class:`Menu`, - (i.e., in the top :class:`MenuBar` level), ``False`` otherwise. + Returns ``True`` if this :class:`Shortcut` is associated with a top-level :class:`wx.Menu`, + (i.e., in the top :class:`wx.MenuBar` level), ``False`` otherwise. """ return self.topMenu @@ -1324,7 +1324,7 @@ class Shortcut(object): def GetImageIndex(self): - """ Returns an integer index to be used in the :class:`ListShortcut` own :class:`ImageList`. """ + """ Returns an integer index to be used in the :class:`ListShortcut` own :class:`wx.ImageList`. """ return self.imageIndex @@ -1515,7 +1515,7 @@ class Shortcut(object): def FromMenuItem(self): """ - Constructs this :class:`Shortcut` starting from a :class:`Menu` or :class:`MenuItem`. + Constructs this :class:`Shortcut` starting from a :class:`wx.Menu` or :class:`wx.MenuItem`. The attributes needed to properly construct a :class:`Shortcut` are the label, the accelerator string, the help string (optional) and the bitmap associated @@ -1554,12 +1554,12 @@ class Shortcut(object): def ToMenuItem(self, menuBar): """ - Dumps this :class:`Shortcut` into a :class:`Menu` or :class:`MenuItem`. + Dumps this :class:`Shortcut` into a :class:`wx.Menu` or :class:`wx.MenuItem`. - The attributes needed to properly dump a :class:`Shortcut` into a :class:`Menu` or :class:`MenuBar` + The attributes needed to properly dump a :class:`Shortcut` into a :class:`wx.Menu` or :class:`wx.MenuBar` are the label and the accelerator string. - :param `menuBar`: an instance of :class:`MenuBar`. + :param `menuBar`: an instance of :class:`wx.MenuBar`. """ if self.menuItem is None or not self.changed: @@ -1803,7 +1803,7 @@ class ListShortcut(HTL.HyperTreeList, treemixin.ExpansionState): :param `shortcut`: an instance of :class:`Shortcut`. If ``None``, it is defaulted to `self.manager` to make this function reentrant (i.e. allow more than one enumeration on one and the same object simultaneously); - :param integer `index`: the current image index inside the :class:`ListShortcut` own :class:`ImageList`. + :param integer `index`: the current image index inside the :class:`ListShortcut` own :class:`wx.ImageList`. """ if shortcut is None: @@ -2166,14 +2166,14 @@ class ListShortcut(HTL.HyperTreeList, treemixin.ExpansionState): def HasFlag(self, flag): """ - Overridden from :class:`Window` as a workaround on the conflicts between `treemixin` and + Overridden from :class:`wx.Window` as a workaround on the conflicts between `treemixin` and :class:`~lib.agw.hypertreelist.HyperTreeList` with the ``wx.TR_HIDE_ROOT`` `agwStyle` set. :param integer `flag`: an integer bit flag specifying the `agwStyle` style. :return: ``True`` if the :class:`ListShortcut` has the input `flag` set, ``False`` otherwise. - :note: Overridden from :class:`Window`. + :note: Overridden from :class:`wx.Window`. """ return self.HasAGWFlag(flag) @@ -2187,7 +2187,7 @@ class ListShortcut(HTL.HyperTreeList, treemixin.ExpansionState): class ShortcutEditor(wx.Dialog): """ :class:`ShortcutEditor` is a widget that allows the user to customize and change keyboard - shortcuts via a dialog. It can be used to edit :class:`MenuItem` shortcuts or accelerators + shortcuts via a dialog. It can be used to edit :class:`wx.MenuItem` shortcuts or accelerators defined in a :class:`AcceleratorTable`. The interface itself is very much inpired by the GIMP shortcut editor: @@ -2202,7 +2202,7 @@ class ShortcutEditor(wx.Dialog): """ Default class constructor. - :param `parent`: an instance of :class:`Window`, it can also be ``None``. + :param `parent`: an instance of :class:`wx.Window`, it can also be ``None``. """ wx.Dialog.__init__(self, parent, title=_('Configure Keyboard Shortcuts'), @@ -2331,9 +2331,9 @@ class ShortcutEditor(wx.Dialog): def FromMenuBar(self, topWindow): """ - Builds the entire shortcut hierarchy starting from a :class:`MenuBar`. + Builds the entire shortcut hierarchy starting from a :class:`wx.MenuBar`. - :param `topWindow`: an instance of :class:`TopLevelWindow`, containing the :class:`MenuBar` + :param `topWindow`: an instance of :class:`TopLevelWindow`, containing the :class:`wx.MenuBar` we wish to scan. """ @@ -2372,11 +2372,11 @@ class ShortcutEditor(wx.Dialog): def ToMenuBar(self, topWindow): """ - Dumps the entire shortcut hierarchy (for shortcuts associated with a :class:`MenuItem`), into - a :class:`MenuBar`, changing only the :class:`Menu` / :class:`MenuItem` labels (it does **not** rebuild - the :class:`MenuBar`). + Dumps the entire shortcut hierarchy (for shortcuts associated with a :class:`wx.MenuItem`), into + a :class:`wx.MenuBar`, changing only the :class:`wx.Menu` / :class:`wx.MenuItem` labels (it does **not** rebuild + the :class:`wx.MenuBar`). - :param `topWindow`: an instance of :class:`TopLevelWindow`, containing the :class:`MenuBar` + :param `topWindow`: an instance of :class:`TopLevelWindow`, containing the :class:`wx.MenuBar` we wish to repopulate. """ @@ -2441,7 +2441,7 @@ class ShortcutEditor(wx.Dialog): a :class:`AcceleratorTable`. This method **does** rebuild the :class:`AcceleratorTable` and sets it back to the input `window`. - :param `window`: an instance of :class:`Window`, to which the new :class:`AcceleratorTable` should be set. + :param `window`: an instance of :class:`wx.Window`, to which the new :class:`AcceleratorTable` should be set. """ def AccelItemSet(shortcut, table): @@ -2625,7 +2625,7 @@ class ShortcutEditor(wx.Dialog): otherwise the box is hidden. If ``False`` and the dialog is modal, control is returned to the calling program. - :note: Reimplemented from :class:`Window`. + :note: Reimplemented from :class:`wx.Window`. """ self.PreShow() diff --git a/wx/lib/agw/speedmeter.py b/wx/lib/agw/speedmeter.py index 0d8a4b27..883ee809 100644 --- a/wx/lib/agw/speedmeter.py +++ b/wx/lib/agw/speedmeter.py @@ -48,7 +48,7 @@ by creating an "angular" control (actually, circular). I remember to have seen it somewhere, and i decided to implement it in wxPython. :class:`SpeedMeter` starts its construction from an empty bitmap, and it uses some -functions of the :class:`DC` class to create the rounded effects. everything is +functions of the :class:`wx.DC` class to create the rounded effects. everything is processed in the `Draw()` method of :class:`SpeedMeter` class. This implementation allows you to use either directly the :class:`PaintDC`, or the @@ -344,7 +344,7 @@ class BufferedWindow(wx.Window): """ This method should be overridden when sub-classed. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ pass @@ -368,7 +368,7 @@ class BufferedWindow(wx.Window): """ Handles the ``wx.EVT_SIZE`` event for :class:`BufferedWindow`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Width, self.Height = self.GetClientSize() @@ -534,7 +534,7 @@ class SpeedMeter(BufferedWindow): Draws everything on the empty bitmap. Here all the chosen styles are applied. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ size = self.GetClientSize() @@ -1286,7 +1286,7 @@ class SpeedMeter(BufferedWindow): """ Sets the ticks font. - :param `font`: a valid :class:`Font` object. If defaulted to ``None``, some standard + :param `font`: a valid :class:`wx.Font` object. If defaulted to ``None``, some standard font will be chosen automatically. """ @@ -1497,7 +1497,7 @@ class SpeedMeter(BufferedWindow): """ Sets the font for the text in the middle. - :param `font`: a valid :class:`Font` object. If defaulted to ``None``, some + :param `font`: a valid :class:`wx.Font` object. If defaulted to ``None``, some standard font will be generated. """ diff --git a/wx/lib/agw/supertooltip.py b/wx/lib/agw/supertooltip.py index 6f7b91ca..f4748445 100644 --- a/wx/lib/agw/supertooltip.py +++ b/wx/lib/agw/supertooltip.py @@ -460,7 +460,7 @@ class ToolTipWindowBase(object): """ Handles the ``wx.EVT_SIZE`` event for :class:`SuperToolTip`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.Refresh() @@ -1274,7 +1274,7 @@ class SuperToolTip(object): """ Sets the font for the main body message. - :param `font`: the font to use for the main body message, a valid :class:`Font` + :param `font`: the font to use for the main body message, a valid :class:`wx.Font` object. """ @@ -1287,7 +1287,7 @@ class SuperToolTip(object): """ Sets the font for the header text. - :param `font`: the font to use for the header text, a valid :class:`Font` + :param `font`: the font to use for the header text, a valid :class:`wx.Font` object. """ @@ -1300,7 +1300,7 @@ class SuperToolTip(object): """ Sets the font for the footer text. - :param `font`: the font to use for the footer text, a valid :class:`Font` + :param `font`: the font to use for the footer text, a valid :class:`wx.Font` object. """ @@ -1313,7 +1313,7 @@ class SuperToolTip(object): """ Sets the font for the hyperlink text. - :param `font`: the font to use for the hyperlink text, a valid :class:`Font` + :param `font`: the font to use for the hyperlink text, a valid :class:`wx.Font` object. """ diff --git a/wx/lib/agw/thumbnailctrl.py b/wx/lib/agw/thumbnailctrl.py index ca40a763..584e6196 100644 --- a/wx/lib/agw/thumbnailctrl.py +++ b/wx/lib/agw/thumbnailctrl.py @@ -199,7 +199,7 @@ def GetMondrianBitmap(): def GetMondrianImage(): - """ Returns a default image placeholder as a :class:`Image`. """ + """ Returns a default image placeholder as a :class:`wx.Image`. """ stream = six.StringIO(GetMondrianData()) return wx.Image(stream) @@ -498,7 +498,7 @@ class PILImageHandler(object): """ Adjust overall image brightness to highlight. - :param `img`: an instance of :class:`Image`; + :param `img`: an instance of :class:`wx.Image`; :param `factor`: unused in :class:`PILImageHandler`. """ @@ -550,7 +550,7 @@ class NativeImageHandler(object): """ Adjust overall image brightness to highlight. - :param `img`: an instance of :class:`Image`; + :param `img`: an instance of :class:`wx.Image`; :param `factor`: a floating point number representing the highlight factor. """ @@ -639,7 +639,7 @@ class Thumb(object): """ Sets the thumbnail image. - :param `image`: a :class:`Image` object. + :param `image`: a :class:`wx.Image` object. """ self._image = image @@ -692,7 +692,7 @@ class Thumb(object): """ Sets the image as rotated (fast). - :param `image`: the rotated image, an instance of :class:`Image`. + :param `image`: the rotated image, an instance of :class:`wx.Image`. """ self._rotatedimage = image @@ -1339,7 +1339,7 @@ class ScrolledThumbnail(wx.ScrolledWindow): """ Sets the thumbnails popup menu when at least one thumbnail is selected. - :param `menu`: an instance of :class:`Menu`. + :param `menu`: an instance of :class:`wx.Menu`. """ self._pmenu = menu @@ -1355,7 +1355,7 @@ class ScrolledThumbnail(wx.ScrolledWindow): """ Sets the global thumbnails popup menu (no need of thumbnail selection). - :param `gpmenu`: an instance of :class:`Menu`. + :param `gpmenu`: an instance of :class:`wx.Menu`. """ self._gpmenu = gpmenu @@ -1747,7 +1747,7 @@ class ScrolledThumbnail(wx.ScrolledWindow): """ Sets the font for all the thumbnail captions. - :param `font`: a valid :class:`Font` object. If defaulted to ``None``, a standard + :param `font`: a valid :class:`wx.Font` object. If defaulted to ``None``, a standard font will be generated. """ @@ -1971,7 +1971,7 @@ class ScrolledThumbnail(wx.ScrolledWindow): """ Calculates the best caption string to show based on the actual zoom factor. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `caption`: the original caption string; :param `sw`: the maximum width allowed for the caption string, in pixels; :param `width`: the caption string width, in pixels. @@ -2175,7 +2175,7 @@ class ScrolledThumbnail(wx.ScrolledWindow): """ Handles the ``wx.EVT_SIZE`` event for :class:`ThumbnailCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.UpdateProp() diff --git a/wx/lib/agw/toasterbox.py b/wx/lib/agw/toasterbox.py index ff7059ec..45224b23 100644 --- a/wx/lib/agw/toasterbox.py +++ b/wx/lib/agw/toasterbox.py @@ -268,7 +268,7 @@ class ToasterBox(wx.Timer): """ Sets the :class:`ToasterBox` position on screen. - :param `pos`: the widget position, an instance of :class:`Point`. + :param `pos`: the widget position, an instance of :class:`wx.Point`. """ self._popupposition = pos @@ -433,7 +433,7 @@ class ToasterBox(wx.Timer): """ Sets the :class:`ToasterBox` size. - :param `size`: the new control size, an instance of :class:`Size`. + :param `size`: the new control size, an instance of :class:`wx.Size`. """ self._popupsize = size @@ -492,7 +492,7 @@ class ToasterBox(wx.Timer): """ Adds a panel to the :class:`ToasterBox`. - :param `panel`: an instance of :class:`Window`. + :param `panel`: an instance of :class:`wx.Window`. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_COMPLEX`` style. """ @@ -835,7 +835,7 @@ class ToasterBoxWindow(wx.Frame): """ Sets the :class:`ToasterBox` size. - :param `size`: the new control size, an instance of :class:`Size`. + :param `size`: the new control size, an instance of :class:`wx.Size`. """ self.SetSize(self._bottomright.x, self._bottomright.y, size[0], size[1]) @@ -845,7 +845,7 @@ class ToasterBoxWindow(wx.Frame): """ Sets the :class:`ToasterBox` position on screen. - :param `pos`: the widget position, an instance of :class:`Point`. + :param `pos`: the widget position, an instance of :class:`wx.Point`. """ self._bottomright = wx.Point(pos[0] + self.GetSize().GetWidth(), @@ -918,7 +918,7 @@ class ToasterBoxWindow(wx.Frame): """ Adds a panel to the :class:`ToasterBox`. - :param `panel`: an instance of :class:`Window`. + :param `panel`: an instance of :class:`wx.Window`. :note: Use this method only for a :class:`ToasterBox` created with the ``TB_COMPLEX`` style. """ @@ -1039,7 +1039,7 @@ class ToasterBoxWindow(wx.Frame): :param `focus`: ``True`` to set the focus on :class:`ToasterBoxWindow`, ``False`` to return it to the original owner; - :param `originalfocus`: an instance of :class:`Window`, representing a pointer to + :param `originalfocus`: an instance of :class:`wx.Window`, representing a pointer to the window which originally had the focus """ @@ -1208,7 +1208,7 @@ class ToasterBoxWindow(wx.Frame): """ Draws the text label for a :class:`ToasterBox` with ``TB_SIMPLE`` style set. - :param `dc`: an instance of :class:`DC`. If defaulted to ``None``, a :class:`ClientDC` + :param `dc`: an instance of :class:`wx.DC`. If defaulted to ``None``, a :class:`ClientDC` will be created on the fly. """ @@ -1281,7 +1281,7 @@ class ToasterBoxWindow(wx.Frame): """ Draw the user specified text. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. :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 f8d5bc5c..8cb0128f 100644 --- a/wx/lib/agw/ultimatelistctrl.py +++ b/wx/lib/agw/ultimatelistctrl.py @@ -50,7 +50,7 @@ Appearance * Multiple images for items/subitems; * Images can be of any size and not limited to a single specific pair of `width`, `height` - as it is the case of :class:`ImageList`. Simply use :class:`PyImageList` instead of :class:`ImageList` + as it is the case of :class:`wx.ImageList`. Simply use :class:`PyImageList` instead of :class:`wx.ImageList` to add your images. * Font, colour, background, custom renderers and formatting for items and subitems; * Ability to add persistent data to an item using :meth:`~UltimateListCtrl.SetItemPyData` and :meth:`~UltimateListCtrl.GetItemPyData`: @@ -653,7 +653,7 @@ def GetdragcursorBitmap(): def GetdragcursorImage(): - """ Returns the drag and drop cursor image as a :class:`Image`. """ + """ Returns the drag and drop cursor image as a :class:`wx.Image`. """ stream = six.BytesIO(GetdragcursorData()) return wx.Image(stream) @@ -896,7 +896,7 @@ class PyImageList(object): Draws a specified image onto a device context. :param `index`: the image index, starting from zero; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `x`: x position on the device context; :param `y`: y position on the device context; :param `flags`: how to draw the image. A bitlist of a selection of the following: @@ -1203,7 +1203,7 @@ class UltimateListItemAttr(object): """ Sets a new font for the item. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ self._font = font @@ -1243,7 +1243,7 @@ class UltimateListItemAttr(object): """ Sets a new font for the footer item. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ self._footerFont = font @@ -1638,7 +1638,7 @@ class UltimateListItem(wx.Object): """ Sets the font for the item. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ self.Attributes().SetFont(font) @@ -1668,7 +1668,7 @@ class UltimateListItem(wx.Object): """ Sets the font for the footer item. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. """ self.Attributes().SetFooterFont(font) @@ -2655,7 +2655,7 @@ class UltimateListItemData(object): """ Sets the text font for the item. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ if font == wx.NullFont: @@ -3546,7 +3546,7 @@ class UltimateListHeaderData(object): """ Sets a new font for the header item. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ self._font = font @@ -3556,7 +3556,7 @@ class UltimateListHeaderData(object): """ Sets a new font for the footer item. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ self._footerFont = font @@ -3902,7 +3902,7 @@ class UltimateListLineData(object): """ Calculates the line size and item positions. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `spacing`: the spacing between the items, in pixels. """ @@ -4279,7 +4279,7 @@ class UltimateListLineData(object): """ Sets various attributes to the input device context. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `attr`: an instance of :class:`UltimateListItemAttr`; :param `highlighted`: ``True`` if the item is highlighted, ``False`` otherwise. """ @@ -4341,7 +4341,7 @@ class UltimateListLineData(object): Draws the line on the specified device context. :param `line`: an instance of :class:`UltimateListLineData`; - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ item = self._items[0] @@ -4439,7 +4439,7 @@ class UltimateListLineData(object): Draws the line on the specified device context when the parent :class:`UltimateListCtrl` is in report mode. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `line`: an instance of :class:`UltimateListLineData`; :param `rect`: the item client rectangle; :param `rectHL`: the item client rectangle when the item is highlighted; @@ -4668,7 +4668,7 @@ class UltimateListLineData(object): """ Draws the item text, correctly formatted. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `text`: the item text; :param `row`: the line number to which this item belongs to; :param `col`: the column number to which this item belongs to; @@ -4747,7 +4747,7 @@ class UltimateListLineData(object): """ Gradient fill from colour 1 to colour 2 from top to bottom. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the rectangle to be filled with the gradient shading; :param `hasfocus`: ``True`` if the main :class:`UltimateListCtrl` has focus, ``False`` otherwise. @@ -4794,7 +4794,7 @@ class UltimateListLineData(object): """ Gradient fill from colour 1 to colour 2 from left to right. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the rectangle to be filled with the gradient shading; :param `hasfocus`: ``True`` if the main :class:`UltimateListCtrl` has focus, ``False`` otherwise. @@ -4842,7 +4842,7 @@ class UltimateListLineData(object): """ Draws the selected item(s) with the Windows Vista style. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `rect`: the rectangle to be filled with the gradient shading; :param `hasfocus`: ``True`` if the main :class:`UltimateListCtrl` has focus, ``False`` otherwise. @@ -5084,10 +5084,10 @@ class UltimateListHeaderWindow(wx.Control): # scrollbar: this allows us to always use logical coords def AdjustDC(self, dc): """ - Shifts the :class:`DC` origin to match the position of the main window horizontal + Shifts the :class:`wx.DC` origin to match the position of the main window horizontal scrollbar: this allows us to always use logical coordinates. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ xpix, dummy = self._owner.GetScrollPixelsPerUnit() @@ -5301,7 +5301,7 @@ class UltimateListHeaderWindow(wx.Control): """ Draws the item text, correctly formatted. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `text`: the item text; :param `rect`: the item client rectangle. """ @@ -5359,7 +5359,7 @@ class UltimateListHeaderWindow(wx.Control): application defining an `OnIdle` handler in a derived class. This method may be used to do delayed painting, for example, and most - implementations call :meth:`Window.UpdateWindowUI` in order to send update events + implementations call :meth:`wx.Window.UpdateWindowUI` in order to send update events to the window in idle time. """ @@ -5709,7 +5709,7 @@ class UltimateListHeaderWindow(wx.Control): Sends a :class:`UltimateListEvent` for the parent window. :param `eventType`: the event type; - :param `pos`: an instance of :class:`Point`. + :param `pos`: an instance of :class:`wx.Point`. """ parent = self.GetParent() @@ -6374,7 +6374,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Overridden base class virtual to reset the line height when the font changes. - :param `font`: a valid :class:`Font` object. + :param `font`: a valid :class:`wx.Font` object. :note: Overridden from :class:`ScrolledWindow`. """ @@ -7199,7 +7199,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Tiles the background image to fill all the available area. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. .. todo:: Support background images also in stretch and centered modes. """ @@ -7233,7 +7233,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Draws a watermark at the bottom right of :class:`UltimateListCtrl`. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. .. todo:: Better support for this is needed. """ @@ -7301,7 +7301,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): :param `line`: an instance of :class:`UltimateListLineData`; :param `command`: the event type to send; - :param `point`: an instance of :class:`Point`. + :param `point`: an instance of :class:`wx.Point`. """ bRet = True @@ -8280,7 +8280,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): Draws one of the item images. :param `index`: the index of the image inside the image list; - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `x`: the x position where to draw the image; :param `y`: the y position where to draw the image; :param `enabled`: ``True`` if the item is enabled, ``False`` if it is disabled. @@ -8307,7 +8307,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Draws the item checkbox/radiobutton image. - :param `dc`: an instance of :class:`DC`; + :param `dc`: an instance of :class:`wx.DC`; :param `x`: the x position where to draw the image; :param `y`: the y position where to draw the image; :param `kind`: may be one of the following integers: @@ -8401,7 +8401,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the image list associated with the control. - :param `imageList`: an instance of :class:`ImageList` or an instance of :class:`PyImageList`; + :param `imageList`: an instance of :class:`wx.ImageList` or an instance of :class:`PyImageList`; :param `which`: one of ``wx.IMAGE_LIST_NORMAL``, ``wx.IMAGE_LIST_SMALL``, ``wx.IMAGE_LIST_STATE`` (the last is unimplemented). @@ -8465,7 +8465,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): :param `sizex`: the width of the bitmaps in the `imglist`; :param `sizey`: the height of the bitmaps in the `imglist`; - :param `imglist`: an instance of :class:`ImageList`. + :param `imglist`: an instance of :class:`wx.ImageList`. """ # Image list to hold disabled versions of each control @@ -9214,7 +9214,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Sets the font used to render hypertext items. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. """ self._hypertextfont = font @@ -10157,7 +10157,7 @@ class UltimateListMainWindow(wx.ScrolledWindow): """ Find an item nearest this position. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ topItem, dummy = self.GetVisibleLinesRange() @@ -10818,7 +10818,7 @@ class UltimateListCtrl(wx.Control): chosen by either the windowing system or wxPython, depending on platform; :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :param `style`: the underlying :class:`Control` window style; + :param `style`: the underlying :class:`wx.Control` window style; :param `agwStyle`: the AGW-specific window style; can be almost any combination of the following bits: @@ -11679,7 +11679,7 @@ class UltimateListCtrl(wx.Control): Sets the item font. :param `item`: the index of the item; - :param `f`: a valid :class:`Font` object. + :param `f`: a valid :class:`wx.Font` object. """ info = UltimateListItem() @@ -11801,7 +11801,7 @@ class UltimateListCtrl(wx.Control): :note: - As :class:`UltimateListCtrl` allows you to use a standard :class:`ImageList` or + As :class:`UltimateListCtrl` allows you to use a standard :class:`wx.ImageList` or :class:`PyImageList`, the returned object depends on which kind of image list you chose. """ @@ -11822,7 +11822,7 @@ class UltimateListCtrl(wx.Control): """ Sets the image list associated with the control. - :param `imageList`: an instance of :class:`ImageList` or an instance of :class:`PyImageList`; + :param `imageList`: an instance of :class:`wx.ImageList` or an instance of :class:`PyImageList`; :param `which`: one of ``wx.IMAGE_LIST_NORMAL``, ``wx.IMAGE_LIST_SMALL``, ``wx.IMAGE_LIST_STATE`` (the last is unimplemented). @@ -11857,7 +11857,7 @@ class UltimateListCtrl(wx.Control): """ Assigns the image list associated with the control. - :param `imageList`: an instance of :class:`ImageList` or an instance of :class:`PyImageList`; + :param `imageList`: an instance of :class:`wx.ImageList` or an instance of :class:`PyImageList`; :param `which`: one of ``wx.IMAGE_LIST_NORMAL``, ``wx.IMAGE_LIST_SMALL``, ``wx.IMAGE_LIST_STATE`` (the last is unimplemented). @@ -12005,7 +12005,7 @@ class UltimateListCtrl(wx.Control): """ Find an item nearest this position. - :param `pt`: an instance of :class:`Point`. + :param `pt`: an instance of :class:`wx.Point`. """ return self._mainWin.FindItemAtPos(pt) @@ -12015,7 +12015,7 @@ class UltimateListCtrl(wx.Control): """ HitTest method for a :class:`UltimateListCtrl`. - :param `pointOrTuple`: an instance of :class:`Point` or a tuple representing + :param `pointOrTuple`: an instance of :class:`wx.Point` or a tuple representing the mouse `x`, `y` position. :see: :meth:`UltimateListMainWindow.HitTestLine() ` for a list of return flags. @@ -12257,7 +12257,7 @@ class UltimateListCtrl(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`UltimateListCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ if not self.IsShownOnScreen(): @@ -12299,7 +12299,7 @@ class UltimateListCtrl(wx.Control): application defining an `OnIdle` handler in a derived class. This method may be used to do delayed painting, for example, and most - implementations call :meth:`Window.UpdateWindowUI` in order to send update events + implementations call :meth:`wx.Window.UpdateWindowUI` in order to send update events to the window in idle time. """ @@ -12326,10 +12326,10 @@ class UltimateListCtrl(wx.Control): event handler function under Windows and automatically under GTK. :note: Setting the background colour does not cause an immediate refresh, so - you may wish to call :meth:`Window.ClearBackground` or :meth:`Window.Refresh` after + you may wish to call :meth:`wx.Window.ClearBackground` or :meth:`wx.Window.Refresh` after calling this function. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if self._mainWin: @@ -12346,7 +12346,7 @@ class UltimateListCtrl(wx.Control): :param `colour`: the colour to be used as the foreground colour, pass :class:`NullColour` to reset to the default colour. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if not wx.Control.SetForegroundColour(self, colour): @@ -12366,9 +12366,9 @@ class UltimateListCtrl(wx.Control): """ Sets the :class:`UltimateListCtrl` font. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if not wx.Control.SetFont(self, font): @@ -12405,7 +12405,7 @@ class UltimateListCtrl(wx.Control): colour, if the field doesn't make sense as is the case for `colBg` for the controls with themed background. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ attr = wx.VisualAttributes() @@ -12432,7 +12432,7 @@ class UltimateListCtrl(wx.Control): :param `dropTarget`: an instance of :class:`DropTarget`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ self._mainWin.SetDropTarget(dropTarget) @@ -12442,7 +12442,7 @@ class UltimateListCtrl(wx.Control): """ Returns the associated drop target, which may be ``None``. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._mainWin.GetDropTarget() @@ -12458,7 +12458,7 @@ class UltimateListCtrl(wx.Control): :note: The window cursor also sets it for the children of the window implicitly. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return (self._mainWin and [self._mainWin.SetCursor(cursor)] or [False])[0] @@ -12468,7 +12468,7 @@ class UltimateListCtrl(wx.Control): """ Returns the background colour of the window. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return (self._mainWin and [self._mainWin.GetBackgroundColour()] or [wx.NullColour])[0] @@ -12478,7 +12478,7 @@ class UltimateListCtrl(wx.Control): """ Returns the foreground colour of the window. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return (self._mainWin and [self._mainWin.GetForegroundColour()] or [wx.NullColour])[0] @@ -12492,10 +12492,10 @@ class UltimateListCtrl(wx.Control): usual. If the coordinates are not specified, the current mouse cursor position is used. - :param `menu`: an instance of :class:`Menu` to pop up; + :param `menu`: an instance of :class:`wx.Menu` to pop up; :param `pos`: the position where the menu will appear. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._mainWin.PopupMenu(menu, pos) @@ -12505,12 +12505,12 @@ class UltimateListCtrl(wx.Control): """ Converts to screen coordinates from coordinates relative to this window. - :param `pointOrTuple`: an instance of :class:`Point` or a tuple representing the + :param `pointOrTuple`: an instance of :class:`wx.Point` or a tuple representing the `x`, `y` coordinates for this point. :return: the coordinates relative to the screen. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._mainWin.ClientToScreen(*pointOrTuple) @@ -12525,7 +12525,7 @@ class UltimateListCtrl(wx.Control): :return: the coordinates relative to the screen. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._mainWin.ClientToScreen(x, y) @@ -12535,12 +12535,12 @@ class UltimateListCtrl(wx.Control): """ Converts from screen to client window coordinates. - :param `pointOrTuple`: an instance of :class:`Point` or a tuple representing the + :param `pointOrTuple`: an instance of :class:`wx.Point` or a tuple representing the `x`, `y` coordinates for this point. :return: the coordinates relative to this window. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._mainWin.ScreenToClient(*pointOrTuple) @@ -12555,7 +12555,7 @@ class UltimateListCtrl(wx.Control): :return: the coordinates relative to this window. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ return self._mainWin.ScreenToClient(x, y) @@ -12824,7 +12824,7 @@ class UltimateListCtrl(wx.Control): event loop iteration, if you need to update the window immediately you should use :meth:`~UltimateListCtrl.Update` instead. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ if not rect: @@ -12869,7 +12869,7 @@ class UltimateListCtrl(wx.Control): happens if nothing has been invalidated (i.e. marked as requiring a redraw). Use :meth:`~UltimateListCtrl.Refresh` first if you want to immediately redraw the window unconditionally. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ self._mainWin.ResetVisibleLinesRange(True) @@ -13283,7 +13283,7 @@ class UltimateListCtrl(wx.Control): """ Sets the font used to render hypertext items. - :param `font`: a valid :class:`Font` instance. + :param `font`: a valid :class:`wx.Font` instance. """ self._mainWin.SetHyperTextFont(font) diff --git a/wx/lib/agw/xlsgrid.py b/wx/lib/agw/xlsgrid.py index d55920ef..39d92fc5 100644 --- a/wx/lib/agw/xlsgrid.py +++ b/wx/lib/agw/xlsgrid.py @@ -521,7 +521,7 @@ def FontFromFont(font): """ Creates a copy of the input `font`. - :param `font`: an instance of :class:`Font`. + :param `font`: an instance of :class:`wx.Font`. """ new_font = wx.Font(font.GetPointSize(), font.GetFamily(), font.GetStyle(), @@ -904,8 +904,8 @@ class XLSText(object): """ Actually draws the text value on a grid cell. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ new_rect = wx.Rect(*rect) @@ -1061,7 +1061,7 @@ class XLSRichText(XLSText): Convenience method to measure the maximum height and total width of all the chunks of text composing our rich text string. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ maxH = -1 @@ -1079,8 +1079,8 @@ class XLSRichText(XLSText): """ Actually draws all the chunks of text on a grid cell, one by one. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ new_rect = wx.Rect(*rect) @@ -1210,8 +1210,8 @@ class XLSBackground(object): """ Actually draws the cell background and pattern hatching on a grid cell. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ dc.SetClippingRegion(rect) @@ -1294,8 +1294,8 @@ class XLSBorder(object): """ Actually draws the cell border. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ dc.SetBackgroundMode(wx.TRANSPARENT) @@ -1311,8 +1311,8 @@ class XLSBorder(object): """ Actually draws the cell diagonal border. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ diag_up, diag_down = self.diagonals @@ -1343,8 +1343,8 @@ class XLSBorder(object): """ Actually draws the cell border (one of left, right, bottom, top). - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ pen_width = self.pen.GetWidth() @@ -1435,8 +1435,8 @@ class XLSBorderFactory(object): """ Actually draws all the cell borders based on their drawing priority. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. :note: The drawing priority is assigned depending on if the border is a custom one or not. Customized borders are drawn last. @@ -1470,8 +1470,8 @@ class XLSComment(object): Actually draws a small red triangle in the top-right corder of the cell to indicate that a comment is present. - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle. + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle. """ right = rect.GetTopRight() @@ -1687,8 +1687,8 @@ class XLSRenderer(gridlib.GridCellRenderer): :param `grid`: an instance of :class:`grid.Grid`; :param `attr`: an instance of :class:`grid.GridCellAttr`; - :param `dc`: an instance of :class:`DC`; - :param `rect`: an instance of :class:`Rect`, representing the cell rectangle; + :param `dc`: an instance of :class:`wx.DC`; + :param `rect`: an instance of :class:`wx.Rect`, representing the cell rectangle; :param `row`: the row in which this cell lives; :param `col`: the column in which this cell lives; :param `isSelected`: ``True`` if the cell is selected, ``False`` otherwise. diff --git a/wx/lib/agw/zoombar.py b/wx/lib/agw/zoombar.py index e027187f..06cf233f 100644 --- a/wx/lib/agw/zoombar.py +++ b/wx/lib/agw/zoombar.py @@ -582,7 +582,7 @@ class ImageBar(object): Default class constructor. :param `bitmap`: if not ``None``, the bitmap to use as a background button - bar on which the buttons float. It should be an instance of :class:`Image`. + bar on which the buttons float. It should be an instance of :class:`wx.Image`. """ if bitmap and bitmap.IsOk(): @@ -599,13 +599,13 @@ class ImageBar(object): def GetPosition(self): - """ Returns the position of :class:`ImageBar`, as a :class:`Point`. """ + """ Returns the position of :class:`wx.ImageBar`, as a :class:`wx.Point`. """ return wx.Point(self._left, self._top) def GetSize(self): - """ Returns the size of :class:`ImageBar`, as a :class:`Size`. """ + """ Returns the size of :class:`wx.ImageBar`, as a :class:`wx.Size`. """ return wx.Size(self._bitmap.GetWidth(), self._bitmap.GetHeight()) @@ -619,7 +619,7 @@ class ImageBar(object): def SetPosition(self, xpos, ypos): """ - Sets the position of :class:`ImageBar`. + Sets the position of :class:`wx.ImageBar`. :param `xpos`: the `x` position of the bar; :param `ypos`: the `y` position of the bar. @@ -631,7 +631,7 @@ class ImageBar(object): def SetSize(self, xSize, ySize): """ - Sets the size of :class:`ImageBar`. + Sets the size of :class:`wx.ImageBar`. :param `xSize`: the width of the bar, in pixels; :param `ySize`: the height of the bar, in pixels. @@ -645,8 +645,8 @@ class ImageBar(object): Sets the background button bar 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. + :param `xSize`: if not ``None``, the new :class:`wx.ImageBar` width; + :param `ySize`: if not ``None``, the new :class:`wx.ImageBar` height. """ if not isinstance(colour, wx.Colour): @@ -793,7 +793,7 @@ class ZoomBar(wx.Control): minimal size which doesn't truncate the control, for a panel - the same size as it would have after a call to `Fit()`. - :note: Overridden from :class:`Control`. + :note: Overridden from :class:`wx.Control`. """ xSize = self._buttonSize*len(self._buttons) + len(self._buttons) + self._buttonSize @@ -1139,7 +1139,7 @@ class ZoomBar(wx.Control): """ Handles the ``wx.EVT_SIZE`` event for :class:`ZoomBar`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ self.SnapToBottom(event.GetSize()) @@ -1192,7 +1192,7 @@ class ZoomBar(wx.Control): """ Draws all the main button bitmaps on the :class:`ZoomBar` client window. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ for button in self._buttons: @@ -1206,7 +1206,7 @@ class ZoomBar(wx.Control): """ Draws all the reflection button bitmaps on the :class:`ZoomBar` client window. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if self._showReflections: @@ -1221,7 +1221,7 @@ class ZoomBar(wx.Control): """ Draws all the button labels on the :class:`ZoomBar` client window. - :param `dc`: an instance of :class:`DC`. + :param `dc`: an instance of :class:`wx.DC`. """ if not self._showLabels: diff --git a/wx/lib/calendar.py b/wx/lib/calendar.py index 24b866a6..5bd4c8a7 100644 --- a/wx/lib/calendar.py +++ b/wx/lib/calendar.py @@ -503,7 +503,7 @@ class CalDraw: """ Draw the week days. - :param `DC`: the :class:`DC` to use. + :param `DC`: the :class:`wx.DC` to use. """ # increase by 1 to include all gridlines diff --git a/wx/lib/colourselect.py b/wx/lib/colourselect.py index 0c23828c..531517c7 100644 --- a/wx/lib/colourselect.py +++ b/wx/lib/colourselect.py @@ -133,7 +133,7 @@ class ColourSelect(wx.BitmapButton): :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :param string `label`: the button text label; - :param colour: a valid :class:`wx.Colour` instance, which will be the default initial + :param wx.Colour: a valid :class:`wx.Colour` instance, which will be the default initial colour for this button; :type `colour`: :class:`wx.Colour` or tuple :param `pos`: the control position. A value of (-1, -1) indicates a default position, diff --git a/wx/lib/expando.py b/wx/lib/expando.py index a778d437..0e0ecfdd 100644 --- a/wx/lib/expando.py +++ b/wx/lib/expando.py @@ -151,13 +151,13 @@ class ExpandoTextCtrl(wx.TextCtrl): chosen by either the windowing system or wxPython, depending on platform; :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :param integer `style`: the underlying :class:`Control` style; - :param Validator `validator`: the window validator; + :param integer `style`: the underlying :class:`wx.Control` style; + :param wx.Validator `validator`: the window validator; :param string `name`: the widget name. - :type parent: :class:`Window` - :type pos: tuple or :class:`Point` - :type size: tuple or :class:`Size` + :type parent: :class:`wx.Window` + :type pos: tuple or :class:`wx.Point` + :type size: tuple or :class:`wx.Size` """ # find the default height of a single line control @@ -209,7 +209,7 @@ class ExpandoTextCtrl(wx.TextCtrl): """ Sets the font for the :class:`ExpandoTextCtrl`. - :param Font font: font to associate with the :class:`ExpandoTextCtrl`, pass + :param wx.Font font: font to associate with the :class:`ExpandoTextCtrl`, pass ``NullFont`` to reset to the default font. :rtype: bool @@ -280,7 +280,7 @@ class ExpandoTextCtrl(wx.TextCtrl): """ Handles the ``wx.EVT_SIZE`` event for :class:`ExpandoTextCtrl`. - :param `event`: a :class:`SizeEvent` event to be processed. + :param `event`: a :class:`wx.SizeEvent` event to be processed. """ # The number of lines needed can change when the ctrl is resized too. diff --git a/wx/lib/floatcanvas/FCObjects.py b/wx/lib/floatcanvas/FCObjects.py index d38ad370..30808aa9 100644 --- a/wx/lib/floatcanvas/FCObjects.py +++ b/wx/lib/floatcanvas/FCObjects.py @@ -1480,14 +1480,14 @@ class Text(TextObjectMixin, DrawObject): :param `Size`: the font size :param `Color`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor` :param `BackgroundColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor` - :param FontFamily `Family`: a valid :ref:`FontFamily` - :param FontStyle `Style`: a valid :ref:`FontStyle` - :param FontWeight `Weight`: a valid :ref:`FontWeight` + :param wx.FontFamily `Family`: a valid :ref:`wx.FontFamily` + :param wx.FontStyle `Style`: a valid :ref:`wx.FontStyle` + :param wx.FontWeight `Weight`: a valid :ref:`wx.FontWeight` :param boolean `Underlined`: underline the text :param string `Position`: a two character string indicating where in relation to the coordinates the box should be oriented :param boolean `InForeground`: should object be in foreground - :param Font `Font`: alternatively you can define :ref:`Font` and the + :param wx.Font `Font`: alternatively you can define :ref:`wx.Font` and the above will be ignored. ============== ========================== @@ -1506,7 +1506,7 @@ class Text(TextObjectMixin, DrawObject): ``r`` right ============== ========================== - :param Font `Font`: a valid :class:`Font` + :param wx.Font `Font`: a valid :class:`wx.Font` :param boolean `InForeground`: should object be in foreground """ @@ -1778,9 +1778,9 @@ class ScaledTextBox(TextObjectMixin, DrawObject): the given width. :param `PadSize`: padding in world units or ``None``, if specified it will creating a space (margin) around the text - :param FontFamily `Family`: a valid :ref:`FontFamily` - :param FontStyle `Style`: a valid :ref:`FontStyle` - :param FontWeight `Weight`: a valid :ref:`FontWeight` + :param wx.FontFamily `Family`: a valid :ref:`wx.FontFamily` + :param wx.FontStyle `Style`: a valid :ref:`wx.FontStyle` + :param wx.FontWeight `Weight`: a valid :ref:`wx.FontWeight` :param boolean `Underlined`: underline the text :param string `Position`: a two character string indicating where in relation to the coordinates the box should be oriented @@ -1802,7 +1802,7 @@ class ScaledTextBox(TextObjectMixin, DrawObject): ============== ========================== :param `Alignment`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetLineWidth` - :param Font `Font`: alternatively a valid :class:`Font` can be defined + :param wx.Font `Font`: alternatively a valid :class:`wx.Font` can be defined in which case the above will be ignored :param float `LineSpacing`: the line space to be used :param boolean `InForeground`: should object be in foreground @@ -2035,7 +2035,7 @@ class Bitmap(TextObjectMixin, DrawObject): """ Default class constructor. - :param Bitmap `Bitmap`: the bitmap to be drawn + :param wx.Bitmap `Bitmap`: the bitmap to be drawn :param `XY`: the (x, y) coordinate of the corner of the bitmap, or a 2-tuple, or a (2,) `NumPy `_ array :param string `Position`: a two character string indicating where in relation to the coordinates diff --git a/wx/lib/floatcanvas/FloatCanvas.py b/wx/lib/floatcanvas/FloatCanvas.py index 2edf7fcc..1e05186f 100644 --- a/wx/lib/floatcanvas/FloatCanvas.py +++ b/wx/lib/floatcanvas/FloatCanvas.py @@ -120,9 +120,9 @@ class FloatCanvas(wx.Panel): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; - :param `size`: a tuple or :class:`Size` + :param `size`: a tuple or :class:`wx.Size` :param `ProjectionFun`: This allows you to change the transform from world to pixel coordinates. We can point to :meth:`~lib.floatcanvas.FloatCanvas.FloatCanvas.FlatEarthProjection` for an example -- though that should really be a class method, or even diff --git a/wx/lib/floatcanvas/NavCanvas.py b/wx/lib/floatcanvas/NavCanvas.py index 3c4aef58..2751d7e4 100644 --- a/wx/lib/floatcanvas/NavCanvas.py +++ b/wx/lib/floatcanvas/NavCanvas.py @@ -63,9 +63,9 @@ class NavCanvas(wx.Panel): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; - :param `size`: a tuple or :class:`Size` + :param `size`: a tuple or :class:`wx.Size` :param `**kwargs`: will be passed on to :class:`~lib.floatcanvas.FloatCanvas.FloatCanvas` """ wx.Panel.__init__(self, parent, id, size=size) diff --git a/wx/lib/imagebrowser.py b/wx/lib/imagebrowser.py index 5e97cb4d..5afc9697 100644 --- a/wx/lib/imagebrowser.py +++ b/wx/lib/imagebrowser.py @@ -51,7 +51,7 @@ an image. Description =========== -The :class:`ImageDialog` allows the user to view images and select one. +The :class:`wx.ImageDialog` allows the user to view images and select one. Usage ===== @@ -98,7 +98,7 @@ def ConvertBMP(file_nm): :param string `file_nm`: path to file - :return: :class:`Image` or BAD_IMAGE + :return: :class:`wx.Image` or BAD_IMAGE """ if file_nm is None: return None @@ -426,14 +426,14 @@ class ImagePanel(wx.Panel): class ImageDialog(wx.Dialog): """ - :class:`ImageDialog` derived from :class:`Dialog` allows the user + :class:`wx.ImageDialog` derived from :class:`Dialog` allows the user to display images and to select an image. """ def __init__(self, parent, set_dir = None): """ Default class constructor. - :param Window `parent`: parent window. + :param wx.Window `parent`: parent window. :param string `set_dir`: path to set as working directory """ diff --git a/wx/lib/imageutils.py b/wx/lib/imageutils.py index dd1901ef..e180b353 100644 --- a/wx/lib/imageutils.py +++ b/wx/lib/imageutils.py @@ -56,9 +56,9 @@ def grayOut(anImage): Convert the given image (in place) to a grayed-out version, appropriate for a 'disabled' appearance. - :param Image `anImage`: the image we want to convert to gray-scale. + :param wx.Image `anImage`: the image we want to convert to gray-scale. - :rtype: :class:`Image` + :rtype: :class:`wx.Image` :returns: The modified (greyed out) image. .. note:: the image is converted in place, i.e. the input image will @@ -117,7 +117,7 @@ def stepColour(c, step): completely black and a step of 200 is totally white, and 100 results in the same color as was passed in. - :param Colour `c`: the input colour to be modified (darkened or lightened); + :param wx.Colour `c`: the input colour to be modified (darkened or lightened); :param integer `step`: the step value. :rtype: :class:`wx.Colour` diff --git a/wx/lib/intctrl.py b/wx/lib/intctrl.py index 60ac70bd..3bc9d0a2 100644 --- a/wx/lib/intctrl.py +++ b/wx/lib/intctrl.py @@ -417,13 +417,13 @@ class IntCtrl(wx.TextCtrl): a default position, chosen by either the windowing system or wxPython, depending on platform - :param Size `size`: the control size. A value of (-1, -1) indicates a + :param wx.Size `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform :param int `style`: the underlying :class:`TextCtrl` style - :param Validator `validator`: Normally None, IntCtrl uses its own + :param wx.Validator `validator`: Normally None, IntCtrl uses its own validator to do value validation and input control. However, a validator derived from :class:`~lib.intctrl.IntValidator` can be supplied to override the data transfer methods for the diff --git a/wx/lib/langlistctrl.py b/wx/lib/langlistctrl.py index f3c9be7c..7691d2c1 100644 --- a/wx/lib/langlistctrl.py +++ b/wx/lib/langlistctrl.py @@ -383,14 +383,14 @@ class LanguageListCtrl(wx.ListCtrl): Default class constructor. :param `parent`: Parent window. Must not be ``None``. - :type `parent`: Window + :type `parent`: wx.Window :param `id`: Window identifier. The value ``ID_ANY`` indicates a default value. :type `id`: int :param `pos`: Window position. If ``DefaultPosition`` is specified then a default position is chosen. - :type `pos`: Point + :type `pos`: wx.Point :param `size`: Window size. If ``DefaultSize`` is specified then the window is sized appropriately. - :type `size`: Size - :param `style`: Window style. See :ref:`ListCtrl`. + :type `size`: wx.Size + :param `style`: Window style. See :ref:`wx.ListCtrl`. :type `style`: long :param `filter`: Filter the list of languages (LC_AVAILABLE, LC_ALL or LC_ONLY) :param `only`: a tuple of language ids diff --git a/wx/lib/masked/combobox.py b/wx/lib/masked/combobox.py index 8e96084a..9c518172 100644 --- a/wx/lib/masked/combobox.py +++ b/wx/lib/masked/combobox.py @@ -92,17 +92,17 @@ class BaseMaskedComboBox( wx.ComboBox, MaskedEditMixin ): """ Default class constructor. - :param Window `parent`: the window parent. Must not be ``None``; + :param wx.Window `parent`: the window parent. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :param string `value`: value to be shown; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param list `choices`: a list of valid choices; :param integer `style`: the window style; - :param Validator `validator`: this is mainly provided for data-transfer, as control does + :param wx.Validator `validator`: this is mainly provided for data-transfer, as control does its own validation; :param string `name`: the window name; :param boolean `setupEventHandling`: setup event handling by default. diff --git a/wx/lib/masked/ipaddrctrl.py b/wx/lib/masked/ipaddrctrl.py index 1b217775..50a917e2 100644 --- a/wx/lib/masked/ipaddrctrl.py +++ b/wx/lib/masked/ipaddrctrl.py @@ -91,16 +91,16 @@ class IpAddrCtrl( BaseMaskedTextCtrl, IpAddrCtrlAccessorsMixin ): """ Default class constructor. - :param Window `parent`: the window parent. Must not be ``None``; + :param wx.Window `parent`: the window parent. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :param string `value`: value to be shown; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the window style; - :param Validator `validator`: this is mainly provided for data-transfer, as control does + :param wx.Validator `validator`: this is mainly provided for data-transfer, as control does its own validation; :param string `name`: the window name; :param boolean `setupEventHandling`: setup event handling by default. diff --git a/wx/lib/masked/numctrl.py b/wx/lib/masked/numctrl.py index 8bc06b65..d3367028 100644 --- a/wx/lib/masked/numctrl.py +++ b/wx/lib/masked/numctrl.py @@ -520,16 +520,16 @@ class NumCtrl(BaseMaskedTextCtrl, NumCtrlAccessorsMixin): """ Default class constructor. - :param Window `parent`: the window parent. Must not be ``None``; + :param wx.Window `parent`: the window parent. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :param integer `value`: value to be shown; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the window style; - :param Validator `validator`: this is mainly provided for data-transfer, as control does + :param wx.Validator `validator`: this is mainly provided for data-transfer, as control does its own validation; :param string `name`: the window name; diff --git a/wx/lib/masked/textctrl.py b/wx/lib/masked/textctrl.py index 1374d96f..53aa5e5a 100644 --- a/wx/lib/masked/textctrl.py +++ b/wx/lib/masked/textctrl.py @@ -73,16 +73,16 @@ class BaseMaskedTextCtrl( wx.TextCtrl, MaskedEditMixin ): """ Default class constructor. - :param Window `parent`: the window parent. Must not be ``None``; + :param wx.Window `parent`: the window parent. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :param string `value`: value to be shown; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param integer `style`: the window style; - :param Validator `validator`: this is mainly provided for data-transfer, as control does + :param wx.Validator `validator`: this is mainly provided for data-transfer, as control does its own validation; :param string `name`: the window name; :param boolean `setupEventHandling`: setup event handling by default. diff --git a/wx/lib/masked/timectrl.py b/wx/lib/masked/timectrl.py index 7f15dacd..8b1d29c6 100644 --- a/wx/lib/masked/timectrl.py +++ b/wx/lib/masked/timectrl.py @@ -364,19 +364,19 @@ class TimeCtrl(BaseMaskedTextCtrl): """ Default class constructor. - :param Window `parent`: the window parent. Must not be ``None``; + :param wx.Window `parent`: the window parent. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :param string `value`: value to be shown; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; :param boolean `fmt24hr`: True to use 24 hour format (sometimes called military format; :param SpinButton `spinButton`: an instance of :class:`SpinButton` or None; :param integer `style`: the window style; - :param Validator `validator`: this is mainly provided for data-transfer, as control does + :param wx.Validator `validator`: this is mainly provided for data-transfer, as control does its own validation; :param string `name`: the window name; diff --git a/wx/lib/mixins/inspection.py b/wx/lib/mixins/inspection.py index 1f379364..360c7ba1 100644 --- a/wx/lib/mixins/inspection.py +++ b/wx/lib/mixins/inspection.py @@ -24,7 +24,7 @@ Description =========== The Widget Inspection Tool (WIT) is very useful debugging tool provided with -wxPython, especially useful to debug layout issues when using :class:`Sizer`. +wxPython, especially useful to debug layout issues when using :class:`wx.Sizer`. The :class:`InspectableApp` is a "pre-mixed" :class:`App` and the :class:`InspectionMixin` allows you to mix it with your custom :class:`App` diff --git a/wx/lib/ogl/basic.py b/wx/lib/ogl/basic.py index 3818df6d..0242238e 100644 --- a/wx/lib/ogl/basic.py +++ b/wx/lib/ogl/basic.py @@ -787,7 +787,7 @@ class Shape(ShapeEvtHandler): """ Set the font for the specified text region. - :param `the_font`: an instance of :class:`Font` ??? + :param `the_font`: an instance of :class:`wx.Font` ??? :param `regionId`: the region identifier """ @@ -2725,7 +2725,7 @@ class Shape(ShapeEvtHandler): class RectangleShape(Shape): """ - The :class:`RectangleShape` class has rounded or square corners. + The :class:`wx.RectangleShape` class has rounded or square corners. """ def __init__(self, w = 0.0, h = 0.0): """ @@ -2864,7 +2864,7 @@ class PolygonShape(Shape): def Create(self, the_points = None): """ - Takes a list of :class:`Points` or tuples; each point is an offset + Takes a list of :class:`wx.Points` or tuples; each point is an offset from the centre. """ self.ClearPoints() @@ -3550,7 +3550,7 @@ class CircleShape(EllipseShape): class TextShape(RectangleShape): """ - The :class:`TextShape` class like :class:`RectangleShape` but only the + The :class:`TextShape` class like :class:`wx.RectangleShape` but only the text is displayed. """ def __init__(self, width, height): @@ -3632,7 +3632,7 @@ class ShapeRegion(object): """ Set the font. - :param `f`: an instance of :class:`Font` + :param `f`: an instance of :class:`wx.Font` """ self._font = f @@ -3829,7 +3829,7 @@ class ShapeRegion(object): class ControlPoint(RectangleShape): - """The :class:`ControlPoint` class.""" + """The :class:`wx.ControlPoint` class.""" def __init__(self, theCanvas, object, size, the_xoffset, the_yoffset, the_type): """ Default class constructor diff --git a/wx/lib/ogl/canvas.py b/wx/lib/ogl/canvas.py index f34913bd..de80b848 100644 --- a/wx/lib/ogl/canvas.py +++ b/wx/lib/ogl/canvas.py @@ -61,12 +61,12 @@ class ShapeCanvas(wx.ScrolledWindow): chosen by either the windowing system or wxPython, depending on platform :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform - :param integer `style`: the underlying :class:`Window` style + :param integer `style`: the underlying :class:`wx.Window` style :param str `name`: the window name - :type parent: :class:`Window` - :type pos: tuple or :class:`Point` - :type size: tuple or :class:`Size` + :type parent: :class:`wx.Window` + :type pos: tuple or :class:`wx.Point` + :type size: tuple or :class:`wx.Size` """ wx.ScrolledWindow.__init__(self, parent, id, pos, size, style, name) diff --git a/wx/lib/pdfviewer/bezier.py b/wx/lib/pdfviewer/bezier.py index 60e6df28..18fb7989 100644 --- a/wx/lib/pdfviewer/bezier.py +++ b/wx/lib/pdfviewer/bezier.py @@ -58,7 +58,7 @@ def compute_points(controlpoints, nsteps=30): """ Input 4 control points as :class:`RealPoint` and convert to vec2d instances. compute the nsteps points on the resulting curve and return them - as a list of :class:`Point` + as a list of :class:`wx.Point` """ controlvectors = [] for p in controlpoints: diff --git a/wx/lib/pdfviewer/buttonpanel.py b/wx/lib/pdfviewer/buttonpanel.py index 74bd455d..258719a8 100644 --- a/wx/lib/pdfviewer/buttonpanel.py +++ b/wx/lib/pdfviewer/buttonpanel.py @@ -32,14 +32,14 @@ class pdfButtonPanel(bp.ButtonPanel): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `style`: the button style (unused); """ diff --git a/wx/lib/pdfviewer/dcgraphics.py b/wx/lib/pdfviewer/dcgraphics.py index cb417fa3..857f7ce5 100644 --- a/wx/lib/pdfviewer/dcgraphics.py +++ b/wx/lib/pdfviewer/dcgraphics.py @@ -16,7 +16,7 @@ #---------------------------------------------------------------------------- """ This module implements an API similar to :class:`GraphicsContext` and the -related classes. The implementation is done using :class:`DC` +related classes. The implementation is done using :class:`wx.DC` Why do this? Neither :class:`GraphicsContext` nor the Cairo-based GraphicsContext API provided by wx.lib.graphics can be written @@ -148,7 +148,7 @@ class dcGraphicsContext(object): The incoming co-ordinates have a bottom left origin with increasing y downwards (so y values are all negative). The DC origin is top left also with increasing y down. - :class:`DC` and :class:`GraphicsContext` fonts are too big in the ratio + :class:`wx.DC` and :class:`GraphicsContext` fonts are too big in the ratio of pixels per inch to points per inch. If screen rendering used Cairo, printed fonts need to be scaled but if :class:`GCDC` was used, they are already scaled. @@ -249,10 +249,10 @@ class dcGraphicsContext(object): def SetFont(self, font, colour=None): """ - Sets the :class:`Font` to be used for drawing text. + Sets the :class:`wx.Font` to be used for drawing text. Don't set the dc font yet as it may need to be scaled - :param `font`: the :class:`Font` for drawing text + :param `font`: the :class:`wx.Font` for drawing text :param `colour`: the colour to be used """ diff --git a/wx/lib/pdfviewer/viewer.py b/wx/lib/pdfviewer/viewer.py index 2e80d87b..cd5406f0 100644 --- a/wx/lib/pdfviewer/viewer.py +++ b/wx/lib/pdfviewer/viewer.py @@ -130,14 +130,14 @@ class pdfViewer(wx.ScrolledWindow): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `style`: the button style (unused); """ @@ -652,7 +652,7 @@ class pdfViewer(wx.ScrolledWindow): def SetFont(self, pdfont, size): """ - Returns :class:`Font` instance from supplied pdf font information. + Returns :class:`wx.Font` instance from supplied pdf font information. """ self.knownfont = True pdfont = pdfont.lower() diff --git a/wx/lib/platebtn.py b/wx/lib/platebtn.py index 5db21adb..636f5c64 100644 --- a/wx/lib/platebtn.py +++ b/wx/lib/platebtn.py @@ -125,7 +125,7 @@ class PlateButton(wx.Control): """Create a PlateButton :keyword string `label`: Buttons label text - :keyword Bitmap `bmp`: Buttons bitmap + :keyword wx.Bitmap `bmp`: Buttons bitmap :keyword `style`: Button style """ @@ -403,7 +403,7 @@ class PlateButton(wx.Control): def DoGetBestSize(self): """Calculate the best size of the button - :return: :class:`Size` + :return: :class:`wx.Size` """ width = 4 @@ -666,8 +666,8 @@ 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:`wx.Colour`) - :keyword Colour `hlight`: Color for when mouse is hovering over + :param wx.Colour `normal`: Label color for normal state (:class:`wx.Colour`) + :keyword wx.Colour `hlight`: Color for when mouse is hovering over """ assert isinstance(normal, wx.Colour), "Must supply a colour object" @@ -689,7 +689,7 @@ class PlateButton(wx.Control): """Set the menu that can be shown when clicking on the drop arrow of the button. - :param Menu `menu`: :class:`Menu` to use as a PopupMenu + :param wx.Menu `menu`: :class:`wx.Menu` to use as a PopupMenu ..note:: Arrow is not drawn unless a menu is set @@ -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:`wx.Colour` + :param wx.Colour `color`: :class:`wx.Colour` ..note:: also resets all text colours as necessary diff --git a/wx/lib/resizewidget.py b/wx/lib/resizewidget.py index b5d8cd4b..3d348003 100644 --- a/wx/lib/resizewidget.py +++ b/wx/lib/resizewidget.py @@ -256,7 +256,7 @@ class ResizeWidget(wx.Panel): """ Handles the ``wx.EVT_SIZE`` event for :class:`ResizeWidget`. - :param `evt`: a :class:`SizeEvent` event to be processed. + :param `evt`: a :class:`wx.SizeEvent` event to be processed. """ if not self._managedChild: diff --git a/wx/lib/scrolledpanel.py b/wx/lib/scrolledpanel.py index 7f5c31f5..20c81996 100644 --- a/wx/lib/scrolledpanel.py +++ b/wx/lib/scrolledpanel.py @@ -97,14 +97,14 @@ class ScrolledPanel(wx.ScrolledWindow): """ Default class constructor. - :param Window `parent`: parent window. Must not be ``None``; + :param wx.Window `parent`: parent window. Must not be ``None``; :param integer `id`: window identifier. A value of -1 indicates a default value; :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; - :type `pos`: tuple or :class:`Point` + :type `pos`: tuple or :class:`wx.Point` :param `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform; - :type `size`: tuple or :class:`Size` + :type `size`: tuple or :class:`wx.Size` :param integer `style`: the underlying :class:`wx.ScrolledWindow` style; :param string `name`: the scrolled panel name. """ @@ -177,7 +177,7 @@ class ScrolledPanel(wx.ScrolledWindow): """ Scroll the panel so that the specified child window is in view. - :param Window `child`: any :class:`Window` - derived control. + :param wx.Window `child`: any :class:`wx.Window` - derived control. .. note:: This method looks redundant if `evt.Skip()` is called as well - the base :class:`ScrolledWindow` widget now seems diff --git a/wx/lib/sized_controls.py b/wx/lib/sized_controls.py index bd80b47c..869acb71 100644 --- a/wx/lib/sized_controls.py +++ b/wx/lib/sized_controls.py @@ -18,10 +18,10 @@ a simple interface for customizing those sizers. The following sized controls exists: -:class:`SizedFrame` -:class:`SizedDialog` -:class:`SizedPanel` -:class:`SizedScrolledPanel` +:class:`wx.SizedFrame` +:class:`wx.SizedDialog` +:class:`wx.SizedPanel` +:class:`wx.SizedScrolledPanel` Description =========== @@ -145,7 +145,7 @@ class TableSizer(wx.Sizer): """ Calculate the minimum size. - :rtype: :ref:`Size` + :rtype: :ref:`wx.Size` """ numrows, numcols = self.CalcNumRowsCols() @@ -602,7 +602,7 @@ class SizedParent: Add a child to sizer :param `child`: child (window or another sizer) to be added to sizer. - :type `child`: :class:`Window` or :class:`Sizer` + :type `child`: :class:`wx.Window` or :class:`wx.Sizer` """ # Note: The wx.LogNull is used here to suppress a log message @@ -697,7 +697,7 @@ class SizedParent: """ Detach children from sizer. - :param Sizer `sizer`: sizer to detach children from + :param wx.Sizer `sizer`: sizer to detach children from """ props = {} @@ -738,7 +738,7 @@ class SizedPanel(wx.Panel, SizedParent): """ def __init__(self, *args, **kwargs): """ - `self` in the following sample is a :class:`SizedPanel` instance. + `self` in the following sample is a :class:`wx.SizedPanel` instance. Sample usage:: @@ -780,7 +780,7 @@ class SizedScrolledPanel(sp.ScrolledPanel, SizedParent): """ def __init__(self, *args, **kwargs): """ - `self` in the following sample is a :class:`SizedScrolledPanel` instance. + `self` in the following sample is a :class:`wx.SizedScrolledPanel` instance. Sample usage:: @@ -825,7 +825,7 @@ class SizedDialog(wx.Dialog): """ def __init__(self, *args, **kwargs): """ - `self` in the following sample is a :class:`SizedDialog` instance. + `self` in the following sample is a :class:`wx.SizedDialog` instance. Sample usage:: @@ -879,7 +879,7 @@ class SizedFrame(wx.Frame): def __init__(self, *args, **kwargs): """ - `self` in the following sample is a :class:`SizedFrame` instance + `self` in the following sample is a :class:`wx.SizedFrame` instance Sample usage:: diff --git a/wx/lib/splitter.py b/wx/lib/splitter.py index 3a5639e4..9dbe2a0a 100644 --- a/wx/lib/splitter.py +++ b/wx/lib/splitter.py @@ -60,11 +60,11 @@ class MultiSplitterWindow(wx.Panel): """ Default class constructor. - :param Window `parent`: the parent window + :param wx.Window `parent`: the parent window :param integer `id`: an identifier for the control: a value of -1 is taken to mean a default - :param Point `pos`: the control position. A value of (-1, -1) indicates a default position, + :param wx.Point `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 `size`: the control size. A value of (-1, -1) indicates a default size, + :param wx.Size `size`: the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform :param integer `style`: the control window style :param string `name`: the control name @@ -129,7 +129,7 @@ class MultiSplitterWindow(wx.Panel): """ Sets the back ground colour. - :param Colour `color`: the colour to use. + :param wx.Colour `color`: the colour to use. """ wx.Panel.SetBackgroundColour(self,color) diff --git a/wx/lib/throbber.py b/wx/lib/throbber.py index 8d2bbdbb..cab5ae2a 100644 --- a/wx/lib/throbber.py +++ b/wx/lib/throbber.py @@ -81,7 +81,7 @@ class Throbber(wx.Panel): :param string `label`: optional text to be displayed :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 integer `style`: the underlying :class:`wx.Control` style :param string `name`: the widget name. :param `rest`: the rest frame :param `current`: the current frame @@ -184,7 +184,7 @@ class Throbber(wx.Panel): """ Handles the ``wx.EVT_WINDOW_DESTROY`` event for :class:`Throbber`. - :param `event`: a :class:`WindowDestroyEvent` event to be processed. + :param `event`: a :class:`wx.WindowDestroyEvent` event to be processed. """ self.Stop() @@ -195,7 +195,7 @@ class Throbber(wx.Panel): """ Draw the widget. - :param `dc`: the :class:`DC` to draw on + :param `dc`: the :class:`wx.DC` to draw on """ dc.DrawBitmap(self.submaps[self.sequence[self.current]], 0, 0, True) @@ -250,7 +250,7 @@ class Throbber(wx.Panel): """ Set the font for the label. - :param `font`: the :class:`Font` to use + :param `font`: the :class:`wx.Font` to use """ wx.Panel.SetFont(self, font) diff --git a/wx/lib/ticker.py b/wx/lib/ticker.py index 5dc6599f..cc284040 100644 --- a/wx/lib/ticker.py +++ b/wx/lib/ticker.py @@ -46,16 +46,16 @@ class Ticker(wx.Control): """ Default class constructor. - :param Window `parent`: the parent + :param wx.Window `parent`: the parent :param integer `id`: an identifier for the control: a value of -1 is taken to mean a default :param string `text`: text in the ticker - :param Colour `fgcolor`: text/foreground color - :param Colour `bgcolor`: background color + :param wx.Colour `fgcolor`: text/foreground color + :param wx.Colour `bgcolor`: background color :param boolean `start`: if True, the ticker starts immediately :param int `ppf`: pixels per frame :param int `fps`: frames per second :param `direction`: direction of ticking, 'rtl' or 'ltr' - :param Point `pos`: the control position. A value of (-1, -1) indicates a default position, + :param wx.Point `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 `name`: the control name @@ -133,7 +133,7 @@ class Ticker(wx.Control): """ Set the font for the control. - :param Font `font`: the font to be used. + :param wx.Font `font`: the font to be used. """ self._extent = (-1, -1) @@ -184,7 +184,7 @@ class Ticker(wx.Control): """ Updates the cached text extent if needed. - :param DC `dc`: the dc to use. + :param wx.DC `dc`: the dc to use. """ if not self._text: @@ -198,7 +198,7 @@ class Ticker(wx.Control): """ Draws the ticker text at the current offset using the provided DC. - :param DC `dc`: the dc to use. + :param wx.DC `dc`: the dc to use. """ dc.SetTextForeground(self.GetForegroundColour()) diff --git a/wx/lib/utils.py b/wx/lib/utils.py index 9a0ab67a..1f3637fd 100644 --- a/wx/lib/utils.py +++ b/wx/lib/utils.py @@ -31,7 +31,7 @@ def AdjustRectToScreen(rect, adjust=(0,0)): the rectangle is at least that much smaller than the display's client area. - :param Rect `rect`: the rectangle to be repositioned; + :param wx.Rect `rect`: the rectangle to be repositioned; :param tuple `adjust`: if given, it will be used to ensure that the rectangle is at least that much smaller than the display's client area.