]> git.saurik.com Git - wxWidgets.git/commitdiff
Latex updates; added defines to printdlg.h for referring to generic print dialogs
authorJulian Smart <julian@anthemion.co.uk>
Wed, 7 Oct 1998 11:04:27 +0000 (11:04 +0000)
committerJulian Smart <julian@anthemion.co.uk>
Wed, 7 Oct 1998 11:04:27 +0000 (11:04 +0000)
by standard names.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@811 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/category.tex
docs/latex/wx/log.tex
docs/latex/wx/socket.tex
docs/latex/wx/tconfig.tex
docs/latex/wx/tlog.tex
docs/latex/wx/url.tex
include/wx/print.h
include/wx/printdlg.h

index 459b0adee0e7c8ff61a7c95c4c1680f92bbf7717..81a96ff771985c7f5665dc399e2066034a4dbb3a 100644 (file)
@@ -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{wxSessionEvent}{wxsessionevent}}{A session ending 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{wxTabEvent}{wxtabevent}}{A tab control event}
 \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}
@@ -239,6 +240,7 @@ classes, functions and macros.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides various debugging facilities}
 \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{wxTrace}{wxtrace}}{Tracing facility}
 \twocolitem{\helpref{wxTraceLevel}{wxtracelevel}}{Tracing facility with levels}
@@ -258,6 +260,9 @@ based on DDE.
 \twocolitem{\helpref{wxDDEClient}{wxddeclient}}{Represents a client}
 \twocolitem{\helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and 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}
 
 {\large {\bf Document/view framework}}
index f6d877de567bbe6e0a1f981e7f7008e168481bf5..bab8c50278d8d76a5d4101b9f6b1fecca86ddbd6 100644 (file)
@@ -34,7 +34,7 @@ of messages.
 
 \helpref{OnLog}{wxlogonlog}\\
 \helpref{GetActiveTarget}{wxloggetactivetarget}\\
-\helpref{SetActiveTarget}{wxsetactivetarget}\\
+\helpref{SetActiveTarget}{wxlogsetactivetarget}\\
 \helpref{DontCreateOnDemand}{wxlogdontcreateondemand}
 
 \membersection{Message buffering}
@@ -50,7 +50,7 @@ verify it.
 \helpref{Flush}{wxlogflush}\\
 \helpref{HasPendingMessages}{haspendingmessages}
 
-\membersection{Customization}{wxlogcustomization}
+\membersection{Customization}\label{wxlogcustomization}
 
 The functions below allow some limited customization of wxLog behaviour
 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.
 
 As for the (real) trace messages, they come in different kinds:
+
 \begin{itemize}\itemsep=0pt
 \item{wxTraceMemAlloc} for the messages about creating and deleting objects
 \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
 currently. (Almost) for internal use only.
 
-\membersection{wxLog::Flush}{wxlogflush}
+\membersection{wxLog::Flush}\label{wxlogflush}
 
 \func{virtual void}{Flush}{\void}
 
 Shows all the messages currently in buffer and clears it. If the buffer
 is already empty, nothing happens.
 
-\membersection{wxLog::HasPendingMessages}{haspendingmessages}
+\membersection{wxLog::HasPendingMessages}\label{haspendingmessages}
 
 \constfunc{bool}{HasPendingMessages}{\void}
 
 Returns true if there are any messages in the buffer (not yet shown to the
 user). (Almost) for internal use only.
 
