Documentation patch from Olly Betts

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@30070 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Kevin Hock
2004-10-22 19:11:07 +00:00
parent 1399de550a
commit 34621cc5d6
22 changed files with 33 additions and 33 deletions

View File

@@ -127,7 +127,7 @@ public:
#endif // wxUSE_TOOLTIPS #endif // wxUSE_TOOLTIPS
// reposition the radio buttons correctly unless justCalc == true and // reposition the radio buttons correctly unless justCalc == true and
// reutrn the total size needed to accomodate them // return the total size needed to accommodate them
wxSize LayoutItems(bool justCalc) const; wxSize LayoutItems(bool justCalc) const;
virtual void DoSetSize( int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO ); virtual void DoSetSize( int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO );

View File

@@ -127,7 +127,7 @@ public:
#endif // wxUSE_TOOLTIPS #endif // wxUSE_TOOLTIPS
// reposition the radio buttons correctly unless justCalc == true and // reposition the radio buttons correctly unless justCalc == true and
// reutrn the total size needed to accomodate them // return the total size needed to accommodate them
wxSize LayoutItems(bool justCalc) const; wxSize LayoutItems(bool justCalc) const;
virtual void DoSetSize( int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO ); virtual void DoSetSize( int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO );

View File

@@ -233,7 +233,7 @@ extern "C"
RETCODE SQL_API SQLTransact (HENV henv, HDBC hdbc, UWORD fType); RETCODE SQL_API SQLTransact (HENV henv, HDBC hdbc, UWORD fType);
/* /*
* Depreciated ODBC 1.0 function - Use SQLBindParameter * Deprecated ODBC 1.0 function - Use SQLBindParameter
*/ */
RETCODE SQL_API SQLSetParam (HSTMT hstmt, UWORD ipar, SWORD fCType, RETCODE SQL_API SQLSetParam (HSTMT hstmt, UWORD ipar, SWORD fCType,
SWORD fSqlType, UDWORD cbColDef, SWORD ibScale, PTR rgbValue, SWORD fSqlType, UDWORD cbColDef, SWORD ibScale, PTR rgbValue,

View File

@@ -1166,7 +1166,7 @@ RETCODE SQL_API SQLBindParameter (HSTMT hstmt, UWORD ipar, SWORD fParamType,
SDWORD cbValueMax, SDWORD FAR * pcbValue); SDWORD cbValueMax, SDWORD FAR * pcbValue);
/* /*
* Depreciated - use SQLSetStmtOptions * Deprecated - use SQLSetStmtOptions
*/ */
RETCODE SQL_API SQLSetScrollOptions (HSTMT hstmt, UWORD fConcurrency, RETCODE SQL_API SQLSetScrollOptions (HSTMT hstmt, UWORD fConcurrency,
SDWORD crowKeyset, UWORD crowRowset); SDWORD crowKeyset, UWORD crowRowset);

View File

@@ -26,25 +26,25 @@
// compatibility settings // compatibility settings
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// This setting determines the compatibility with 2.0 API: set it to 1 to // This setting determines the compatibility with 2.2 API: set it to 1 to
// enable it // enable it.
// //
// Default is 0. // Default is 0.
// //
// Recommended setting: 0 (please update your code instead!) // Recommended setting: 0 (please update your code instead!)
#define WXWIN_COMPATIBILITY_2_2 0 #define WXWIN_COMPATIBILITY_2_2 0
// This setting determines the compatibility with 2.2 API: set it to 0 to // This setting determines the compatibility with 2.4 API: set it to 0 to
// flag all cases of using deprecated functions. // flag all cases of using deprecated functions.
// //
// Default is 1 but please try building your code with 0 as the default will // Default is 1 but please try building your code with 0 as the default will
// change to 0 in the next version and the deprecated functions will disappear // change to 0 in the next version and the deprecated functions will
// in the version after it completely. // completely disappear in the version after that.
// //
// Recommended setting: 0 (please update your code) // Recommended setting: 0 (please update your code)
#define WXWIN_COMPATIBILITY_2_4 1 #define WXWIN_COMPATIBILITY_2_4 1
// in wxMSW version 2.1.11 and earlier, wxIcon always derives from wxBitmap, // In wxMSW version 2.1.11 and earlier, wxIcon always derives from wxBitmap,
// but this is very dangerous because you can mistakenly pass an icon instead // but this is very dangerous because you can mistakenly pass an icon instead
// of a bitmap to a function taking "const wxBitmap&" - which will *not* work // of a bitmap to a function taking "const wxBitmap&" - which will *not* work
// because an icon is not a valid bitmap // because an icon is not a valid bitmap

View File

@@ -86,7 +86,7 @@ extern const unsigned int wxSTRING_MAXLEN;
#else #else
// maximum possible length for a string means "take all string" everywhere // maximum possible length for a string means "take all string" everywhere
// (as sizeof(StringData) is unknown here, we substract 100) // (as sizeof(StringData) is unknown here, we subtract 100)
const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100; const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100;
#endif #endif

View File

@@ -115,7 +115,7 @@ public:
wxRect *rectIn = (wxRect *)NULL) = 0; wxRect *rectIn = (wxRect *)NULL) = 0;
// draw text control border (I hate to have a separate method for this but // draw text control border (I hate to have a separate method for this but
// it is needed to accomodate GTK+) // it is needed to accommodate GTK+)
virtual void DrawTextBorder(wxDC& dc, virtual void DrawTextBorder(wxDC& dc,
wxBorder border, wxBorder border,
const wxRect& rect, const wxRect& rect,

View File

@@ -325,7 +325,7 @@ wxLayoutObjectText::GetOffsetScreen(wxDC &dc, CoordType xpos) const
&width, &height, &descent); &width, &height, &descent);
offs++; offs++;
} }
/* We have to substract 1 to compensate for the offs++, and another /* We have to subtract 1 to compensate for the offs++, and another
one because we don't want to position the cursor behind the one because we don't want to position the cursor behind the
object what we clicked on, but before - otherwise it looks object what we clicked on, but before - otherwise it looks
funny. */ funny. */
@@ -2141,7 +2141,7 @@ wxLayoutList::MoveCursorWord(int n, bool untilNext)
CoordType moveDelta = p - start - offset; CoordType moveDelta = p - start - offset;
if ( (n < 0) && (offset == tobj->GetLength() - 1) ) if ( (n < 0) && (offset == tobj->GetLength() - 1) )
{ {
// because we substracted 1 from offset in this case above, now // because we subtracted 1 from offset in this case above, now
// compensate for it // compensate for it
moveDelta--; moveDelta--;
} }

