Lots of docstring fixes and additions

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@33975 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2005-05-07 06:26:59 +00:00
parent 5fad19e319
commit e47ce385a7
4 changed files with 1002 additions and 213 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -809,7 +809,7 @@ colour everywhere else.", "");
JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
number between 0 and 100 (0 is terrible, 100 is very good).", " number between 0 and 100 (0 is terrible, 100 is very good).", "
================================= ================================= ===
wx.IMAGE_OPTION_BMP_FORMAT wx.IMAGE_OPTION_BMP_FORMAT
wx.IMAGE_OPTION_CUR_HOTSPOT_X wx.IMAGE_OPTION_CUR_HOTSPOT_X
wx.IMAGE_OPTION_CUR_HOTSPOT_Y wx.IMAGE_OPTION_CUR_HOTSPOT_Y
@@ -824,7 +824,7 @@ number between 0 and 100 (0 is terrible, 100 is very good).", "
wx.IMAGE_OPTION_IMAGEDESCRIPTOR wx.IMAGE_OPTION_IMAGEDESCRIPTOR
wx.IMAGE_OPTION_PNG_FORMAT wx.IMAGE_OPTION_PNG_FORMAT
wx.IMAGE_OPTION_PNG_BITDEPTH wx.IMAGE_OPTION_PNG_BITDEPTH
================================= ================================= ===
:see: `HasOption`, `GetOption`, `GetOptionInt`, `SetOptionInt`"); :see: `HasOption`, `GetOption`, `GetOptionInt`, `SetOptionInt`");

View File

@@ -51,9 +51,13 @@ public:
bool IsVertical() const { return (m_windowStyle & wxVERTICAL) != 0; } bool IsVertical() const { return (m_windowStyle & wxVERTICAL) != 0; }
virtual void SetThumbPosition(int viewStart); virtual void SetThumbPosition(int viewStart);
virtual void SetScrollbar(int position, int thumbSize,
int range, int pageSize, DocDeclStr(
bool refresh = true); virtual void , SetScrollbar(int position, int thumbSize,
int range, int pageSize,
bool refresh = true),
"", "");
static wxVisualAttributes static wxVisualAttributes
GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

View File

@@ -175,12 +175,12 @@ Extra Styles
wx.WS_EX_PROCESS_IDLE This window should always process idle wx.WS_EX_PROCESS_IDLE This window should always process idle
events, even if the mode set by events, even if the mode set by
wx.IdleEvent.SetMode is `wx.IdleEvent.SetMode` is
wx.IDLE_PROCESS_SPECIFIED. wx.IDLE_PROCESS_SPECIFIED.
wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
update events, even if the mode update events, even if the mode
set by wxUpdateUIEvent::SetMode is set by `wx.UpdateUIEvent.SetMode` is
wxUPDATE_UI_PROCESS_SPECIFIED. wxUPDATE_UI_PROCESS_SPECIFIED.
============================= ===================================== ============================= =====================================
@@ -1555,7 +1555,7 @@ 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 at function from your application to ensure that your UI is up-to-date at
a particular point in time (as far as your EVT_UPDATE_UI handlers are a particular point in time (as far as your EVT_UPDATE_UI handlers are
concerned). This may be necessary if you have called concerned). This may be necessary if you have called
wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
limit the overhead that wxWindows incurs by sending update UI events limit the overhead that wxWindows incurs by sending update UI events
in idle time.", in idle time.",
" "
@@ -1796,11 +1796,15 @@ a drop target, it is deleted.", "");
"Returns the associated drop target, which may be None.", ""); "Returns the associated drop target, which may be None.", "");
#ifdef __WXMSW__ // TODO: should I drop-kick this? DocStr(DragAcceptFiles,
DocDeclStr(
void , DragAcceptFiles(bool accept),
"Enables or disables eligibility for drop file events, EVT_DROP_FILES. "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
Only available on Windows.", ""); Only functional on Windows.", "");
#ifdef __WXMSW__
void DragAcceptFiles(bool accept);
#else
%extend {
void DragAcceptFiles(bool accept) {}
}
#endif #endif
#endif #endif