-\membersection{wxLog::SetVerbose}{wxlogsetverbose}
+\membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
 
 \func{void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
 
 Activates or desactivates verbose mode in which the verbose messages are
 logged as the normal ones instead of being silently dropped.
 
-\membersection{wxLog::GetVerbose}{wxloggetverbose}
+\membersection{wxLog::GetVerbose}\label{wxloggetverbose}
 
 \constfunc{bool}{GetVerbose}{\void}
 
 Returns whether the verbose mode is currently active.
 
-\membersection{wxLog::SetTimeStampFormat}{wxlogsettimestampformat}
+\membersection{wxLog::SetTimeStampFormat}\label{wxlogsettimestampformat}
 
 \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.
 Passing an empty string to this function disables message timestamping.
 
-\membersection{wxLog::GetTimeStampFormat}{wxloggettimestampformat}
+\membersection{wxLog::GetTimeStampFormat}\label{wxloggettimestampformat}
 
 \constfunc{const char *}{GetTimeStampFormat}{\void}
 
 Returns the current timestamp format string.
 
-\membersection{wxLog::SetTraceMask}{wxlogsettracemask}
+\membersection{wxLog::SetTraceMask}\label{wxlogsettracemask}
 
 \func{static void}{SetTraceMask}{\param{wxTraceMask }{ mask}}
 
 Sets the trace mask, see \helpref{Customization}{wxlogcustomization}
 section for details.
 
-\membersection{wxLog::GetTraceMask}{wxloggettracemask}
+\membersection{wxLog::GetTraceMask}\label{wxloggettracemask}
 
-Returns the current trace mask, see \helpref{Customization}{wxlogcustomization}
-section for details.
+Returns the current trace mask, see \helpref{Customization}{wxlogcustomization} section
+for details.
index 18c8ddc249aaaa92552055c50933444d645d1a4f..7216280a3a4ab964cdbff3ed50920a87e782de0f 100644 (file)
@@ -13,7 +13,7 @@ To process events from a socket, use the following event handler macro to direct
  input to member
 functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
 
-\twocolwidtha{7cm}
+\twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_SOCKET(id, func)}}{A socket event occured.}
 \end{twocollist}%
@@ -21,20 +21,17 @@ functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
 % ---------------------------------------------------------------------------
 % See also ...
 % ---------------------------------------------------------------------------
-
 \wxheading{See also}
 
-\helpref{wxSocketEvent}{wxsocketevent}
-\helpref{wxSocketClient}{wxsocketclient}
-\helpref{wxSocketServer}{wxsocketserver}
+\helpref{wxSocketEvent}{wxsocketevent}, \helpref{wxSocketClient}{wxsocketclient}, \helpref{wxSocketServer}{wxsocketserver}
 
 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------
-
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSocketBase::wxSocketBase}
+
 \func{}{wxSocketBase}{\void}
 
 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.
 
-\membersection{wxSocketBase::IsData}\label{wxsocketbaseerror}
+\membersection{wxSocketBase::IsData}\label{wxsocketbaseisdata}
 
 \constfunc{bool}{IsData}{\void}
 
@@ -102,11 +99,9 @@ Returns an error in the errno format (see your C programmer's guide).
 % ---------------------------------------------------------------------------
 % IO calls
 % ---------------------------------------------------------------------------
-
 %
 % Peek
 %
-
 \membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
 
 \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}
 
 \docparam{buffer}{Buffer where to put peeked data.}
+
 \docparam{nbytes}{Number of bytes.}
 
-\wxheading{Returns value}
+\wxheading{Return value}
+
 Returns a reference to the current object.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % Read
 %
-
 \membersection{wxSocketBase::Read}\label{wxsocketbaseread}
 
 \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}
 
 \docparam{buffer}{Buffer where to put read data.}
+
 \docparam{nbytes}{Number of bytes.}
 
-\wxheading{Returns value}
+\wxheading{Return value}
+
 Returns a reference to the current object.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
  
+\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
+
+\func{void}{SetFlags}{\param{wxSockFlags}{ flags}}
+
+TODO
+
 %
 % Read
 %
-
 \membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
 
 \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}
 
 \docparam{buffer}{Buffer where to get the data to write.}
+
 \docparam{nbytes}{Number of bytes.}
 
-\wxheading{Returns value}
+\wxheading{Return value}
+
 Returns a reference to the current object.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % WriteMsg
 %
-
 \membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
 
 \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}
 
 \docparam{buffer}{Buffer where to put data peeked.}
+
 \docparam{nbytes}{Number of bytes.}
 
-\wxheading{Returns value}
+\wxheading{Return value}
+
 Returns a reference to the current object.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
-\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+ \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
 
 %
 % ReadMsg
 %
-
 \membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
 
 \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}
 
 \docparam{buffer}{Buffer where to put read data.}
+
 \docparam{nbytes}{Number of bytes allocated for the buffer.}
 
