second merge of the 2.2 branch (RL)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@7973 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/cmdevent.tex

@@ -36,7 +36,9 @@ which is generated by a wxListBox control.}
 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED command,
 which is generated by a wxTextCtrl control.}
 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_ENTER command,
-which is generated by a wxTextCtrl control.}
+which is generated by a wxTextCtrl control. Note that you must use
+wxTE\_PROCESS\_ENTER flag when creating the control if you want it to generate
+such events.}
 \twocolitem{{\bf EVT\_MENU(id, func)}}{Process a wxEVT\_COMMAND\_MENU\_SELECTED command,
 which is generated by a menu item.}
 \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_MENU\_RANGE command,
@@ -117,16 +119,16 @@ Constructor.
 
 \membersection{wxCommandEvent::Checked}
 
-\func{bool}{Checked}{\void}
+\constfunc{bool}{Checked}{\void}
 
-Returns TRUE or FALSE for a checkbox selection event.
+Deprecated, use \helpref{IsChecked}{wxcommandeventischecked} instead.
 
 \membersection{wxCommandEvent::GetClientData}
 
 \func{void*}{GetClientData}{\void}
 
 Returns client data pointer for a listbox or choice selection event
-(not valid for a deselection). Beware, this is not implmented anywhere...
+(not valid for a deselection).
 
 \membersection{wxCommandEvent::GetExtraLong}
 
@@ -154,6 +156,16 @@ a deselection).
 Returns item string for a listbox or choice selection event (not valid for
 a deselection).
 
+\membersection{wxCommandEvent::IsChecked}\label{wxcommandeventischecked}
+
+\constfunc{bool}{IsChecked}{\void}
+
+This method can be used with checkbox and menu events: for the checkboxes, the
+method returns {\tt TRUE} for a selection event and {\tt FALSE} for a
+deselection one. For the menu events, this method indicates if the menu item
+just has become checked or unchecked (and thus only makes sense for checkable
+menu items).
+
 \membersection{wxCommandEvent::IsSelection}
 
 \func{bool}{IsSelection}{\void}

docs/latex/wx/combobox.tex

@@ -23,8 +23,9 @@ A combobox permits a single selection only. Combobox items are numbered from zer
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxCB\_SIMPLE}}{Creates a combobox with a permanently displayed list. Windows only. }
 \twocolitem{\windowstyle{wxCB\_DROPDOWN}}{Creates a combobox with a drop-down list.}
-\twocolitem{\windowstyle{wxCB\_READONLY}}{Creates a combo box consisting of a drop-down list and static text item
-displaying the current selection.}
+\twocolitem{\windowstyle{wxCB\_READONLY}}{Same as wxCB\_DROPDOWN but only the
+strings specified as the combobox choices can be selected, it is impossible to
+select (even from a program) a string which is not in the choices list.}
 \twocolitem{\windowstyle{wxCB\_SORT}}{Sorts the entries in the list alphabetically.}
 \end{twocollist}
 
@@ -319,6 +320,9 @@ wxPython.}
 
 Sets the text for the combobox text field.
 
+{\bf NB:} For a combobox with {\tt wxCB\_READONLY} style the string must be in
+the combobox choices list, otherwise the call to SetValue() is ignored.
+
 \wxheading{Parameters}
 
 \docparam{text}{The text to set.}

docs/latex/wx/database.tex

@@ -3,9 +3,6 @@
 Every database object represents an ODBC connection.
 The connection may be closed and reopened.
 
-Note: this class is considered obsolete, replaced by the Remstar wxDB/wxTable classes
-(documented separately in Word and PDF format, as odbc.doc and odbc.pdf).
-
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -80,9 +77,9 @@ and disconnects from the current data source.
 
 Commits previous transactions. Not implemented.
 
-\membersection{wxDatabase::ErrorOccurred}
+\membersection{wxDatabase::ErrorOccured}
 
-\func{bool}{ErrorOccurred}{\void}
+\func{bool}{ErrorOccured}{\void}
 
 Returns TRUE if the last action caused an error.
 
@@ -90,7 +87,7 @@ Returns TRUE if the last action caused an error.
 
 \func{void}{ErrorSnapshot}{\param{HSTMT}{ statement = SQL\_NULL\_HSTMT}}
 
-This function will be called whenever an ODBC error occurred. It stores the
+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.
 

docs/latex/wx/gridwork.tex

