]> git.saurik.com Git - wxWidgets.git/commitdiff
* Some more on streams.
authorGuilhem Lavaux <lavaux@easynet.fr>
Sun, 31 Jan 1999 16:56:04 +0000 (16:56 +0000)
committerGuilhem Lavaux <lavaux@easynet.fr>
Sun, 31 Jan 1999 16:56:04 +0000 (16:56 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1533 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/classes.tex
docs/latex/wx/strmext.tex [new file with mode: 0644]

index 4d2263df39d9a4168c2ee1b96fd719e7a40a4b85..b9f91ca60bff29a4c8976683430383723fa400c2 100644 (file)
@@ -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 (file)
index 0000000..a9d852d
--- /dev/null
@@ -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.