-\wxheading{Returns value}
+\wxheading{Return value}
+
 Returns a reference to the current object.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
-\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+ \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
 
 %
 % Unread
 %
-
 \membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread}
 
 \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}
 
 \docparam{buffer}{Buffer to be unread.}
+
 \docparam{nbytes}{Number of bytes.}
 
-\wxheading{Returns value}
+\wxheading{Return value}
+
 Returns a reference to the current object.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % Discard
 %
-
 \membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
 
 \func{wxSocketBase\&}{Discard}{\void}
@@ -271,6 +278,7 @@ doesn't wait.
 % Wait functions
 % ---------------------------------------------------------------------------
 \membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
+
 \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
@@ -280,23 +288,24 @@ established connection.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
+
 \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.
 
 \wxheading{See also}
 
 \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+ \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+ \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForRead
 %
-
 \membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
+
 \func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a read event.
@@ -304,23 +313,24 @@ This function waits for a read event.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
+
 \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.
 
 \wxheading{See also}
 
 \helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+ \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+ \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForWrite
 %
-
 \membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
+
 \func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a write event.
@@ -328,23 +338,24 @@ This function waits for a write event.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
+
 \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.
 
 \wxheading{See also}
 
 \helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+ \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
+ \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForLost
 %
-
 \membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
+
 \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
@@ -353,26 +364,40 @@ the connection, or the connection may have been broken.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
+
 \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.
 
 \wxheading{See also}
 
 \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+ \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+ \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+
+%
+% RestoreState
+%
+\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
+
+\func{void}{RestoreState}{\void}
+
+This function restores a previously saved state.
+
+\wxheading{See also}
+
+\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:
@@ -382,25 +407,11 @@ actually it saves all flags and the state of the asynchronous callbacks.
 
 \helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
 
-%
-% RestoreState
-%
-
-\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
-
-\func{void}{RestoreState}{\void}
-
-This function restores a previously saved state.
-
-\wxheading{See also}
-
-\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
-
 % ---------------------------------------------------------------------------
 % Socket callbacks
 % ---------------------------------------------------------------------------
+\membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
 
-\membersection{wxSocketBase::SetEventHandler}{wxsocketbaseseteventhandler}
 \func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
 
 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}
 
 \docparam{evt\_hdlr}{Specifies the event handler you want to use.}
+
 \docparam{id}{The id of socket event.}
 
 \wxheading{See also}
@@ -417,7 +429,6 @@ Sets an event handler to be called when a socket event occured.
 % ---------------------------------------------------------------------------
 % CLASS wxSocketClient
 % ---------------------------------------------------------------------------
-
 \section{\class{wxSocketClient}}\label{wxsocketclient}
 
 \wxheading{Derived from}
@@ -427,16 +438,16 @@ Sets an event handler to be called when a socket event occured.
 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------
-
 %
 % wxSocketClient
 %
-
 \membersection{wxSocketClient::wxSocketClient}
+
 \func{}{wxSocketClient}{\param{wxSockFlags}{ flags = wxSocketBase::NONE}}
 
 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}
 
@@ -445,8 +456,8 @@ Constructs a new wxSocketClient.
 %
 % ~wxSocketClient
 %
-
 \membersection{wxSocketClient::\destruct{wxSocketClient}}
+
 \func{}{\destruct{wxSocketClient}}{\void}
 
 Destructs a wxSocketClient object.
@@ -454,8 +465,8 @@ Destructs a wxSocketClient object.
 %
 % Connect
 %
+\membersection{wxSocketClient::Connect}\label{wxsocketclientconnect}
 
-\membersection{wxSocketClient::Connect}{wxsocketclientconnect}
 \func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
 
 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}
 
 \docparam{address}{Address of the server.}
+
 \docparam{wait}{If true, waits for the connection to be ready.}
 
 \wxheading{Return value}
@@ -477,8 +489,8 @@ Returns TRUE if the connection is established and no error occurs.
 %
 % WaitOnConnect
 %
+\membersection{wxSocketClient::WaitOnConnect}\label{wxsocketclientwaitonconnect}
 
-\membersection{wxSocketClient::WaitOnConnect}
 \func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ microseconds = 0}}
 
 Wait for a "connect" event.
