From fab86f26bf792dc79c67968dad906e4afa00a98c Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 11 Feb 2007 02:53:05 +0000 Subject: [PATCH] miscellaneous minor corrections (patch 1652327) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@44459 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 2 +- docs/latex/wx/boxsizer.tex | 2 +- docs/latex/wx/ctrlsub.tex | 2 +- docs/latex/wx/dc.tex | 5 +++-- docs/latex/wx/fsfile.tex | 2 +- docs/latex/wx/log.tex | 2 +- docs/latex/wx/mutex.tex | 2 +- docs/latex/wx/spinevt.inc | 2 +- docs/latex/wx/tevent.tex | 2 +- docs/latex/wx/tsizer.tex | 2 +- docs/latex/wx/url.tex | 2 +- docs/latex/wx/window.tex | 10 +++++----- 12 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index 1c50ac52eb..d29ee9d6db 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -238,7 +238,7 @@ to do it. Returns \true if the main event loop is currently running, i.e. if the application is inside \helpref{OnRun}{wxapponrun}. -This can be useful to test whether the events can be dispatched. For example, +This can be useful to test whether events can be dispatched. For example, if this function returns \false, non-blocking sockets cannot be used because the events from them would never be processed. diff --git a/docs/latex/wx/boxsizer.tex b/docs/latex/wx/boxsizer.tex index 279896593d..4f75fb61a0 100644 --- a/docs/latex/wx/boxsizer.tex +++ b/docs/latex/wx/boxsizer.tex @@ -32,7 +32,7 @@ or wxHORIZONTAL for creating either a column sizer or a row sizer. Implements the calculation of a box sizer's dimensions and then sets the size of its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize} if the child is a window). It is used internally only and must not be called -by the user. Documented for information. +by the user (call Layout() if you want to resize). Documented for information. \membersection{wxBoxSizer::CalcMin}\label{wxboxsizercalcmin} diff --git a/docs/latex/wx/ctrlsub.tex b/docs/latex/wx/ctrlsub.tex index a494823a1e..302e2722d8 100644 --- a/docs/latex/wx/ctrlsub.tex +++ b/docs/latex/wx/ctrlsub.tex @@ -359,7 +359,7 @@ Sets the label for the given item. \func{bool}{SetStringSelection}{\param{const wxString\& }{ string}} Selects the item with the specified string in the control. This doesn't cause -any command events being emitted. +any command events to be emitted. \wxheading{Parameters} diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index b6c7feed01..5f57bfbac9 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -999,7 +999,7 @@ whether text will be drawn with a background colour or not. Sets the current brush for the DC. If the argument is wxNullBrush, the current brush is selected out of the device -context, and the original brush restored, allowing the current brush to +context (leaving wxDC without any valid brush), allowing the current brush to be destroyed safely. See also \helpref{wxBrush}{wxbrush}. @@ -1152,7 +1152,8 @@ See \helpref{wxPalette}{wxpalette} for further details. Sets the current pen for the DC. If the argument is wxNullPen, the current pen is selected out of the device -context, and the original pen restored. +context (leaving wxDC without any valid pen), allowing the current brush to +be destroyed safely. See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours when drawing into a monochrome bitmap. diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex index 220a616158..50b13411d4 100644 --- a/docs/latex/wx/fsfile.tex +++ b/docs/latex/wx/fsfile.tex @@ -12,7 +12,7 @@ It provides more information than wxWindow's input stream {\bf Note:} Any pointer returned by a method of wxFSFile is valid only as long as the wxFSFile object exists. For example a call to GetStream() doesn't {\it create} the stream but only returns the pointer to it. In -other words after 10 calls to GetStream() you will obtain ten identical +other words after 10 calls to GetStream() you will have obtained ten identical pointers. \wxheading{Derived from} diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index 04e2889690..026dc1eadd 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -264,7 +264,7 @@ corresponding to the log level and then calls \func{virtual void}{DoLogString}{\param{const wxChar }{*msg}, \param{time\_t }{timestamp}} -Called to log the specified string. The timestamp is already included into the +Called to log the specified string. The timestamp is already included in the string but still passed to this function. A simple implementation may just send the string to {\tt stdout} or, better, diff --git a/docs/latex/wx/mutex.tex b/docs/latex/wx/mutex.tex index 5e8275059f..64c95d8c84 100644 --- a/docs/latex/wx/mutex.tex +++ b/docs/latex/wx/mutex.tex @@ -41,7 +41,7 @@ because during a new node addition the list integrity is temporarily broken s_mutexProtectingTheGlobalList->Unlock(); } - // return true the given number is greater than all array elements + // return true if the given number is greater than all array elements bool MyThread::IsGreater(int num) { // before using the list we must acquire the mutex diff --git a/docs/latex/wx/spinevt.inc b/docs/latex/wx/spinevt.inc index 2523492edc..8f88fea536 100644 --- a/docs/latex/wx/spinevt.inc +++ b/docs/latex/wx/spinevt.inc @@ -24,5 +24,5 @@ direct input to member functions that take a \end{twocollist}% Note that if you handle both SPIN and UP or DOWN events, you will be notified -about each of them twice: first the UP/DOWN event will be receieved and then, +about each of them twice: first the UP/DOWN event will be received and then, if it wasn't vetoed, the SPIN event will be sent. diff --git a/docs/latex/wx/tevent.tex b/docs/latex/wx/tevent.tex index e615864ac3..7a959a9fb4 100644 --- a/docs/latex/wx/tevent.tex +++ b/docs/latex/wx/tevent.tex @@ -449,7 +449,7 @@ DEFINE_EVENT_TYPE(name) \end{verbatim} You can ignore the {\it value} parameter of the DECLARE\_EVENT\_TYPE macro -since it used only for backwards compatibility with wxWidgets 2.0.x based +since it is used only for backwards compatibility with wxWidgets 2.0.x based applications where you have to give the event type ID an explicit value. See also the \helpref{event sample}{sampleevent} for an example of code diff --git a/docs/latex/wx/tsizer.tex b/docs/latex/wx/tsizer.tex index 1ebd9dbbfb..815b7e4357 100644 --- a/docs/latex/wx/tsizer.tex +++ b/docs/latex/wx/tsizer.tex @@ -215,7 +215,7 @@ wxALIGN\_BOTTOM, wxALIGN\_CENTER\_HORIZONTAL and wxALIGN\_CENTER\_VERTICAL do wh wxALIGN\_CENTRE (same as wxALIGN\_CENTER) is defined as (wxALIGN\_CENTER\_HORIZONTAL | wxALIGN\_CENTER\_VERTICAL). Default alignment is wxALIGN\_LEFT | wxALIGN\_TOP. -As mentioned above, any window belonging to a sizer may have border, and it can be specified +As mentioned above, any window belonging to a sizer may have a border, and it can be specified which of the four sides may have this border, using the wxTOP, wxLEFT, wxRIGHT and wxBOTTOM constants or wxALL for all directions (and you may also use wxNORTH, wxWEST etc instead). These flags can be used in combination with the alignment flags above as the second parameter of the diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index cd06c6688f..fd2c854687 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -73,7 +73,7 @@ It can be one of these errors: \twocolitem{{\bf wxURL\_NOERR}}{No error.} \twocolitem{{\bf wxURL\_SNTXERR}}{Syntax error in the URL string.} \twocolitem{{\bf wxURL\_NOPROTO}}{Found no protocol which can get this URL.} -\twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.} +\twocolitem{{\bf wxURL\_NOHOST}}{A host name is required for this protocol.} \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.} \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.} \twocolitem{{\bf wxURL\_PROTOERR}}{An error occurred during negotiation.} diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 6983c824cf..e170cc92da 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -659,7 +659,7 @@ If no window with such name is found, \func{virtual void}{Fit}{\void} Sizes the window so that it fits around its subwindows. This function won't do -anything if there are no subwindows and will only really work correctly if the +anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call @@ -1171,7 +1171,7 @@ method:\par \constfunc{virtual wxRect}{GetRect}{\void} -Returns the size and position of the window as a \helpref{wxRect}{wxrect} object. +Returns the position and size of the window as a \helpref{wxRect}{wxrect} object. \wxheading{See also} @@ -1202,7 +1202,7 @@ child window or a top level one. \constfunc{virtual wxRect}{GetScreenRect}{\void} -Returns the size and position of the window on the screen as a +Returns the position and size of the window on the screen as a \helpref{wxRect}{wxrect} object. \wxheading{See also} @@ -3266,7 +3266,7 @@ and usually the scrollbar will be automatically hidden. \func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}} -Sets the size and position of the window in pixels. +Sets the position and size of the window in pixels. \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}} @@ -3363,7 +3363,7 @@ parameter if the {\it sizer}\/ is non-NULL and {\tt false} otherwise. \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete the window's sizer. See below.} -\docparam{deleteOld}{If true (the default), this will delete any prexisting sizer. +\docparam{deleteOld}{If true (the default), this will delete any pre-existing sizer. Pass false if you wish to handle deleting the old sizer yourself.} \wxheading{Remarks} -- 2.45.2