* Docs fixes, wxStream overview enabled (all docs should compile now)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1922 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -83,14 +83,14 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip
|
||||
|
||||
\membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
|
||||
|
||||
\func{bool}{GetData}{\param{wxDataObject&}{ data}}
|
||||
\func{bool}{GetData}{\param{wxDataObject\&}{ data}}
|
||||
|
||||
Call this function to fill {\it data} with data on the clipboard, if available in the required
|
||||
format. Returns TRUE on success.
|
||||
|
||||
\membersection{wxClipboard::IsSupported}\label{wxclipboardissupported}
|
||||
|
||||
\func{bool}{IsSupported}{\param{wxDataObject&}{ data}}
|
||||
\func{bool}{IsSupported}{\param{wxDataObject\&}{ data}}
|
||||
|
||||
Returns TRUE if the format of the given data object is available on the clipboard.
|
||||
|
||||
|
@@ -261,7 +261,7 @@ TRUE if the operation was successful.
|
||||
|
||||
\membersection{wxFile::Write}\label{wxfilewrites}
|
||||
|
||||
\func{bool}{Write}{\param{const wxString& }{s}}
|
||||
\func{bool}{Write}{\param{const wxString\& }{s}}
|
||||
|
||||
Writes the contents of the string to the file, returns TRUE on success.
|
||||
|
||||
|
@@ -97,7 +97,7 @@ The default value of the user name is "anonymous".
|
||||
\wxheading{Remark}
|
||||
|
||||
This parameter can be included in a URL if you want to use the URL manager.
|
||||
For example, you can use: "ftp://a_user:a_password@a.host:service/a_directory/a_file"
|
||||
For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file"
|
||||
to specify a user and a password.
|
||||
|
||||
\membersection{wxFTP::SetPassword}
|
||||
@@ -115,7 +115,7 @@ user name and the host name of the local machine from the system.
|
||||
\wxheading{Remark}
|
||||
|
||||
This parameter can be included in a URL if you want to use the URL manager.
|
||||
For example, you can use: "ftp://a\_user:a\_password@a.host:service/a_directory/a\_file"
|
||||
For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file"
|
||||
to specify a user and a password.
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
|
@@ -42,10 +42,10 @@ to be reestablished: but you don't have to take care of this wxHTTP reestablishe
|
||||
|
||||
\membersection{wxHTTP::SetHeader}
|
||||
|
||||
\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h_data}}
|
||||
\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}}
|
||||
|
||||
It sets data of a field to be sent during the next request to the HTTP server. The field
|
||||
name is specified by \it{header} and the content by \it{h_data}.
|
||||
name is specified by \it{header} and the content by \it{h\_data}.
|
||||
This is a low level function and it assumes that you know what you are doing.
|
||||
|
||||
\membersection{wxHTTP::SetHeader}
|
||||
|
@@ -74,7 +74,7 @@ The buffer absolutely needs to have at least the specified size.
|
||||
This function returns a reference on the current object, so the user can test
|
||||
any states of the stream right away.
|
||||
|
||||
\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}}
|
||||
\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}
|
||||
|
||||
Reads data from the input queue and stores it in the specified output stream.
|
||||
The data is read until an error is raised by one of the two streams.
|
||||
|
@@ -43,7 +43,7 @@ Returns the stream buffer associated with the output stream.
|
||||
|
||||
\membersection{wxOutputStream::LastWrite}
|
||||
|
||||
\constfunc{size_t}{LastWrite}{\void}
|
||||
\constfunc{size\_t}{LastWrite}{\void}
|
||||
|
||||
\membersection{wxOutputStream::PutC}
|
||||
|
||||
@@ -54,19 +54,19 @@ stream position.
|
||||
|
||||
\membersection{wxOutputStream::SeekO}
|
||||
|
||||
\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
|
||||
\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
|
||||
|
||||
Changes the stream current position.
|
||||
|
||||
\membersection{wxOutputStream::TellO}
|
||||
|
||||
\constfunc{off_t}{TellO}{\void}
|
||||
\constfunc{off\_t}{TellO}{\void}
|
||||
|
||||
Returns the current stream position.
|
||||
|
||||
\membersection{wxOutputStream::Write}
|
||||
|
||||
\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}}
|
||||
\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
|
||||
|
||||
Writes the specified amount of bytes using the data of \it{buffer}.
|
||||
\it{WARNING!} The buffer absolutely needs to have at least the specified size.
|
||||
@@ -74,7 +74,7 @@ Writes the specified amount of bytes using the data of \it{buffer}.
|
||||
This function returns a reference on the current object, so the user can test
|
||||
any states of the stream right away.
|
||||
|
||||
\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
|
||||
\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
|
||||
|
||||
Reads data from the specified input stream and stores them
|
||||
in the current stream. The data is read until an error is raised
|
||||
|
@@ -43,10 +43,10 @@ Destructor.
|
||||
This function returns the last error.
|
||||
\twocolwidtha{5cm}
|
||||
\begin{twocollist}\itemsep=0pt
|
||||
\twocolitem{{\bf wxStream_NOERROR}}{No error occured.}
|
||||
\twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.}
|
||||
\twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.}
|
||||
\twocolitem{{\bf wxStream_READ_ERR}}{A generic error occured on the last read call.}
|
||||
\twocolitem{{\bf wxStream\_NOERROR}}{No error occured.}
|
||||
\twocolitem{{\bf wxStream\_EOF}}{An End-Of-File occured.}
|
||||
\twocolitem{{\bf wxStream\_WRITE\_ERR}}{A generic error occured on the last write call.}
|
||||
\twocolitem{{\bf wxStream\_READ\_ERR}}{A generic error occured on the last read call.}
|
||||
\end{twocollist}
|
||||
|
||||
\membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
|
||||
|
@@ -75,7 +75,7 @@ Returns TRUE if the stream is initialized and ready.
|
||||
Creates a new file with \it{ofilename} name and initializes the stream in
|
||||
write-only mode.
|
||||
|
||||
\func{}{wxFileOutputStream}{\param{wxFile&}{ file}}
|
||||
\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
|
||||
|
||||
Initializes a file stream in write-only mode using the file I/O object \it{file}.
|
||||
|
||||
|
@@ -40,4 +40,5 @@ This chapter contains a selection of topic overviews.
|
||||
\input tthreads.tex
|
||||
\input tfile.tex
|
||||
\input ti18n.tex
|
||||
\input tstream.tex
|
||||
\input tusage.tex
|
||||
|
Reference in New Issue
Block a user