docs/latex/wx/strmext.tex

   1 % -----------------------------------------------------------------------------
   2 % wxZlibInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxZlibInputStream}}
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxFilterInputStream}{wxfilterinputstream}
   9
  10 \wxheading{See also}
  11
  12 \helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxInputStream}{wxinputstream}
  13
  14 \wxheading{Short description}
  15
  16 This stream uncompresses all data read from it. It uses the ``filtered''
  17 stream to get new compressed data.
  18
  19 % -----------------------------------------------------------------------------
  20 % wxZlibOutputStream
  21 % -----------------------------------------------------------------------------
  22 \section{\class{wxZlibOutputStream}}
  23
  24 \wxheading{Derived from}
  25
  26 \helpref{wxFilterOutputStream}{wxfilteroutputstream}
  27
  28 \wxheading{See also}
  29
  30 \helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxOutputStream}{woutputstream}
  31
  32 \wxheading{Short description}
  33
  34 This stream compresses all data written to it and passed the compressed data
  35 to the ``filtered'' stream.
  36
  37 % -----------------------------------------------------------------------------
  38 % wxFileInputStream
  39 % -----------------------------------------------------------------------------
  40 \section{\class{wxFileInputStream}}\label{wxfileinputstream}
  41
  42 \wxheading{Derived from}
  43
  44 \helpref{wxInputStream}{wxinputstream}
  45
  46 \wxheading{See also}
  47
  48 \helpref{wxStreamBuffer}{wxstreamBuffer}
  49
  50 % ----------
  51 % Members
  52 % ----------
  53 \latexignore{\rtfignore{\wxheading{Members}}}
  54
  55 \membersection{wxFileInputStream::wxFileInputStream}
  56
  57 \func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
  58
  59 Opens the specified file using its \it{ifilename} name in read-only mode.
  60
  61 \func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
  62
  63 Initializes a file stream in read-only mode using the file I/O object \it{file}.
  64
  65 \func{}{wxFileInputStream}{\param{int}{ fd}}
  66
  67 Initializes a file stream in read-only mode using the specified file descriptor.
  68
  69 \membersection{wxFileInputStream::\destruct{wxFileInputStream}}
  70
  71 \func{}{\destruct{wxFileInputStream}}{\void}
  72
  73 Destructor.
  74
  75 \membersection{wxFileInputStream::Ok}
  76
  77 \constfunc{bool}{Ok}{\void}
  78
  79 Returns TRUE if the stream is initialized and ready.
  80
  81 % -----------------------------------------------------------------------------
  82 % wxFileOutputStream
  83 % -----------------------------------------------------------------------------
  84 \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
  85
  86 \wxheading{Derived from}
  87
  88 \helpref{wxOutputStream}{wxoutputstream}
  89
  90 \wxheading{See also}
  91
  92 \helpref{wxStreamBuffer}{wxstreamBuffer}
  93
  94 % ----------
  95 % Members
  96 % ----------
  97 \latexignore{\rtfignore{\wxheading{Members}}}
  98
  99 \membersection{wxFileOutputStream::wxFileOutputStream}
 100
 101 \func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
 102
 103 Creates a new file with \it{ofilename} name and initializes the stream in
 104 write-only mode.
 105
 106 \func{}{wxFileOutputStream}{\param{wxFile&}{ file}}
 107
 108 Initializes a file stream in write-only mode using the file I/O object \it{file}.
 109
 110 \func{}{wxFileOutputStream}{\param{int}{ fd}}
 111
 112 Initializes a file stream in write-only mode using the file descriptor \it{fd}.
 113
 114 \membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
 115
 116 \func{}{\destruct{wxFileOutputStream}}{\void}
 117
 118 Destructor.
 119
 120 \membersection{wxFileOutputStream::Ok}
 121
 122 \constfunc{bool}{Ok}{\void}
 123
 124 Returns TRUE if the stream is initialized and ready.
 125
 126 % -----------------------------------------------------------------------------
 127 % wxFileStream
 128 % -----------------------------------------------------------------------------
 129 \section{\class{wxFileStream}}
 130
 131 \wxheading{Derived from}
 132
 133 \helpref{wxFileOutputStream}{wxFileOutputStream}, \helpref{wxFileInputStream}{wxfileinputstream}
 134
 135 \wxheading{See also}
 136
 137 \helpref{wxStreamBuffer}{wxstreamBuffer}
 138
 139 \latexignore{\rtfignore{\wxheading{Members}}}
 140
 141 \membersection{wxFileStream::wxFileStream}
 142
 143 \func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
 144
 145 Initializes a new file stream in read-write mode using the specified
 146 \it{iofilename} name.
 147
 148 % -----------------------------------------------------------------------------
 149 % wxSocketInputStream
 150 % -----------------------------------------------------------------------------
 151 \section{\class{wxSocketInputStream}}
 152
 153 \wxheading{Derived from}
 154
 155 \helpref{wxInputStream}{wxinputStream}
 156
 157 \wxheading{See also}
 158
 159 \helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase}
 160
 161 \latexignore{\rtfignore{\wxheading{Members}}}
 162
 163 \membersection{wxSocketInputStream::wxSocketInputStream}
 164
 165 \func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}
 166
 167 Initializes a new read-only socket stream using the specified initialized
 168 socket connection.
 169
 170 % -----------------------------------------------------------------------------
 171 % wxSocketOutputStream
 172 % -----------------------------------------------------------------------------
 173 \section{\class{wxSocketInputStream}}
 174
 175 \wxheading{Derived from}
 176
 177 \helpref{wxOutputStream}{wxoutputStream}
 178
 179 \wxheading{See also}
 180
 181 \helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase}
 182
 183 \latexignore{\rtfignore{\wxheading{Members}}}
 184
 185 \membersection{wxSocketOutputStream::wxSocketOutputStream}
 186
 187 \func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}
 188
 189 Initializes a new write-only socket stream using the specified initialized
 190 socket connection.
 191