Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some doc corrections

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4294 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
1999-11-02 10:02:01 +00:00
parent e92f266ca7
commit 407f36811e
11 changed files with 110 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/latex/wx/bmpdatob.tex
View File

@@ -15,7 +15,7 @@ efficiency.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxDataObjectSimple}{wxdataobjectsimple} \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject} \helpref{wxDataObject}{wxdataobject}
\wxheading{Include files} \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 data object receives data. Usually there will be no reason to override this
function. function.

5
docs/latex/wx/classes.tex
View File

@@ -40,8 +40,8 @@
\input cursor.tex \input cursor.tex
\input database.tex \input database.tex
\input dataobj.tex \input dataobj.tex
\input dobjcomp.tex %\input dobjcomp.tex
\input dobjsmpl.tex %\input dobjsmpl.tex
\input datstrm.tex \input datstrm.tex
\input date.tex \input date.tex
\input dc.tex \input dc.tex
@@ -193,7 +193,6 @@
\input slider.tex \input slider.tex
\input sckaddr.tex \input sckaddr.tex
\input socket.tex \input socket.tex
%\input gsocket.tex
\input splitevt.tex \input splitevt.tex
\input strmsock.tex \input strmsock.tex
\input spinbutt.tex \input spinbutt.tex

55
docs/latex/wx/dataobj.tex
View File

@@ -13,15 +13,15 @@
A wxDataObject represents data that can be copied to or from the clipboard, or 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 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 '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 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 know what data formats it supports and how to render itself in each of
supported formats. supported formats.
A supported format, incidentally, is exactly the format in which the data can 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 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 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 '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 created from data on this format or vice versa. wxDataObject defines an
enumeration type enumeration type
@@ -36,14 +36,13 @@ enum Direction
which allows to distinguish between them. See which allows to distinguish between them. See
\helpref{wxDataFormat}{wxdataformat} documentation for more about formats. \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, 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 but may be annoying if you only want to do something simple like cut and paste
text. text.
To provide a solution for both cases, wxWindows has two predefined classes To provide a solution for both cases, wxWindows has two predefined classes
which derive from wxDataObject: which derive from wxDataObject: \helpref{wxDataObjectSimple}{wxdataobjectsimple} and
\helpref{wxDataObjectSimple}{wxdataobjectsimple} and
\helpref{wxDataObjectComposite}{wxdataobjectcomposite}. \helpref{wxDataObjectComposite}{wxdataobjectcomposite}.
\helpref{wxDataObjectSimple}{wxdataobjectsimple} is \helpref{wxDataObjectSimple}{wxdataobjectsimple} is
the simplest wxDataObject possible and only holds data in a single format (such 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 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): 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, \twocolitem{0. Use one of built-in classes}{You may use wxTextDataObject,
wxBitmapDataObject or wxFileDataObject in the simplest cases when you only need 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 \twocolitem{1. Derive your class from wxDataObjectSimple}{This is the simplest
solution for custom data - you will only support one format and so probably 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 won't be able to communicate with other programs, but data transfer will work
in your program (or between different copies of it).} in your program (or between different copies of it).}
\twocolitem{2. Use wxDataObjectComposite}{This is a quite simple, but rather \twocolitem{2. Use wxDataObjectComposite}{This is a simple but powerful
powerful solution which allows you to support any number of formats (either solution which allows you to support any number of formats (either
standard or custom if you combine it with the previous solution).} 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 maximal flexibility and efficiency, but it also is the most difficult to
implement.} implement.}
\end{twocollist} \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 multiple formats is by using wxDataObjectComposite, but it is not the most
efficient one as each wxDataObjectSimple would contain the whole data in its 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 respective formars. Now imagine that you want to paste 200 pages of text in
@@ -80,10 +79,10 @@ will have to derive from wxDataObject directly and make it enumerate its
formats and provide the data in the requested format on demand. formats and provide the data in the requested format on demand.
Note that neither the GTK data transfer mechanisms for the clipboard and 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 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 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 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. available.
There are several predefined data object classes derived from There are several predefined data object classes derived from
@@ -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 "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 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 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 and from the clipboard and for drag and drop). Note that the format string
translation under Windows is not yet finnished. translation under Windows is not yet finished.
\wxheading{Virtual functions to override} \wxheading{Virtual functions to override}
@@ -147,12 +146,10 @@ Destructor.
\membersection{wxDataObject::GetAllFormats}\label{wxdataobjectgetallformats} \membersection{wxDataObject::GetAllFormats}\label{wxdataobjectgetallformats}
\constfunc{virtual void}{GetAllFormats}{ \constfunc{virtual void}{GetAllFormats}{ \param{wxDataFormat *}{formats}, \param{Direction}{ dir = Get}}
\param{wxDataFormat *}{formats},
\param{Direction}{ dir = Get}}
Copy all supported formats in the given direction to the array pointed to by 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). {\it formats}. There is enough space for GetFormatCount(dir) formats in it.
\membersection{wxDataObject::GetDataHere}\label{wxdataobjectgetdatahere} \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}} \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} \membersection{wxDataObject::GetPreferredFormat}\label{wxdataobjectgetpreferredformat}
\constfunc{virtual wxDataFormat}{GetPreferredFormat}{\param{Direction}{ dir = Get}} \constfunc{virtual wxDataFormat}{GetPreferredFormat}{\param{Direction}{ dir = Get}}
Returns the preferred format for either rendering the data (if {\it dir} is Returns the preferred format for either rendering the data (if {\it dir} is {\tt Get},
{\tt Get}, its default value) or for setting it. Usually this will be the its default value) or for setting it. Usually this will be the
native format of the wxDataObject. native format of the wxDataObject.
\membersection{wxDataObject::SetData}\label{wxdataobjectsetdata} \membersection{wxDataObject::SetData}\label{wxdataobjectsetdata}
\func{virtual bool}{SetData}{ \func{virtual bool}{SetData}{ \param{const wxDataFormat\&}{ format}, \param{size\_t}{ len}, \param{const void }{*buf} }
\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 Set the data in the format {\it format} of the length {\it len} provided in the
buffer {\it buf}. buffer {\it buf}.
Returns TRUE on sucess, FALSE on failure. Returns TRUE on success, FALSE on failure.

2
docs/latex/wx/fildatob.tex
View File

@@ -12,7 +12,7 @@ None.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxDataObjectSimple}{wxdataobjectsimple} \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject} \helpref{wxDataObject}{wxdataobject}
\wxheading{Include files} \wxheading{Include files}

