X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/df467a9d7475917264cc5cffe68163effc50233c..78cd9c69eb3f4c158fe10ce49325d57ec05d1306:/docs/latex/wx/zipstrm.tex diff --git a/docs/latex/wx/zipstrm.tex b/docs/latex/wx/zipstrm.tex index 998e75e47d..7713a90a6d 100644 --- a/docs/latex/wx/zipstrm.tex +++ b/docs/latex/wx/zipstrm.tex @@ -10,16 +10,21 @@ for details. \wxheading{Derived from} -\helpref{wxArchiveClassFactory}{wxarchiveclassfactory} +\helpref{wxArchiveClassFactory}{wxarchiveclassfactory}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \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} @@ -36,12 +41,17 @@ Holds the meta-data for an entry in a zip. \wxheading{Derived from} -\helpref{wxArchiveEntry}{wxarchiveentry} +\helpref{wxArchiveEntry}{wxarchiveentry}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Data structures} Constants for \helpref{Get/SetMethod}{wxzipentrymethod}: @@ -438,12 +448,19 @@ wxZipInputStream::SeekI() always returns wxInvalidOffset. \wxheading{Derived from} -\helpref{wxArchiveInputStream}{wxarchiveinputstream} +\helpref{wxArchiveInputStream}{wxarchiveinputstream}\\ +\helpref{wxFilterInputStream}{wxfilterinputstream}\\ +\helpref{wxInputStream}{wxinputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Data structures} \begin{verbatim} typedef wxZipEntry entry_type @@ -462,13 +479,18 @@ 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, @@ -489,7 +511,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. @@ -555,6 +577,10 @@ No base class +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{Archives on non-seekable streams}{wxarcnoseek}\\ @@ -589,12 +615,19 @@ entry and begins the next. \wxheading{Derived from} -\helpref{wxArchiveOutputStream}{wxarchiveoutputstream} +\helpref{wxArchiveOutputStream}{wxarchiveoutputstream}\\ +\helpref{wxFilterOutputStream}{wxfilteroutputstream}\\ +\helpref{wxOutputStream}{wxoutputstream}\\ +\helpref{wxStreamBase}{wxstreambase} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{Archive formats such as zip}{wxarc}\\ @@ -608,12 +641,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. @@ -629,7 +667,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.