View File

@@ -279,7 +279,7 @@ void MyFrame::RecreateToolbar()
#ifdef __WXWINCE__ #ifdef __WXWINCE__
// On Windows CE, we should not delete the // On Windows CE, we should not delete the
// previous toolbar in case it contains the menubar. // previous toolbar in case it contains the menubar.
// We'll try to accomodate this usage in due course. // We'll try to accommodate this usage in due course.
wxToolBar* toolBar = CreateToolBar(); wxToolBar* toolBar = CreateToolBar();
#else #else
// delete and recreate the toolbar // delete and recreate the toolbar

View File

@@ -3868,7 +3868,7 @@ void wxListMainWindow::RecalculatePositions(bool noRefresh)
iconSpacing = 0; iconSpacing = 0;
// Note that we do not call GetClientSize() here but // Note that we do not call GetClientSize() here but
// GetSize() and substract the border size for sunken // GetSize() and subtract the border size for sunken
// borders manually. This is technically incorrect, // borders manually. This is technically incorrect,
// but we need to know the client area's size WITHOUT // but we need to know the client area's size WITHOUT
// scrollbars here. Since we don't know if there are // scrollbars here. Since we don't know if there are

View File

@@ -220,7 +220,7 @@ extern "C"
RETCODE SQL_API SQLTransact (HENV henv, HDBC hdbc, UWORD fType); RETCODE SQL_API SQLTransact (HENV henv, HDBC hdbc, UWORD fType);
/* /*
* Depreciated ODBC 1.0 function - Use SQLBindParameter * Deprecated ODBC 1.0 function - Use SQLBindParameter
*/ */
RETCODE SQL_API SQLSetParam (HSTMT hstmt, UWORD ipar, SWORD fCType, RETCODE SQL_API SQLSetParam (HSTMT hstmt, UWORD ipar, SWORD fCType,
SWORD fSqlType, UDWORD cbColDef, SWORD ibScale, PTR rgbValue, SWORD fSqlType, UDWORD cbColDef, SWORD ibScale, PTR rgbValue,

View File

@@ -1165,7 +1165,7 @@ RETCODE SQL_API SQLBindParameter (HSTMT hstmt, UWORD ipar, SWORD fParamType,
SDWORD cbValueMax, SDWORD FAR * pcbValue); SDWORD cbValueMax, SDWORD FAR * pcbValue);
/* /*
* Depreciated - use SQLSetStmtOptions * Deprecated - use SQLSetStmtOptions
*/ */
RETCODE SQL_API SQLSetScrollOptions (HSTMT hstmt, UWORD fConcurrency, RETCODE SQL_API SQLSetScrollOptions (HSTMT hstmt, UWORD fConcurrency,
SDWORD crowKeyset, UWORD crowRowset); SDWORD crowKeyset, UWORD crowRowset);

View File

@@ -167,7 +167,7 @@ bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
// this will also allow offsetting the accel string from the right edge // this will also allow offsetting the accel string from the right edge
*pwidth += GetDefaultMarginWidth() + 16; *pwidth += GetDefaultMarginWidth() + 16;
// increase size to accomodate bigger bitmaps if necessary // increase size to accommodate bigger bitmaps if necessary
if (m_bmpChecked.Ok()) if (m_bmpChecked.Ok())
{ {
// Is BMP height larger then text height? // Is BMP height larger then text height?

View File

@@ -4420,7 +4420,7 @@ static wxWindowMSW *FindWindowForMouseEvent(wxWindowMSW *win, int *x, int *y) //
bool wxWindowMSW::HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags) bool wxWindowMSW::HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags)
{ {
// the mouse events take consecutive IDs from WM_MOUSEFIRST to // the mouse events take consecutive IDs from WM_MOUSEFIRST to
// WM_MOUSELAST, so it's enough to substract WM_MOUSEMOVE == WM_MOUSEFIRST // WM_MOUSELAST, so it's enough to subtract WM_MOUSEMOVE == WM_MOUSEFIRST
// from the message id and take the value in the table to get wxWin event // from the message id and take the value in the table to get wxWin event
// id // id
static const wxEventType eventsMouse[] = static const wxEventType eventsMouse[] =

View File

@@ -239,7 +239,7 @@ compilers) can also be used but I've never done the work to make that
happen. If you want to try that then first you'll want to find out if happen. If you want to try that then first you'll want to find out if
there are any tricks that have to be done to make Python extension there are any tricks that have to be done to make Python extension
modules using that compiler, and then make a few changes to setup.py modules using that compiler, and then make a few changes to setup.py
to accomodate that. (And send the patches to me.) If you plan on to accommodate that. (And send the patches to me.) If you plan on
using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
have to build Python and any other extension modules that you use with have to build Python and any other extension modules that you use with
that compiler because a different version of the C runtime library is that compiler because a different version of the C runtime library is

View File

@@ -254,7 +254,7 @@ compilers) can also be used but I've never done the work to make that
happen. If you want to try that then first you'll want to find out if happen. If you want to try that then first you'll want to find out if
there are any tricks that have to be done to make Python extension there are any tricks that have to be done to make Python extension
modules using that compiler, and then make a few changes to setup.py modules using that compiler, and then make a few changes to setup.py
to accomodate that. (And send the patches to me.) If you plan on to accommodate that. (And send the patches to me.) If you plan on
using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also using VisualStudio.Net (a.k.a. MSVC 7.1) keep in mind that you'll also
have to build Python and any other extension modules that you use with have to build Python and any other extension modules that you use with
that compiler because a different version of the C runtime library is that compiler because a different version of the C runtime library is

View File

@@ -1184,7 +1184,7 @@ an EVT_SIZE handler that calls Layout().</p>
<p>Fixed deadlock problem that happened when using threads.</p> <p>Fixed deadlock problem that happened when using threads.</p>
<p>Added new HTML printing classes.</p> <p>Added new HTML printing classes.</p>
<p>Added wxWindow.GetHandle</p> <p>Added wxWindow.GetHandle</p>
<p>Apparently wxMouseEvent.Position has been depreciated in wxWindows as <p>Apparently wxMouseEvent.Position has been deprecated in wxWindows as
it is no longer available by default. You can use GetPositionTuple it is no longer available by default. You can use GetPositionTuple
(returning a tuple with x,y) instead, or GetPosition (returning a (returning a tuple with x,y) instead, or GetPosition (returning a
wxPoint.)</p> wxPoint.)</p>
@@ -1242,7 +1242,7 @@ pages. See the demo for an example.</p>
wxGTK. Added them back in since the methods exist now.</p> wxGTK. Added them back in since the methods exist now.</p>
<p>Wrapped the wxHtmlHelpController and related classes.</p> <p>Wrapped the wxHtmlHelpController and related classes.</p>
<p>Wrapped the C++ versions of wxSizer and friends. The Python-only <p>Wrapped the C++ versions of wxSizer and friends. The Python-only
versions are still in the library, but depreciated. (You will get a versions are still in the library, but deprecated. (You will get a
warning message if you try to use them, but the warning can be warning message if you try to use them, but the warning can be
disabled.) The usage of the C++ versions is slightly different, and disabled.) The usage of the C++ versions is slightly different, and
the functionality of wxBorderSizer is now part of wxBoxSizer. I have the functionality of wxBorderSizer is now part of wxBoxSizer. I have
@@ -1381,7 +1381,7 @@ matches MSW's.</p>
<p>Added wxGrid.GetCells</p> <p>Added wxGrid.GetCells</p>
<p>Added wxSystemSettings static methods as functions with names like <p>Added wxSystemSettings static methods as functions with names like
wxSystemSettings_GetSystemColour.</p> wxSystemSettings_GetSystemColour.</p>
<p>Removed wxPyMenu since using menu callbacks have been depreciated in <p>Removed wxPyMenu since using menu callbacks have been deprecated in
wxWindows. Use wxMenu and events instead.</p> wxWindows. Use wxMenu and events instead.</p>
<dl> <dl>
<dt>Added alternate wxBitmap constructor (for MSW only) as</dt> <dt>Added alternate wxBitmap constructor (for MSW only) as</dt>

View File

@@ -1585,7 +1585,7 @@ Added new HTML printing classes.
Added wxWindow.GetHandle Added wxWindow.GetHandle
Apparently wxMouseEvent.Position has been depreciated in wxWindows as Apparently wxMouseEvent.Position has been deprecated in wxWindows as
it is no longer available by default. You can use GetPositionTuple it is no longer available by default. You can use GetPositionTuple
(returning a tuple with x,y) instead, or GetPosition (returning a (returning a tuple with x,y) instead, or GetPosition (returning a
wxPoint.) wxPoint.)
@@ -1667,7 +1667,7 @@ wxGTK. Added them back in since the methods exist now.
Wrapped the wxHtmlHelpController and related classes. Wrapped the wxHtmlHelpController and related classes.
Wrapped the C++ versions of wxSizer and friends. The Python-only Wrapped the C++ versions of wxSizer and friends. The Python-only
versions are still in the library, but depreciated. (You will get a versions are still in the library, but deprecated. (You will get a
warning message if you try to use them, but the warning can be warning message if you try to use them, but the warning can be
disabled.) The usage of the C++ versions is slightly different, and disabled.) The usage of the C++ versions is slightly different, and
the functionality of wxBorderSizer is now part of wxBoxSizer. I have the functionality of wxBorderSizer is now part of wxBoxSizer. I have
@@ -1827,7 +1827,7 @@ Added wxGrid.GetCells
Added wxSystemSettings static methods as functions with names like Added wxSystemSettings static methods as functions with names like
wxSystemSettings_GetSystemColour. wxSystemSettings_GetSystemColour.
Removed wxPyMenu since using menu callbacks have been depreciated in Removed wxPyMenu since using menu callbacks have been deprecated in
wxWindows. Use wxMenu and events instead. wxWindows. Use wxMenu and events instead.
Added alternate wxBitmap constructor (for MSW only) as Added alternate wxBitmap constructor (for MSW only) as

View File

@@ -5724,7 +5724,7 @@ value as used by the parent. In addition, if the window overrides
ShouldInheritColours to return false, the colours will not be changed ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might. no matter what and only the font might.
This rather complicated logic is necessary in order to accomodate the This rather complicated logic is necessary in order to accommodate the
different usage scenarius. The most common one is when all default different usage scenarius. The most common one is when all default
attributes are used and in this case, nothing should be inherited as attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours) in modern GUIs different controls use different fonts (and colours)