@@ -0,0 +1,59 @@
+%
+% automatically generated by HelpGen from
+% grid.h at 11/May/00 18:30:18
+%
+
+
+\section{\class{wxGridCellWorker}}\label{wxgridcellworker}
+
+
+
+wxGridCellWorker: common base class for wxGridCellRenderer and
+wxGridCellEditor
+NB: this is more an implementation convenience than a design issue, so this
+class is not documented and is not public at all
+
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxGridCellWorker::wxGridCellWorker}\label{wxgridcellworkerwxgridcellworker}
+
+\func{}{wxGridCellWorker}{\void}
+
+
+\membersection{wxGridCellWorker::IncRef}\label{wxgridcellworkerincref}
+
+\func{void}{IncRef}{\void}
+
+this class is ref counted: it is created with ref count of 1, so
+calling DecRef() once will delete it. Calling IncRef() allows to lock
+it until the matching DecRef() is called
+
+
+\membersection{wxGridCellWorker::DecRef}\label{wxgridcellworkerdecref}
+
+\func{void}{DecRef}{\void}
+
+
+\membersection{wxGridCellWorker::SetParameters}\label{wxgridcellworkersetparameters}
+
+\func{void}{SetParameters}{\param{const wxString\& }{params}}
+
+interpret renderer parameters: arbitrary string whose interpretatin is
+left to the derived classes
+
+
+\membersection{wxGridCellWorker::\destruct{wxGridCellWorker}}\label{wxgridcellworkerdtor}
+
+\func{}{\destruct{wxGridCellWorker}}{\void}
+
+virtual dtor for any base class - private because only DecRef() can
+delete us
+

docs/latex/wx/image.tex

@@ -187,6 +187,10 @@ on program start-up to look up colors. This ensures a very fast conversion, but
 the image quality won't be perfect (and could be better for photo images using more
 sophisticated dithering algorithms).
 
+On Windows, if there is a palette present (set with SetPalette), it will be used when
+creating the wxBitmap (most useful in 8-bit display mode). On other platforms,
+the palette is currently ignored.
+
 \membersection{wxImage::Copy}\label{wximagecopy}
 
 \constfunc{wxImage}{Copy}{\void}
@@ -309,6 +313,15 @@ Gets the green value of the mask colour.
 
 Gets the red value of the mask colour.
 
+\membersection{wxImage::GetPalette}\label{wximagegetpalette}
+
+\constfunc{const wxPalette\&}{GetPalette}{\void}
+
+Returns the palette associated with the image. Currently the palette is only
+used in ConvertToBitmap under Windows.
+
+Eventually wxImage handlers will set the palette if one exists in the image file.
+
 \membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
 
 \constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}}
@@ -653,6 +666,12 @@ used, which is a number between 0 and 100 (0 is terrible, 100 is very good).
 \helpref{wxImage::GetOptionInt}{wximagegetoptionint},\rtfsp
 \helpref{wxImage::HasOption}{wximagehasoption}
 
+\membersection{wxImage::SetPalette}\label{wximagesetpalette}
+
+\func{void}{SetPalette}{\param{const wxPalette\&}{ palette}}
+
+Associates a palette with the image. Currently, the palette is not used.
+
 \membersection{wxImage::SetRGB}\label{wximagesetrgb}
 
 \func{void}{SetRGB}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{red}, \param{unsigned char }{green}, \param{unsigned char }{blue}}

docs/latex/wx/locale.tex

@@ -61,13 +61,6 @@ The destructor, like the constructor, also has global side effects: the previous
 set locale is restored and so the changes described in 
 \helpref{Init}{wxlocaleinit} documentation are rolled back.
 
-\membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
-
-\constfunc{const char*}{GetLocale}{\void}
-
-Returns the locale name as passed to the constructor or 
-\helpref{Init()}{wxlocaleinit}.
-
 \membersection{wxLocale::AddCatalog}\label{wxlocaleaddcatalog}
 
 \func{bool}{AddCatalog}{\param{const char }{*szDomain}}
@@ -93,6 +86,36 @@ looked up under prefix/<lang>/LC\_MESSAGES, prefix/LC\_MESSAGES and prefix
 
 This only applies to subsequent invocations of AddCatalog()!
 
+\membersection{wxLocale::GetLocale}\label{wxlocalegetlocale}
+
+\constfunc{const char*}{GetLocale}{\void}
+
+Returns the locale name as passed to the constructor or 
+\helpref{Init()}{wxlocaleinit}.
+
+\membersection{wxLocale::GetName}\label{wxlocalegetname}
+
+\constfunc{const wxString\&}{GetName}{\void}
+
+Returns the current short name for the locale (as given to the constructor or
+the Init() function).
+
+\membersection{wxLocale::GetString}\label{wxlocalegetstring}
+
+\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
+
+Retrieves the translation for a string in all loaded domains unless the szDomain
+parameter is specified (and then only this catalog/domain is searched).
+
+Returns original string if translation is not available
+(in this case an error message is generated the first time
+a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it).
+
+\wxheading{Remarks}
+
+Domains are searched in the last to first order, i.e. catalogs
+added later override those added before.
+
 \membersection{wxLocale::Init}\label{wxlocaleinit}
 
 \func{bool}{Init}{\param{const char }{*szName}, \param{const char }{*szShort = NULL}, \param{const char }{*szLocale = NULL}, \param{bool }{bLoadDefault = TRUE}}
@@ -129,26 +152,9 @@ normally corresponds to 'domain' which is more or less the application name.
 
 See also: \helpref{AddCatalog}{wxlocaleaddcatalog}
 
-\membersection{wxLocale::GetName}\label{wxlocalegetname}
+\membersection{wxLocale::IsOk}\label{wxlocaleisok}
 
-\constfunc{const wxString\&}{GetName}{\void}
+\constfunc{bool}{IsOk}{\void}
 
