\constfunc{bool}{HasTextColour}{\void}
-Returns {\tt true} if this item has a non default text foreground colour.
+Returns {\tt true} if this item has a non-default text foreground colour.
\membersection{wxCalendarDateAttr::HasBackgroundColour}\label{wxcalendardateattrhasbackgroundcolour}
\constfunc{bool}{HasBackgroundColour}{\void}
-Returns {\tt true} if this attribute specifies a non default text background colour.
+Returns {\tt true} if this attribute specifies a non-default text background colour.
\membersection{wxCalendarDateAttr::HasBorderColour}\label{wxcalendardateattrhasbordercolour}
\constfunc{bool}{HasBorderColour}{\void}
-Returns {\tt true} if this attribute specifies a non default border colour.
+Returns {\tt true} if this attribute specifies a non-default border colour.
\membersection{wxCalendarDateAttr::HasFont}\label{wxcalendardateattrhasfont}
\constfunc{bool}{HasFont}{\void}
-Returns {\tt true} if this attribute specifies a non default font.
+Returns {\tt true} if this attribute specifies a non-default font.
\membersection{wxCalendarDateAttr::HasBorder}\label{wxcalendardateattrhasborder}
\constfunc{bool}{HasBorder}{\void}
-Returns {\tt true} if this attribute specifies a non default (i.e. any) border.
+Returns {\tt true} if this attribute specifies a non-default (i.e. any) border.
\membersection{wxCalendarDateAttr::IsHoliday}\label{wxcalendardateattrisholiday}
exceptions has been switched off}
\twocolitem{wxNO\_THREADS}{if this macro is defined, the compilation options
don't include compiler flags needed for multithreaded code generation. This
-implies that wxUSE\_THREADS is $0$ and also that other (non wx-based) threading
+implies that wxUSE\_THREADS is $0$ and also that other (non-wx-based) threading
packages cannot be used neither.}
\end{twocollist}
the derived classes implements them differently, they still all conform to the
same interface.
-The items in a wxControlWithItems have (non empty) string labels and,
+The items in a wxControlWithItems have (non-empty) string labels and,
optionally, client data associated with them. Client data may be of two
different kinds: either simple untyped ({\tt void *}) pointers which are simply
stored by the control but not used in any way by it, or typed pointers
When adding a month to the date, all lesser components (days, hours, ...)
won't be changed unless the resulting date would be invalid: for example,
-Jan 31 + 1 month will be Feb 28, not (non existing) Feb 31.
+Jan 31 + 1 month will be Feb 28, not (non-existing) Feb 31.
Because of this feature, adding and subtracting back again the same
wxDateSpan will {\bf not}, in general give back the original date: Feb 28 - 1
equivalently, the first week which has Thursday in this year. Both of these
definitions are the same as saying that the first week of the year must contain
more than half of its days in this year. Accordingly, the week number will
-always be in $1\ldots53$ range ($52$ for non leap years).
+always be in $1\ldots53$ range ($52$ for non-leap years).
The function depends on the \helpref{week start}{wxdatetime} convention
specified by the {\it flags} argument but its results for
\param{UWORD }{numIndexColumns}, \param{wxDbIdxDef *}{pIndexDefs},
\param{bool }{attemptDrop=true}}
-This member function allows you to create secondary (non primary) indexes on
+This member function allows you to create secondary (non-primary) indexes on
your tables. You first create your table, normally specifying a primary
index, and then create any secondary indexes on the table. Indexes in
relational model are not required. You do not need indexes to look up records
\section{\class{wxDir}}\label{wxdir}
wxDir is a portable equivalent of Unix {open/read/close}dir functions which
-allow enumerating of the files in a directory. wxDir allows enumerate files as
-well as directories.
+allow enumerating of the files in a directory. wxDir allows to enumerate files
+as well as directories.
wxDir also provides a flexible way to enumerate files recursively using
\helpref{Traverse}{wxdirtraverse} or a simpler
\constfunc{bool}{GetNext}{\param{wxString* }{filename}}
-Continue enumerating files satisfying the criteria specified by the last call
-to \helpref{GetFirst}{wxdirgetfirst}.
+Continue enumerating files which satisfy the criteria specified by the last
+call to \helpref{GetFirst}{wxdirgetfirst}.
\membersection{wxDir::HasFiles}\label{wxdirhasfiles}
\func{bool}{Open}{\param{const wxString\& }{dir}}
-Open the directory for enumerating, returns true on success or false if an
-error occurred.
+Open the directory for enumerating, returns {\tt true} on success
+or {\tt false} if an error occurred.
\membersection{wxDir::Traverse}\label{wxdirtraverse}
This function is primarily intended for GetOpenCommand and GetPrintCommand
usage but may be also used by the application directly if, for example, you want
-to use some non default command to open the file.
+to use some non-default command to open the file.
The function replaces all occurrences of
direction but unequally ("flexibly") in the other. If the sizer is only
flexible in one direction (this can be changed using
\helpref{SetFlexibleDirection}{wxflexgridsizersetflexibledirection}),
-it needs to be decided how the sizer should grow in the other ("non flexible")
+it needs to be decided how the sizer should grow in the other ("non-flexible")
direction in order to fill the available space. The
\helpref{SetNonFlexibleGrowMode}{wxflexgridsizersetnonflexiblegrowmode} method
serves this purpose.
\constfunc{int}{GetNonFlexibleGrowMode}{\void}
-Returns the value that specifies how the sizer grows in the "non flexible"
+Returns the value that specifies how the sizer grows in the "non-flexible"
direction if there is one.
\wxheading{Return value}
One of the following values:
\begin{twocollist}
-\twocolitem{wxFLEX\_GROWMODE\_NONE}{Sizer doesn't grow in the non flexible direction.}
+\twocolitem{wxFLEX\_GROWMODE\_NONE}{Sizer doesn't grow in the non-flexible direction.}
\twocolitem{wxFLEX\_GROWMODE\_SPECIFIED}{Sizer honors growable columns/rows set with
\helpref{AddGrowableCol}{wxflexgridsizeraddgrowablecol} and
\helpref{AddGrowableRow}{wxflexgridsizeraddgrowablerow}.
In this case equal sizing applies to minimum sizes of columns or
rows (this is the default value).}
\twocolitem{wxFLEX\_GROWMODE\_ALL}{Sizer equally stretches all columns or rows
-in the non flexible direction, whether they are growable or not in the flexible
+in the non-flexible direction, whether they are growable or not in the flexible
direction.}
\end{twocollist}
\func{void}{SetNonFlexibleGrowMode}{\param{wxFlexSizerGrowMode }{mode}}
-Specifies how the sizer should grow in the non flexible direction if
+Specifies how the sizer should grow in the non-flexible direction if
there is one (so
\helpref{SetFlexibleDirection()}{wxflexgridsizersetflexibledirection} must have
been called previously). Argument {\it mode} can be one of those documented in
This function shuts down or reboots the computer depending on the value of the
{\it flags}. Please notice that doing this requires the corresponding access
-rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
+rights (superuser under Unix, {\tt SE\_SHUTDOWN} privilege under Windows NT)
and that this function is only implemented under Unix and Win32.
\wxheading{Parameters}
Makes the directory \arg{dir}, returning true if successful.
{\it perm} is the access mask for the directory for the systems on which it is
-supported (Unix) and doesn't have effect for the other ones.
+supported (Unix) and doesn't have any effect on the other ones.
\membersection{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter}
This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
latter provokes spurious compilation warnings from some compilers (because it
-tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
+tests whether {\tt this} pointer is non-{\tt NULL} which is always true), so
this macro should be used to avoid them.
\wxheading{See also}
Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
This check is done even in release mode.
-This macro may be only used in non void functions, see also
+This macro may be only used in non-void functions, see also
\helpref{wxCHECK\_RET}{wxcheckret}.
This is a simple, type-safe, and reasonably efficient hash map class,
whose interface is a subset of the interface of STL containers. In
particular, the interface is modeled after std::map, and the various,
-non standard, std::hash\_map.
+non-standard, std::hash\_map.
\wxheading{Example}
This is a simple, type-safe, and reasonably efficient hash set class,
whose interface is a subset of the interface of STL containers. In
particular, the interface is modeled after std::set, and the various,
-non standard, std::hash\_map.
+non-standard, std::hash\_map.
\wxheading{Example}
Creates a new input stream on the specified path. You can use all except the seek
functionality of wxStream. Seek isn't available on all streams. For example,
-http or ftp streams doesn't deal with it. Other functions like Tell and SeekI
-for this sort of stream.
+HTTP or FTP streams don't deal with it. Other functions like Tell and SeekI
+aren't available for the moment for this sort of stream.
You will be notified when the EOF is reached by an error.
\wxheading{Note}
\wxheading{Parameters}
\docparam{cell}{The cell inside which the mouse was clicked, always a simple
-(i.e. non container) cell}
+(i.e. non-container) cell}
\docparam{x, y}{The logical coordinates of the click point}
\wxheading{Parameters}
\docparam{cell}{The cell inside which the mouse is currently, always a simple
-(i.e. non container) cell}
+(i.e. non-container) cell}
\docparam{x, y}{The logical coordinates of the click point}
Although in this simple case it is clear that the correct key code could be
found in the key down event handler by checking the value returned by
\helpref{ShiftDown()}{wxkeyeventshiftdown}, in general you should use
-{\tt EVT\_CHAR} for this as for non alphanumeric keys the translation is
+{\tt EVT\_CHAR} for this as for non-alphanumeric keys the translation is
keyboard-layout dependent and can only be done properly by the system itself.
Another kind of translation is done when the control key is pressed: for
\func{static wxLog *}{SetActiveTarget}{\param{wxLog * }{ logtarget}}
Sets the specified log target as the active one. Returns the pointer to the
-previous active log target (may be NULL). To supress logging use a new
+previous active log target (may be NULL). To suppress logging use a new
instance of wxLogNull not NULL. If the active log target is set to NULL a
new default log target will be created when logging occurs.
\func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long}{ *flags = {\tt NULL}}}
Returns the index of the tab at the specified position or {\tt wxNOT\_FOUND}
-if none. If {\it flags} parameter is non {\tt NULL}, the position of the point
+if none. If {\it flags} parameter is non-{\tt NULL}, the position of the point
inside the tab is returned as well.
\wxheading{Parameters}
\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
Creates a new input stream on the specified path. You can use all but seek
-functionality of wxStream. Seek isn't available on all stream. For example,
-http or ftp streams doesn't deal with it. Other functions like StreamSize and
+functionality of wxStream. Seek isn't available on all streams. For example,
+HTTP or FTP streams don't deal with it. Other functions like StreamSize and
Tell aren't available for the moment for this sort of stream.
You will be notified when the EOF is reached by an error.
\section{\class{wxRealPoint}}\label{wxrealpoint}
A {\bf wxRealPoint} is a useful data structure for graphics operations.
-It contains floating point point {\it x} and {\it y} members.
+It contains floating point {\it x} and {\it y} members.
See also \helpref{wxPoint}{wxpoint} for an integer version.
\wxheading{Derived from}
\section{\class{wxRecursionGuard}}\label{wxrecursionguard}
wxRecursionGuard is a very simple class which can be used to prevent reentrancy
-problems in a function. It is not thread-safe and so should be used only in the
+problems in a function. It is not thread-safe and so should be used only in
single-threaded programs or in combination with some thread synchronization
mechanisms.
\constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}
-Returns {\tt true} if this rectangle has a non empty intersection with the
+Returns {\tt true} if this rectangle has a non-empty intersection with the
rectangle {\it rect} and {\tt false} otherwise.
or \helpref{wxWindow::FitInside}{wxwindowfitinside}, and setting the
scrolling increments for it by calling
\helpref{wxScrolledWindow::SetScrollRate}{wxscrolledwindowsetscrollrate}.
-Scrolling in some orientation is enabled by setting a non zero increment
+Scrolling in some orientation is enabled by setting a non-zero increment
for it.
The most automatic and newest way is to simply let sizers determine the
\wxheading{Parameters}
-\docparam{text}{The text control to append output too, must be non NULL}
+\docparam{text}{The text control to append output too, must be non-NULL}
\docparam{ostr}{The C++ stream to redirect, {\it cout} is used if it is NULL}
\item You may derive a new class from wxTimer and override the
\helpref{Notify}{wxtimernotify} member to perform the required action.
\item Or you may redirect the notifications to any
-\helpref{wxEvtHandler}{wxevthandler} derived object by using the non default
+\helpref{wxEvtHandler}{wxevthandler} derived object by using the non-default
constructor or \helpref{SetOwner}{wxtimersetowner}. Then use the {\tt EVT\_TIMER}
macro to connect it to the event handler which will receive
\helpref{wxTimerEvent}{wxtimerevent} notifications.
\wxheading{Parameters}
-\docparam{parent}{The parent window, must be non {\tt NULL}}
+\docparam{parent}{The parent window, must be non-{\tt NULL}}
\docparam{text}{The text to show, may contain the new line characters}
\helpref{SetTipWindowPtr}{wxtipwindowsettipwindowptr} below, please see its
documentation for the description of this parameter}
-\docparam{rectBounds}{If non {\tt NULL}, passed to
+\docparam{rectBounds}{If non-{\tt NULL}, passed to
\helpref{SetBoundingRect}{wxtipwindowsetboundingrect} below, please see its
documentation for the description of this parameter}
a keyboard key or if it loses focus in any other way - for example because the
user switched to another application window.
-Additionally, if a non empty {\it rectBound} is provided, the tip window will
+Additionally, if a non-empty {\it rectBound} is provided, the tip window will
also automatically close if the mouse leaves this area. This is useful to
dismiss the tip mouse when the mouse leaves the object it is associated with.
This is a general overview of logging classes provided by wxWidgets. The word
logging here has a broad sense, including all of the program output, not only
-non interactive messages. The logging facilities included in wxWidgets provide
+non-interactive messages. The logging facilities included in wxWidgets provide
the base {\it wxLog} class which defines the standard interface for a {\it log
target} as well as several standard implementations of it and a family of
functions to use with them.
\constfunc{int}{GetKeyCode}{}
-Returns the key code if the event was is a key event. Use
+Returns the key code if the event is a key event. Use
\helpref{GetKeyEvent}{wxtreeeventgetkeyevent} to get the values of the
modifier keys for this event (i.e. Shift or Ctrl).
\constfunc{const wxString\&}{GetLabel}{}
-Returns the label if the event was a begin or end edit label event.
+Returns the label if the event is a begin or end edit label event.
\membersection{wxTreeEvent::GetOldItem}\label{wxtreeeventgetolditem}
These classes will hopefully make writing MT programs easier and they also
provide some extra error checking (compared to the native (be it Win32 or Posix)
-thread API), however it is still an non-trivial undertaking especially for large
+thread API), however it is still a non-trivial undertaking especially for large
projects. Before starting an MT application (or starting to add MT features to
an existing one) it is worth asking oneself if there is no easier and safer way
to implement the same functionality. Of course, in some situations threads
For communication between secondary threads and the main thread, you may use
\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}
or its short version \helpref{wxPostEvent}{wxpostevent}. These functions
-have thread safe implementation so that they can be used as they are for
+have a thread-safe implementation so that they can be used as they are for
sending events from one thread to another. However there is no built in method
to send messages to the worker threads and you will need to use the available
synchronization classes to implement the solution which suits your needs
"http://mysite.com/john/mydir".
\docparam{base}{Base URI to inherit from. Must be a full URI and not a reference}
-\docparam{flags}{Currently either \texttt{wxURI\_STRICT} or $0$, in non strict
+\docparam{flags}{Currently either \texttt{wxURI\_STRICT} or $0$, in non-strict
mode some compatibility layers are enabled to allow loopholes from RFCs prior
to 2396}
\func{wxInputStream *}{GetInputStream}{\void}
Creates a new input stream on the specified URL. You can use all but seek
-functionality of wxStream. Seek isn't available on all stream. For example,
-http or ftp streams doesn't deal with it.
+functionality of wxStream. Seek isn't available on all streams. For example,
+HTTP or FTP streams don't deal with it.
Note that this method is somewhat depreciated, all future wxWidgets applications
should really use \helpref{wxFileSystem}{wxfilesystem} instead.
\wxheading{Parameters}
-\docparam{handler}{The event handler to remove, must be non {\tt NULL} and
+\docparam{handler}{The event handler to remove, must be non-{\tt NULL} and
must be present in this windows event handlers chain}
\wxheading{Return value}
\docparam{bitmap}{The page-specific bitmap if different from the global one}
-\docparam{resource}{Load the page from the specified resource if non NULL}
+\docparam{resource}{Load the page from the specified resource if non-NULL}
\membersection{wxWizardPage::GetPrev}\label{wxwizardpagegetprev}
that the handler name is equal to the control's name plus 'XmlHandler', for example
wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
(wxxrc) can create include file that contains initialization code for
-all controls used within the resource.
+all controls used within the resource. Note that this handler should be
+located on heap instead of stack, since it will get destroyed on shutdown.
\membersection{wxXmlResource::AttachUnknownControl}\label{wxxmlresourceattachunknowncontrol}
projects / wxWidgets.git / commitdiff
