fix typo in Selecting() description (bug 1726270)

[wxWidgets.git] / docs / latex / wx / zipstrm.tex

diff --git a/docs/latex/wx/zipstrm.tex b/docs/latex/wx/zipstrm.tex
index c738495cbb3c96cfac20280074fed3c53dd56a42..f907245f175e3faa5596c295ecc4ed602dda3fc2 100644 (file)
--- a/docs/latex/wx/zipstrm.tex
+++ b/docs/latex/wx/zipstrm.tex
@@ -19,7 +19,7 @@ for details.
 \wxheading{See also}
 
 \helpref{Archive formats such as zip}{wxarc}\\
-\helpref{Generic archive programming}{wxarcgeneric}
+\helpref{Generic archive programming}{wxarcgeneric}\\
 \helpref{wxZipEntry}{wxzipentry}\\
 \helpref{wxZipInputStream}{wxzipinputstream}\\
 \helpref{wxZipOutputStream}{wxzipoutputstream}
@@ -433,6 +433,9 @@ the wxZipInputStream then returns the entry's data. Eof() becomes true
 after an attempt has been made to read past the end of the entry's data.
 When there are no more entries, GetNextEntry() returns NULL and sets Eof().
 
+Note that in general zip entries are not seekable, and
+wxZipInputStream::SeekI() always returns wxInvalidOffset.
+
 \wxheading{Derived from}
 
 \helpref{wxArchiveInputStream}{wxarchiveinputstream}
@@ -459,13 +462,22 @@ typedef wxZipEntry entry_type
 
 \func{}{wxZipInputStream}{\param{wxInputStream\& }{stream}, \param{wxMBConv\& }{conv = wxConvLocal}}
 
+\func{}{wxZipInputStream}{\param{wxInputStream*}{stream}, \param{wxMBConv\& }{conv = wxConvLocal}}
+
 Constructor. In a Unicode build the second parameter {\tt conv} is
 used to translate the filename and comment fields into Unicode. It has
 no effect on the stream's data.
 
+If the parent stream is passed as a pointer then the new filter stream
+takes ownership of it. If it is passed by reference then it does not.
+
 \func{}{wxZipInputStream}{\param{const wxString\& }{archive}, \param{const wxString\& }{file}}
 
-Compatibility constructor.
+Compatibility constructor (requires WXWIN\_COMPATIBILITY\_2\_6).
+
+When this constructor is used, an emulation of seeking is
+switched on for compatibility with previous versions. Note however,
+that it is deprecated.
 
 
 \membersection{wxZipInputStream::CloseEntry}\label{wxzipinputstreamcloseentry}
@@ -482,7 +494,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.
@@ -601,12 +613,17 @@ entry and begins the next.
 
 \func{}{wxZipOutputStream}{\param{wxOutputStream\& }{stream}, \param{int }{level = -1}, \param{wxMBConv\& }{conv = wxConvLocal}}
 
+\func{}{wxZipOutputStream}{\param{wxOutputStream*}{stream}, \param{int }{level = -1}, \param{wxMBConv\& }{conv = wxConvLocal}}
+
 Constructor. {\tt level} is the compression level to use.
 It can be a value between 0 and 9 or -1 to use the default value
 which currently is equivalent to 6.
 
+If the parent stream is passed as a pointer then the new filter stream
+takes ownership of it. If it is passed by reference then it does not.
+
 In a Unicode build the third parameter {\tt conv} is used to translate
-the filename and comment fields to Unicode. It has no effect on the
+the filename and comment fields to an 8-bit encoding. It has no effect on the
 stream's data.
 
 
@@ -622,7 +639,7 @@ writing the zip if it has not been called already.
 
 \func{bool}{Close}{\void}
 
-Finishes writing the zip, returning true if successfully.
+Finishes writing the zip, returning true if successful.
 Called by the destructor if not called explicitly.