Latex updates; added defines to printdlg.h for referring to generic print dialogs
by standard names. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@811 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -177,6 +177,7 @@ An event object contains information about a specific event. Event handlers
|
|||||||
\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event}
|
\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event}
|
||||||
%\twocolitem{\helpref{wxSessionEvent}{wxsessionevent}}{A session ending event}
|
%\twocolitem{\helpref{wxSessionEvent}{wxsessionevent}}{A session ending event}
|
||||||
\twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
|
\twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
|
||||||
|
\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
|
||||||
\twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
|
\twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
|
||||||
\twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event}
|
\twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event}
|
||||||
\twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}
|
\twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}
|
||||||
@@ -239,6 +240,7 @@ classes, functions and macros.
|
|||||||
\begin{twocollist}\itemsep=0pt
|
\begin{twocollist}\itemsep=0pt
|
||||||
\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides various debugging facilities}
|
\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides various debugging facilities}
|
||||||
\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream}
|
\twocolitem{\helpref{wxDebugStreamBuf}{wxdebugstreambuf}}{A stream buffer writing to the debug stream}
|
||||||
|
\twocolitem{\helpref{wxLog}{wxlog}}{Logging facility}
|
||||||
\twocolitem{\helpref{wxObject}{wxobject}}{Provides optional debugging versions of {\bf new} and {\bf delete}}
|
\twocolitem{\helpref{wxObject}{wxobject}}{Provides optional debugging versions of {\bf new} and {\bf delete}}
|
||||||
\twocolitem{\helpref{wxTrace}{wxtrace}}{Tracing facility}
|
\twocolitem{\helpref{wxTrace}{wxtrace}}{Tracing facility}
|
||||||
\twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels}
|
\twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels}
|
||||||
@@ -258,6 +260,9 @@ based on DDE.
|
|||||||
\twocolitem{\helpref{wxDDEClient}{wxddeclient}}{Represents a client}
|
\twocolitem{\helpref{wxDDEClient}{wxddeclient}}{Represents a client}
|
||||||
\twocolitem{\helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server}
|
\twocolitem{\helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server}
|
||||||
\twocolitem{\helpref{wxDDEServer}{wxddeserver}}{Represents a server}
|
\twocolitem{\helpref{wxDDEServer}{wxddeserver}}{Represents a server}
|
||||||
|
\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}
|
||||||
|
\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
|
||||||
|
\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}
|
||||||
\end{twocollist}
|
\end{twocollist}
|
||||||
|
|
||||||
{\large {\bf Document/view framework}}
|
{\large {\bf Document/view framework}}
|
||||||
|
@@ -34,7 +34,7 @@ of messages.
|
|||||||
|
|
||||||
\helpref{OnLog}{wxlogonlog}\\
|
\helpref{OnLog}{wxlogonlog}\\
|
||||||
\helpref{GetActiveTarget}{wxloggetactivetarget}\\
|
\helpref{GetActiveTarget}{wxloggetactivetarget}\\
|
||||||
\helpref{SetActiveTarget}{wxsetactivetarget}\\
|
\helpref{SetActiveTarget}{wxlogsetactivetarget}\\
|
||||||
\helpref{DontCreateOnDemand}{wxlogdontcreateondemand}
|
\helpref{DontCreateOnDemand}{wxlogdontcreateondemand}
|
||||||
|
|
||||||
\membersection{Message buffering}
|
\membersection{Message buffering}
|
||||||
@@ -50,7 +50,7 @@ verify it.
|
|||||||
\helpref{Flush}{wxlogflush}\\
|
\helpref{Flush}{wxlogflush}\\
|
||||||
\helpref{HasPendingMessages}{haspendingmessages}
|
\helpref{HasPendingMessages}{haspendingmessages}
|
||||||
|
|
||||||
\membersection{Customization}{wxlogcustomization}
|
\membersection{Customization}\label{wxlogcustomization}
|
||||||
|
|
||||||
The functions below allow some limited customization of wxLog behaviour
|
The functions below allow some limited customization of wxLog behaviour
|
||||||
without writing a new log target class (which, aside of being a matter of
|
without writing a new log target class (which, aside of being a matter of
|
||||||
@@ -62,6 +62,7 @@ shown to the user because they present little interest, but may be activated,
|
|||||||
for example, in order to help the user find some program problem.
|
for example, in order to help the user find some program problem.
|
||||||
|
|
||||||
As for the (real) trace messages, they come in different kinds:
|
As for the (real) trace messages, they come in different kinds:
|
||||||
|
|
||||||
\begin{itemize}\itemsep=0pt
|
\begin{itemize}\itemsep=0pt
|
||||||
\item{wxTraceMemAlloc} for the messages about creating and deleting objects
|
\item{wxTraceMemAlloc} for the messages about creating and deleting objects
|
||||||
\item{wxTraceMessages} for tracing the windowing system messages/events
|
\item{wxTraceMessages} for tracing the windowing system messages/events
|
||||||
@@ -130,34 +131,34 @@ previous active log target (may be NULL).
|
|||||||
Instructs wxLog to not create new log targets on the fly if there is none
|
Instructs wxLog to not create new log targets on the fly if there is none
|
||||||
currently. (Almost) for internal use only.
|
currently. (Almost) for internal use only.
|
||||||
|
|
||||||
\membersection{wxLog::Flush}{wxlogflush}
|
\membersection{wxLog::Flush}\label{wxlogflush}
|
||||||
|
|
||||||
\func{virtual void}{Flush}{\void}
|
\func{virtual void}{Flush}{\void}
|
||||||
|
|
||||||
Shows all the messages currently in buffer and clears it. If the buffer
|
Shows all the messages currently in buffer and clears it. If the buffer
|
||||||
is already empty, nothing happens.
|
is already empty, nothing happens.
|
||||||
|
|
||||||
\membersection{wxLog::HasPendingMessages}{haspendingmessages}
|
\membersection{wxLog::HasPendingMessages}\label{haspendingmessages}
|
||||||
|
|
||||||
\constfunc{bool}{HasPendingMessages}{\void}
|
\constfunc{bool}{HasPendingMessages}{\void}
|
||||||
|
|
||||||
Returns true if there are any messages in the buffer (not yet shown to the
|
Returns true if there are any messages in the buffer (not yet shown to the
|
||||||
user). (Almost) for internal use only.
|
user). (Almost) for internal use only.
|
||||||
|
|
||||||
\membersection{wxLog::SetVerbose}{wxlogsetverbose}
|
\membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
|
||||||
|
|
||||||
\func{void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
|
\func{void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
|
||||||
|
|
||||||
Activates or desactivates verbose mode in which the verbose messages are
|
Activates or desactivates verbose mode in which the verbose messages are
|
||||||
logged as the normal ones instead of being silently dropped.
|
logged as the normal ones instead of being silently dropped.
|
||||||
|
|
||||||
\membersection{wxLog::GetVerbose}{wxloggetverbose}
|
\membersection{wxLog::GetVerbose}\label{wxloggetverbose}
|
||||||
|
|
||||||
\constfunc{bool}{GetVerbose}{\void}
|
\constfunc{bool}{GetVerbose}{\void}
|
||||||
|
|
||||||
Returns whether the verbose mode is currently active.
|
Returns whether the verbose mode is currently active.
|
||||||
|
|
||||||
\membersection{wxLog::SetTimeStampFormat}{wxlogsettimestampformat}
|
\membersection{wxLog::SetTimeStampFormat}\label{wxlogsettimestampformat}
|
||||||
|
|
||||||
\func{void}{SetTimeStampFormat}{\param{const char * }{ format}}
|
\func{void}{SetTimeStampFormat}{\param{const char * }{ format}}
|
||||||
|
|
||||||
@@ -166,20 +167,20 @@ messages. The string may contain any normal characters as well as \%
|
|||||||
prefixed format specificators, see {\it strftime()} manual for details.
|
prefixed format specificators, see {\it strftime()} manual for details.
|
||||||
Passing an empty string to this function disables message timestamping.
|
Passing an empty string to this function disables message timestamping.
|
||||||
|
|
||||||
\membersection{wxLog::GetTimeStampFormat}{wxloggettimestampformat}
|
\membersection{wxLog::GetTimeStampFormat}\label{wxloggettimestampformat}
|
||||||
|
|
||||||
\constfunc{const char *}{GetTimeStampFormat}{\void}
|
\constfunc{const char *}{GetTimeStampFormat}{\void}
|
||||||
|
|
||||||
Returns the current timestamp format string.
|
Returns the current timestamp format string.
|
||||||
|
|
||||||
\membersection{wxLog::SetTraceMask}{wxlogsettracemask}
|
\membersection{wxLog::SetTraceMask}\label{wxlogsettracemask}
|
||||||
|
|
||||||
\func{static void}{SetTraceMask}{\param{wxTraceMask }{ mask}}
|
\func{static void}{SetTraceMask}{\param{wxTraceMask }{ mask}}
|
||||||
|
|
||||||
Sets the trace mask, see \helpref{Customization}{wxlogcustomization}
|
Sets the trace mask, see \helpref{Customization}{wxlogcustomization}
|
||||||
section for details.
|
section for details.
|
||||||
|
|
||||||
\membersection{wxLog::GetTraceMask}{wxloggettracemask}
|
\membersection{wxLog::GetTraceMask}\label{wxloggettracemask}
|
||||||
|
|
||||||
Returns the current trace mask, see \helpref{Customization}{wxlogcustomization}
|
Returns the current trace mask, see \helpref{Customization}{wxlogcustomization} section
|
||||||
section for details.
|
for details.
|
||||||
|
@@ -13,7 +13,7 @@ To process events from a socket, use the following event handler macro to direct
|
|||||||
input to member
|
input to member
|
||||||
functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
|
functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
|
||||||
|
|
||||||
\twocolwidtha{7cm}
|
\twocolwidtha{7cm}%
|
||||||
\begin{twocollist}\itemsep=0pt
|
\begin{twocollist}\itemsep=0pt
|
||||||
\twocolitem{{\bf EVT\_SOCKET(id, func)}}{A socket event occured.}
|
\twocolitem{{\bf EVT\_SOCKET(id, func)}}{A socket event occured.}
|
||||||
\end{twocollist}%
|
\end{twocollist}%
|
||||||
@@ -21,20 +21,17 @@ functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
|
|||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% See also ...
|
% See also ...
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketEvent}{wxsocketevent}
|
\helpref{wxSocketEvent}{wxsocketevent}, \helpref{wxSocketClient}{wxsocketclient}, \helpref{wxSocketServer}{wxsocketserver}
|
||||||
\helpref{wxSocketClient}{wxsocketclient}
|
|
||||||
\helpref{wxSocketServer}{wxsocketserver}
|
|
||||||
|
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% Members
|
% Members
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||||
|
|
||||||
\membersection{wxSocketBase::wxSocketBase}
|
\membersection{wxSocketBase::wxSocketBase}
|
||||||
|
|
||||||
\func{}{wxSocketBase}{\void}
|
\func{}{wxSocketBase}{\void}
|
||||||
|
|
||||||
Default constructor but don't use it, you must use \helpref{wxSocketClient}{wxsocketclient}
|
Default constructor but don't use it, you must use \helpref{wxSocketClient}{wxsocketclient}
|
||||||
@@ -69,7 +66,7 @@ Returns TRUE if an error occured.
|
|||||||
|
|
||||||
Returns TRUE if the socket is connected.
|
Returns TRUE if the socket is connected.
|
||||||
|
|
||||||
\membersection{wxSocketBase::IsData}\label{wxsocketbaseerror}
|
\membersection{wxSocketBase::IsData}\label{wxsocketbaseisdata}
|
||||||
|
|
||||||
\constfunc{bool}{IsData}{\void}
|
\constfunc{bool}{IsData}{\void}
|
||||||
|
|
||||||
@@ -102,11 +99,9 @@ Returns an error in the errno format (see your C programmer's guide).
|
|||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% IO calls
|
% IO calls
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
%
|
%
|
||||||
% Peek
|
% Peek
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
|
\membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{Peek}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
|
\func{wxSocketBase\&}{Peek}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
|
||||||
@@ -117,21 +112,22 @@ doesn't delete it from the system socket in-queue.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{buffer}{Buffer where to put peeked data.}
|
\docparam{buffer}{Buffer where to put peeked data.}
|
||||||
|
|
||||||
\docparam{nbytes}{Number of bytes.}
|
\docparam{nbytes}{Number of bytes.}
|
||||||
|
|
||||||
\wxheading{Returns value}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns a reference to the current object.
|
Returns a reference to the current object.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Error}{wxsocketbaserror},
|
\helpref{wxSocketBase::Error}{wxsocketbaseerror},
|
||||||
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
||||||
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
||||||
|
|
||||||
%
|
%
|
||||||
% Read
|
% Read
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::Read}\label{wxsocketbaseread}
|
\membersection{wxSocketBase::Read}\label{wxsocketbaseread}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{Read}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
|
\func{wxSocketBase\&}{Read}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
|
||||||
@@ -141,21 +137,28 @@ This function reads a buffer of {\it nbytes} bytes from the socket.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{buffer}{Buffer where to put read data.}
|
\docparam{buffer}{Buffer where to put read data.}
|
||||||
|
|
||||||
\docparam{nbytes}{Number of bytes.}
|
\docparam{nbytes}{Number of bytes.}
|
||||||
|
|
||||||
\wxheading{Returns value}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns a reference to the current object.
|
Returns a reference to the current object.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Error}{wxsocketbaserror},
|
\helpref{wxSocketBase::Error}{wxsocketbaseerror},
|
||||||
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
||||||
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
||||||
|
|
||||||
|
\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
|
||||||
|
|
||||||
|
\func{void}{SetFlags}{\param{wxSockFlags}{ flags}}
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
%
|
%
|
||||||
% Read
|
% Read
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
|
\membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{Write}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
|
\func{wxSocketBase\&}{Write}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
|
||||||
@@ -165,21 +168,22 @@ This function writes a buffer of {\it nbytes} bytes from the socket.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{buffer}{Buffer where to get the data to write.}
|
\docparam{buffer}{Buffer where to get the data to write.}
|
||||||
|
|
||||||
\docparam{nbytes}{Number of bytes.}
|
\docparam{nbytes}{Number of bytes.}
|
||||||
|
|
||||||
\wxheading{Returns value}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns a reference to the current object.
|
Returns a reference to the current object.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Error}{wxsocketbaserror},
|
\helpref{wxSocketBase::Error}{wxsocketbaseerror},
|
||||||
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
||||||
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
||||||
|
|
||||||
%
|
%
|
||||||
% WriteMsg
|
% WriteMsg
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
|
\membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{WriteMsg}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
|
\func{wxSocketBase\&}{WriteMsg}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
|
||||||
@@ -191,22 +195,23 @@ the buffer. So a buffer sent with WriteMsg {\bf must} be read with ReadMsg.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{buffer}{Buffer where to put data peeked.}
|
\docparam{buffer}{Buffer where to put data peeked.}
|
||||||
|
|
||||||
\docparam{nbytes}{Number of bytes.}
|
\docparam{nbytes}{Number of bytes.}
|
||||||
|
|
||||||
\wxheading{Returns value}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns a reference to the current object.
|
Returns a reference to the current object.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Error}{wxsocketbaserror},
|
\helpref{wxSocketBase::Error}{wxsocketbaseerror},
|
||||||
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
||||||
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
|
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
|
||||||
\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
|
\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
|
||||||
|
|
||||||
%
|
%
|
||||||
% ReadMsg
|
% ReadMsg
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
|
\membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{ReadMsg}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
|
\func{wxSocketBase\&}{ReadMsg}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
|
||||||
@@ -218,22 +223,23 @@ bytes left. This function always wait for the buffer to be entirely filled.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{buffer}{Buffer where to put read data.}
|
\docparam{buffer}{Buffer where to put read data.}
|
||||||
|
|
||||||
\docparam{nbytes}{Number of bytes allocated for the buffer.}
|
\docparam{nbytes}{Number of bytes allocated for the buffer.}
|
||||||
|
|
||||||
\wxheading{Returns value}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns a reference to the current object.
|
Returns a reference to the current object.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Error}{wxsocketbaserror},
|
\helpref{wxSocketBase::Error}{wxsocketbaseerror},
|
||||||
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
||||||
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
|
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
|
||||||
\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
|
\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
|
||||||
|
|
||||||
%
|
%
|
||||||
% Unread
|
% Unread
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread}
|
\membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{UnRead}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
|
\func{wxSocketBase\&}{UnRead}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
|
||||||
@@ -245,21 +251,22 @@ It is useful for sockets because we can't seek it.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{buffer}{Buffer to be unread.}
|
\docparam{buffer}{Buffer to be unread.}
|
||||||
|
|
||||||
\docparam{nbytes}{Number of bytes.}
|
\docparam{nbytes}{Number of bytes.}
|
||||||
|
|
||||||
\wxheading{Returns value}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns a reference to the current object.
|
Returns a reference to the current object.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Error}{wxsocketbaserror},
|
\helpref{wxSocketBase::Error}{wxsocketbaseerror},
|
||||||
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
|
||||||
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
|
||||||
|
|
||||||
%
|
%
|
||||||
% Discard
|
% Discard
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
|
\membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
|
||||||
|
|
||||||
\func{wxSocketBase\&}{Discard}{\void}
|
\func{wxSocketBase\&}{Discard}{\void}
|
||||||
@@ -271,6 +278,7 @@ doesn't wait.
|
|||||||
% Wait functions
|
% Wait functions
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
\membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
|
\membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
|
||||||
|
|
||||||
\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
||||||
|
|
||||||
This function waits for an event: it could be an incoming byte, the possibility
|
This function waits for an event: it could be an incoming byte, the possibility
|
||||||
@@ -280,23 +288,24 @@ established connection.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
||||||
|
|
||||||
\docparam{microsecond}{Number of microseconds to wait.}
|
\docparam{microsecond}{Number of microseconds to wait.}
|
||||||
|
|
||||||
\wxheading{Return value:}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns TRUE if an event occured, FALSE if the timeout was reached.
|
Returns TRUE if an event occured, FALSE if the timeout was reached.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
|
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
|
||||||
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
|
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
|
||||||
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
||||||
|
|
||||||
%
|
%
|
||||||
% WaitForRead
|
% WaitForRead
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
|
\membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
|
||||||
|
|
||||||
\func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
\func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
||||||
|
|
||||||
This function waits for a read event.
|
This function waits for a read event.
|
||||||
@@ -304,23 +313,24 @@ This function waits for a read event.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
||||||
|
|
||||||
\docparam{microsecond}{Number of microseconds to wait.}
|
\docparam{microsecond}{Number of microseconds to wait.}
|
||||||
|
|
||||||
\wxheading{Return value:}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns TRUE if a byte arrived, FALSE if the timeout was reached.
|
Returns TRUE if a byte arrived, FALSE if the timeout was reached.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Wait}{wxsocketbasewait},
|
\helpref{wxSocketBase::Wait}{wxsocketbasewait},
|
||||||
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
|
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
|
||||||
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
||||||
|
|
||||||
%
|
%
|
||||||
% WaitForWrite
|
% WaitForWrite
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
|
\membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
|
||||||
|
|
||||||
\func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
\func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
||||||
|
|
||||||
This function waits for a write event.
|
This function waits for a write event.
|
||||||
@@ -328,23 +338,24 @@ This function waits for a write event.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
||||||
|
|
||||||
\docparam{microsecond}{Number of microseconds to wait.}
|
\docparam{microsecond}{Number of microseconds to wait.}
|
||||||
|
|
||||||
\wxheading{Return value:}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns TRUE if a write event occured, FALSE if the timeout was reached.
|
Returns TRUE if a write event occured, FALSE if the timeout was reached.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::Wait}{wxsocketbasewait},
|
\helpref{wxSocketBase::Wait}{wxsocketbasewait},
|
||||||
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
|
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
|
||||||
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
||||||
|
|
||||||
%
|
%
|
||||||
% WaitForLost
|
% WaitForLost
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
|
\membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
|
||||||
|
|
||||||
\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
|
||||||
|
|
||||||
This function waits for a "lost" event. For instance, the peer may have closed
|
This function waits for a "lost" event. For instance, the peer may have closed
|
||||||
@@ -353,39 +364,22 @@ the connection, or the connection may have been broken.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
||||||
|
|
||||||
\docparam{microsecond}{Number of microseconds to wait.}
|
\docparam{microsecond}{Number of microseconds to wait.}
|
||||||
|
|
||||||
\wxheading{Return value:}
|
\wxheading{Return value}
|
||||||
|
|
||||||
Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
|
Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
|
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
|
||||||
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
|
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
|
||||||
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
|
||||||
|
|
||||||
% ---------------------------------------------------------------------------
|
|
||||||
% Socket state
|
|
||||||
% ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
%
|
|
||||||
% SaveState
|
|
||||||
%
|
|
||||||
\membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}
|
|
||||||
\func{void}{SaveState}{\void}
|
|
||||||
|
|
||||||
This function saves the current state of the socket object in a stack:
|
|
||||||
actually it saves all flags and the state of the asynchronous callbacks.
|
|
||||||
|
|
||||||
\wxheading{See also}
|
|
||||||
|
|
||||||
\helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
|
|
||||||
|
|
||||||
%
|
%
|
||||||
% RestoreState
|
% RestoreState
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
|
\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
|
||||||
|
|
||||||
\func{void}{RestoreState}{\void}
|
\func{void}{RestoreState}{\void}
|
||||||
@@ -396,11 +390,28 @@ This function restores a previously saved state.
|
|||||||
|
|
||||||
\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
|
\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
|
||||||
|
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
% Socket state
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
%
|
||||||
|
% SaveState
|
||||||
|
%
|
||||||
|
\membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}
|
||||||
|
|
||||||
|
\func{void}{SaveState}{\void}
|
||||||
|
|
||||||
|
This function saves the current state of the socket object in a stack:
|
||||||
|
actually it saves all flags and the state of the asynchronous callbacks.
|
||||||
|
|
||||||
|
\wxheading{See also}
|
||||||
|
|
||||||
|
\helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
|
||||||
|
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% Socket callbacks
|
% Socket callbacks
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
\membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
|
||||||
|
|
||||||
\membersection{wxSocketBase::SetEventHandler}{wxsocketbaseseteventhandler}
|
|
||||||
\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
|
\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
|
||||||
|
|
||||||
Sets an event handler to be called when a socket event occured.
|
Sets an event handler to be called when a socket event occured.
|
||||||
@@ -408,6 +419,7 @@ Sets an event handler to be called when a socket event occured.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{evt\_hdlr}{Specifies the event handler you want to use.}
|
\docparam{evt\_hdlr}{Specifies the event handler you want to use.}
|
||||||
|
|
||||||
\docparam{id}{The id of socket event.}
|
\docparam{id}{The id of socket event.}
|
||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
@@ -417,7 +429,6 @@ Sets an event handler to be called when a socket event occured.
|
|||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% CLASS wxSocketClient
|
% CLASS wxSocketClient
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
\section{\class{wxSocketClient}}\label{wxsocketclient}
|
\section{\class{wxSocketClient}}\label{wxsocketclient}
|
||||||
|
|
||||||
\wxheading{Derived from}
|
\wxheading{Derived from}
|
||||||
@@ -427,16 +438,16 @@ Sets an event handler to be called when a socket event occured.
|
|||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% Members
|
% Members
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
%
|
%
|
||||||
% wxSocketClient
|
% wxSocketClient
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketClient::wxSocketClient}
|
\membersection{wxSocketClient::wxSocketClient}
|
||||||
|
|
||||||
\func{}{wxSocketClient}{\param{wxSockFlags}{ flags = wxSocketBase::NONE}}
|
\func{}{wxSocketClient}{\param{wxSockFlags}{ flags = wxSocketBase::NONE}}
|
||||||
|
|
||||||
Constructs a new wxSocketClient.
|
Constructs a new wxSocketClient.
|
||||||
{\bf Warning !} The created needs to be registered to a socket handler (See \helpref{wxSocketHandler}{wxsockethandler}).
|
|
||||||
|
{\bf Warning !} The created socket client needs to be registered to a socket handler (See \helpref{wxSocketHandler}{wxsockethandler}).
|
||||||
|
|
||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
@@ -445,8 +456,8 @@ Constructs a new wxSocketClient.
|
|||||||
%
|
%
|
||||||
% ~wxSocketClient
|
% ~wxSocketClient
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketClient::\destruct{wxSocketClient}}
|
\membersection{wxSocketClient::\destruct{wxSocketClient}}
|
||||||
|
|
||||||
\func{}{\destruct{wxSocketClient}}{\void}
|
\func{}{\destruct{wxSocketClient}}{\void}
|
||||||
|
|
||||||
Destructs a wxSocketClient object.
|
Destructs a wxSocketClient object.
|
||||||
@@ -454,8 +465,8 @@ Destructs a wxSocketClient object.
|
|||||||
%
|
%
|
||||||
% Connect
|
% Connect
|
||||||
%
|
%
|
||||||
|
\membersection{wxSocketClient::Connect}\label{wxsocketclientconnect}
|
||||||
|
|
||||||
\membersection{wxSocketClient::Connect}{wxsocketclientconnect}
|
|
||||||
\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
|
\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
|
||||||
|
|
||||||
Connects to a server using the specified address. If {\it wait} is TRUE, Connect
|
Connects to a server using the specified address. If {\it wait} is TRUE, Connect
|
||||||
@@ -464,6 +475,7 @@ will wait for the socket ready to send or receive data.
|
|||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{address}{Address of the server.}
|
\docparam{address}{Address of the server.}
|
||||||
|
|
||||||
\docparam{wait}{If true, waits for the connection to be ready.}
|
\docparam{wait}{If true, waits for the connection to be ready.}
|
||||||
|
|
||||||
\wxheading{Return value}
|
\wxheading{Return value}
|
||||||
@@ -477,8 +489,8 @@ Returns TRUE if the connection is established and no error occurs.
|
|||||||
%
|
%
|
||||||
% WaitOnConnect
|
% WaitOnConnect
|
||||||
%
|
%
|
||||||
|
\membersection{wxSocketClient::WaitOnConnect}\label{wxsocketclientwaitonconnect}
|
||||||
|
|
||||||
\membersection{wxSocketClient::WaitOnConnect}
|
|
||||||
\func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ microseconds = 0}}
|
\func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ microseconds = 0}}
|
||||||
|
|
||||||
Wait for a "connect" event.
|
Wait for a "connect" event.
|
||||||
@@ -487,10 +499,199 @@ Wait for a "connect" event.
|
|||||||
|
|
||||||
\helpref{wxSocketBase::Wait}{wxsocketbasewait} for a detailed description.
|
\helpref{wxSocketBase::Wait}{wxsocketbasewait} for a detailed description.
|
||||||
|
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
% CLASS: wxSocketEvent
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
\section{\class{wxSocketEvent}}\label{wxsocketevent}
|
||||||
|
|
||||||
|
This event class contains information about socket events.
|
||||||
|
|
||||||
|
\wxheading{Derived from}
|
||||||
|
|
||||||
|
\helpref{wxEvent}{wxevent}
|
||||||
|
|
||||||
|
\wxheading{Event table macros}
|
||||||
|
|
||||||
|
To process a socket event, use these event handler macros to direct input to member
|
||||||
|
functions that take a wxSocketEvent argument.
|
||||||
|
|
||||||
|
\twocolwidtha{7cm}
|
||||||
|
\begin{twocollist}\itemsep=0pt
|
||||||
|
\twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a socket event, supplying the member function.}
|
||||||
|
\end{twocollist}%
|
||||||
|
|
||||||
|
\wxheading{See also}
|
||||||
|
|
||||||
|
\helpref{wxSocketHandler}{wxsockethandler},\rtfsp
|
||||||
|
\helpref{wxSocketBase}{wxsocketbase},\rtfsp
|
||||||
|
\helpref{wxSocketClient}{wxsocketclient},\rtfsp
|
||||||
|
\helpref{wxSocketServer}{wxsocketserver}
|
||||||
|
|
||||||
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||||
|
|
||||||
|
\membersection{wxSocketEvent::wxSocketEvent}
|
||||||
|
|
||||||
|
\func{}{wxSocketEvent}{\param{int}{ id = 0}}
|
||||||
|
|
||||||
|
Constructor.
|
||||||
|
|
||||||
|
\membersection{wxSocketEvent::SocketEvent}\label{wxsocketeventsocketevent}
|
||||||
|
|
||||||
|
\constfunc{wxSocketBase::wxRequestEvent}{SocketEvent}{\void}
|
||||||
|
|
||||||
|
Returns the socket event type.
|
||||||
|
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
% CLASS: wxSocketHandler
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
\section{\class{wxSocketHandler}}\label{wxsockethandler}
|
||||||
|
|
||||||
|
\wxheading{Derived from}
|
||||||
|
|
||||||
|
\helpref{wxObject}{wxobject}
|
||||||
|
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
% Members
|
||||||
|
% ---------------------------------------------------------------------------
|
||||||
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||||
|
|
||||||
|
%
|
||||||
|
% wxSocketHandler
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::wxSocketHandler}
|
||||||
|
|
||||||
|
\func{}{wxSocketHandler}{\void}
|
||||||
|
|
||||||
|
Constructs a new wxSocketHandler.
|
||||||
|
|
||||||
|
It is advised to use \helpref{wxSocketHandler::Master}{wxsockethandlermaster} to
|
||||||
|
get a socket handler. But creating a socket handler is useful to group
|
||||||
|
many sockets.
|
||||||
|
|
||||||
|
%
|
||||||
|
% ~wxSocketHandler
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::\destruct{wxSocketHandler}}
|
||||||
|
|
||||||
|
\func{}{\destruct{wxSocketHandler}}{\void}
|
||||||
|
|
||||||
|
Destructs a wxSocketHandler object.
|
||||||
|
|
||||||
|
%
|
||||||
|
% Register
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::Register}
|
||||||
|
|
||||||
|
\func{void}{Register}{\param{wxSocketBase *}{socket}}
|
||||||
|
|
||||||
|
Register a socket: if it is already registered in this handler it will just
|
||||||
|
return immediately.
|
||||||
|
|
||||||
|
\wxheading{Parameters}
|
||||||
|
|
||||||
|
\docparam{socket}{Socket to be registered.}
|
||||||
|
|
||||||
|
%
|
||||||
|
% UnRegister
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::UnRegister}
|
||||||
|
|
||||||
|
\func{void}{UnRegister}{\param{wxSocketBase *}{socket}}
|
||||||
|
|
||||||
|
UnRegister a socket: if it isn't registered in this handler it will just
|
||||||
|
return.
|
||||||
|
|
||||||
|
\wxheading{Parameters}
|
||||||
|
|
||||||
|
\docparam{socket}{Socket to be unregistered.}
|
||||||
|
|
||||||
|
%
|
||||||
|
% Count
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::Count}
|
||||||
|
|
||||||
|
\constfunc{unsigned long}{Count}{\void}
|
||||||
|
|
||||||
|
Returns the number of sockets registered in the handler.
|
||||||
|
|
||||||
|
\wxheading{Return value}
|
||||||
|
|
||||||
|
Number of sockets registered.
|
||||||
|
|
||||||
|
%
|
||||||
|
% CreateServer
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::CreateServer}
|
||||||
|
|
||||||
|
\func{wxSocketServer *}{CreateServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
|
||||||
|
|
||||||
|
Creates a new wxSocketServer object. The object is automatically registered
|
||||||
|
to the current socket handler.
|
||||||
|
For a detailed description of the parameters, see \helpref{wxSocketServer::wxSocketServer}{wxsocketserverconstr}.
|
||||||
|
|
||||||
|
\wxheading{Return value}
|
||||||
|
|
||||||
|
Returns a new socket server.
|
||||||
|
|
||||||
|
%
|
||||||
|
% CreateClient
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::CreateClient}
|
||||||
|
|
||||||
|
\func{wxSocketServer *}{CreateClient}{\param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
|
||||||
|
|
||||||
|
Creates a new wxSocketClient object. The object is automatically registered
|
||||||
|
to the current socket handler.
|
||||||
|
|
||||||
|
For a detailed description of the parameters, see \helpref{wxSocketClient::Connect}{wxsocketclientconnect}.
|
||||||
|
|
||||||
|
\wxheading{Return value}
|
||||||
|
|
||||||
|
Returns a new socket client.
|
||||||
|
|
||||||
|
%
|
||||||
|
% Master
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::Master}\label{wxsockethandlermaster}
|
||||||
|
|
||||||
|
\func{static wxSocketHandler\&}{Master}{\void}
|
||||||
|
|
||||||
|
Returns a default socket handler.
|
||||||
|
|
||||||
|
%
|
||||||
|
% Wait
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::Wait}
|
||||||
|
|
||||||
|
\func{int}{Wait}{\param{long}{ seconds},\param{long}{ microseconds}}
|
||||||
|
|
||||||
|
Wait for an event on all registered sockets.
|
||||||
|
|
||||||
|
\wxheading{Parameters}
|
||||||
|
|
||||||
|
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
||||||
|
|
||||||
|
\docparam{microsecond}{Number of microseconds to wait.}
|
||||||
|
|
||||||
|
\wxheading{Return value}
|
||||||
|
|
||||||
|
Returns 0 if a timeout occured, else the number of events detected.
|
||||||
|
|
||||||
|
\wxheading{See also}
|
||||||
|
|
||||||
|
\helpref{wxSocketBase::Wait}{wxsocketbasewait}
|
||||||
|
|
||||||
|
%
|
||||||
|
% YieldSock
|
||||||
|
%
|
||||||
|
\membersection{wxSocketHandler::YieldSock}
|
||||||
|
|
||||||
|
\func{void}{YieldSock}{\void}
|
||||||
|
|
||||||
|
Execute pending requests in all registered sockets.
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% CLASS: wxSocketServer
|
% CLASS: wxSocketServer
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
\section{\class{wxSocketServer}}\label{wxsocketserver}
|
\section{\class{wxSocketServer}}\label{wxsocketserver}
|
||||||
|
|
||||||
\wxheading{Derived from}
|
\wxheading{Derived from}
|
||||||
@@ -500,31 +701,31 @@ Wait for a "connect" event.
|
|||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
% Members
|
% Members
|
||||||
% ---------------------------------------------------------------------------
|
% ---------------------------------------------------------------------------
|
||||||
|
|
||||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||||
|
|
||||||
%
|
%
|
||||||
% wxSocketServer
|
% wxSocketServer
|
||||||
%
|
%
|
||||||
|
\membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr}
|
||||||
|
|
||||||
\membersection{wxSocketServer::wxSocketServer}{wxsocketserverconstr}
|
|
||||||
\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
|
\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
|
||||||
|
|
||||||
Constructs a new wxSocketServer.
|
Constructs a new wxSocketServer.
|
||||||
|
|
||||||
{\bf Warning !} The created object needs to be registered to a socket handler
|
{\bf Warning !} The created object needs to be registered to a socket handler
|
||||||
(See \helpref{wxSocketHandler}{wxsockethandler}).
|
(see \helpref{wxSocketHandler}{wxsockethandler}).
|
||||||
|
|
||||||
\wxheading{Parameters}
|
\wxheading{Parameters}
|
||||||
|
|
||||||
\docparam{address}{Specifies the local address for the server (e.g. port number).}
|
\docparam{address}{Specifies the local address for the server (e.g. port number).}
|
||||||
\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbase
|
|
||||||
setflags})}
|
\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
|
||||||
|
|
||||||
%
|
%
|
||||||
% ~wxSocketServer
|
% ~wxSocketServer
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketServer::\destruct{wxSocketServer}}
|
\membersection{wxSocketServer::\destruct{wxSocketServer}}
|
||||||
|
|
||||||
\func{}{\destruct{wxSocketServer}}{\void}
|
\func{}{\destruct{wxSocketServer}}{\void}
|
||||||
|
|
||||||
Destructs a wxSocketServer object (it doesn't close the accepted connection).
|
Destructs a wxSocketServer object (it doesn't close the accepted connection).
|
||||||
@@ -532,8 +733,8 @@ Destructs a wxSocketServer object (it doesn't close the accepted connection).
|
|||||||
%
|
%
|
||||||
% Accept
|
% Accept
|
||||||
%
|
%
|
||||||
|
|
||||||
\membersection{wxSocketServer::Accept}
|
\membersection{wxSocketServer::Accept}
|
||||||
|
|
||||||
\func{wxSocketBase *}{Accept}{\void}
|
\func{wxSocketBase *}{Accept}{\void}
|
||||||
|
|
||||||
Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
|
Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
|
||||||
@@ -549,8 +750,8 @@ Returns an opened socket connection.
|
|||||||
%
|
%
|
||||||
% AcceptWith
|
% AcceptWith
|
||||||
%
|
%
|
||||||
|
\membersection{wxSocketServer::AcceptWith}\label{wxsocketserveracceptwith}
|
||||||
|
|
||||||
\membersection{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
|
|
||||||
\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
|
\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
|
||||||
|
|
||||||
Accept an incoming connection using the specified socket object.
|
Accept an incoming connection using the specified socket object.
|
||||||
@@ -565,147 +766,3 @@ This is useful when someone wants to inherit wxSocketBase.
|
|||||||
Returns TRUE if no error occurs, else FALSE.
|
Returns TRUE if no error occurs, else FALSE.
|
||||||
|
|
||||||
|
|
||||||
% ---------------------------------------------------------------------------
|
|
||||||
% CLASS: wxSocketHandler
|
|
||||||
% ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
\section{\class{wxSocketHandler}}\label{wxsockethandler}
|
|
||||||
|
|
||||||
\wxheading{Derived from}
|
|
||||||
|
|
||||||
\helpref{wxObject}{wxobject}
|
|
||||||
|
|
||||||
% ---------------------------------------------------------------------------
|
|
||||||
% Members
|
|
||||||
% ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
||||||
|
|
||||||
%
|
|
||||||
% wxSocketHandler
|
|
||||||
%
|
|
||||||
\membersection{wxSocketHandler::wxSocketHandler}
|
|
||||||
\func{}{wxSocketHandler}{\void}
|
|
||||||
|
|
||||||
Constructs a new wxSocketHandler.
|
|
||||||
It is advised to use \helpref{wxSocketHandler::Master}{wxsockethandlermaster}
|
|
||||||
to get a socket handler. But creating a socket handler is useful to group
|
|
||||||
many sockets.
|
|
||||||
|
|
||||||
%
|
|
||||||
% ~wxSocketHandler
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::\destruct{wxSocketHandler}}
|
|
||||||
\func{}{\destruct{wxSocketHandler}}{\void}
|
|
||||||
|
|
||||||
Destructs a wxSocketHandler object.
|
|
||||||
|
|
||||||
%
|
|
||||||
% Register
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::Register}
|
|
||||||
\func{void}{Register}{\param{wxSocketBase *}{socket}}
|
|
||||||
|
|
||||||
Register a socket: if it is already registered in this handler it will just
|
|
||||||
return immediately.
|
|
||||||
|
|
||||||
\wxheading{Parameters}
|
|
||||||
|
|
||||||
\docparam{socket}{Socket to be registered.}
|
|
||||||
|
|
||||||
%
|
|
||||||
% UnRegister
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::UnRegister}
|
|
||||||
\func{void}{UnRegister}{\param{wxSocketBase *}{socket}}
|
|
||||||
|
|
||||||
UnRegister a socket: if it isn't registered in this handler it will just
|
|
||||||
return.
|
|
||||||
|
|
||||||
\wxheading{Parameters}
|
|
||||||
|
|
||||||
\docparam{socket}{Socket to be unregistered.}
|
|
||||||
|
|
||||||
%
|
|
||||||
% Count
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::Count}
|
|
||||||
\constfunc{unsigned long}{Count}{\void}
|
|
||||||
|
|
||||||
Returns the number of sockets registered in the handler.
|
|
||||||
|
|
||||||
\wxheading{Return value}
|
|
||||||
|
|
||||||
Number of sockets registered.
|
|
||||||
|
|
||||||
%
|
|
||||||
% CreateServer
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::CreateServer}
|
|
||||||
\func{wxSocketServer *}{CreateServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
|
|
||||||
|
|
||||||
Creates a new wxSocketServer object. The object is automatically registered
|
|
||||||
to the current socket handler.
|
|
||||||
For a detailed description of the parameters, see \helpref{wxSocketServer::wxSocketServer}{wxsocketserverconstr}.
|
|
||||||
|
|
||||||
\wxheading{Return value}
|
|
||||||
|
|
||||||
Returns a new socket server.
|
|
||||||
|
|
||||||
%
|
|
||||||
% CreateClient
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::CreateClient}
|
|
||||||
\func{wxSocketServer *}{CreateClient}{\param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
|
|
||||||
|
|
||||||
Creates a new wxSocketClient object. The object is automatically registered
|
|
||||||
to the current socket handler.
|
|
||||||
For a detailed description of the parameters, see \helpref{wxSocketClient::Connect}{wxsocketclientconnect}.
|
|
||||||
|
|
||||||
\wxheading{Return value}
|
|
||||||
|
|
||||||
Returns a new socket client.
|
|
||||||
|
|
||||||
%
|
|
||||||
% Master
|
|
||||||
%
|
|
||||||
|
|
||||||
\membersection{wxSocketHandler::Master}
|
|
||||||
\func{static wxSocketHandler\&}{Master}{\void}
|
|
||||||
|
|
||||||
Returns a default socket handler.
|
|
||||||
|
|
||||||
%
|
|
||||||
% Wait
|
|
||||||
%
|
|
||||||
\membersection{wxSocketHandler::Wait}
|
|
||||||
\func{int}{Wait}{\param{long}{ seconds},\param{long}{ microseconds}}
|
|
||||||
|
|
||||||
Wait for an event on all registered sockets.
|
|
||||||
|
|
||||||
\wxheading{Parameters}
|
|
||||||
|
|
||||||
\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
|
|
||||||
\docparam{microsecond}{Number of microseconds to wait.}
|
|
||||||
|
|
||||||
\wxheading{Return value}
|
|
||||||
|
|
||||||
Returns 0 if a timeout occured, else the number of events detected.
|
|
||||||
|
|
||||||
\wxheading{See also}
|
|
||||||
|
|
||||||
\helpref{wxSocketBase::Wait}{wxsockebasewait}
|
|
||||||
|
|
||||||
%
|
|
||||||
% YieldSock
|
|
||||||
%
|
|
||||||
\membersection{wxSocketHandler::YieldSock}
|
|
||||||
\func{void}{YieldSock}{\void}
|
|
||||||
|
|
||||||
Execute pending requests in all registered sockets.
|
|
||||||
|
@@ -1,8 +1,6 @@
|
|||||||
\section{Config classes overview}\label{wxconfigoverview}
|
\section{Config classes overview}\label{wxconfigoverview}
|
||||||
|
|
||||||
Classes: \helpref{wxConfig}{wxconfig}, \helpref{wxConfigBase}{wxconfigbase},
|
Classes: \helpref{wxConfig}{wxconfigbase}
|
||||||
\helpref{wxRegConfig}{wxregconfig}, \helpref{wxFileConfig}{wxfileconfig},
|
|
||||||
\helpref{wxIniConfig}{wxiniconfig}
|
|
||||||
|
|
||||||
This overview briefly describes what the config classes are and what are the
|
This overview briefly describes what the config classes are and what are the
|
||||||
for. All the details about how to use them may be found in the description of
|
for. All the details about how to use them may be found in the description of
|
||||||
|
@@ -1,9 +1,9 @@
|
|||||||
\section{Log classes overview}\label{wxlogoverview}
|
\section{Log classes overview}\label{wxlogoverview}
|
||||||
|
|
||||||
Classes: \helpref{wxLog}{wxlog}, \helpref{wxLogStderr}{wxlogstderr},
|
Classes: \helpref{wxLog}{wxlog}, \helpref{wxLogStderr}{wxlogstderr},
|
||||||
\helpref{wxLogOstream}{wxlogostream}, \helpref{wxLogTextCtrl}{wxlogtextctrl},
|
\helpref{wxLogOstream}{wxlogostream}, \helpref{wxLogTextCtrl}{wxlogtextctrl},
|
||||||
\helpref{wxLogWindow}{wxlogwindow}, \helpref{wxLogGui}{wxloggui},
|
\helpref{wxLogWindow}{wxlogwindow}, \helpref{wxLogGui}{wxloggui},
|
||||||
\helpref{wxLogNull}{wxlognull}
|
\helpref{wxLogNull}{wxlognull}
|
||||||
|
|
||||||
This is a general overview of logging classes provided by wxWindows. The word
|
This is a general overview of logging classes provided by wxWindows. The word
|
||||||
logging here has a broad sense, including all of the program output, not only
|
logging here has a broad sense, including all of the program output, not only
|
||||||
@@ -36,8 +36,7 @@ might be activated if the user wishes to know more details about the program
|
|||||||
progress (another, but possibly confusing name for the same function is {\bf
|
progress (another, but possibly confusing name for the same function is {\bf
|
||||||
wxLogInfo}
|
wxLogInfo}
|
||||||
\item{\bf wxLogStatus} is for status messages - they will go into the status
|
\item{\bf wxLogStatus} is for status messages - they will go into the status
|
||||||
bar of the active or specified (as the first argument)
|
bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
|
||||||
\helpref{wxFrame}{wxframe} if it has one.
|
|
||||||
\item{\bf wxLogSysError} is mostly used by wxWindows itself, but might be
|
\item{\bf wxLogSysError} is mostly used by wxWindows itself, but might be
|
||||||
handy for logging errors after system call (API function) failure. It logs the
|
handy for logging errors after system call (API function) failure. It logs the
|
||||||
specified message text as well as the last system error code ({\it errno} or
|
specified message text as well as the last system error code ({\it errno} or
|
||||||
@@ -63,18 +62,18 @@ generic mechanisms, but are not really adapted for wxWindows, while the log
|
|||||||
classes are. Some of advantages in using wxWindows log functions are:
|
classes are. Some of advantages in using wxWindows log functions are:
|
||||||
|
|
||||||
\begin{itemize}\itemsep=0pt
|
\begin{itemize}\itemsep=0pt
|
||||||
\item{Portability} It's a common practice to use {\it printf()} statements or
|
\item{\bf Portability} It's a common practice to use {\it printf()} statements or
|
||||||
cout/cerr C++ streams for writing out some (debug or otherwise) information.
|
cout/cerr C++ streams for writing out some (debug or otherwise) information.
|
||||||
Although it works just fine under Unix, these messages go strictly nowever
|
Although it works just fine under Unix, these messages go strictly nowever
|
||||||
under Windows where the stdout of GUI programs is not assigned to anything.
|
under Windows where the stdout of GUI programs is not assigned to anything.
|
||||||
Thus, you might view {\it wxLogMessage()} as a simple substitute for {\it
|
Thus, you might view {\it wxLogMessage()} as a simple substitute for {\it
|
||||||
printf()}.
|
printf()}.
|
||||||
\item{Flexibility} The output of wxLog functions can be redirected or
|
\item{\bf Flexibility} The output of wxLog functions can be redirected or
|
||||||
suppressed entirely based on their importance, which is either impossible or
|
suppressed entirely based on their importance, which is either impossible or
|
||||||
difficult to do with traditional methods. For example, only error messages, or
|
difficult to do with traditional methods. For example, only error messages, or
|
||||||
only error messages and warnings might be logged, filtering out all
|
only error messages and warnings might be logged, filtering out all
|
||||||
informational messages.
|
informational messages.
|
||||||
\item{Completeness} Usually, an error message should be presented to the user
|
\item{\bf Completeness} Usually, an error message should be presented to the user
|
||||||
when some operation fails. Let's take a quite simple but common case of a file
|
when some operation fails. Let's take a quite simple but common case of a file
|
||||||
error: suppose that you're writing your data file on disk and there is not
|
error: suppose that you're writing your data file on disk and there is not
|
||||||
enough space. The actual error might have been detected inside wxWindows code
|
enough space. The actual error might have been detected inside wxWindows code
|
||||||
|
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxSocketBase}{wxsocketbase},\helpref{wxProtocol}{wxprotocol}
|
\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
|
||||||
|
|
||||||
% ----------------------------------------------------------------------------
|
% ----------------------------------------------------------------------------
|
||||||
% Members
|
% Members
|
||||||
@@ -14,7 +14,8 @@
|
|||||||
|
|
||||||
\latexignore{\rtfignore{\membersection{Members}}}
|
\latexignore{\rtfignore{\membersection{Members}}}
|
||||||
|
|
||||||
\membersection{wxURL::wxURL}{wxurlconstr}
|
\membersection{wxURL::wxURL}\label{wxurlconstr}
|
||||||
|
|
||||||
\func{}{wxURL}{\param{const wxString\&}{ url}}
|
\func{}{wxURL}{\param{const wxString\&}{ url}}
|
||||||
|
|
||||||
Constructs an URL object from the string.
|
Constructs an URL object from the string.
|
||||||
@@ -24,6 +25,7 @@ Constructs an URL object from the string.
|
|||||||
\docparam{url}{Url string to parse.}
|
\docparam{url}{Url string to parse.}
|
||||||
|
|
||||||
\membersection{wxURL::\destruct{wxURL}}
|
\membersection{wxURL::\destruct{wxURL}}
|
||||||
|
|
||||||
\func{}{\destruct{wxURL}}{\void}
|
\func{}{\destruct{wxURL}}{\void}
|
||||||
|
|
||||||
Destroys the URL object.
|
Destroys the URL object.
|
||||||
@@ -32,6 +34,7 @@ Destroys the URL object.
|
|||||||
% GetProtocolName
|
% GetProtocolName
|
||||||
%
|
%
|
||||||
\membersection{wxURL::GetProtocolName}
|
\membersection{wxURL::GetProtocolName}
|
||||||
|
|
||||||
\constfunc{wxString}{GetProtocolName}{\void}
|
\constfunc{wxString}{GetProtocolName}{\void}
|
||||||
|
|
||||||
Returns the name of the protocol which will be used to get the URL.
|
Returns the name of the protocol which will be used to get the URL.
|
||||||
@@ -40,6 +43,7 @@ Returns the name of the protocol which will be used to get the URL.
|
|||||||
% GetProtocol
|
% GetProtocol
|
||||||
%
|
%
|
||||||
\membersection{wxURL::GetProtocol}
|
\membersection{wxURL::GetProtocol}
|
||||||
|
|
||||||
\func{wxProtocol\&}{GetProtocol}{\void}
|
\func{wxProtocol\&}{GetProtocol}{\void}
|
||||||
|
|
||||||
Returns a reference to the protocol which will be used to get the URL.
|
Returns a reference to the protocol which will be used to get the URL.
|
||||||
@@ -48,6 +52,7 @@ Returns a reference to the protocol which will be used to get the URL.
|
|||||||
% GetError
|
% GetError
|
||||||
%
|
%
|
||||||
\membersection{wxURL::GetError}
|
\membersection{wxURL::GetError}
|
||||||
|
|
||||||
\constfunc{wxURLError}{GetError}{\void}
|
\constfunc{wxURLError}{GetError}{\void}
|
||||||
|
|
||||||
Returns the last error. This error refers to the URL parsing or to the protocol.
|
Returns the last error. This error refers to the URL parsing or to the protocol.
|
||||||
@@ -68,22 +73,24 @@ It can be one of these errors:
|
|||||||
% GetInputStream
|
% GetInputStream
|
||||||
%
|
%
|
||||||
\membersection{wxURL::GetInputStream}
|
\membersection{wxURL::GetInputStream}
|
||||||
|
|
||||||
\func{wxInputStream *}{GetInputStream}{\void}
|
\func{wxInputStream *}{GetInputStream}{\void}
|
||||||
|
|
||||||
Initializes the protocol and opens the input stream.
|
Initializes the protocol and opens the input stream.
|
||||||
|
|
||||||
\wxheading{Return value:}
|
\wxheading{Return value}
|
||||||
|
|
||||||
It returns a read-only wxStream.
|
It returns a read-only wxStream.
|
||||||
|
|
||||||
\wxheading{See also:}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxInputStream}{wxinputstream}
|
\helpref{wxInputStream}{wxinputstream}
|
||||||
|
|
||||||
%
|
%
|
||||||
% SetDefaultProxy
|
% SetDefaultProxy
|
||||||
%
|
%
|
||||||
\membersection{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
|
\membersection{wxURL::SetDefaultProxy}\label{wxurlsetdefaultproxy}
|
||||||
|
|
||||||
\func{static void}{SetDefaultProxy}{\param{const wxString\&}{ url\_proxy}}
|
\func{static void}{SetDefaultProxy}{\param{const wxString\&}{ url\_proxy}}
|
||||||
|
|
||||||
Sets the default proxy server to use to get the URL. The string specifies
|
Sets the default proxy server to use to get the URL. The string specifies
|
||||||
@@ -100,7 +107,8 @@ the proxy like this: <hostname>:<port number>.
|
|||||||
%
|
%
|
||||||
% SetProxy
|
% SetProxy
|
||||||
%
|
%
|
||||||
\membersection{wxURL::SetProxy}{wxurlsetproxy}
|
\membersection{wxURL::SetProxy}\label{wxurlsetproxy}
|
||||||
|
|
||||||
\func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
|
\func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
|
||||||
|
|
||||||
Sets the proxy to use for this URL.
|
Sets the proxy to use for this URL.
|
||||||
@@ -108,3 +116,4 @@ Sets the proxy to use for this URL.
|
|||||||
\wxheading{See also}
|
\wxheading{See also}
|
||||||
|
|
||||||
\helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
|
\helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
|
||||||
|
|
||||||
|
@@ -16,9 +16,11 @@
|
|||||||
|
|
||||||
#ifndef wxPrinter
|
#ifndef wxPrinter
|
||||||
#define wxPrinter wxPostScriptPrinter
|
#define wxPrinter wxPostScriptPrinter
|
||||||
|
#define sm_classwxPrinter sm_classwxPostScriptPrinter
|
||||||
#endif
|
#endif
|
||||||
#ifndef wxPrintPreview
|
#ifndef wxPrintPreview
|
||||||
#define wxPrintPreview wxPostScriptPrintPreview
|
#define wxPrintPreview wxPostScriptPrintPreview
|
||||||
|
#define sm_classwxPrintPreview sm_classwxPostScriptPrintPreview
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
@@ -10,9 +10,20 @@
|
|||||||
#elif defined(__WXQT__)
|
#elif defined(__WXQT__)
|
||||||
#include "wx/generic/prntdlgg.h"
|
#include "wx/generic/prntdlgg.h"
|
||||||
#elif defined(__WXMAC__)
|
#elif defined(__WXMAC__)
|
||||||
|
#include "wx/mac/printdlg.h"
|
||||||
|
#elif defined(__WXSTUBS__)
|
||||||
#include "wx/generic/prntdlgg.h"
|
#include "wx/generic/prntdlgg.h"
|
||||||
#elif defined(__WXSRUBS__)
|
#endif
|
||||||
#include "wx/generic/prntdlgg.h"
|
|
||||||
|
#if !defined(__WXMSW__) && !defined(__WXMAC__)
|
||||||
|
#define wxPrintDialog wxGenericPrintDialog
|
||||||
|
#define sm_classwxPrintDialog sm_classwxGenericPrintDialog
|
||||||
|
|
||||||
|
#define wxPrintSetupDialog wxGenericPrintSetupDialog
|
||||||
|
#define sm_classwxPrintSetupDialog sm_classwxGenericPrintSetupDialog
|
||||||
|
|
||||||
|
#define wxPageSetupDialog wxGenericPageSetupDialog
|
||||||
|
#define sm_classwxPageSetupDialog sm_classwxGenericPageSetupDialog
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
Reference in New Issue
Block a user