@@ -488,87 +500,50 @@ Wait for a "connect" event.
 \helpref{wxSocketBase::Wait}{wxsocketbasewait} for a detailed description.
 
 % ---------------------------------------------------------------------------
-% CLASS: wxSocketServer
+% CLASS: wxSocketEvent
 % ---------------------------------------------------------------------------
+\section{\class{wxSocketEvent}}\label{wxsocketevent}
 
-\section{\class{wxSocketServer}}\label{wxsocketserver}
+This event class contains information about socket events.
 
 \wxheading{Derived from}
 
-\helpref{wxSocketBase}{wxsocketbase}
-
-% ---------------------------------------------------------------------------
-% Members
-% ---------------------------------------------------------------------------
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-%
-% wxSocketServer
-%
-
-\membersection{wxSocketServer::wxSocketServer}{wxsocketserverconstr}
-\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
-
-Constructs a new wxSocketServer.
-{\bf Warning !} The created object needs to be registered to a socket handler
-(See \helpref{wxSocketHandler}{wxsockethandler}).
-
-\wxheading{Parameters}
+\helpref{wxEvent}{wxevent}
 
-\docparam{address}{Specifies the local address for the server (e.g. port number).}
-\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbase
-setflags})}
+\wxheading{Event table macros}
 
-%
-% ~wxSocketServer
-%
+To process a socket event, use these event handler macros to direct input to member
+functions that take a wxSocketEvent argument.
 
-\membersection{wxSocketServer::\destruct{wxSocketServer}}
-\func{}{\destruct{wxSocketServer}}{\void}
-
-Destructs a wxSocketServer object (it doesn't close the accepted connection).
-
-%
-% Accept
-%
-
-\membersection{wxSocketServer::Accept}
-\func{wxSocketBase *}{Accept}{\void}
-
-Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
-
-\wxheading{Return value}
-
-Returns an opened socket connection.
+\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{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
-
-%
-% AcceptWith
-%
+\helpref{wxSocketHandler}{wxsockethandler},\rtfsp
+\helpref{wxSocketBase}{wxsocketbase},\rtfsp
+\helpref{wxSocketClient}{wxsocketclient},\rtfsp
+\helpref{wxSocketServer}{wxsocketserver}
 
-\membersection{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
-\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
+\latexignore{\rtfignore{\wxheading{Members}}}
 
-Accept an incoming connection using the specified socket object.
-This is useful when someone wants to inherit wxSocketBase.
+\membersection{wxSocketEvent::wxSocketEvent}
 
-\wxheading{Parameters}
+\func{}{wxSocketEvent}{\param{int}{ id = 0}}
 
-\docparam{socket}{Socket to be initialized}
+Constructor.
 
-\wxheading{Return value}
+\membersection{wxSocketEvent::SocketEvent}\label{wxsocketeventsocketevent}
 
-Returns TRUE if no error occurs, else FALSE.
+\constfunc{wxSocketBase::wxRequestEvent}{SocketEvent}{\void}
 
+Returns the socket event type.
 
 % ---------------------------------------------------------------------------
 % CLASS: wxSocketHandler
 % ---------------------------------------------------------------------------
-
 \section{\class{wxSocketHandler}}\label{wxsockethandler}
 
 \wxheading{Derived from}
@@ -578,25 +553,26 @@ Returns TRUE if no error occurs, else FALSE.
 % ---------------------------------------------------------------------------
 % 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
+
+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.
@@ -604,8 +580,8 @@ 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
@@ -618,8 +594,8 @@ return immediately.
 %
 % UnRegister
 %
-
 \membersection{wxSocketHandler::UnRegister}
+
 \func{void}{UnRegister}{\param{wxSocketBase *}{socket}}
 
 UnRegister a socket: if it isn't registered in this handler it will just
@@ -632,8 +608,8 @@ return.
 %
 % Count
 %
-
 \membersection{wxSocketHandler::Count}
+
 \constfunc{unsigned long}{Count}{\void}
 
 Returns the number of sockets registered in the handler.
@@ -645,8 +621,8 @@ 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
@@ -660,12 +636,13 @@ 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}
@@ -675,8 +652,8 @@ Returns a new socket client.
 %
 % Master
 %
+\membersection{wxSocketHandler::Master}\label{wxsockethandlermaster}
 
-\membersection{wxSocketHandler::Master}
 \func{static wxSocketHandler\&}{Master}{\void}
 
 Returns a default socket handler.
@@ -685,6 +662,7 @@ 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.
@@ -692,6 +670,7 @@ 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}
@@ -700,12 +679,90 @@ Returns 0 if a timeout occured, else the number of events detected.
 
 \wxheading{See also}
 
-\helpref{wxSocketBase::Wait}{wxsockebasewait}
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}
 
 %
 % YieldSock
 %
 \membersection{wxSocketHandler::YieldSock}
