docstrings and other minor tweaks

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41283 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-09-18 19:44:21 +00:00
parent e2b79cc98f
commit 6a223074d3
13 changed files with 47 additions and 24 deletions

View File

@@ -1287,10 +1287,14 @@ on it, everything is in fact first drawn on an in-memory buffer (a
`wx.Bitmap`) and then copied to the screen only once, when this object `wx.Bitmap`) and then copied to the screen only once, when this object
is destroyed. is destroyed.
It can be used in the same way as any other device It can be used in the same way as any other device context.
context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to
want to use it in your EVT_PAINT handler, you should look at use it in your EVT_PAINT handler, you should look at
`wx.BufferedPaintDC`. `wx.BufferedPaintDC`.
Please note that GTK+ 2.0 and OS X provide double buffering themselves
natively so using this class on those platforms will normally result
in an unneeded level of buffering.
", ""); ", "");
class wxBufferedDC : public wxMemoryDC class wxBufferedDC : public wxMemoryDC

View File

@@ -678,8 +678,8 @@ Events
EVT_SCROLL_PAGEDOWN page down events EVT_SCROLL_PAGEDOWN page down events
EVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent EVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
as the user drags the 'thumb') as the user drags the 'thumb')
EVT_SCROLL_THUMBRELEASE thumb release events. EVT_SCROLL_THUMBRELEASE thumb release events
EVT_SCROLL_ENDSCROLL End of scrolling EVT_SCROLL_CHANGED End of scrolling
======================= ========================================== ======================= ==========================================
Note Note
@@ -687,17 +687,17 @@ Note
The EVT_SCROLL_THUMBRELEASE event is only emitted when actually The EVT_SCROLL_THUMBRELEASE event is only emitted when actually
dragging the thumb using the mouse and releasing it (This dragging the thumb using the mouse and releasing it (This
EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_THUMBRELEASE event is also followed by an
EVT_SCROLL_ENDSCROLL event). EVT_SCROLL_CHANGED event).
The EVT_SCROLL_ENDSCROLL event also occurs when using the keyboard The EVT_SCROLL_CHANGED event also occurs when using the keyboard
to change the thumb position, and when clicking next to the thumb to change the thumb position, and when clicking next to the thumb
(In all these cases the EVT_SCROLL_THUMBRELEASE event does not (In all these cases the EVT_SCROLL_THUMBRELEASE event does not
happen). happen).
In short, the EVT_SCROLL_ENDSCROLL event is triggered when In short, the EVT_SCROLL_CHANGED event is triggered when
scrolling/ moving has finished. The only exception (unfortunately) scrolling/ moving has finished. The only exception (unfortunately)
is that changing the thumb position using the mousewheel does give is that changing the thumb position using the mousewheel does give
a EVT_SCROLL_THUMBRELEASE event but NOT an EVT_SCROLL_ENDSCROLL a EVT_SCROLL_THUMBRELEASE event but NOT an EVT_SCROLL_CHANGED
event. event.
"); ");
@@ -745,8 +745,8 @@ Events
EVT_SCROLLWIN_PAGEDOWN page down events EVT_SCROLLWIN_PAGEDOWN page down events
EVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent EVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent
as the user drags the 'thumb') as the user drags the 'thumb')
EVT_SCROLLWIN_THUMBRELEASE thumb release events. EVT_SCROLLWIN_THUMBRELEASE thumb release events
EVT_SCROLLWIN_ENDSCROLL End of scrolling EVT_SCROLLWIN_CHANGED End of scrolling
========================== ========================================== ========================== ==========================================
:see: `wx.ScrollEvent` :see: `wx.ScrollEvent`

View File