15
docs/latex/wx/menu.tex
View File

@@ -42,7 +42,7 @@ this window.
\membersection{wxMenu::wxMenu}\label{wxmenuconstr} \membersection{wxMenu::wxMenu}\label{wxmenuconstr}
\func{}{wxMenu}{\param{const wxString\& }{title = ""}, \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. Constructs a wxMenu object.
@@ -68,6 +68,7 @@ does.
Constructs a wxMenu object. Constructs a wxMenu object.
\wxheading{Parameters} \wxheading{Parameters}
\docparam{style}{If set to \tt{wxMENU_TEAROFF}, the menu will be detachable.} \docparam{style}{If set to \tt{wxMENU_TEAROFF}, the menu will be detachable.}
\membersection{wxMenu::\destruct{wxMenu}} \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::AppendSeparator}{wxmenuappendseparator}, \helpref{wxMenu::SetLabel}{wxmenusetlabel}, \helpref{wxMenu::GetHelpString}{wxmenugethelpstring},\rtfsp
\helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem} \helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem}
\pythonnote{In place of a single overloaded method name, wxPython \pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par implements the following methods:\par
\indented{2cm}{\begin{twocollist} \indented{2cm}{\begin{twocollist}
@@ -137,7 +137,6 @@ implements the following methods:\par
\end{twocollist}} \end{twocollist}}
} }
\membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator} \membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
\func{void}{AppendSeparator}{\void} \func{void}{AppendSeparator}{\void}
@@ -230,6 +229,7 @@ before matching.
\membersection{wxMenu::FindItemForId}\label{wxmenufinditemforid} \membersection{wxMenu::FindItemForId}\label{wxmenufinditemforid}
\constfunc{wxMenuItem*}{FindItemForId}{\param{int}{ id}} \constfunc{wxMenuItem*}{FindItemForId}{\param{int}{ id}}
\constfunc{wxMenuItem*}{FindItem}{\param{int}{ id}} \constfunc{wxMenuItem*}{FindItem}{\param{int}{ id}}
Finds the menu item object associated with the given menu item identifier. 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. \pythonnote{Only the default constructor is supported in wxPython.
Use wxMenuBar.Append instead.} Use wxMenuBar.Append instead.}
\membersection{wxMenuBar::\destruct{wxMenuBar}} \membersection{wxMenuBar::\destruct{wxMenuBar}}
\func{void}{\destruct{wxMenuBar}}{\void} \func{void}{\destruct{wxMenuBar}}{\void}
@@ -542,13 +541,14 @@ before matching.
\membersection{wxMenuBar::FindItem}\label{wxmenubarfinditem} \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. Finds the menu item object associated with the given menu item identifier.
\wxheading{Parameters} \wxheading{Parameters}
\docparam{id}{Menu item identifier.} \docparam{id}{Menu item identifier.}
\docparam{menu}{If not NULL, menu will get set to the associated menu.} \docparam{menu}{If not NULL, menu will get set to the associated menu.}
\wxheading{Return value} \wxheading{Return value}
@@ -716,8 +716,3 @@ Use only after the menubar has been associated with a frame.
\helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop} \helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End:

121
docs/latex/wx/socket.tex
View File

@@ -8,7 +8,7 @@
<wx/socket.h> <wx/socket.h>
\wxheading{wxSocket errors}%\label{wxsocketerrs} % Labels don't work on a non-section! \wxheading{wxSocket errors}
\twocolwidtha{7cm} \twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt \begin{twocollist}\itemsep=0pt
@@ -72,8 +72,8 @@ input to member functions that take a \helpref{wxSocketEvent}{wxsocketevent} arg
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketEvent}{wxsocketevent}\\ \helpref{wxSocketEvent}{wxsocketevent},
\helpref{wxSocketClient}{wxsocketclient}\\ \helpref{wxSocketClient}{wxsocketclient},
\helpref{wxSocketServer}{wxsocketserver} \helpref{wxSocketServer}{wxsocketserver}
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
@@ -145,10 +145,13 @@ extra care to avoid unwanted reentrance.
So: So:
{\bf wxSOCKET\_NONE} will try to read SOME data, no matter how much. {\bf wxSOCKET\_NONE} will try to read SOME data, no matter how much.
{\bf wxSOCKET\_NOWAIT} will always return immediately, even if it cannot {\bf wxSOCKET\_NOWAIT} will always return immediately, even if it cannot
read or write ANY data. read or write ANY data.
{\bf wxSOCKET\_WAITALL} will only return when it has read or written ALL {\bf wxSOCKET\_WAITALL} will only return when it has read or written ALL
the data. the data.
{\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and {\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and
it control whether the GUI blocks. it control whether the GUI blocks.
@@ -172,9 +175,11 @@ following flags can be used:
\end{twocollist}% \end{twocollist}%
For example: For example:
\begin{verbatim} \begin{verbatim}
sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG); sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
\end{verbatim} \end{verbatim}
In this example, the user will be notified about incoming socket data and In this example, the user will be notified about incoming socket data and
whenever the connection is closed. whenever the connection is closed.
@@ -302,9 +307,9 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ \helpref{wxSocketBase::Error}{wxsocketbaseerror},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
% %
@@ -333,13 +338,13 @@ Returns a reference to the current object.
\wxheading{Remark/Warning} \wxheading{Remark/Warning}
The exact behaviour of wxSocketBase::Read() depends on the combination 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} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ \helpref{wxSocketBase::Error}{wxsocketbaseerror},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
% %
@@ -368,13 +373,13 @@ Returns a reference to the current object.
\wxheading{Remark/Warning} \wxheading{Remark/Warning}
The exact behaviour of wxSocketBase::Write() depends on the combination 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} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ \helpref{wxSocketBase::Error}{wxsocketbaseerror},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
% %
@@ -412,10 +417,10 @@ depends on the wxSOCKET_BLOCK flag. For a detailed explanation, see \helpref{wxS
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ \helpref{wxSocketBase::Error}{wxsocketbaseerror},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}\\ \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg} \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
% %
@@ -451,10 +456,10 @@ depends on the wxSOCKET_SPEED flag. For a detailed explanation, see \helpref{wxS
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ \helpref{wxSocketBase::Error}{wxsocketbaseerror},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}\\ \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg} \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
% %
@@ -483,8 +488,8 @@ Returns a reference to the current object.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\ \helpref{wxSocketBase::Error}{wxsocketbaseerror},
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror} \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
% %
@@ -495,8 +500,8 @@ Returns a reference to the current object.
\func{wxSocketBase\&}{Discard}{\void} \func{wxSocketBase\&}{Discard}{\void}
This function simply deletes all bytes in the incoming queue. This function 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 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. wxSOCKET\_SPEED and wxSOCKET\_WAITALL flags have no effect on this function.
Use LastCount to see the number of bytes discarded. 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} \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}
% %
@@ -551,8 +556,8 @@ Returns TRUE if there is data to be read, 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}
% %
@@ -576,8 +581,8 @@ Returns TRUE if you can write to the socket, 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}
% %
@@ -602,8 +607,8 @@ Returns TRUE if the connection was lost, 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}
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
@@ -695,11 +700,11 @@ Callback and CallbackData.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}\\ \helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketEvent}{wxsocketevent}\\ \helpref{wxSocketEvent}{wxsocketevent},
\helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxEvtHandler}{wxevthandler},
\helpref{wxSocketBase::Callback}{wxsocketbasecallback}\\ \helpref{wxSocketBase::Callback}{wxsocketbasecallback},
\helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata} \helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata}
\membersection{wxSocketBase::Callback}\label{wxsocketbasecallback} \membersection{wxSocketBase::Callback}\label{wxsocketbasecallback}
@@ -724,8 +729,8 @@ A pointer to the previous callback.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata}\\ \helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify} \helpref{wxSocketBase::Notify}{wxsocketbasenotify}
\membersection{wxSocketBase::CallbackData}\label{wxsocketbasecallbackdata} \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. A pointer to the previous user data.
\helpref{wxSocketBase::Callback}{wxsocketbasecallback}\\ \helpref{wxSocketBase::Callback}{wxsocketbasecallback},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify} \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 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. the socket is ready to send or receive data, or until an event occurs.
{\bf Warning !} This will block the GUI. {\bf Warning !} This will block the GUI.
If {\it wait} is FALSE, Connect will try to establish the connection and 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 return immediately, without blocking the GUI. When used this way, even if
Connect returns FALSE, the connection request can be completed later. Connect returns FALSE, the connection request can be completed later.
To detect this, use WaitConnection, or watch "connection" events (for 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} \wxheading{Parameters}
@@ -819,8 +824,8 @@ with WaitOnConnect or by watching "connection" and "lost" events.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}\\ \helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify} \helpref{wxSocketBase::Notify}{wxsocketbasenotify}
% %
@@ -880,8 +885,8 @@ The wxSOCKET_INPUT event is generated when the
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase},\rtfsp \helpref{wxSocketBase}{wxsocketbase},
\helpref{wxSocketClient}{wxsocketclient},\rtfsp \helpref{wxSocketClient}{wxsocketclient},
\helpref{wxSocketServer}{wxsocketserver} \helpref{wxSocketServer}{wxsocketserver}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
@@ -968,9 +973,9 @@ connections.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}\\ \helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}\\ \helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith} \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 {\it wait} parameter was FALSE and there were no pending
connections. connections.
\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}\\ \helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\ \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}\\ \helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketServer::Accept}{wxsocketserveraccept} for a detailed explanation \helpref{wxSocketServer::Accept}{wxsocketserveraccept}
% %
% WaitForAccept % WaitForAccept
@@ -1022,7 +1026,6 @@ Returns TRUE if an incoming connection arrived, FALSE if the timeout expired.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketServer::Accept}{wxsocketserveraccept}\\ \helpref{wxSocketServer::Accept}{wxsocketserveraccept},
\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith} \helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}

