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