@@ -835,7 +835,7 @@ any.", "",
%extend { %extend {
wxWindow* GetMainWindow() { wxWindow* GetMainWindow() {
#ifdef __WXMSW__ #if defined(__WXMSW__) || defined(__WXMAC__)
return self; return self;
#else #else
return (wxWindow*)self->m_mainWin; return (wxWindow*)self->m_mainWin;

View File

@@ -44,6 +44,7 @@ enum {
wxTB_HORZ_LAYOUT, wxTB_HORZ_LAYOUT,
wxTB_HORZ_TEXT, wxTB_HORZ_TEXT,
wxTB_NO_TOOLTIPS, wxTB_NO_TOOLTIPS,
wxTB_BOTTOM
}; };

View File

@@ -3456,6 +3456,7 @@ TB_NOALIGN = _controls_.TB_NOALIGN
TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT
TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT
TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS
TB_BOTTOM = _controls_.TB_BOTTOM
class ToolBarToolBase(_core.Object): class ToolBarToolBase(_core.Object):
"""Proxy of C++ ToolBarToolBase class""" """Proxy of C++ ToolBarToolBase class"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

View File

@@ -48802,6 +48802,7 @@ SWIGEXPORT void SWIG_init(void) {
SWIG_Python_SetConstant(d, "TB_HORZ_LAYOUT",SWIG_From_int(static_cast< int >(wxTB_HORZ_LAYOUT))); SWIG_Python_SetConstant(d, "TB_HORZ_LAYOUT",SWIG_From_int(static_cast< int >(wxTB_HORZ_LAYOUT)));
SWIG_Python_SetConstant(d, "TB_HORZ_TEXT",SWIG_From_int(static_cast< int >(wxTB_HORZ_TEXT))); SWIG_Python_SetConstant(d, "TB_HORZ_TEXT",SWIG_From_int(static_cast< int >(wxTB_HORZ_TEXT)));
SWIG_Python_SetConstant(d, "TB_NO_TOOLTIPS",SWIG_From_int(static_cast< int >(wxTB_NO_TOOLTIPS))); SWIG_Python_SetConstant(d, "TB_NO_TOOLTIPS",SWIG_From_int(static_cast< int >(wxTB_NO_TOOLTIPS)));
SWIG_Python_SetConstant(d, "TB_BOTTOM",SWIG_From_int(static_cast< int >(wxTB_BOTTOM)));
SWIG_addvarlink(SWIG_globals(),(char*)"ListCtrlNameStr",ListCtrlNameStr_get, ListCtrlNameStr_set); SWIG_addvarlink(SWIG_globals(),(char*)"ListCtrlNameStr",ListCtrlNameStr_get, ListCtrlNameStr_set);
SWIG_Python_SetConstant(d, "LC_VRULES",SWIG_From_int(static_cast< int >(wxLC_VRULES))); SWIG_Python_SetConstant(d, "LC_VRULES",SWIG_From_int(static_cast< int >(wxLC_VRULES)));
SWIG_Python_SetConstant(d, "LC_HRULES",SWIG_From_int(static_cast< int >(wxLC_HRULES))); SWIG_Python_SetConstant(d, "LC_HRULES",SWIG_From_int(static_cast< int >(wxLC_HRULES)));

View File

@@ -4414,11 +4414,15 @@ class BufferedDC(MemoryDC):
`wx.Bitmap`) and then copied to the screen only once, when this object `wx.Bitmap`) and then copied to the screen only once, when this object
is destroyed. is destroyed.
It can be used in the same way as any other device It can be used in the same way as any other device context.
context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to
want to use it in your EVT_PAINT handler, you should look at use it in your EVT_PAINT handler, you should look at
`wx.BufferedPaintDC`. `wx.BufferedPaintDC`.
Please note that GTK+ 2.0 and OS X provide double buffering themselves
natively so using this class on those platforms will normally result
in an unneeded level of buffering.
""" """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr __repr__ = _swig_repr

View File

@@ -3449,6 +3449,7 @@ TB_NOALIGN = _controls_.TB_NOALIGN
TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT
TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT
TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS
TB_BOTTOM = _controls_.TB_BOTTOM
class ToolBarToolBase(_core.Object): class ToolBarToolBase(_core.Object):
"""Proxy of C++ ToolBarToolBase class""" """Proxy of C++ ToolBarToolBase class"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

View File

@@ -3107,9 +3107,9 @@ SWIGINTERN bool wxPyListCtrl_SortItems(wxPyListCtrl *self,PyObject *func){
} }
SWIGINTERN wxWindow *wxPyListCtrl_GetMainWindow(wxPyListCtrl *self){ SWIGINTERN wxWindow *wxPyListCtrl_GetMainWindow(wxPyListCtrl *self){
return self;
return (wxWindow*)self->m_mainWin;
} }
@@ -48725,6 +48725,7 @@ SWIGEXPORT void SWIG_init(void) {
SWIG_Python_SetConstant(d, "TB_HORZ_LAYOUT",SWIG_From_int(static_cast< int >(wxTB_HORZ_LAYOUT))); SWIG_Python_SetConstant(d, "TB_HORZ_LAYOUT",SWIG_From_int(static_cast< int >(wxTB_HORZ_LAYOUT)));
SWIG_Python_SetConstant(d, "TB_HORZ_TEXT",SWIG_From_int(static_cast< int >(wxTB_HORZ_TEXT))); SWIG_Python_SetConstant(d, "TB_HORZ_TEXT",SWIG_From_int(static_cast< int >(wxTB_HORZ_TEXT)));
SWIG_Python_SetConstant(d, "TB_NO_TOOLTIPS",SWIG_From_int(static_cast< int >(wxTB_NO_TOOLTIPS))); SWIG_Python_SetConstant(d, "TB_NO_TOOLTIPS",SWIG_From_int(static_cast< int >(wxTB_NO_TOOLTIPS)));
SWIG_Python_SetConstant(d, "TB_BOTTOM",SWIG_From_int(static_cast< int >(wxTB_BOTTOM)));
SWIG_addvarlink(SWIG_globals(),(char*)"ListCtrlNameStr",ListCtrlNameStr_get, ListCtrlNameStr_set); SWIG_addvarlink(SWIG_globals(),(char*)"ListCtrlNameStr",ListCtrlNameStr_get, ListCtrlNameStr_set);
SWIG_Python_SetConstant(d, "LC_VRULES",SWIG_From_int(static_cast< int >(wxLC_VRULES))); SWIG_Python_SetConstant(d, "LC_VRULES",SWIG_From_int(static_cast< int >(wxLC_VRULES)));
SWIG_Python_SetConstant(d, "LC_HRULES",SWIG_From_int(static_cast< int >(wxLC_HRULES))); SWIG_Python_SetConstant(d, "LC_HRULES",SWIG_From_int(static_cast< int >(wxLC_HRULES)));

View File

@@ -4413,11 +4413,15 @@ class BufferedDC(MemoryDC):
`wx.Bitmap`) and then copied to the screen only once, when this object `wx.Bitmap`) and then copied to the screen only once, when this object
is destroyed. is destroyed.
It can be used in the same way as any other device It can be used in the same way as any other device context.
context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to
want to use it in your EVT_PAINT handler, you should look at use it in your EVT_PAINT handler, you should look at
`wx.BufferedPaintDC`. `wx.BufferedPaintDC`.
Please note that GTK+ 2.0 and OS X provide double buffering themselves
natively so using this class on those platforms will normally result
in an unneeded level of buffering.
""" """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr __repr__ = _swig_repr

View File

@@ -3464,6 +3464,7 @@ TB_NOALIGN = _controls_.TB_NOALIGN
TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT TB_HORZ_LAYOUT = _controls_.TB_HORZ_LAYOUT
TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT TB_HORZ_TEXT = _controls_.TB_HORZ_TEXT
TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS TB_NO_TOOLTIPS = _controls_.TB_NO_TOOLTIPS
TB_BOTTOM = _controls_.TB_BOTTOM
class ToolBarToolBase(_core.Object): class ToolBarToolBase(_core.Object):
"""Proxy of C++ ToolBarToolBase class""" """Proxy of C++ ToolBarToolBase class"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

View File

@@ -49025,6 +49025,7 @@ SWIGEXPORT void SWIG_init(void) {
SWIG_Python_SetConstant(d, "TB_HORZ_LAYOUT",SWIG_From_int(static_cast< int >(wxTB_HORZ_LAYOUT))); SWIG_Python_SetConstant(d, "TB_HORZ_LAYOUT",SWIG_From_int(static_cast< int >(wxTB_HORZ_LAYOUT)));
SWIG_Python_SetConstant(d, "TB_HORZ_TEXT",SWIG_From_int(static_cast< int >(wxTB_HORZ_TEXT))); SWIG_Python_SetConstant(d, "TB_HORZ_TEXT",SWIG_From_int(static_cast< int >(wxTB_HORZ_TEXT)));
SWIG_Python_SetConstant(d, "TB_NO_TOOLTIPS",SWIG_From_int(static_cast< int >(wxTB_NO_TOOLTIPS))); SWIG_Python_SetConstant(d, "TB_NO_TOOLTIPS",SWIG_From_int(static_cast< int >(wxTB_NO_TOOLTIPS)));
SWIG_Python_SetConstant(d, "TB_BOTTOM",SWIG_From_int(static_cast< int >(wxTB_BOTTOM)));
SWIG_addvarlink(SWIG_globals(),(char*)"ListCtrlNameStr",ListCtrlNameStr_get, ListCtrlNameStr_set); SWIG_addvarlink(SWIG_globals(),(char*)"ListCtrlNameStr",ListCtrlNameStr_get, ListCtrlNameStr_set);
SWIG_Python_SetConstant(d, "LC_VRULES",SWIG_From_int(static_cast< int >(wxLC_VRULES))); SWIG_Python_SetConstant(d, "LC_VRULES",SWIG_From_int(static_cast< int >(wxLC_VRULES)));
SWIG_Python_SetConstant(d, "LC_HRULES",SWIG_From_int(static_cast< int >(wxLC_HRULES))); SWIG_Python_SetConstant(d, "LC_HRULES",SWIG_From_int(static_cast< int >(wxLC_HRULES)));

View File

@@ -4507,11 +4507,15 @@ class BufferedDC(MemoryDC):
`wx.Bitmap`) and then copied to the screen only once, when this object `wx.Bitmap`) and then copied to the screen only once, when this object
is destroyed. is destroyed.
It can be used in the same way as any other device It can be used in the same way as any other device context.
context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to
want to use it in your EVT_PAINT handler, you should look at use it in your EVT_PAINT handler, you should look at
`wx.BufferedPaintDC`. `wx.BufferedPaintDC`.
Please note that GTK+ 2.0 and OS X provide double buffering themselves
natively so using this class on those platforms will normally result
in an unneeded level of buffering.
""" """
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr __repr__ = _swig_repr