View File

@@ -1883,8 +1883,8 @@ value as used by the parent. In addition, if the window overrides
ShouldInheritColours to return false, the colours will not be changed ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might. no matter what and only the font might.
This rather complicated logic is necessary in order to accomodate the This rather complicated logic is necessary in order to accommodate the
different usage scenarius. The most common one is when all default different usage scenarios. The most common one is when all default
attributes are used and in this case, nothing should be inherited as attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours) in modern GUIs different controls use different fonts (and colours)
than their siblings so they can't inherit the same value from the than their siblings so they can't inherit the same value from the

View File

@@ -7678,7 +7678,7 @@ class Window(EvtHandler):
ShouldInheritColours to return false, the colours will not be changed ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might. no matter what and only the font might.
This rather complicated logic is necessary in order to accomodate the This rather complicated logic is necessary in order to accommodate the
different usage scenarius. The most common one is when all default different usage scenarius. The most common one is when all default
attributes are used and in this case, nothing should be inherited as attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours) in modern GUIs different controls use different fonts (and colours)

View File

@@ -5622,7 +5622,7 @@ class MaskedEditMixin:
and sel_to >= edit_end and sel_to >= edit_end
and not self._GetValue()[edit_start:sel_start].strip() ): and not self._GetValue()[edit_start:sel_start].strip() ):
# text won't fit within selection, but left of selection is empty; # text won't fit within selection, but left of selection is empty;
# check to see if we can expand selection to accomodate the value: # check to see if we can expand selection to accommodate the value:
empty_space = sel_start - edit_start empty_space = sel_start - edit_start
amount_needed = len(paste_text) - (sel_to - sel_start) amount_needed = len(paste_text) - (sel_to - sel_start)
if amount_needed <= empty_space: if amount_needed <= empty_space: