From 7d2946d285c11f5cf187db418c2e6093100af7a7 Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Sun, 10 Jan 1999 20:14:07 +0000 Subject: [PATCH] * Socket doc update. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1364 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/classes.tex | 2 + docs/latex/wx/ftp.tex | 95 ++++++++++++++++++++++++++++++++++++++ docs/latex/wx/protocol.tex | 82 ++++++++++++++++++++++++++++++++ docs/latex/wx/url.tex | 6 ++- 4 files changed, 183 insertions(+), 2 deletions(-) create mode 100644 docs/latex/wx/ftp.tex create mode 100644 docs/latex/wx/protocol.tex diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index e7eded49ff..3e0b6cbc0e 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -87,6 +87,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input fontdlg.tex \input fontlist.tex \input frame.tex +\input ftp.tex \input gauge.tex \input gdiobj.tex \input grid.tex @@ -142,6 +143,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$ \input print.tex \input process.tex \input procevt.tex +\input protocol.tex \input query.tex \input qylayevt.tex \input radiobox.tex diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex new file mode 100644 index 0000000000..11fce8e931 --- /dev/null +++ b/docs/latex/wx/ftp.tex @@ -0,0 +1,95 @@ +\section{\class{wxFTP}}\label{wxftp} + +\wxheading{Derived from} + +\helpref{wxProtocol}{wxprotocol} + +\wxheading{See also} + +\helpref{wxSocketBase}{wxsocketbase} + +% ---------------------------------------------------------------------------- +% Members +% ---------------------------------------------------------------------------- + +\latexignore{\rtfignore{\membersection{Members}}} + +\membersection{wxFTP::SendCommand} + +\func{bool}{SendCommand}{\param{const wxString\&}{command}, \param{char }{ret}} + +Send the specified \it{command} to the FTP server. \it{ret} specifies +the expected result. + +\wxheading{Return value} + +TRUE, if the command has been sent successfully, else FALSE. + +% ---------------------------------------------------------------------------- + +\membersection{wxFTP::GetLastResult} + +\func{const wxString\&}{GetLastResult}{\void} + +Returns the last command result. + +% ---------------------------------------------------------------------------- + +\membersection{wxFTP::ChDir} + +\func{bool}{ChDir}{\param{const wxString\&}{dir}} + +Change the current FTP working directory. +Returns TRUE, if successful. + +\membersection{wxFTP::MkDir} + +\func{bool}{MkDir}{\param{const wxString\&}{dir}} + +Create the specified directory in the current FTP working directory. +Returns TRUE, if successful. + +\membersection{wxFTP::RmDir} + +\func{bool}{RmDir}{\param{const wxString\&}{dir}} + +Remove the specified directory from the current FTP working directory. +Returns TRUE, if successful. + +\membersection{wxFTP::Pwd} + +\func{wxString}{Pwd}{\void} + +Returns the current FTP working directory. + +% ---------------------------------------------------------------------------- + +\membersection{wxFTP::Rename} + +\func{bool}{Rename}{\param{const wxString\&}{src}, \param{const wxString\&}{dst}} + +Rename the specified \it{src} element into \it{dst} +Returns TRUE, if successful. + +% ---------------------------------------------------------------------------- + +\membersection{wxFTP::RmFile} + +\func{bool}{RmFile}{\param{const wxString\&}{path}} + +Delete the file specified by \it{path}. +Returns TRUE, if successful. + +% ---------------------------------------------------------------------------- + +\membersection{wxFTP::GetOutputStream} + +\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{file}} + +Initializes an output stream to the specified \it{file}. The returned +stream has all but seek functionality of wxStreams. When the user finishes +writing data, he has to delete the stream to close it. + +\wxheading{Return value} + +An initialized write-only stream. diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex new file mode 100644 index 0000000000..7cf0aed0c1 --- /dev/null +++ b/docs/latex/wx/protocol.tex @@ -0,0 +1,82 @@ +\section{\class{wxProtocol}}\label{wxprotocol} + +\wxheading{Derived from} + +\helpref{wxSocketClient}{wxsocketclient} + +\wxheading{See also} + +\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl} + +% ---------------------------------------------------------------------------- +% Members +% ---------------------------------------------------------------------------- + +\latexignore{\rtfignore{\membersection{Members}}} + +\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} + +\func{bool}{Reconnect}{\void} + +Tries to reestablish a previous opened connection (close and renegotiate connection). + +\wxheading{Return value} + +TRUE, if the connection is established, else FALSE. + +% ---------------------------------------------------------------------------- + +\membersection{wxProtocol::GetInputStream}\label{wxprotogetinput} + +\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} + +Creates a new input stream on the the specified path. You can use all but seek +functionnality of wxStream. Seek isn't available on all stream. For example, +http or ftp streams doesn't deal with it. + +\wxheading{Return value} + +Returns the initialized stream. You will have to delete it yourself. + +% ---------------------------------------------------------------------------- + +\membersection{wxProtocol::Abort}\label{wxprotoabort} + +\func{bool }{Abort}{\void} + +Abort the current stream. +\it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.} + +\wxheading{Return value} + +Returns TRUE, if successful, else FALSE. + +% ---------------------------------------------------------------------------- + +\membersection{wxProtocol::GetError} + +\func{wxProtocolError }{GetError}{\void} + +Returns the last occured error. + +% ---------------------------------------------------------------------------- + +\membersection{wxProtocol::GetContentType} + +\func{wxString }{GetContentType}{\void} + +Returns the type of the content of the last opened stream. It is a mime-type. + +% ---------------------------------------------------------------------------- + +\membersection{wxProtocol::SetUser} + +\func{void }{SetUser}{\param{const wxString\&}{ user}} + +Sets the authentication user. It is mainly useful when FTP is used. + +\membersection{wxProtocol::SetPassword} + +\func{void }{SetPassword}{\param{const wxString\&}{ user}} + +Sets the authentication password. It is mainly useful when FTP is used. diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index dcd6399e90..bc3fe3f15b 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -76,11 +76,13 @@ It can be one of these errors: \func{wxInputStream *}{GetInputStream}{\void} -Initializes the protocol and opens the input stream. +Creates a new input stream on the the specified URL. You can use all but seek +functionnality of wxStream. Seek isn't available on all stream. For example, +http or ftp streams doesn't deal with it. \wxheading{Return value} -It returns a read-only wxStream. +Returns the initialized stream. You will have to delete it yourself. \wxheading{See also}