+
 \func{void}{YieldSock}{\void}
 
 Execute pending requests in all registered sockets.
+% ---------------------------------------------------------------------------
+% CLASS: wxSocketServer
+% ---------------------------------------------------------------------------
+\section{\class{wxSocketServer}}\label{wxsocketserver}
+
+\wxheading{Derived from}
+
+\helpref{wxSocketBase}{wxsocketbase}
+
+% ---------------------------------------------------------------------------
+% Members
+% ---------------------------------------------------------------------------
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+%
+% wxSocketServer
+%
+\membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr}
+
+\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
+
+Constructs a new wxSocketServer.
+
+{\bf Warning !} The created object needs to be registered to a socket handler
+(see \helpref{wxSocketHandler}{wxsockethandler}).
+
+\wxheading{Parameters}
+
+\docparam{address}{Specifies the local address for the server (e.g. port number).}
+
+\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
+
+%
+% ~wxSocketServer
+%
+\membersection{wxSocketServer::\destruct{wxSocketServer}}
+
+\func{}{\destruct{wxSocketServer}}{\void}
+
+Destructs a wxSocketServer object (it doesn't close the accepted connection).
+
+%
+% Accept
+%
+\membersection{wxSocketServer::Accept}
+
+\func{wxSocketBase *}{Accept}{\void}
+
+Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
+
+\wxheading{Return value}
+
+Returns an opened socket connection.
+
+\wxheading{See also}
+
+\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
+
+%
+% AcceptWith
+%
+\membersection{wxSocketServer::AcceptWith}\label{wxsocketserveracceptwith}
+
+\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
+
+Accept an incoming connection using the specified socket object.
+This is useful when someone wants to inherit wxSocketBase.
+
+\wxheading{Parameters}
+
+\docparam{socket}{Socket to be initialized}
+
+\wxheading{Return value}
+
+Returns TRUE if no error occurs, else FALSE.
+
+
index 1c5b11a0aba28f253a85d6e9ff21e14464a61b96..fa762b629d506561acea308b1cd927d108c09b92 100644 (file)
@@ -1,8 +1,6 @@
 \section{Config classes overview}\label{wxconfigoverview}
 
-Classes: \helpref{wxConfig}{wxconfig}, \helpref{wxConfigBase}{wxconfigbase},
-\helpref{wxRegConfig}{wxregconfig}, \helpref{wxFileConfig}{wxfileconfig},
-\helpref{wxIniConfig}{wxiniconfig}
+Classes: \helpref{wxConfig}{wxconfigbase}
 
 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
index 1556d82ffd5befc770b7d29b3d4332fac8da2e61..3cb6ecb4398190aa312bb4bf58e20eea4785ebff 100644 (file)
@@ -1,9 +1,9 @@
 \section{Log classes overview}\label{wxlogoverview}
 
 Classes: \helpref{wxLog}{wxlog}, \helpref{wxLogStderr}{wxlogstderr},
-\helpref{wxLogOstream}{wxlogostream}, \helpref{wxLogTextCtrl}{wxlogtextctrl},
-\helpref{wxLogWindow}{wxlogwindow}, \helpref{wxLogGui}{wxloggui},
-\helpref{wxLogNull}{wxlognull}
+ \helpref{wxLogOstream}{wxlogostream}, \helpref{wxLogTextCtrl}{wxlogtextctrl},
+ \helpref{wxLogWindow}{wxlogwindow}, \helpref{wxLogGui}{wxloggui},
+ \helpref{wxLogNull}{wxlognull}
 
 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
@@ -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
 wxLogInfo}
 \item{\bf wxLogStatus} is for status messages - they will go into the status
