Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docstring fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@40069 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-07-11 15:21:05 +00:00
parent a189504e7f
commit a2cccbc3f3
4 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
wxPython/src/_pseudodc.i
View File

@@ -342,8 +342,10 @@ current text background colour to draw the background (all bits set to
font, and the current text foreground and background colours. font, and the current text foreground and background colours.
The coordinates refer to the top-left corner of the rectangle bounding The coordinates refer to the top-left corner of the rectangle bounding
the string. See `GetTextExtent` for how to get the dimensions of a the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
text string, which can be used to position the text more precisely. a text string, which can be used to position the text more precisely,
(you will need to use a real DC with GetTextExtent as wx.PseudoDC does
not implement it.)
**NOTE**: under wxGTK the current logical function is used by this **NOTE**: under wxGTK the current logical function is used by this
function but it is ignored by wxMSW. Thus, you should avoid using function but it is ignored by wxMSW. Thus, you should avoid using
@@ -545,9 +547,8 @@ context, and the original palette restored.", "
DocDeclStr( DocDeclStr(
virtual void , SetLogicalFunction(int function), virtual void , SetLogicalFunction(int function),
"Sets the current logical function for the device context. This "Sets the current logical function for the device context. This
determines how a source pixel (from a pen or brush colour, or source determines how a source pixel (from a pen or brush colour, combines
device context if using `Blit`) combines with a destination pixel in with a destination pixel in the current device context.
the current device context.
The possible values and their meaning in terms of source and The possible values and their meaning in terms of source and
destination pixel values are as follows: destination pixel values are as follows:

8
wxPython/src/_renderer.i
View File

@@ -243,16 +243,16 @@ The flags parameter may be:
"Return the generic implementation of the renderer. Under some "Return the generic implementation of the renderer. Under some
platforms, this is the default renderer implementation, others have platforms, this is the default renderer implementation, others have
platform-specific default renderer which can be retrieved by calling platform-specific default renderer which can be retrieved by calling
`GetDefault`.", ""); `wx.RendererNative.GetDefault`.", "");
MustHaveApp(GetDefault); MustHaveApp(GetDefault);
DocDeclStr( DocDeclStr(
static wxRendererNative& , GetDefault(), static wxRendererNative& , GetDefault(),
"Return the default (native) implementation for this platform -- this "Return the default (native) implementation for this platform -- this
is also the one used by default but this may be changed by calling `Set` is also the one used by default but this may be changed by calling
in which case the return value of this method may be different from `wx.RendererNative.Set` in which case the return value of this method
the return value of `Get`.", ""); may be different from the return value of `wx.RendererNative.Get`.", "");

4
wxPython/src/_sizers.i
View File

@@ -360,8 +360,8 @@ DocStr(wxSizer,
"wx.Sizer is the abstract base class used for laying out subwindows in "wx.Sizer is the abstract base class used for laying out subwindows in
a window. You cannot use wx.Sizer directly; instead, you will have to a window. You cannot use wx.Sizer directly; instead, you will have to
use one of the sizer classes derived from it such as `wx.BoxSizer`, use one of the sizer classes derived from it such as `wx.BoxSizer`,
`wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer` `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
and `wx.GridBagSizer`. `wx.GridBagSizer`.
The concept implemented by sizers in wxWidgets is closely related to The concept implemented by sizers in wxWidgets is closely related to
layout tools in other GUI toolkits, such as Java's AWT, the GTK layout tools in other GUI toolkits, such as Java's AWT, the GTK

2
wxPython/src/richtext.i
View File

@@ -571,7 +571,7 @@ during sizing.", "");
virtual bool , SaveFile(const wxString& file = wxPyEmptyString, virtual bool , SaveFile(const wxString& file = wxPyEmptyString,
int type = wxRICHTEXT_TYPE_ANY), int type = wxRICHTEXT_TYPE_ANY),
"Save the contents of the document to the given filename, or if the "Save the contents of the document to the given filename, or if the
empty string is passed then to the filename set with `SetFileName`.", ""); empty string is passed then to the filename set with `SetFilename`.", "");
// sets/clears the dirty flag // sets/clears the dirty flag