From e2cad352289dc34a33c8d6c4c0df6ecea3f7037a Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Sun, 31 Jan 1999 16:56:04 +0000 Subject: [PATCH] * Some more on streams. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1533 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/classes.tex | 1 + docs/latex/wx/strmext.tex | 180 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 181 insertions(+) create mode 100644 docs/latex/wx/strmext.tex diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 4d2263df39..b9f91ca60b 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -188,6 +188,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input strlist.tex \input stream.tex \input strmbase.tex +\input strmext.tex \input sysclevt.tex \input settings.tex \input tab.tex diff --git a/docs/latex/wx/strmext.tex b/docs/latex/wx/strmext.tex new file mode 100644 index 0000000000..a9d852de33 --- /dev/null +++ b/docs/latex/wx/strmext.tex @@ -0,0 +1,180 @@ +% ----------------------------------------------------------------------------- +% wxZlibInputStream +% ----------------------------------------------------------------------------- +\section{\class{wxZlibInputStream}} + +\wxheading{Derived from} + +\helpref{wxFilterInputStream}{wxfilterinputstream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer},\helpref{wxInputStream}{wxinputstream} + +\wxheading{Short description} +This stream uncompresses all data read from it, it uses the ``filtered'' +stream to get new compressed data. + +% ----------------------------------------------------------------------------- +% wxZlibOutputStream +% ----------------------------------------------------------------------------- +\section{\class{wxZlibOutputStream}} + +\wxheading{Derived from} + +\helpref{wxFilterOutputStream}{wxfilteroutputstream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer},\helpref{wxOutputStream}{woutputstream} + +\wxheading{Short description} +This stream compresses all data written to it and passed the compressed data +to the ``filtered'' stream. + +% ----------------------------------------------------------------------------- +% wxFileInputStream +% ----------------------------------------------------------------------------- +\section{\class{wxFileInputStream}}\label{wxfileinputstream} + +\wxheading{Derived from} + +\helpref{wxInputStream}{wxinputstream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer} + +% ---------- +% Members +% ---------- +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxFileInputStream::wxFileInputStream} + +\func{}{wxFileInputStream}{\param{const wxString&}{ ifileName}} + +Opens the specified file using its \it{ifilename} name in read-only mode. + +\func{}{wxFileInputStream}{\param{wxFile&}{ file}} + +Initializes a file stream in read-only mode using the file I/O object \it{file}. + +\func{}{wxFileInputStream}{\param{int}{ fd}}; + +Initializes a file stream in read-only mode using the specified file descriptor. + +\membersection{wxFileInputStream::\destruct{wxFileInputStream}} +\func{}{\destruct{wxFileInputStream}{\void} + +Destructor. + +\membersection{wxFileInputStream::Ok} +\constfunc{bool}{Ok}{\void} + +Returns TRUE if the stream is initialized and ready. + +% ----------------------------------------------------------------------------- +% wxFileOutputStream +% ----------------------------------------------------------------------------- +\section{\class{wxFileOutputStream}}\label{wxfileoutputstream} + +\wxheading{Derived from} + +\helpref{wxOutputStream}{wxoutputstream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer} + +% ---------- +% Members +% ---------- +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxFileOutputStream::wxFileOutputStream} + +\func{}{wxFileOutputStream}{\param{const wxString&}{ ofileName}} + +Creates a new file with \it{ofilename} name and initializes the stream in +write-only mode. + +\func{}{wxFileOutputStream}{\param{wxFile&}{ file}} +Initializes a file stream in write-only mode using the file I/O object \it{file}. + +\func{}{wxFileOutputStream}{\param{int}{ fd}} +Initializes a file stream in write-only mode using the file descriptor \it{fd}. + +\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}} +\func{}{\destruct{wxFileOutputStream}{\void} + +Destructor. + +\membersection{wxFileOutputStream::Ok} +\constfunc{bool}{Ok}{\void} + +Returns TRUE if the stream is initialized and ready. + +% ----------------------------------------------------------------------------- +% wxFileStream +% ----------------------------------------------------------------------------- +\section{\class{wxFileStream}} + +\wxheading{Derived from} + +\helpref{wxFileOutputStream}{wxFileOutputStream}, \helpref{wxFileInputStream}{wxfileinputstream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxFileStream::wxFileStream} + +\func{}{wxFileStream}{\param{const wxString&}{ iofileName}} + +Initializes a new file stream in read-write mode using the specified +\it{iofilename} name. + +% ----------------------------------------------------------------------------- +% wxSocketInputStream +% ----------------------------------------------------------------------------- +\section{\class{wxSocketInputStream}} + +\wxheading{Derived from} + +\helpref{wxInputStream}{wxinputStream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxSocketInputStream::wxSocketInputStream} +\func{}{wxSocketInputStream}{\param{wxSocketBase&}{ s}} + +Initializes a new read-only socket stream using the specified initialized +socket connection. + +% ----------------------------------------------------------------------------- +% wxSocketOutputStream +% ----------------------------------------------------------------------------- +\section{\class{wxSocketInputStream}} + +\wxheading{Derived from} + +\helpref{wxOutputStream}{wxoutputStream} + +\wxheading{See also} + +\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxSocketOutputStream::wxSocketOutputStream} +\func{}{wxSocketInputStream}{\param{wxSocketBase&}{ s}} + +Initializes a new write-only socket stream using the specified initialized +socket connection. -- 2.47.2