From: Julian Smart Date: Tue, 2 Nov 1999 10:02:01 +0000 (+0000) Subject: Some doc corrections X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/407f36811ed2513233df1343f0b3591f09efb77e?ds=inline Some doc corrections git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4294 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/bmpdatob.tex b/docs/latex/wx/bmpdatob.tex index 3e654b6ea6..3c7038a843 100644 --- a/docs/latex/wx/bmpdatob.tex +++ b/docs/latex/wx/bmpdatob.tex @@ -15,7 +15,7 @@ efficiency. \wxheading{Derived from} -\helpref{wxDataObjectSimple}{wxdataobjectsimple} +\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\ \helpref{wxDataObject}{wxdataobject} \wxheading{Include files} @@ -53,4 +53,3 @@ Sets the bitmap associated with the data object. This method is called when the data object receives data. Usually there will be no reason to override this function. - diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index ac4974f463..26d1c333b6 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -40,8 +40,8 @@ \input cursor.tex \input database.tex \input dataobj.tex -\input dobjcomp.tex -\input dobjsmpl.tex +%\input dobjcomp.tex +%\input dobjsmpl.tex \input datstrm.tex \input date.tex \input dc.tex @@ -193,7 +193,6 @@ \input slider.tex \input sckaddr.tex \input socket.tex -%\input gsocket.tex \input splitevt.tex \input strmsock.tex \input spinbutt.tex diff --git a/docs/latex/wx/dataobj.tex b/docs/latex/wx/dataobj.tex index e0df5ff8a7..2538703aaf 100644 --- a/docs/latex/wx/dataobj.tex +++ b/docs/latex/wx/dataobj.tex @@ -13,15 +13,15 @@ A wxDataObject represents data that can be copied to or from the clipboard, or dragged and dropped. The important thing about wxDataObject is that this is a -"smart" piece of data unlike usual "dumb" data containers such as memory -buffers or files. Being "smart" here means that the data object itself should +'smart' piece of data unlike usual 'dumb' data containers such as memory +buffers or files. Being 'smart' here means that the data object itself should know what data formats it supports and how to render itself in each of supported formats. A supported format, incidentally, is exactly the format in which the data can be requested from a data object or from which the data object may be set. In -the general case, an object may support different formats on "input" and -"output", i.e. it may be able to render itself in a given format but not be +the general case, an object may support different formats on 'input' and +'output', i.e. it may be able to render itself in a given format but not be created from data on this format or vice versa. wxDataObject defines an enumeration type @@ -36,14 +36,13 @@ enum Direction which allows to distinguish between them. See \helpref{wxDataFormat}{wxdataformat} documentation for more about formats. -Not surprizingly, being "smart" comes at a price of added complexity. This is +Not surprizingly, being 'smart' comes at a price of added complexity. This is reasonable for the situations when you really need to support multiple formats, but may be annoying if you only want to do something simple like cut and paste text. To provide a solution for both cases, wxWindows has two predefined classes -which derive from wxDataObject: -\helpref{wxDataObjectSimple}{wxdataobjectsimple} and +which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and \helpref{wxDataObjectComposite}{wxdataobjectcomposite}. \helpref{wxDataObjectSimple}{wxdataobjectsimple} is the simplest wxDataObject possible and only holds data in a single format (such @@ -54,23 +53,23 @@ because it achievs this by simply holding several wxDataObjectSimple objects. So, you have several solutions when you need a wxDataObject class (and you need one as soon as you want to transfer data via the clipboard or drag and drop): -\begin{twocollist} +\begin{twocollist}\itemsep=0pt \twocolitem{0. Use one of built-in classes}{You may use wxTextDataObject, wxBitmapDataObject or wxFileDataObject in the simplest cases when you only need -to support one format and your data is either text, bitmap or list of files} +to support one format and your data is either text, bitmap or list of files.} \twocolitem{1. Derive your class from wxDataObjectSimple}{This is the simplest solution for custom data - you will only support one format and so probably won't be able to communicate with other programs, but data transfer will work in your program (or between different copies of it).} -\twocolitem{2. Use wxDataObjectComposite}{This is a quite simple, but rather -powerful solution which allows you to support any number of formats (either +\twocolitem{2. Use wxDataObjectComposite}{This is a simple but powerful +solution which allows you to support any number of formats (either standard or custom if you combine it with the previous solution).} -\twocolitem{3. Derive from wxDataObject directly}{This is the solution of +\twocolitem{3. Derive from wxDataObject directly}{This is the solution for maximal flexibility and efficiency, but it also is the most difficult to implement.} \end{twocollist} -Please note that the easiest way to use Drag'n'Drop and the clipboard with +Please note that the easiest way to use drag and drop and the clipboard with multiple formats is by using wxDataObjectComposite, but it is not the most efficient one as each wxDataObjectSimple would contain the whole data in its respective formars. Now imagine that you want to paste 200 pages of text in @@ -80,14 +79,14 @@ will have to derive from wxDataObject directly and make it enumerate its formats and provide the data in the requested format on demand. Note that neither the GTK data transfer mechanisms for the clipboard and -Drag'n'Drop nor the OLE data transfer copies any data until another application -actually requests the data. This is in contrast to the "feel" offered to the +drag and drop, neither does the OLE data transfer copy any data until another application +actually requests the data. This is in contrast to the 'feel' offered to the user of a program who would normally think that the data resides in the -clipboard after having pressed "Copy" - in reality it is only declared to be +clipboard after having pressed 'Copy' - in reality it is only declared to be available. There are several predefined data object classes derived from -wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject}, +wxDataObjectSimple: \helpref{wxFileDataObject}{wxfiledataobject}, \helpref{wxTextDataObject}{wxtextdataobject} and \helpref{wxBitmapDataObject}{wxbitmapdataobject} which can be used without change. @@ -98,8 +97,8 @@ format of user-defined data is given as mime-type string literal, such as "application/word" or "image/png". These strings are used as they are under Unix (so far only GTK) to identify a format and are translated into their Windows equivalent under Win32 (using the OLE IDataObject for data exchange to -and from the clipboard and for Drag'n'Drop). Note that the format string -translation under Windows is not yet finnished. +and from the clipboard and for drag and drop). Note that the format string +translation under Windows is not yet finished. \wxheading{Virtual functions to override} @@ -147,12 +146,10 @@ Destructor. \membersection{wxDataObject::GetAllFormats}\label{wxdataobjectgetallformats} -\constfunc{virtual void}{GetAllFormats}{ - \param{wxDataFormat *}{formats}, - \param{Direction}{ dir = Get}} +\constfunc{virtual void}{GetAllFormats}{ \param{wxDataFormat *}{formats}, \param{Direction}{ dir = Get}} -Copy all supported formats in the given direction to the array pointed to by -{\it formats} (there is enough place for GetFormatCount(dir) formats in it). +Copy all supported formats in the given direction to the array pointed to by +{\it formats}. There is enough space for GetFormatCount(dir) formats in it. \membersection{wxDataObject::GetDataHere}\label{wxdataobjectgetdatahere} @@ -171,26 +168,22 @@ Returns the data size of the given format {\it format}. \constfunc{virtual size\_t}{GetFormatCount}{\param{Direction}{ dir = Get}} -Return the number of available formats for rendering or setting the data. +Returns the number of available formats for rendering or setting the data. \membersection{wxDataObject::GetPreferredFormat}\label{wxdataobjectgetpreferredformat} \constfunc{virtual wxDataFormat}{GetPreferredFormat}{\param{Direction}{ dir = Get}} -Returns the preferred format for either rendering the data (if {\it dir} is -{\tt Get}, its default value) or for setting it. Usually this will be the +Returns the preferred format for either rendering the data (if {\it dir} is {\tt Get}, +its default value) or for setting it. Usually this will be the native format of the wxDataObject. \membersection{wxDataObject::SetData}\label{wxdataobjectsetdata} -\func{virtual bool}{SetData}{ - \param{const wxDataFormat\&}{ format}, - \param{size\_t}{ len}, - \param{const void }{*buf} } +\func{virtual bool}{SetData}{ \param{const wxDataFormat\&}{ format}, \param{size\_t}{ len}, \param{const void }{*buf} } Set the data in the format {\it format} of the length {\it len} provided in the buffer {\it buf}. -Returns TRUE on sucess, FALSE on failure. - +Returns TRUE on success, FALSE on failure. diff --git a/docs/latex/wx/fildatob.tex b/docs/latex/wx/fildatob.tex index c6bd03af78..03fd12f6d0 100644 --- a/docs/latex/wx/fildatob.tex +++ b/docs/latex/wx/fildatob.tex @@ -12,7 +12,7 @@ None. \wxheading{Derived from} -\helpref{wxDataObjectSimple}{wxdataobjectsimple} +\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\ \helpref{wxDataObject}{wxdataobject} \wxheading{Include files} diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index 43654ca559..8846d7579b 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -42,7 +42,7 @@ this window. \membersection{wxMenu::wxMenu}\label{wxmenuconstr} \func{}{wxMenu}{\param{const wxString\& }{title = ""}, - \param{const wxFunction}{ func = NULL}\param{long}{ style = 0}} + \param{const wxFunction}{ func = NULL}, \param{long}{ style = 0}} Constructs a wxMenu object. @@ -56,18 +56,19 @@ Constructs a wxMenu object. \pythonnote{The wxPython version of the \tt{wxMenu} constructor doesn't accept the callback argument because of reference counting -issues. There is a specialized wxMenu constructor called +issues. There is a specialized wxMenu constructor called \tt{wxPyMenu} which does and can be used for PopupMenus when callbacks are needed. You must retain a reference to the menu while useing it otherwise your callback function will get dereferenced when the menu does. } -\func{}{wxMenu}{\param{long}{ style }} +\func{}{wxMenu}{\param{long}{ style}} Constructs a wxMenu object. \wxheading{Parameters} + \docparam{style}{If set to \tt{wxMENU_TEAROFF}, the menu will be detachable.} \membersection{wxMenu::\destruct{wxMenu}} @@ -127,7 +128,6 @@ creation of a menu or menubar. \helpref{wxMenu::AppendSeparator}{wxmenuappendseparator}, \helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp \helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem} - \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} @@ -137,7 +137,6 @@ implements the following methods:\par \end{twocollist}} } - \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator} \func{void}{AppendSeparator}{\void} @@ -230,6 +229,7 @@ before matching. \membersection{wxMenu::FindItemForId}\label{wxmenufinditemforid} \constfunc{wxMenuItem*}{FindItemForId}{\param{int}{ id}} + \constfunc{wxMenuItem*}{FindItem}{\param{int}{ id}} Finds the menu item object associated with the given menu item identifier. @@ -449,7 +449,6 @@ menu bar.} \pythonnote{Only the default constructor is supported in wxPython. Use wxMenuBar.Append instead.} - \membersection{wxMenuBar::\destruct{wxMenuBar}} \func{void}{\destruct{wxMenuBar}}{\void} @@ -542,13 +541,14 @@ before matching. \membersection{wxMenuBar::FindItem}\label{wxmenubarfinditem} -\constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu}{ **menu = NULL} +\constfunc{wxMenuItem *}{FindItem}{\param{int}{ id}, \param{wxMenu}{ **menu = NULL}} Finds the menu item object associated with the given menu item identifier. \wxheading{Parameters} \docparam{id}{Menu item identifier.} + \docparam{menu}{If not NULL, menu will get set to the associated menu.} \wxheading{Return value} @@ -716,8 +716,3 @@ Use only after the menubar has been associated with a frame. \helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop} - -%%% Local Variables: -%%% mode: latex -%%% TeX-master: t -%%% End: diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex index 4e67a9352b..9d27c9e945 100644 --- a/docs/latex/wx/socket.tex +++ b/docs/latex/wx/socket.tex @@ -8,7 +8,7 @@ -\wxheading{wxSocket errors}%\label{wxsocketerrs} % Labels don't work on a non-section! +\wxheading{wxSocket errors} \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt @@ -72,8 +72,8 @@ input to member functions that take a \helpref{wxSocketEvent}{wxsocketevent} arg % --------------------------------------------------------------------------- \wxheading{See also} -\helpref{wxSocketEvent}{wxsocketevent}\\ -\helpref{wxSocketClient}{wxsocketclient}\\ +\helpref{wxSocketEvent}{wxsocketevent}, +\helpref{wxSocketClient}{wxsocketclient}, \helpref{wxSocketServer}{wxsocketserver} % --------------------------------------------------------------------------- @@ -85,7 +85,7 @@ input to member functions that take a \helpref{wxSocketEvent}{wxsocketevent} arg \func{}{wxSocketBase}{\void} -Default constructor. Don't use it; use \helpref{wxSocketClient}{wxsocketclient} +Default constructor. Don't use it; use \helpref{wxSocketClient}{wxsocketclient} or \helpref{wxSocketServer}{wxsocketserver}. \membersection{wxSocketBase::\destruct{wxSocketBase}} @@ -111,7 +111,7 @@ Destroys the wxSocketBase object. \twocolitem{{\bf wxSOCKET\_NONE}}{Normal functionnality.} \twocolitem{{\bf wxSOCKET\_NOWAIT}}{Get the available data in the input queue and return immediately.} \twocolitem{{\bf wxSOCKET\_WAITALL}}{Wait for all required data unless an error occurs.} -\twocolitem{{\bf wxSOCKET\_BLOCK}}{Block the GUI (do not wxYield) while reading / writing data.} +\twocolitem{{\bf wxSOCKET\_BLOCK}}{Block the GUI (do not wxYield) while reading/writing data.} \end{twocollist} A brief overview on how to use these flags follows. @@ -145,10 +145,13 @@ extra care to avoid unwanted reentrance. So: {\bf wxSOCKET\_NONE} will try to read SOME data, no matter how much. + {\bf wxSOCKET\_NOWAIT} will always return immediately, even if it cannot read or write ANY data. + {\bf wxSOCKET\_WAITALL} will only return when it has read or written ALL the data. + {\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and it control whether the GUI blocks. @@ -172,9 +175,11 @@ following flags can be used: \end{twocollist}% For example: + \begin{verbatim} sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG); \end{verbatim} + In this example, the user will be notified about incoming socket data and whenever the connection is closed. @@ -302,9 +307,9 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF \wxheading{See also} -\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ -\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ -\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ +\helpref{wxSocketBase::Error}{wxsocketbaseerror}, +\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, +\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} % @@ -333,13 +338,13 @@ Returns a reference to the current object. \wxheading{Remark/Warning} The exact behaviour of wxSocketBase::Read() depends on the combination -of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} +of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}. \wxheading{See also} -\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ -\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ -\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ +\helpref{wxSocketBase::Error}{wxsocketbaseerror}, +\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, +\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} % @@ -368,13 +373,13 @@ Returns a reference to the current object. \wxheading{Remark/Warning} The exact behaviour of wxSocketBase::Write() depends on the combination -of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} +of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}. \wxheading{See also} -\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ -\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ -\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ +\helpref{wxSocketBase::Error}{wxsocketbaseerror}, +\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, +\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} % @@ -412,10 +417,10 @@ depends on the wxSOCKET_BLOCK flag. For a detailed explanation, see \helpref{wxS \wxheading{See also} -\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ -\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ -\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ -\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}\\ +\helpref{wxSocketBase::Error}{wxsocketbaseerror}, +\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, +\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, +\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}, \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg} % @@ -451,10 +456,10 @@ depends on the wxSOCKET_SPEED flag. For a detailed explanation, see \helpref{wxS \wxheading{See also} -\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ -\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ -\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ -\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}\\ +\helpref{wxSocketBase::Error}{wxsocketbaseerror}, +\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, +\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, +\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}, \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg} % @@ -483,8 +488,8 @@ Returns a reference to the current object. \wxheading{See also} -\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ -\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ +\helpref{wxSocketBase::Error}{wxsocketbaseerror}, +\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastError}{wxsocketbaselasterror} % @@ -495,8 +500,8 @@ Returns a reference to the current object. \func{wxSocketBase\&}{Discard}{\void} This function simply deletes all bytes in the incoming queue. This function -doesn't wait. That is, it will behave as if the wxSOCKET_NOWAIT flag was set. The -wxSOCKET_SPEED and wxSOCKET_WAITALL flags have no effect on this function. +doesn't wait. That is, it will behave as if the wxSOCKET\_NOWAIT flag was set. The +wxSOCKET\_SPEED and wxSOCKET\_WAITALL flags have no effect on this function. Use LastCount to see the number of bytes discarded. @@ -526,8 +531,8 @@ 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::WaitForRead}{wxsocketbasewaitforread}, +\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} % @@ -551,8 +556,8 @@ Returns TRUE if there is data to be read, FALSE if the timeout was reached. \wxheading{See also} -\helpref{wxSocketBase::Wait}{wxsocketbasewait}\\ -\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\ +\helpref{wxSocketBase::Wait}{wxsocketbasewait}, +\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} % @@ -576,8 +581,8 @@ Returns TRUE if you can write to the socket, FALSE if the timeout was reached. \wxheading{See also} -\helpref{wxSocketBase::Wait}{wxsocketbasewait}\\ -\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\ +\helpref{wxSocketBase::Wait}{wxsocketbasewait}, +\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} % @@ -602,8 +607,8 @@ Returns TRUE if the connection was lost, FALSE if the timeout was reached. \wxheading{See also} -\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\ -\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\ +\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, +\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} % --------------------------------------------------------------------------- @@ -695,11 +700,11 @@ Callback and CallbackData. \wxheading{See also} -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ -\helpref{wxSocketBase::Notify}{wxsocketbasenotify}\\ -\helpref{wxSocketEvent}{wxsocketevent}\\ -\helpref{wxEvtHandler}{wxevthandler}\\ -\helpref{wxSocketBase::Callback}{wxsocketbasecallback}\\ +\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, +\helpref{wxSocketBase::Notify}{wxsocketbasenotify}, +\helpref{wxSocketEvent}{wxsocketevent}, +\helpref{wxEvtHandler}{wxevthandler}, +\helpref{wxSocketBase::Callback}{wxsocketbasecallback}, \helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata} \membersection{wxSocketBase::Callback}\label{wxsocketbasecallback} @@ -724,8 +729,8 @@ A pointer to the previous callback. \wxheading{See also} -\helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata}\\ -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ +\helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata}, +\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, \helpref{wxSocketBase::Notify}{wxsocketbasenotify} \membersection{wxSocketBase::CallbackData}\label{wxsocketbasecallbackdata} @@ -738,8 +743,8 @@ This function sets the the user data which will be passed to a \helpref{C callba A pointer to the previous user data. -\helpref{wxSocketBase::Callback}{wxsocketbasecallback}\\ -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ +\helpref{wxSocketBase::Callback}{wxsocketbasecallback}, +\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, \helpref{wxSocketBase::Notify}{wxsocketbasenotify} % --------------------------------------------------------------------------- @@ -791,14 +796,14 @@ Connects to a server using the specified address. If {\it wait} is TRUE, Connect will wait until the connection completes and the socket is ready to send or receive data, or until an event occurs. + {\bf Warning !} This will block the GUI. If {\it wait} is FALSE, Connect will try to establish the connection and return immediately, without blocking the GUI. When used this way, even if Connect returns FALSE, the connection request can be completed later. To detect this, use WaitConnection, or watch "connection" events (for -succesful establishment) and "lost" events (for connection failure) - +succesful establishment) and "lost" events (for connection failure). \wxheading{Parameters} @@ -819,8 +824,8 @@ with WaitOnConnect or by watching "connection" and "lost" events. \wxheading{See also} -\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}\\ -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ +\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}, +\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, \helpref{wxSocketBase::Notify}{wxsocketbasenotify} % @@ -880,8 +885,8 @@ The wxSOCKET_INPUT event is generated when the \wxheading{See also} -\helpref{wxSocketBase}{wxsocketbase},\rtfsp -\helpref{wxSocketClient}{wxsocketclient},\rtfsp +\helpref{wxSocketBase}{wxsocketbase}, +\helpref{wxSocketClient}{wxsocketclient}, \helpref{wxSocketServer}{wxsocketserver} \latexignore{\rtfignore{\wxheading{Members}}} @@ -968,9 +973,9 @@ connections. \wxheading{See also} -\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}\\ -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ -\helpref{wxSocketBase::Notify}{wxsocketbasenotify}\\ +\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}, +\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, +\helpref{wxSocketBase::Notify}{wxsocketbasenotify}, \helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith} % @@ -993,11 +998,10 @@ Returns TRUE on success, or FALSE if an error occured or if the {\it wait} parameter was FALSE and there were no pending connections. -\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}\\ -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ -\helpref{wxSocketBase::Notify}{wxsocketbasenotify}\\ -\helpref{wxSocketServer::Accept}{wxsocketserveraccept} for a detailed explanation - +\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}, +\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, +\helpref{wxSocketBase::Notify}{wxsocketbasenotify}, +\helpref{wxSocketServer::Accept}{wxsocketserveraccept} % % WaitForAccept @@ -1022,7 +1026,6 @@ Returns TRUE if an incoming connection arrived, FALSE if the timeout expired. \wxheading{See also} -\helpref{wxSocketServer::Accept}{wxsocketserveraccept}\\ +\helpref{wxSocketServer::Accept}{wxsocketserveraccept}, \helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith} - diff --git a/docs/latex/wx/stattext.tex b/docs/latex/wx/stattext.tex index aea19213d2..2802fe6ff8 100644 --- a/docs/latex/wx/stattext.tex +++ b/docs/latex/wx/stattext.tex @@ -93,4 +93,3 @@ label unless the control has wxST\_NO\_AUTORESIZE flag. \docparam{label}{The new label to set. It may contain newline characters.} - diff --git a/docs/latex/wx/tclipbrd.tex b/docs/latex/wx/tclipbrd.tex index e22440d9c4..dc78c445d5 100644 --- a/docs/latex/wx/tclipbrd.tex +++ b/docs/latex/wx/tclipbrd.tex @@ -26,7 +26,7 @@ implement both of them using almost the same code - or, in other words, if you implement drag and drop support for your application, you get clipboard support for free and vice versa. -In the heart of both clipboard and drag and drop operations lies the +At the heart of both clipboard and drag and drop operations lies the \helpref{wxDataObject}{wxdataobject} class. The objects of this class (or, to be precise, classes derived from it) represent the data which is being carried by the mouse during drag and drop operation or copied to or pasted from the @@ -42,7 +42,7 @@ application and even the same window when, for example, you drag some text from one position to another in a word processor. Let us describe what each of them should do. -\subsection{The data provider (source) duties}{wxdataobjectsource} +\subsection{The data provider (source) duties}\label{wxdataobjectsource} The data provider is responsible for creating a \helpref{wxDataObject}{wxdataobject} containing the data to be @@ -66,7 +66,7 @@ deletes) data - in fact, this usually depends on which menu item the user chose. But for drag and drop it can only know it after \helpref{DoDragDrop}{wxdropsourcedodragdrop} returns (from its return value). -\subsection{The data receiver (target) duties}{wxdataobjecttarget} +\subsection{The data receiver (target) duties}\label{wxdataobjecttarget} To receive (paste in usual terminology) data from the clipboard, you should create a \helpref{wxDataObject}{wxdataobject} derived class which supports the @@ -81,4 +81,3 @@ data itself may be requested by calling \helpref{wxDropTarget::GetData}{wxdroptargetwxdroptarget} method which fills the data object. - diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex index 7daf692886..6f0f483b54 100644 --- a/docs/latex/wx/topics.tex +++ b/docs/latex/wx/topics.tex @@ -4,7 +4,7 @@ This chapter contains a selection of topic overviews. -\input tsamples.tex +%\input tsamples.tex \input tapp.tex \input tstring.tex \input tcontain.tex diff --git a/docs/latex/wx/txtdatob.tex b/docs/latex/wx/txtdatob.tex index 13cce6cb88..342408feeb 100644 --- a/docs/latex/wx/txtdatob.tex +++ b/docs/latex/wx/txtdatob.tex @@ -22,7 +22,7 @@ overridden to increase efficiency. \wxheading{Derived from} -\helpref{wxDataObjectSimple}{wxdataobjectsimple} +\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\ \helpref{wxDataObject}{wxdataobject} \wxheading{Include files} @@ -44,7 +44,7 @@ overridden to increase efficiency. \func{}{wxTextDataObject}{\param{const wxString\& }{text = wxEmptyString}} Constructor, may be used to initialise the text (otherwise -\helpref{SetText}{wxtextdataobjectsettext} should be used later) +\helpref{SetText}{wxtextdataobjectsettext} should be used later). \membersection{wxTextDataObject::GetTextLength}\label{wxtextdataobjectgettextlength} @@ -74,4 +74,3 @@ when the data object receives the data and, by default, copies the text into the member variable. If you want to process the text on the fly you may wish to override this function. - diff --git a/docs/latex/wx/wx.hpj b/docs/latex/wx/wx.hpj index b8f8205dae..43d8c37176 100644 --- a/docs/latex/wx/wx.hpj +++ b/docs/latex/wx/wx.hpj @@ -1,14 +1,14 @@ [OPTIONS] -BMROOT=L:\wxWindows\docs\latex\wx ; Assume that bitmaps are where the source is +BMROOT=d:\wx2\wxWindows\docs\latex\wx ; Assume that bitmaps are where the source is TITLE=wxWindows Manual CONTENTS=Contents COMPRESS=HIGH [FILES] -Wx.rtf +wx.rtf [CONFIG] -CreateButton("Up", "&Up", "JumpId(`Wx.hlp', `Contents')") +CreateButton("Up", "&Up", "JumpId(`wx.hlp', `Contents')") BrowseButtons() [MAP]