-bar of the active or specified (as the first argument)
-\helpref{wxFrame}{wxframe} if it has one.
+bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
 \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
 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:
 
 \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.
 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.
 Thus, you might view {\it wxLogMessage()} as a simple substitute for {\it
 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
 difficult to do with traditional methods. For example, only error messages, or
 only error messages and warnings might be logged, filtering out all
 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
 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
index 11d860e7bb20a7703b181ab6ef6a9b0d11136df3..dcd6399e90f0e91e0f917acae4d646ac212e4d71 100644 (file)
@@ -6,7 +6,7 @@
 
 \wxheading{See also}
 
-\helpref{wxSocketBase}{wxsocketbase},\helpref{wxProtocol}{wxprotocol}
+\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
 
 % ----------------------------------------------------------------------------
 % Members
@@ -14,7 +14,8 @@
 
 \latexignore{\rtfignore{\membersection{Members}}}
 
-\membersection{wxURL::wxURL}{wxurlconstr}
+\membersection{wxURL::wxURL}\label{wxurlconstr}
+
 \func{}{wxURL}{\param{const wxString\&}{ url}}
 
 Constructs an URL object from the string.
@@ -24,6 +25,7 @@ Constructs an URL object from the string.
 \docparam{url}{Url string to parse.}
 
 \membersection{wxURL::\destruct{wxURL}}
+
 \func{}{\destruct{wxURL}}{\void}
 
 Destroys the URL object.
@@ -32,6 +34,7 @@ Destroys the URL object.
 % GetProtocolName
 %
 \membersection{wxURL::GetProtocolName}
+
 \constfunc{wxString}{GetProtocolName}{\void}
 
 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
 %
 \membersection{wxURL::GetProtocol}
+
 \func{wxProtocol\&}{GetProtocol}{\void}
 
 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
 %
 \membersection{wxURL::GetError}
+
 \constfunc{wxURLError}{GetError}{\void}
 
 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
 %
 \membersection{wxURL::GetInputStream}
+
 \func{wxInputStream *}{GetInputStream}{\void}
 
 Initializes the protocol and opens the input stream.
 
-\wxheading{Return value:}
+\wxheading{Return value}
 
 It returns a read-only wxStream.
 
-\wxheading{See also:}
+\wxheading{See also}
 
 \helpref{wxInputStream}{wxinputstream}
 
 %
 % SetDefaultProxy
 %
-\membersection{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
+\membersection{wxURL::SetDefaultProxy}\label{wxurlsetdefaultproxy}
+
 \func{static void}{SetDefaultProxy}{\param{const wxString\&}{ url\_proxy}}
 
 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
 %
-\membersection{wxURL::SetProxy}{wxurlsetproxy}
+\membersection{wxURL::SetProxy}\label{wxurlsetproxy}
+
 \func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
 
 Sets the proxy to use for this URL.
@@ -108,3 +116,4 @@ Sets the proxy to use for this URL.
 \wxheading{See also}
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
+
index 4d63fb0e567b35f598922ae974d1e0ffcff0d014..5d7c7a4f60c8f546c20332632a53182e6f690e86 100644 (file)
 
 #ifndef wxPrinter
 #define wxPrinter wxPostScriptPrinter
+#define sm_classwxPrinter sm_classwxPostScriptPrinter
 #endif
 #ifndef wxPrintPreview
 #define wxPrintPreview wxPostScriptPrintPreview
+#define sm_classwxPrintPreview sm_classwxPostScriptPrintPreview
 #endif
 
 #endif
index a1455213a13e323d23f2dcb0b53e02e0c7e8b49d..59d382735ef3d079dcd4163af0aacd775fc3fc79 100644 (file)
 #elif defined(__WXQT__)
 #include "wx/generic/prntdlgg.h"
 #elif defined(__WXMAC__)
+#include "wx/mac/printdlg.h"
+#elif defined(__WXSTUBS__)
 #include "wx/generic/prntdlgg.h"
-#elif defined(__WXSRUBS__)
-#include "wx/generic/prntdlgg.h"
+#endif
+
+#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