1
docs/latex/wx/stattext.tex
View File

@@ -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.} \docparam{label}{The new label to set. It may contain newline characters.}

7
docs/latex/wx/tclipbrd.tex
View File

@@ -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 words, if you implement drag and drop support for your application, you get
clipboard support for free and vice versa. 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 \helpref{wxDataObject}{wxdataobject} class. The objects of this class (or, to
be precise, classes derived from it) represent the data which is being carried 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 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 one position to another in a word processor. Let us describe what each of them
should do. 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 The data provider is responsible for creating a
\helpref{wxDataObject}{wxdataobject} containing the data to be \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 chose. But for drag and drop it can only know it after
\helpref{DoDragDrop}{wxdropsourcedodragdrop} returns (from its return value). \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 To receive (paste in usual terminology) data from the clipboard, you should
create a \helpref{wxDataObject}{wxdataobject} derived class which supports the 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 \helpref{wxDropTarget::GetData}{wxdroptargetwxdroptarget} method which fills
the data object. the data object.

2
docs/latex/wx/topics.tex
View File

@@ -4,7 +4,7 @@
This chapter contains a selection of topic overviews. This chapter contains a selection of topic overviews.
\input tsamples.tex %\input tsamples.tex
\input tapp.tex \input tapp.tex
\input tstring.tex \input tstring.tex
\input tcontain.tex \input tcontain.tex

5
docs/latex/wx/txtdatob.tex
View File

@@ -22,7 +22,7 @@ overridden to increase efficiency.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxDataObjectSimple}{wxdataobjectsimple} \helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject} \helpref{wxDataObject}{wxdataobject}
\wxheading{Include files} \wxheading{Include files}
@@ -44,7 +44,7 @@ overridden to increase efficiency.
\func{}{wxTextDataObject}{\param{const wxString\& }{text = wxEmptyString}} \func{}{wxTextDataObject}{\param{const wxString\& }{text = wxEmptyString}}
Constructor, may be used to initialise the text (otherwise 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} \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 the member variable. If you want to process the text on the fly you may wish to
override this function. override this function.

6
docs/latex/wx/wx.hpj
View File

@@ -1,14 +1,14 @@
[OPTIONS] [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 TITLE=wxWindows Manual
CONTENTS=Contents CONTENTS=Contents
COMPRESS=HIGH COMPRESS=HIGH
[FILES] [FILES]
Wx.rtf wx.rtf
[CONFIG] [CONFIG]
CreateButton("Up", "&Up", "JumpId(`Wx.hlp', `Contents')") CreateButton("Up", "&Up", "JumpId(`wx.hlp', `Contents')")
BrowseButtons() BrowseButtons()
[MAP] [MAP]