From 43e8916ff3fd271e55c9daa6660cb8ea5ff7efe6 Mon Sep 17 00:00:00 2001 From: Michael Wetherell Date: Fri, 8 Apr 2005 14:34:30 +0000 Subject: [PATCH] Documentation fixes, patch 1179223 by Andreas Mohr git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@33428 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 6 +-- docs/latex/wx/boxsizer.tex | 2 +- docs/latex/wx/brush.tex | 4 +- docs/latex/wx/category.tex | 4 +- docs/latex/wx/cmdlpars.tex | 2 +- docs/latex/wx/conditn.tex | 4 +- docs/latex/wx/config.tex | 57 +++++++++++------------ docs/latex/wx/database.tex | 14 ------ docs/latex/wx/db.tex | 2 +- docs/latex/wx/dc.tex | 10 ++-- docs/latex/wx/ddeclint.tex | 4 +- docs/latex/wx/dir.tex | 2 +- docs/latex/wx/dllload.tex | 2 +- docs/latex/wx/docmanag.tex | 2 +- docs/latex/wx/dropsrc.tex | 2 +- docs/latex/wx/dynlib.tex | 4 +- docs/latex/wx/ffile.tex | 2 +- docs/latex/wx/filename.tex | 2 +- docs/latex/wx/filetype.tex | 2 +- docs/latex/wx/fontdlg.tex | 4 +- docs/latex/wx/frame.tex | 4 +- docs/latex/wx/ftp.tex | 10 ++-- docs/latex/wx/function.tex | 28 +++++------ docs/latex/wx/glcontext.tex | 2 +- docs/latex/wx/http.tex | 2 +- docs/latex/wx/imaglist.tex | 2 +- docs/latex/wx/listevt.tex | 2 +- docs/latex/wx/listitem.tex | 2 +- docs/latex/wx/locale.tex | 2 +- docs/latex/wx/mimetype.tex | 2 +- docs/latex/wx/protocol.tex | 2 +- docs/latex/wx/rect.tex | 2 +- docs/latex/wx/regex.tex | 2 +- docs/latex/wx/region.tex | 4 +- docs/latex/wx/renderer.tex | 2 +- docs/latex/wx/slider.tex | 62 ++++++++++++------------- docs/latex/wx/splitevt.tex | 2 +- docs/latex/wx/statusbr.tex | 4 +- docs/latex/wx/tdate.tex | 2 +- docs/latex/wx/tdb.tex | 4 +- docs/latex/wx/text.tex | 27 ++++++++--- docs/latex/wx/textfile.tex | 6 +-- docs/latex/wx/ti18n.tex | 10 ++-- docs/latex/wx/tmbconv.tex | 2 +- docs/latex/wx/treedata.tex | 2 +- docs/latex/wx/tunicode.tex | 2 +- docs/latex/wx/url.tex | 2 +- docs/latex/wx/window.tex | 6 +-- docs/latex/wx/zipstrm.tex | 2 +- docs/publicity/announce.txt | 2 +- include/wx/db.h | 2 +- include/wx/fileconf.h | 4 +- include/wx/filesys.h | 2 +- include/wx/listbox.h | 2 +- include/wx/longlong.h | 2 +- include/wx/xrc/xmlres.h | 2 +- samples/xrc/myframe.cpp | 4 +- src/common/db.cpp | 2 +- src/common/mediactrlcmn.cpp | 2 +- src/msw/listctrl.cpp | 2 +- src/os2/listctrl.cpp | 2 +- wxPython/docs/xml/wxPython-metadata.xml | 2 +- wxPython/src/_dc.i | 2 +- wxPython/src/gtk/_gdi.py | 2 +- wxPython/src/mac/_gdi.py | 2 +- wxPython/src/msw/_gdi.py | 2 +- 66 files changed, 186 insertions(+), 184 deletions(-) diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index 6aa9ecd22b..461dcc6f10 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -282,9 +282,9 @@ the user to stop the program, continue or ignore all subsequent asserts. \wxheading{Parameters} -\docparam{file}{the name of the source file where the assert occured} +\docparam{file}{the name of the source file where the assert occurred} -\docparam{line}{the line number in this file where the assert occured} +\docparam{line}{the line number in this file where the assert occurred} \docparam{cond}{the condition of the failed assert in string form} @@ -699,7 +699,7 @@ messages immediately (otherwise it will be done during the next idle loop iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}. Calling Yield() recursively is normally an error and an assert failure is -raised in debug build if such situation is detected. However if the the +raised in debug build if such situation is detected. However if the {\it onlyIfNeeded} parameter is {\tt true}, the method will just silently return {\tt false} instead. diff --git a/docs/latex/wx/boxsizer.tex b/docs/latex/wx/boxsizer.tex index 08de2b2152..279896593d 100644 --- a/docs/latex/wx/boxsizer.tex +++ b/docs/latex/wx/boxsizer.tex @@ -30,7 +30,7 @@ or wxHORIZONTAL for creating either a column sizer or a row sizer. \func{void}{RecalcSizes}{\void} Implements the calculation of a box sizer's dimensions and then sets -the size of its its children (calling \helpref{wxWindow::SetSize}{wxwindowsetsize} +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. diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex index 9cdf71dcc3..dfc9a09aea 100644 --- a/docs/latex/wx/brush.tex +++ b/docs/latex/wx/brush.tex @@ -329,10 +329,10 @@ cleanup because it can lead to double deletion in some circumstances. There are two mechanisms in recent versions of wxWidgets which make the brush list less useful than it once was. Under Windows, scarce resources -are cleaned up internally if they are not being used. Also, a referencing +are cleaned up internally if they are not being used. Also, a reference counting mechanism applied to all GDI objects means that some sharing of underlying resources is possible. You don't have to keep track of pointers, -working out when it is safe delete a brush, because the referencing counting does +working out when it is safe delete a brush, because the reference counting does it for you. For example, you can set a brush in a device context, and then immediately delete the brush you passed, because the brush is `copied'. diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index cc9d9eb9f1..da93d49889 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -612,8 +612,8 @@ product, donated by Remstar. This is known as wxODBC. \twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class} \twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)} \twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.} -\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render opengl calls to.} -\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of opengl data resources.} +\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.} +\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.} \twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility} \twocolitem{\helpref{wxProcess}{wxprocess}}{Process class} \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class} diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex index e471321c42..35d1ab1178 100644 --- a/docs/latex/wx/cmdlpars.tex +++ b/docs/latex/wx/cmdlpars.tex @@ -453,7 +453,7 @@ Add a parameter of the given {\it type} to the command line description. Parse the command line, return $0$ if ok, $-1$ if {\tt "-h"} or {\tt "--help"} option was encountered and the help message was given or a positive value if a -syntax error occured. +syntax error occurred. \wxheading{Parameters} diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex index ff0cfb3407..c39e2c1689 100644 --- a/docs/latex/wx/conditn.tex +++ b/docs/latex/wx/conditn.tex @@ -145,7 +145,7 @@ not. \constfunc{bool}{IsOk}{\void} Returns {\tt true} if the object had been initialized successfully, {\tt false} -if an error occured. +if an error occurred. \membersection{wxCondition::Signal}\label{wxconditionsignal} @@ -181,7 +181,7 @@ Wait or the thread may sleep forever. \wxheading{Return value} -Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occured. +Returns {\tt wxCOND\_NO\_ERROR} on success, another value if an error occurred. \wxheading{See also} diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index d8b57af2b4..a9c58e4168 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -99,7 +99,7 @@ disable this behaviour {\it DontCreateOnDemand()} is provided. {\bf Note:} You should use either {\it Set()} or {\it Get()} because wxWidgets library itself would take advantage of it and could save various information in it. For example \helpref{wxFontMapper}{wxfontmapper} or Unix version -of \helpref{wxFileDialog}{wxfiledialog} have ability to use wxConfig class. +of \helpref{wxFileDialog}{wxfiledialog} have the ability to use wxConfig class. \helpref{Set}{wxconfigbaseset}\\ \helpref{Get}{wxconfigbaseget}\\ @@ -186,7 +186,7 @@ regardless of the platform (i.e. it is {\bf not} '$\backslash\backslash$' under \membersection{Enumeration}\label{configenumeration} The functions in this section allow to enumerate all entries and groups in the -config file. All functions here return false when there are no more items. +config file. All functions here return \false when there are no more items. You must pass the same index to GetNext and GetFirst (don't modify it). Please note that it is {\bf not} the index of the current item (you will have @@ -284,7 +284,7 @@ arbitrary path (either relative or absolute), not just the key name. \membersection{Rename entries/groups}\label{configrenaming} The functions in this section allow to rename entries or subgroups of the -current group. They will return false on error. typically because either the +current group. They will return \false on error. typically because either the entry/group with the original name doesn't exist, because the entry/group with the new name already exists or because the function is not supported in this wxConfig implementation. @@ -429,7 +429,7 @@ created object and also sets it as the current one. Calling this function will prevent {\it Get()} from automatically creating a new config object if the current one is NULL. It might be useful to call it -near the program end to prevent new config object "accidental" creation. +near the program end to prevent "accidental" creation of a new config object. \membersection{wxConfigBase::DeleteAll}\label{wxconfigbasedeleteall} @@ -437,7 +437,7 @@ near the program end to prevent new config object "accidental" creation. \func{bool}{DeleteAll}{\void} Delete the whole underlying object (disk file, registry key, ...). Primarly -for use by desinstallation routine. +for use by uninstallation routine. \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry} @@ -459,7 +459,7 @@ Delete the group (with all subgroups) \constfunc{bool}{Exists}{\param{wxString\& }{strName}} -returns true if either a group or an entry with a given name exists +returns \true if either a group or an entry with a given name exists \membersection{wxConfigBase::Flush}\label{wxconfigbaseflush} @@ -501,11 +501,11 @@ The result is an element of enum EntryType: \begin{verbatim} enum EntryType { - Unknown, - String, - Boolean, - Integer, - Float + Type_Unknown, + Type_String, + Type_Boolean, + Type_Integer, + Type_Float }; \end{verbatim} @@ -597,35 +597,35 @@ Returns the vendor name. \constfunc{bool}{HasEntry}{\param{wxString\& }{strName}} -returns true if the entry by this name exists +returns \true if the entry by this name exists \membersection{wxConfigBase::HasGroup}\label{wxconfigbasehasgroup} \constfunc{bool}{HasGroup}{\param{const wxString\& }{strName}} -returns true if the group by this name exists +returns \true if the group by this name exists \membersection{wxConfigBase::IsExpandingEnvVars}\label{wxconfigbaseisexpandingenvvars} \constfunc{bool}{IsExpandingEnvVars}{\void} -Returns true if we are expanding environment variables in key values. +Returns \true if we are expanding environment variables in key values. \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults} \constfunc{bool}{IsRecordingDefaults}{\void} -Returns true if we are writing defaults back to the config file. +Returns \true if we are writing defaults back to the config file. \membersection{wxConfigBase::Read}\label{wxconfigbaseread} \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}} -Read a string from the key, returning true if the value was read. If the key +Read a string from the key, returning \true if the value was read. If the key was not found, {\it str} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}} @@ -633,7 +633,7 @@ was not found, {\it str} is not changed. Read a string from the key. The default value is returned if the key was not found. -Returns true if value was really read, false if the default was used. +Returns \true if value was really read, \false if the default was used. \constfunc{wxString}{Read}{\param{const wxString\& }{key}, \param{const wxString\& }{defaultVal}} @@ -642,13 +642,13 @@ Another version of {\it Read()}, returning the string value directly. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}} -Reads a long value, returning true if the value was found. If the value was +Reads a long value, returning \true if the value was found. If the value was not found, {\it l} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{long*}{ l}, \param{long}{ defaultVal}} -Reads a long value, returning true if the value was found. If the value was +Reads a long value, returning \true if the value was found. If the value was not found, {\it defaultVal} is used instead. \constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}} @@ -675,24 +675,24 @@ won't work because the call is ambiguous: compiler can not choose between two \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}} -Reads a double value, returning true if the value was found. If the value was +Reads a double value, returning \true if the value was found. If the value was not found, {\it d} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{double*}{ d}, \param{double}{ defaultVal}} -Reads a double value, returning true if the value was found. If the value was +Reads a double value, returning \true if the value was found. If the value was not found, {\it defaultVal} is used instead. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ b}} -Reads a bool value, returning true if the value was found. If the value was +Reads a bool value, returning \true if the value was found. If the value was not found, {\it b} is not changed. \constfunc{bool}{Read}{\param{const wxString\& }{ key}, \param{bool*}{ d}, \param{bool}{ defaultVal}} -Reads a bool value, returning true if the value was found. If the value was +Reads a bool value, returning \true if the value was found. If the value was not found, {\it defaultVal} is used instead. \pythonnote{In place of a single overloaded method name, wxPython @@ -722,7 +722,7 @@ Renames an entry in the current group. The entries names (both the old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function. -Returns false if the {\it oldName} doesn't exist or if {\it newName} already +Returns \false if {\it oldName} doesn't exist or if {\it newName} already exists. @@ -734,7 +734,7 @@ Renames a subgroup of the current group. The subgroup names (both the old and the new one) shouldn't contain backslashes, i.e. only simple names and not arbitrary paths are accepted by this function. -Returns false if the {\it oldName} doesn't exist or if {\it newName} already +Returns \false if {\it oldName} doesn't exist or if {\it newName} already exists. @@ -758,7 +758,7 @@ Determine whether we wish to expand environment variables in key values. \func{void}{SetPath}{\param{const wxString\& }{strPath}} Set current path: if the first character is '/', it is the absolute path, -otherwise it is a relative path. '..' is supported. If the strPath doesn't +otherwise it is a relative path. '..' is supported. If strPath doesn't exist it is created. @@ -767,7 +767,7 @@ exist it is created. \func{void}{SetRecordDefaults}{\param{bool }{bDoIt = true}} Sets whether defaults are recorded to the config file whenever an attempt to -read read the value which is not present in it is done. +read the value which is not present in it is done. If on (default is off) all default values for the settings used by the program are written back to the config file. This allows the user to see what config @@ -785,8 +785,7 @@ value}} \func{bool}{Write}{\param{const wxString\& }{ key}, \param{bool}{ value}} -These functions write the specified value to the config file and return true -on success. +These functions write the specified value to the config file and return \true on success. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par diff --git a/docs/latex/wx/database.tex b/docs/latex/wx/database.tex index ebbc51279a..3f188cae4e 100644 --- a/docs/latex/wx/database.tex +++ b/docs/latex/wx/database.tex @@ -77,20 +77,6 @@ and disconnects from the current data source. Commits previous transactions. Not implemented. -\membersection{wxDatabase::ErrorOccured} - -\func{bool}{ErrorOccured}{\void} - -Returns true if the last action caused an error. - -\membersection{wxDatabase::ErrorSnapshot} - -\func{void}{ErrorSnapshot}{\param{HSTMT}{ statement = SQL\_NULL\_HSTMT}} - -This function will be called whenever an ODBC error occured. It stores the -error related information returned by ODBC. If a statement handle of the -concerning ODBC action is available it should be passed to the function. - \membersection{wxDatabase::GetDatabaseName} \func{wxString}{GetDatabaseName}{\void} diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex index 1158657f99..f8174535f5 100644 --- a/docs/latex/wx/db.tex +++ b/docs/latex/wx/db.tex @@ -3713,7 +3713,7 @@ the datasource knows on which column values the tables should be joined on. \begin{verbatim} ... // Base table is the "LOCATION" table, and it is being - // outer joined to the "PART" table via the the field "PART_NUMBER" + // outer joined to the "PART" table via the field "PART_NUMBER" // that can be related between the two tables. location->SetWhereClause("LOCATION.PART_NUMBER = PART.PART_NUMBER") location->SetFromClause("PART"); diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index 7a2a77b2a3..2127df4f0d 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -681,12 +681,12 @@ Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMod \constfunc{bool}{GetPartialTextExtents}{\param{const wxString\& }{text}, \param{wxArrayInt\& }{widths}} -Fills the {\it widths} array with the widths from the begining of -{\it text} to the coresponding character of {\it text}. The generic +Fills the {\it widths} array with the widths from the beginning of +{\it text} to the corresponding character of {\it text}. The generic version simply builds a running total of the widths of each character using \helpref{GetTextExtent}{wxdcgettextextent}, however if the various platforms have a native API function that is faster or more -accurate than the generic implementaiton then it should be used +accurate than the generic implementation then it should be used instead. \pythonnote{This method only takes the {\it text} parameter and @@ -707,6 +707,8 @@ Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}). Sets {\it colour} to the colour at the specified location. Not available for wxPostScriptDC or wxMetafileDC. +Note that setting a pixel can be done using \helpref{DrawPoint}{wxdcdrawpoint}. + \pythonnote{For wxPython the wxColour value is returned and is not required as a parameter.} @@ -1154,7 +1156,7 @@ No base class \func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{const wxRect\&}{ rect}} -Constructor: sets the the clipping region for the given device context to the +Constructor: sets the clipping region for the given device context to the specified rectangle. diff --git a/docs/latex/wx/ddeclint.tex b/docs/latex/wx/ddeclint.tex index bfb9f6eca2..dbe2607587 100644 --- a/docs/latex/wx/ddeclint.tex +++ b/docs/latex/wx/ddeclint.tex @@ -66,6 +66,6 @@ store application-specific data in instances of the new class. \func{bool}{ValidHost}{\param{const wxString\& }{host}} -Returns true if this is a valid host name, false otherwise. This always -returns true under MS Windows. +Returns \true if this is a valid host name, \false otherwise. This always +returns \true under MS Windows. diff --git a/docs/latex/wx/dir.tex b/docs/latex/wx/dir.tex index cac3971232..8f0fade28c 100644 --- a/docs/latex/wx/dir.tex +++ b/docs/latex/wx/dir.tex @@ -106,7 +106,7 @@ Test for existence of a directory with the given name \func{static size\_t}{GetAllFiles}{\param{const wxString\& }{dirname}, \param{wxArrayString *}{files}, \param{const wxString\& }{filespec = wxEmptyString}, \param{int }{flags = wxDIR\_DEFAULT}} The function appends the names of all the files under directory {\it dirname} -to the array {\it files} (note that its old contents is preserved). Only files +to the array {\it files} (note that its old content is preserved). Only files matching the {\it filespec} are taken, with empty spec matching all the files. The {\it flags} parameter should always include {\tt wxDIR\_FILES} or the array diff --git a/docs/latex/wx/dllload.tex b/docs/latex/wx/dllload.tex index 53aacf39e4..c0f217dfd2 100644 --- a/docs/latex/wx/dllload.tex +++ b/docs/latex/wx/dllload.tex @@ -113,7 +113,7 @@ This function resolves a symbol in a loaded DLL, such as a variable or function name. Returned value will be {\tt NULL} if the symbol was not found in the DLL or if -an error occured. +an error occurred. \wxheading{Parameters} diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex index b815c5b06a..d8516852f0 100644 --- a/docs/latex/wx/docmanag.tex +++ b/docs/latex/wx/docmanag.tex @@ -85,7 +85,7 @@ The directory last selected by the user when opening a file. \membersection{wxDocManager::m\_templates}\label{wxdocmanagermtemplates} -\member{wxList}{mnTemplates} +\member{wxList}{m\_templates} A list of all document templates. diff --git a/docs/latex/wx/dropsrc.tex b/docs/latex/wx/dropsrc.tex index d75a027701..f0c4e90ff8 100644 --- a/docs/latex/wx/dropsrc.tex +++ b/docs/latex/wx/dropsrc.tex @@ -93,7 +93,7 @@ operation}. \wxheading{Return value} Returns the operation requested by the user, may be {\tt wxDragCopy}, {\tt -wxDragMove}, {\tt wxDragLink}, {\tt wxDragCancel} or {\tt wxDragNone} if an error occured. +wxDragMove}, {\tt wxDragLink}, {\tt wxDragCancel} or {\tt wxDragNone} if an error occurred. \membersection{wxDropSource::GetDataObject}\label{wxdropsourcegetdataobject} diff --git a/docs/latex/wx/dynlib.tex b/docs/latex/wx/dynlib.tex index 505832463b..5eaaa4265f 100644 --- a/docs/latex/wx/dynlib.tex +++ b/docs/latex/wx/dynlib.tex @@ -88,7 +88,7 @@ The possible values for \arg{cat} are: Detaches this object from its library handle, i.e. the object will not unload the library any longer in its destructor but it is now the callers -responsability to do this using \helpref{Unload}{wxdynamiclibraryunload}. +responsibility to do this using \helpref{Unload}{wxdynamiclibraryunload}. \membersection{wxDynamicLibrary::GetSymbol}\label{wxdynamiclibrarygetsymbol} @@ -136,7 +136,7 @@ Returns \true if the library was successfully loaded, \false otherwise. This static method returns an \helpref{array}{wxarray} containing the details of all modules loaded into the address space of the current project, the array elements are object of \texttt{wxDynamicLibraryDetails} class. The array will -be empty if an error occured. +be empty if an error occurred. This method is currently implemented only under Win32 and Linux and is useful mostly for diagnostics purposes. diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex index 495dc32f43..fafe340746 100644 --- a/docs/latex/wx/ffile.tex +++ b/docs/latex/wx/ffile.tex @@ -127,7 +127,7 @@ the file is not opened. \membersection{wxFFile::Error}\label{wxffileerror} -Returns \true if an error has occured on this file, similar to the standard +Returns \true if an error has occurred on this file, similar to the standard \texttt{ferror()} function. Please note that this method may only be called for opened files and may crash diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index 27a8e9ebdf..27ced29111 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -342,7 +342,7 @@ function exists mainly for symmetry with \helpref{DirName}{wxfilenamedirname}. \func{static wxString}{GetCwd}{\param{const wxString\& }{volume = ""}} Retrieves the value of the current working directory on the specified volume. If -the volume is empty, the programs current working directory is returned for the +the volume is empty, the program's current working directory is returned for the current volume. \wxheading{Return value} diff --git a/docs/latex/wx/filetype.tex b/docs/latex/wx/filetype.tex index 9cbeb4f35a..15ac25a77c 100644 --- a/docs/latex/wx/filetype.tex +++ b/docs/latex/wx/filetype.tex @@ -190,7 +190,7 @@ class. In the second case, only the filename is specified and the command to be used to open this kind of file is returned directly. An empty string is returned to -indicate that an error occured (typically meaning that there is no standard way +indicate that an error occurred (typically meaning that there is no standard way to open this kind of files). \membersection{wxFileType::GetPrintCommand}\label{wxfiletypegetprintcommand} diff --git a/docs/latex/wx/fontdlg.tex b/docs/latex/wx/fontdlg.tex index e28d3c9b23..e3d7dc948b 100644 --- a/docs/latex/wx/fontdlg.tex +++ b/docs/latex/wx/fontdlg.tex @@ -177,8 +177,8 @@ shown. \func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}} Creates the dialog if it the wxFontDialog object had been initialized using the -default constructor. Returns {\tt true} on success and {\tt false} if an error -occured. +default constructor. Returns \true on success and \false if an error +occurred. \membersection{wxFontDialog::GetFontData}\label{wxfontdialoggetfontdata} diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index 3f3bd4fa10..bd81c1fa61 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -191,7 +191,7 @@ wxWidgets.} \wxheading{Return value} -A pointer to the the status bar if it was created successfully, NULL otherwise. +A pointer to the status bar if it was created successfully, NULL otherwise. \wxheading{Remarks} @@ -228,7 +228,7 @@ wxWidgets.} \wxheading{Return value} -A pointer to the the toolbar if it was created successfully, NULL otherwise. +A pointer to the toolbar if it was created successfully, NULL otherwise. \wxheading{Remarks} diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index 015bb590ed..67925829ef 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -122,8 +122,8 @@ Destructor will close the connection if connected. \func{bool}{Abort}{\void} -Aborts the download currently in process, returns {\tt true} if ok, {\tt false} -if an error occured. +Aborts the download currently in process, returns \true if ok, \false +if an error occurred. \membersection{wxFTP::CheckCommand}\label{wxftpcheckcommand} @@ -285,7 +285,7 @@ to specify a user and a password. \func{bool}{FileExists}{\param{const wxString\&}{ filename}} -Returns {\tt true} if the given remote file exists, {\tt false} otherwise. +Returns \true if the given remote file exists, \false otherwise. \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize} @@ -371,9 +371,9 @@ An initialized write-only stream. \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} -Creates a new input stream on the the specified path. You can use all but the seek +Creates a new input stream on the specified path. You can use all but the seek functionality of wxStream. Seek isn't available on all streams. For example, -http or ftp streams do not deal with it. Other functions like Tell +HTTP or FTP streams do not deal with it. Other functions like Tell are not available for this sort of stream, at present. You will be notified when the EOF is reached by an error. diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index f9741e745b..1a1bb44e51 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -435,7 +435,7 @@ This function is used in wxBase only and only if you don't create \helpref{wxApp}{wxapp} object at all. In this case you must call it from your {\tt main()} function before calling any other wxWidgets functions. -If the function returns {\tt false} the initialization could not be performed, +If the function returns \false the initialization could not be performed, in this case the library cannot be used and \helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither. @@ -740,7 +740,7 @@ and that this function is only implemented under Unix and Win32. \wxheading{Returns} -{\tt true} on success, {\tt false} if an error occured. +\true on success, \false if an error occurred. \wxheading{Include files} @@ -841,7 +841,7 @@ This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if \func{bool}{wxIsMainThread}{\void} -Returns {\tt true} if this thread is the main one. Always returns {\tt true} if +Returns \true if this thread is the main one. Always returns \true if {\tt wxUSE\_THREADS} is $0$. @@ -960,7 +960,7 @@ parent directory "..". \wxheading{Warning} -As of wx 2.5.2, these functions are not thread-safe! (use static variables) +As of wx 2.5.2, these functions are not thread-safe! (they use static variables). You probably want to use \helpref{wxDir::GetFirst}{wxdirgetfirst} or \helpref{wxDirTraverser}{wxdirtraverser} instead. {\it spec} may contain wildcards. @@ -998,7 +998,7 @@ information is not needed. \wxheading{Returns} -{\tt true} on success, {\tt false} if an error occured (for example, the +\true on success, \false if an error occurred (for example, the directory doesn't exist). \wxheading{Portability} @@ -1460,8 +1460,8 @@ is running, the entry {\bf Current} in the section {\bf User} of the PENWIN.INI file is used. The first variant of this function returns the user name if successful or an -empty string otherwise. The second (deprecated) function returns {\tt true} -if successful, {\tt false} otherwise. +empty string otherwise. The second (deprecated) function returns \true +if successful, \false otherwise. \wxheading{See also} @@ -1518,8 +1518,8 @@ Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}. \func{bool}{wxIsEmpty}{\param{const char *}{ p}} -Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty -string, {\tt false} otherwise. +Returns \true if the pointer is either {\tt NULL} or points to an empty +string, \false otherwise. \membersection{::wxStrcmp}\label{wxstrcmp} @@ -1551,8 +1551,8 @@ case-sensitive comparison. {\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead. -Returns {\tt true} if the substring {\it s1} is found within {\it s2}, -ignoring case if {\it exact} is false. If {\it subString} is {\tt false}, +Returns \true if the substring {\it s1} is found within {\it s2}, +ignoring case if {\it exact} is false. If {\it subString} is \false, no substring matching is done. @@ -4336,7 +4336,7 @@ Returns the current value of the environment variable {\it var} in {\it value}. {\it value} may be {\tt NULL} if you just want to know if the variable exists and are not interested in its value. -Returns {\tt true} if the variable exists, {\tt false} otherwise. +Returns \true if the variable exists, \false otherwise. \membersection{wxSetEnv}\label{wxsetenv} @@ -4346,7 +4346,7 @@ Returns {\tt true} if the variable exists, {\tt false} otherwise. Sets the value of the environment variable {\it var} (adding it if necessary) to {\it value}. -Returns {\tt true} on success. +Returns \true on success. \membersection{wxUnsetEnv}\label{wxunsetenv} @@ -4357,5 +4357,5 @@ Removes the variable {\it var} from the environment. \helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this function. -Returns {\tt true} on success. +Returns \true on success. diff --git a/docs/latex/wx/glcontext.tex b/docs/latex/wx/glcontext.tex index 2016939e97..f2c4b1c33f 100644 --- a/docs/latex/wx/glcontext.tex +++ b/docs/latex/wx/glcontext.tex @@ -1,6 +1,6 @@ \section{\class{wxGLContext}}\label{wxglcontext} -wxGLContext is a class for sharing opengl data resources, such as display lists, with another \helpref{wxGLCanvas}{wxglcanvas}. +wxGLContext is a class for sharing OpenGL data resources, such as display lists, with another \helpref{wxGLCanvas}{wxglcanvas}. By sharing data resources, you can prevent code duplication, save memory, and ultimately help optimize your application. diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex index 642d697fce..e9966fe8ad 100644 --- a/docs/latex/wx/http.tex +++ b/docs/latex/wx/http.tex @@ -29,7 +29,7 @@ Returns the HTTP response code returned by the server. Please refer to the RFC \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} -Creates a new input stream on the the specified path. You can use all except the seek +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. diff --git a/docs/latex/wx/imaglist.tex b/docs/latex/wx/imaglist.tex index 96662824aa..62b41b6e13 100644 --- a/docs/latex/wx/imaglist.tex +++ b/docs/latex/wx/imaglist.tex @@ -97,7 +97,7 @@ Initializes the list. See \helpref{wxImageList::wxImageList}{wximagelistconstr} \membersection{wxImageList::Draw}\label{wximagelistdraw} \func{bool}{Draw}{\param{int}{ index}, \param{wxDC\&}{ dc}, \param{int }{x},\rtfsp -\param{int }{x}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp +\param{int }{y}, \param{int }{flags = wxIMAGELIST\_DRAW\_NORMAL},\rtfsp \param{const bool }{solidBackground = false}} Draws a specified image onto a device context. diff --git a/docs/latex/wx/listevt.tex b/docs/latex/wx/listevt.tex index c38f9322a3..8d944ca89e 100644 --- a/docs/latex/wx/listevt.tex +++ b/docs/latex/wx/listevt.tex @@ -35,7 +35,7 @@ functions that take a wxListEvent argument. \twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.} \twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.} \twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.} -\twocolitem{{\bf EVT\_LIST\_COL\_RIGHT\_CLICK(id, func)}}{A column ({\bf m\_col}) (which can be $-1$ if the click occured outside any column) has been right-clicked.} +\twocolitem{{\bf EVT\_LIST\_COL\_RIGHT\_CLICK(id, func)}}{A column ({\bf m\_col}) (which can be $-1$ if the click occurred outside any column) has been right-clicked.} \twocolitem{{\bf EVT\_LIST\_COL\_BEGIN\_DRAG(id, func)}}{The user started resizing a column - can be vetoed.} \twocolitem{{\bf EVT\_LIST\_COL\_DRAGGING(id, func)}}{The divider between columns is being dragged.} \twocolitem{{\bf EVT\_LIST\_COL\_END\_DRAG(id, func)}}{A column has been resized by the user.} diff --git a/docs/latex/wx/listitem.tex b/docs/latex/wx/listitem.tex index a2df66652a..7f5604df6c 100644 --- a/docs/latex/wx/listitem.tex +++ b/docs/latex/wx/listitem.tex @@ -178,7 +178,7 @@ Sets the mask of valid fields. See \helpref{wxListItem::GetMask}{wxlistitemgetma Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see \helpref{wxListItem::SetStateMask}{wxlistitemsetstatemask}). -See \helpref{wxListItem::GetState}{wxlistitemsetstate} for valid flag +See \helpref{wxListItem::GetState}{wxlistitemgetstate} for valid flag values. \membersection{wxListItem::SetStateMask}\label{wxlistitemsetstatemask} diff --git a/docs/latex/wx/locale.tex b/docs/latex/wx/locale.tex index 46c6c681a0..a8d51c9378 100644 --- a/docs/latex/wx/locale.tex +++ b/docs/latex/wx/locale.tex @@ -389,7 +389,7 @@ description of this behaviour. Note that this flag is meaningless in Unicode bui \docparam{szName}{The name of the locale. Only used in diagnostic messages.} -\docparam{szShort}{The standard 2 letter locale abbreviation and is used as the +\docparam{szShort}{The standard 2 letter locale abbreviation; it is used as the directory prefix when looking for the message catalog files.} \docparam{szLocale}{The parameter for the call to setlocale(). Note that it is diff --git a/docs/latex/wx/mimetype.tex b/docs/latex/wx/mimetype.tex index d763119014..d28bd3e9c4 100644 --- a/docs/latex/wx/mimetype.tex +++ b/docs/latex/wx/mimetype.tex @@ -23,7 +23,7 @@ If GNOME or KDE desktop environment is installed, then wxMimeTypesManager gathers MIME information from respective files (e.g. .kdelnk files under KDE). NB: Currently, wxMimeTypesManager is limited to reading MIME type information -but it will support modifying it as well in the future versions. +but it will support modifying it as well in future versions. \wxheading{Global objects} diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex index 905ca5c410..c1073dd4d6 100644 --- a/docs/latex/wx/protocol.tex +++ b/docs/latex/wx/protocol.tex @@ -33,7 +33,7 @@ true, if the connection is established, else false. \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} -Creates a new input stream on the the specified path. You can use all but seek +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 Tell aren't available for the moment for this sort of stream. diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex index 8e3c6bf1de..30cba05bf7 100644 --- a/docs/latex/wx/rect.tex +++ b/docs/latex/wx/rect.tex @@ -126,7 +126,7 @@ Gets the topleft position of the rectangle. (Same as GetPosition). \constfunc{wxPoint}{GetBottomRight}{\void} -Gets the the bottom right position. Returns the bottom right point inside the rectangle. +Gets the bottom right position. Returns the bottom right point inside the rectangle. \membersection{wxRect::GetRight}\label{wxrectgetright} diff --git a/docs/latex/wx/regex.tex b/docs/latex/wx/regex.tex index c78422222e..52ea21d508 100644 --- a/docs/latex/wx/regex.tex +++ b/docs/latex/wx/regex.tex @@ -163,7 +163,7 @@ May only be called after successful call to \helpref{Matches()}{wxregexmatches} and only if {\tt wxRE\_NOSUB} was {\bf not} used in \helpref{Compile()}{wxregexcompile}. -Returns {\tt false} if no match or if an error occured. +Returns {\tt false} if no match or if an error occurred. \constfunc{wxString}{GetMatch}{\param{const wxString\& }{text}, \param{size\_t }{index = 0}} diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex index 696a66fa92..fed642106c 100644 --- a/docs/latex/wx/region.tex +++ b/docs/latex/wx/region.tex @@ -187,7 +187,7 @@ Finds the union of this region and another region. \func{bool}{Union}{\param{const wxBitmap\&}{ bmp}} -Finds the union of this region and the the non-transparent pixels of a +Finds the union of this region and the non-transparent pixels of a bitmap. Bitmap's mask is used to determine transparency. If the bitmap doesn't have a mask, solid rectangle of bitmap's dimensions is used. @@ -195,7 +195,7 @@ have a mask, solid rectangle of bitmap's dimensions is used. \param{const wxColour\&}{ transColour}, \param{int}{ tolerance = 0}} -Finds the union of this region and the the non-transparent pixels of a +Finds the union of this region and the non-transparent pixels of a bitmap. Colour to be treated as transparent is specified in the \arg{transColour} argument, along with an optional colour tolerance value. diff --git a/docs/latex/wx/renderer.tex b/docs/latex/wx/renderer.tex index 0f5a4111a2..ec48042f02 100644 --- a/docs/latex/wx/renderer.tex +++ b/docs/latex/wx/renderer.tex @@ -134,7 +134,7 @@ well. \func{void}{DrawSplitterSash}{\param{wxWindow* }{win}, \param{wxDC\& }{dc}, \param{const wxSize\& }{size}, \param{wxCoord }{position}, \param{wxOrientation }{orient}, \param{int }{flags = 0}} Draw a sash. The \arg{orient} parameter defines whether the sash should be -vertical or horizontal and how should the \arg{position} be interpreted. +vertical or horizontal and how the \arg{position} should be interpreted. \membersection{wxRendererNative::DrawTreeItemButton}\label{wxrenderernativedrawtreeitembutton} diff --git a/docs/latex/wx/slider.tex b/docs/latex/wx/slider.tex index 86d051bed7..1612b6aebe 100644 --- a/docs/latex/wx/slider.tex +++ b/docs/latex/wx/slider.tex @@ -227,37 +227,6 @@ Gets the current slider value. \helpref{wxSlider::GetMin}{wxslidergetmin}, \helpref{wxSlider::GetMax}{wxslidergetmax},\rtfsp \helpref{wxSlider::SetValue}{wxslidersetvalue} -\membersection{wxSlider::SetRange}\label{wxslidersetrange} - -\func{void}{SetRange}{\param{int}{ minValue}, \param{int}{ maxValue}} - -Sets the minimum and maximum slider values. - -\wxheading{See also} - -\helpref{wxSlider::GetMin}{wxslidergetmin}, \helpref{wxSlider::GetMax}{wxslidergetmax} - -\membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq} - -\func{void}{SetTickFreq}{\param{int }{n}, \param{int }{pos}} - -Sets the tick mark frequency and position. - -\wxheading{Parameters} - -\docparam{n}{Frequency. For example, if the frequency is set to two, a tick mark is displayed for -every other increment in the slider's range.} - -\docparam{pos}{Position. Must be greater than zero. TODO: what is this for?} - -\wxheading{Remarks} - -Windows 95 only. - -\wxheading{See also} - -\helpref{wxSlider::GetTickFreq}{wxslidergettickfreq} - \membersection{wxSlider::SetLineSize}\label{wxslidersetlinesize} \func{void}{SetLineSize}{\param{int }{lineSize}} @@ -286,6 +255,16 @@ Sets the page size for the slider. \helpref{wxSlider::GetPageSize}{wxslidergetpagesize} +\membersection{wxSlider::SetRange}\label{wxslidersetrange} + +\func{void}{SetRange}{\param{int}{ minValue}, \param{int}{ maxValue}} + +Sets the minimum and maximum slider values. + +\wxheading{See also} + +\helpref{wxSlider::GetMin}{wxslidergetmin}, \helpref{wxSlider::GetMax}{wxslidergetmax} + \membersection{wxSlider::SetSelection}\label{wxslidersetselection} \func{void}{SetSelection}{\param{int }{startPos}, \param{int }{endPos}} @@ -342,6 +321,27 @@ Windows 95 only. \helpref{wxSlider::SetTickFreq}{wxslidersettickfreq} +\membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq} + +\func{void}{SetTickFreq}{\param{int }{n}, \param{int }{pos}} + +Sets the tick mark frequency and position. + +\wxheading{Parameters} + +\docparam{n}{Frequency. For example, if the frequency is set to two, a tick mark is displayed for +every other increment in the slider's range.} + +\docparam{pos}{Position. Must be greater than zero. TODO: what is this for?} + +\wxheading{Remarks} + +Windows 95 only. + +\wxheading{See also} + +\helpref{wxSlider::GetTickFreq}{wxslidergettickfreq} + \membersection{wxSlider::SetValue}\label{wxslidersetvalue} \func{void}{SetValue}{\param{int}{ value}} diff --git a/docs/latex/wx/splitevt.tex b/docs/latex/wx/splitevt.tex index 9f430e802d..269cfe5ab9 100644 --- a/docs/latex/wx/splitevt.tex +++ b/docs/latex/wx/splitevt.tex @@ -108,7 +108,7 @@ wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events. \func{void}{SetSashPosition}{\param{int}{ pos}} In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events, -sets the the new sash position. In the case of +sets the new sash position. In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING events, sets the new tracking bar position so visual feedback during dragging will represent that change that will actually take place. Set to -1 from diff --git a/docs/latex/wx/statusbr.tex b/docs/latex/wx/statusbr.tex index 0eb65bf927..a1d0f20dc0 100644 --- a/docs/latex/wx/statusbr.tex +++ b/docs/latex/wx/statusbr.tex @@ -198,7 +198,7 @@ Sets the text for one field. Sets the widths of the fields in the status line. There are two types of fields: fixed widths one and variable width fields. For the fixed width fields you should specify their (constant) width in pixels. For the variable width -fields, specify a negative number which indicates how should the field expand: +fields, specify a negative number which indicates how the field should expand: the space left for all variable width fields is divided between them according to the absolute value of this number. A variable width field with width of $-2$ gets twice as much of it as a field with width $-1$ and so on. @@ -215,7 +215,7 @@ time it was called.} \docparam{widths}{Contains an array of {\it n} integers, each of which is either an absolute status field width in pixels if positive or indicates a -variable width field if negative} +variable width field if negative.} \wxheading{Remarks} diff --git a/docs/latex/wx/tdate.tex b/docs/latex/wx/tdate.tex index 605f40cc1c..dfffeaa98a 100644 --- a/docs/latex/wx/tdate.tex +++ b/docs/latex/wx/tdate.tex @@ -37,7 +37,7 @@ them is fast} There are 3 main classes declared in {\tt }: except \helpref{wxDateTime}{wxdatetime} itself which represents an absolute moment in time, there are also two classes - -\helpref{wxTimeSpan}{wxtimespan} and \helpref{wxDateSpan}{wxdatespan} which +\helpref{wxTimeSpan}{wxtimespan} and \helpref{wxDateSpan}{wxdatespan} - which represent the intervals of time. There are also helper classes which are used together with wxDateTime: diff --git a/docs/latex/wx/tdb.tex b/docs/latex/wx/tdb.tex index 9319c7d775..71a470d202 100644 --- a/docs/latex/wx/tdb.tex +++ b/docs/latex/wx/tdb.tex @@ -835,9 +835,9 @@ they also needed to take in to account different database manufacturers and different ODBC driver manufacturers. Because of all the possible combinations of OS/database/drivers, it is impossible to say that these classes will work perfectly with datasource ABC, ODBC driver XYZ, on platform LMN. You may run -in to some incompatibilities or unsupported features when moving your +into some incompatibilities or unsupported features when moving your application from one environment to another. But that is what makes -cross-platform programming fun. It is also pinpoints one of the great +cross-platform programming fun. It also pinpoints one of the great things about open source software. It can evolve! The most common difference between different database/ODBC driver diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index 6846abd8b9..0da0113a0f 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -461,7 +461,7 @@ comes from the program itself (for example, if SetValue() is called)} \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event, generated when enter is pressed in a text control (which must have wxTE\_PROCESS\_ENTER style for this event to be generated).} -\twocolitem{{\bf EVT\_TEXT\_URL(id, func)}}{A mouse event occured over an URL +\twocolitem{{\bf EVT\_TEXT\_URL(id, func)}}{A mouse event occurred over an URL in the text control (wxMSW and wxGTK2 only)} \twocolitem{{\bf EVT\_TEXT\_MAXLEN(id, func)}}{User tried to enter more text into the control than the limit set by @@ -634,7 +634,7 @@ Resets the internal `modified' flag as if the current edits had been saved. \func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}} This functions inserts into the control the character which would have been -inserted if the given key event had occured in the text control. The +inserted if the given key event had occurred in the text control. The {\it event} object should be the same as the one passed to {\tt EVT\_KEY\_DOWN} handler previously by wxWidgets. @@ -743,7 +743,7 @@ working with controls that contain large amounts of text. \constfunc{virtual wxString}{GetRange}{\param{long}{ from}, \param{long}{ to}} -Returns the string containing the text staring in the positions {\it from} and +Returns the string containing the text starting in the positions {\it from} and up to {\it to} in the control. The positions must have been returned by another wxTextCtrl method. @@ -799,7 +799,7 @@ support this function. \wxheading{Return value} -{\tt true} on success, {\tt false} if an error occured - it may also mean that +{\tt true} on success, {\tt false} if an error occurred - it may also mean that the styles are not supported under this platform. \wxheading{See also} @@ -853,6 +853,10 @@ read-only mode by a previous call to Returns {\tt true} if the text has been modified by user. Note that calling \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified. +\wxheading{See also} + +\helpref{MarkDirty}{wxtextctrlmarkdirty} + \membersection{wxTextCtrl::IsMultiLine}\label{wxtextctrlismultiline} @@ -923,6 +927,17 @@ Loads and displays the named file, if it exists. %% \helpref{wxKeyEvent}{wxkeyevent} +\membersection{wxTextCtrl::MarkDirty}\label{wxtextctrlmarkdirty} + +\func{void}{MarkDirty}{\void} + +Mark text as modified (dirty). + +\wxheading{See also} + +\helpref{IsModified}{wxtextctrlismodified} + + \membersection{wxTextCtrl::OnDropFiles}\label{wxtextctrlondropfiles} \func{void}{OnDropFiles}{\param{wxDropFilesEvent\& }{event}} @@ -1057,7 +1072,7 @@ wouldn't change it at all). \wxheading{Return value} -{\tt true} on success, {\tt false} if an error occured - may also mean that +{\tt true} on success, {\tt false} if an error occurred - may also mean that the styles are not supported under this platform. \wxheading{See also} @@ -1156,7 +1171,7 @@ not set, the corresponding attribute from \helpref{GetDefaultStyle()}{wxtextctrl \wxheading{Return value} -{\tt true} on success, {\tt false} if an error occured - it may also mean that +{\tt true} on success, {\tt false} if an error occurred - it may also mean that the styles are not supported under this platform. \wxheading{See also} diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex index 2bb0040d61..c139c6262a 100644 --- a/docs/latex/wx/textfile.tex +++ b/docs/latex/wx/textfile.tex @@ -7,11 +7,11 @@ native" line termination sequences - in fact, it can be also used to modify the text files and change the line termination characters from one type (say DOS) to another (say Unix). -One word of warning: the class is not at all optimized for big files and so it -will load the file entirely into memory when opened. Of course, you should not +One word of warning: the class is not at all optimized for big files and thus +it will load the file entirely into memory when opened. Of course, you should not work in this way with large files (as an estimation, anything over 1 Megabyte is surely too big for this class). On the other hand, it is not a serious -limitation for the small files like configuration files or programs sources +limitation for small files like configuration files or program sources which are well handled by wxTextFile. The typical things you may do with wxTextFile in order are: diff --git a/docs/latex/wx/ti18n.tex b/docs/latex/wx/ti18n.tex index a112b1e958..93a0c60d9a 100644 --- a/docs/latex/wx/ti18n.tex +++ b/docs/latex/wx/ti18n.tex @@ -9,13 +9,13 @@ facilities for message translation with its \helpref{wxLocale}{wxlocale} class and is itself fully translated into several languages. Please consult wxWidgets home page for the most up-to-date translations - and if you translate it into one of the languages not done -yet, your translations would be gratefully accepted for inclusion into the -future versions of the library! +yet, your translations would be gratefully accepted for inclusion into future +versions of the library! -The wxWidgets approach to i18n closely follows GNU gettext package. wxWidgets uses the +The wxWidgets approach to i18n closely follows the GNU gettext package. wxWidgets uses the message catalogs which are binary compatible with gettext catalogs and this allows to use all of the programs in this package to work with them. But note -that no additional libraries are needed during the run-time, however, so you +that no additional libraries are needed during run-time, however, so you have only the message catalogs to distribute and nothing else. During program development you will need the gettext package for @@ -80,5 +80,5 @@ See also \helpref{Writing non-English applications}{nonenglishoverview}. It focuses on handling charsets related problems. Finally, take a look at the \helpref{i18n sample}{sampleinternat} which shows -to you how all this looks in practice. +you how all this looks in practice. diff --git a/docs/latex/wx/tmbconv.tex b/docs/latex/wx/tmbconv.tex index 2a1ad1f348..4ef2750a27 100644 --- a/docs/latex/wx/tmbconv.tex +++ b/docs/latex/wx/tmbconv.tex @@ -52,7 +52,7 @@ literals). But often, your environment doesn't want Unicode strings. You could be sending data over a network, or processing a text file for some other application. You need a way to quickly convert your easily-handled Unicode data to and from a -traditional 8-bit-encoding. And this is what the wxMBConv classes do. +traditional 8-bit encoding. And this is what the wxMBConv classes do. \subsection{wxMBConv classes}\label{wxmbconvclasses} diff --git a/docs/latex/wx/treedata.tex b/docs/latex/wx/treedata.tex index 72553e6551..03d1f2c0e3 100644 --- a/docs/latex/wx/treedata.tex +++ b/docs/latex/wx/treedata.tex @@ -7,7 +7,7 @@ it means that the memory and any other resources associated with a tree item will be automatically freed when it is deleted. Note that we don't use wxObject as the base class for wxTreeItemData because the size of this class is critical: in many applications, each tree leaf will have wxTreeItemData -associated with it and number of leaves may be quite big. +associated with it and the number of leaves may be quite big. Also please note that because the objects of this class are deleted by the tree using the operator {\tt delete}, they must always be allocated on the heap diff --git a/docs/latex/wx/tunicode.tex b/docs/latex/wx/tunicode.tex index 831458bbed..880a3f8da9 100644 --- a/docs/latex/wx/tunicode.tex +++ b/docs/latex/wx/tunicode.tex @@ -121,7 +121,7 @@ In wxWidgets, the code fragment from above should be written instead: What happens here? First of all, you see that there are no more {\tt \#ifdef}s at all. Instead, we define some types and macros which behave differently in -the Unicode and ANSI builds and allows us to avoid using conditional +the Unicode and ANSI builds and allow us to avoid using conditional compilation in the program itself. We have a {\tt wxChar} type which maps either on {\tt char} or {\tt wchar\_t} diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index 7452671911..04caeb84ed 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -80,7 +80,7 @@ It can be one of these errors: \func{wxInputStream *}{GetInputStream}{\void} -Creates a new input stream on the the specified URL. You can use all but seek +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. diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index c307195d6e..f5d55bf74b 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1320,7 +1320,7 @@ method. {\bf GetWindowStyle()} is another name for the same function. \constfunc{wxWindowVariant}{GetWindowVariant}{\void} -Returns the value previous passed to +Returns the value previously passed to \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}. @@ -1485,12 +1485,12 @@ layout is on, this function gets called automatically when the window is resized \membersection{wxWindow::LineDown}\label{wxwindowlinedown} -This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$. +This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(1)$. \membersection{wxWindow::LineUp}\label{wxwindowlineup} -This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(-1)$. +This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$. \membersection{wxWindow::Lower}\label{wxwindowlower} diff --git a/docs/latex/wx/zipstrm.tex b/docs/latex/wx/zipstrm.tex index 998e75e47d..e60b07afd8 100644 --- a/docs/latex/wx/zipstrm.tex +++ b/docs/latex/wx/zipstrm.tex @@ -489,7 +489,7 @@ the current entry first. Returns the zip comment. -This is stored a the end of the zip, therefore when reading a zip +This is stored at the end of the zip, therefore when reading a zip from a non-seekable stream, it returns the empty string until the end of the zip has been reached, i.e. when GetNextEntry() returns NULL. diff --git a/docs/publicity/announce.txt b/docs/publicity/announce.txt index a9019698e8..b6f4517769 100644 --- a/docs/publicity/announce.txt +++ b/docs/publicity/announce.txt @@ -62,7 +62,7 @@ handlers for reading and writing many image types, resizeable panels and dialogs on all platforms, document/view, OpenGL support, HTML-based and context-sensitive help, wizards, drag and drop, a grid class, ODBC support, threads, sockets, container classes, -a styled text control, and much more. An 1800-page reference manual +a styled text control, and much more. A 1800-page reference manual is provided in HTML, MS HTML Help, WinHelp, wxWidgets Help and PDF formats, and there are over 80 samples and demos. diff --git a/include/wx/db.h b/include/wx/db.h index 9bd5f2ca00..827e35cdbc 100644 --- a/include/wx/db.h +++ b/include/wx/db.h @@ -26,7 +26,7 @@ #define _WX_DB_H_ -// BJO 20000503: introduce new GetColumns members which are more database independant and +// BJO 20000503: introduce new GetColumns members which are more database independent and // return columns in the order they were created #define OLD_GETCOLUMNS 1 #define EXPERIMENTAL_WXDB_FUNCTIONS 1 diff --git a/include/wx/fileconf.h b/include/wx/fileconf.h index 8a9e6d565a..5bb6b91fb1 100644 --- a/include/wx/fileconf.h +++ b/include/wx/fileconf.h @@ -89,7 +89,7 @@ in the entries it reads: for example, if you have an entry score_file = $HOME/.score a call to Read(&str, "score_file") will return a complete path to .score file - unless the expansion was previousle disabled with SetExpandEnvVars(false) call + unless the expansion was previously disabled with SetExpandEnvVars(false) call (it's on by default, the current status can be retrieved with IsExpandingEnvVars function). */ @@ -113,7 +113,7 @@ public: // Unix /etc/file.ext ~/.file // Win %windir%\file.ext %USERPROFILE%\file.ext // - // where file is the basename of szFile, ext is it's extension + // where file is the basename of szFile, ext is its extension // or .conf (Unix) or .ini (Win) if it has none static wxString GetGlobalFileName(const wxChar *szFile); static wxString GetLocalFileName(const wxChar *szFile); diff --git a/include/wx/filesys.h b/include/wx/filesys.h index a75350f724..99dba2e96c 100644 --- a/include/wx/filesys.h +++ b/include/wx/filesys.h @@ -186,7 +186,7 @@ public: wxString FindNext(); // Adds FS handler. - // In fact, this class is only front-end to the FS hanlers :-) + // In fact, this class is only front-end to the FS handlers :-) static void AddHandler(wxFileSystemHandler *handler); // remove all items from the m_Handlers list diff --git a/include/wx/listbox.h b/include/wx/listbox.h index 7c46b0cca5..e4931b0b5e 100644 --- a/include/wx/listbox.h +++ b/include/wx/listbox.h @@ -47,7 +47,7 @@ public: virtual ~wxListBoxBase(); // all generic methods are in wxControlWithItems, except for the following - // ones which are not yet implemented by wxChoice/wxCombobox + // ones which are not yet implemented by wxChoice/wxComboBox void Insert(const wxString& item, int pos) { DoInsert(item, pos); } void Insert(const wxString& item, int pos, void *clientData) diff --git a/include/wx/longlong.h b/include/wx/longlong.h index 5670a66fab..066f7a5b67 100644 --- a/include/wx/longlong.h +++ b/include/wx/longlong.h @@ -798,7 +798,7 @@ public: // post increment operator wxULongLongWx& operator++(int) { return ++(*this); } - // substraction + // subtraction wxLongLongWx operator-(const wxULongLongWx& ll) const; wxULongLongWx& operator-=(const wxULongLongWx& ll); diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h index 737ed87f21..25db858a02 100644 --- a/include/wx/xrc/xmlres.h +++ b/include/wx/xrc/xmlres.h @@ -369,7 +369,7 @@ protected: void AddWindowStyles(); // Gets style flags from text in form "flag | flag2| flag3 |..." - // Only understads flags added with AddStyle + // Only understands flags added with AddStyle int GetStyle(const wxString& param = wxT("style"), int defaults = 0); // Gets text from param and does some conversions: diff --git a/samples/xrc/myframe.cpp b/samples/xrc/myframe.cpp index 577997cc1e..a12311059e 100644 --- a/samples/xrc/myframe.cpp +++ b/samples/xrc/myframe.cpp @@ -123,7 +123,7 @@ MyFrame::MyFrame(wxWindow* parent) SetToolBar(wxXmlResource::Get()->LoadToolBar(this, wxT("main_toolbar"))); #if wxUSE_STATUSBAR - // Give the frame a optional statusbar. The '1' just means one field. + // Give the frame an optional statusbar. The '1' just means one field. // A gripsizer will automatically get put on into the corner, if that // is the normal OS behaviour for frames on that platform. Helptext // for menu items and toolbar tools will automatically get displayed @@ -172,7 +172,7 @@ void MyFrame::OnControlsToolOrMenuCommand(wxCommandEvent& WXUNUSED(event)) #if wxUSE_LISTCTRL // There is no data in the listctrl. This will add some columns - // and some data. You don't need use any pointers + // and some data. You don't need to use any pointers // at all to manipulate the controls, just simply use the XRCCTL(...) macros. // "controls_treectrl" is the name of this control in the XRC. // (1) Insert a column, with the column header of "Name" diff --git a/src/common/db.cpp b/src/common/db.cpp index ee2a47b16a..85d53a78f0 100644 --- a/src/common/db.cpp +++ b/src/common/db.cpp @@ -2861,7 +2861,7 @@ wxDbColInf *wxDb::GetColumns(const wxString &tableName, UWORD *numCols, const wx /* BJO 20000503 These are tentative new GetColumns members which should be more database - independant and which always returns the columns in the order they were + independent and which always returns the columns in the order they were created. - The first one (wxDbColInf *wxDb::GetColumns(wxChar *tableName[], const diff --git a/src/common/mediactrlcmn.cpp b/src/common/mediactrlcmn.cpp index 074777d486..fa89291316 100644 --- a/src/common/mediactrlcmn.cpp +++ b/src/common/mediactrlcmn.cpp @@ -226,7 +226,7 @@ bool wxMediaCtrl::DoCreate(wxClassInfo* classInfo, // of wxMediaBackend // // -// STL isn't compatable with and will have a compilation error +// STL isn't compatible with and will have a compilation error // on a wxNode, however, wxHashTable::compatibility_iterator is // incompatible with the old 2.4 stable version - but since // we're in 2.5 only we don't need to worry about this diff --git a/src/msw/listctrl.cpp b/src/msw/listctrl.cpp index c343501f9f..baf227794a 100644 --- a/src/msw/listctrl.cpp +++ b/src/msw/listctrl.cpp @@ -166,7 +166,7 @@ private: // // Solution: // Under MSW the only way to associate data with a List -// item independant of its position in the list is to +// item independent of its position in the list is to // store a pointer to it in its lParam attribute. However // user programs are already using this (via the // SetItemData() GetItemData() calls). diff --git a/src/os2/listctrl.cpp b/src/os2/listctrl.cpp index 701d27f3c8..366f156d73 100644 --- a/src/os2/listctrl.cpp +++ b/src/os2/listctrl.cpp @@ -116,7 +116,7 @@ typedef struct _MYRECORD // // Solution: // Under MSW the only way to associate data with a -// List item independant of its position in the list is to store a pointer +// List item independent of its position in the list is to store a pointer // to it in its lParam attribute. However user programs are already using // this (via the SetItemData() GetItemData() calls). // diff --git a/wxPython/docs/xml/wxPython-metadata.xml b/wxPython/docs/xml/wxPython-metadata.xml index 48ef3ad331..eb25717942 100644 --- a/wxPython/docs/xml/wxPython-metadata.xml +++ b/wxPython/docs/xml/wxPython-metadata.xml @@ -11369,7 +11369,7 @@ pixels from the begining of text to the coresponding character of *text*. The generic version simply builds a running total of the widths of each character using GetTextExtent, however if the various platforms have a native API function that is faster or more accurate -than the generic implementaiton then it will be used instead. +than the generic implementation then it will be used instead. diff --git a/wxPython/src/_dc.i b/wxPython/src/_dc.i index 64aa56c535..a220816d4b 100644 --- a/wxPython/src/_dc.i +++ b/wxPython/src/_dc.i @@ -577,7 +577,7 @@ pixels from the begining of text to the coresponding character of *text*. The generic version simply builds a running total of the widths of each character using GetTextExtent, however if the various platforms have a native API function that is faster or more accurate -than the generic implementaiton then it will be used instead.", ""); +than the generic implementation then it will be used instead.", ""); wxArrayInt GetPartialTextExtents(const wxString& text) { wxArrayInt widths; self->GetPartialTextExtents(text, widths); diff --git a/wxPython/src/gtk/_gdi.py b/wxPython/src/gtk/_gdi.py index 3473162461..7d4d700df8 100644 --- a/wxPython/src/gtk/_gdi.py +++ b/wxPython/src/gtk/_gdi.py @@ -3219,7 +3219,7 @@ class DC(_core.Object): *text*. The generic version simply builds a running total of the widths of each character using GetTextExtent, however if the various platforms have a native API function that is faster or more accurate - than the generic implementaiton then it will be used instead. + than the generic implementation then it will be used instead. """ return _gdi_.DC_GetPartialTextExtents(*args, **kwargs) diff --git a/wxPython/src/mac/_gdi.py b/wxPython/src/mac/_gdi.py index 59802f4027..55ae2364fc 100644 --- a/wxPython/src/mac/_gdi.py +++ b/wxPython/src/mac/_gdi.py @@ -3219,7 +3219,7 @@ class DC(_core.Object): *text*. The generic version simply builds a running total of the widths of each character using GetTextExtent, however if the various platforms have a native API function that is faster or more accurate - than the generic implementaiton then it will be used instead. + than the generic implementation then it will be used instead. """ return _gdi_.DC_GetPartialTextExtents(*args, **kwargs) diff --git a/wxPython/src/msw/_gdi.py b/wxPython/src/msw/_gdi.py index 44fd817962..016d34c4fe 100644 --- a/wxPython/src/msw/_gdi.py +++ b/wxPython/src/msw/_gdi.py @@ -3315,7 +3315,7 @@ class DC(_core.Object): *text*. The generic version simply builds a running total of the widths of each character using GetTextExtent, however if the various platforms have a native API function that is faster or more accurate - than the generic implementaiton then it will be used instead. + than the generic implementation then it will be used instead. """ return _gdi_.DC_GetPartialTextExtents(*args, **kwargs) -- 2.45.2