-Returns the current short name for the locale (as given to the constructor or
-the Init() function).
-
-\membersection{wxLocale::GetString}\label{wxlocalegetstring}
-
-\constfunc{const char*}{GetString}{\param{const char }{*szOrigString}, \param{const char }{*szDomain = NULL}}
-
-Retrieves the translation for a string in all loaded domains unless the szDomain
-parameter is specified (and then only this catalog/domain is searched).
-
-Returns original string if translation is not available
-(in this case an error message is generated the first time
-a string is not found; use \helpref{wxLogNull}{wxlogoverview} to suppress it).
-
-\wxheading{Remarks}
-
-Domains are searched in the last to first order, i.e. catalogs
-added later override those added before.
+Returns TRUE if the locale could be set successfully.
 

docs/latex/wx/spinbutt.tex

@@ -6,6 +6,9 @@ Portable programs should try to use \helpref{wxSpinCtrl}{wxspinctrl} instead
 as wxSpinButton is not implemented for all platforms (Win32 and GTK only
 currently).
 
+{\bf NB:} the range supported by this control (and wxSpinCtrl) depends on the
+platform but is at least {\tt SHRT\_MIN} to {\tt SHRT\_MAX}.
+
 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}\\

docs/latex/wx/tconstr.tex

@@ -2,8 +2,8 @@
 
 Classes: \helpref{wxLayoutConstraints}{wxlayoutconstraints}, \helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}.
 
-Objects of class wxLayoutConstraint can be associated with a window to define the
-way its subwindows are laid out, with respect to their siblings or parent.
+Objects of class wxLayoutConstraint can be associated with a window to define
+the way it is laid out, with respect to its siblings or the parent.
 
 The class consists of the following eight constraints of class wxIndividualLayoutConstraint,
 some or all of which should be accessed directly to set the appropriate
@@ -34,9 +34,12 @@ label).
 
 The constrains calculation is done in \helpref{wxWindow::Layout}{wxwindowlayout} 
 function which evaluates constraints. To call it you can either call
-wxWindow::SetAutoLayout to tell default OnSize handlers to call Layout
-automatically whenever the window size changes, or override OnSize and call Layout
-yourself.
+\helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} if the parent window
+is a frame, panel or a dialog to tell default OnSize handlers to call Layout
+automatically whenever the window size changes, or override OnSize and call
+Layout yourself (note that you do have to call 
+\helpref{Layout}{wxwindowlayout} yourself if the parent window is not a
+frame, panel or dialog).
 
 \subsection{Constraint layout: more detail}
 

docs/latex/wx/textfile.tex

@@ -189,10 +189,13 @@ allows more "iterator-like" traversal of the list of lines, i.e. you may
 write something like:
 
 \begin{verbatim}
-for ( str = GetFirstLine(); !Eof(); str = GetNextLine() )
+wxTextFile file;
+...
+for ( str = file.GetFirstLine(); !file.Eof(); str = file.GetNextLine() )
 {
     // do something with the current line in str
 }
+// do something with the last line in str
 \end{verbatim}
 
 \membersection{wxTextFile::GetNextLine}\label{wxtextfilegetnextline}
@@ -212,7 +215,21 @@ Gets the previous line in the file.
 
 \func{wxString\&}{GetLastLine}{\void}
 
-Gets the last line of the file.
+Gets the last line of the file. Together with 
+\helpref{GetPrevLine}{wxtextfilegetprevline} it allows to enumerate the lines
+in the file from the end to the beginning like this:
+
+\begin{verbatim}
+wxTextFile file;
+...
+for ( str = file.GetLastLine();
+      file.GetCurrentLine() > 0;
+      str = file.GetPrevLine() )
+{
+    // do something with the current line in str
+}
+// do something with the first line in str
+\end{verbatim}
 
 \membersection{wxTextFile::GetLineType}\label{wxtextfilegetlinetype}
 

docs/latex/wx/toolbar.tex

@@ -168,12 +168,16 @@ Adds a separator for spacing groups of tools.
 
 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
 
+\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
+\param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
+
 \func{wxToolBarTool*}{AddTool}{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp
 \param{long}{ xPos = -1}, \param{long}{ yPos = -1},\rtfsp
 \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
 
-Adds a tool to the toolbar.
+Adds a tool to the toolbar. The first (short and most commonly used) version
+adds a normal (and not a togglable) button without any associated client data.
 
 \wxheading{Parameters}
 

docs/latex/wx/upduievt.tex

@@ -19,7 +19,8 @@ functions that take a wxUpdateUIEvent argument.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_UPDATE\_UI(id, func)}}{Process a wxEVT\_UPDATE\_UI event.}
+\twocolitem{{\bf EVT\_UPDATE\_UI(id, func)}}{Process a wxEVT\_UPDATE\_UI event for the command with the given id.}
+\twocolitem{{\bf EVT\_UPDATE\_UI\_RANGE(id1, id2, func)}}{Process a wxEVT\_UPDATE\_UI event for any command with id included in the given range.}
 \end{twocollist}%
 
 \wxheading{Remarks}