\wxheading{Derived from}
-\helpref{wxDataObjectSimple}{wxdataobjectsimple}
+\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject}
\wxheading{Include files}
data object receives data. Usually there will be no reason to override this
function.
-
\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
\input slider.tex
\input sckaddr.tex
\input socket.tex
-%\input gsocket.tex
\input splitevt.tex
\input strmsock.tex
\input spinbutt.tex
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
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
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
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.
"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}
\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}
\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.
\wxheading{Derived from}
-\helpref{wxDataObjectSimple}{wxdataobjectsimple}
+\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject}
\wxheading{Include files}
\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.
\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}}
\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}
\end{twocollist}}
}
-
\membersection{wxMenu::AppendSeparator}\label{wxmenuappendseparator}
\func{void}{AppendSeparator}{\void}
\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.
\pythonnote{Only the default constructor is supported in wxPython.
Use wxMenuBar.Append instead.}
-
\membersection{wxMenuBar::\destruct{wxMenuBar}}
\func{void}{\destruct{wxMenuBar}}{\void}
\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}
\helpref{wxMenuBar::GetLabelTop}{wxmenubargetlabeltop}
-
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: t
-%%% End:
<wx/socket.h>
-\wxheading{wxSocket errors}%\label{wxsocketerrs} % Labels don't work on a non-section!
+\wxheading{wxSocket errors}
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
% ---------------------------------------------------------------------------
\wxheading{See also}
-\helpref{wxSocketEvent}{wxsocketevent}\\
-\helpref{wxSocketClient}{wxsocketclient}\\
+\helpref{wxSocketEvent}{wxsocketevent},
+\helpref{wxSocketClient}{wxsocketclient},
\helpref{wxSocketServer}{wxsocketserver}
% ---------------------------------------------------------------------------
\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}}
\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.
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.
\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.
\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}
%
\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}
%
\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}
%
\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}
%
\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}
%
\wxheading{See also}
-\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
%
\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.
\wxheading{See also}
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
%
\wxheading{See also}
-\helpref{wxSocketBase::Wait}{wxsocketbasewait}\\
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\
+\helpref{wxSocketBase::Wait}{wxsocketbasewait},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
%
\wxheading{See also}
-\helpref{wxSocketBase::Wait}{wxsocketbasewait}\\
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\
+\helpref{wxSocketBase::Wait}{wxsocketbasewait},
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
%
\wxheading{See also}
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
% ---------------------------------------------------------------------------
\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}
\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}
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}
% ---------------------------------------------------------------------------
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}
\wxheading{See also}
-\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}\\
-\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}\\
+\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect},
+\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}
%
\wxheading{See also}
-\helpref{wxSocketBase}{wxsocketbase},\rtfsp
-\helpref{wxSocketClient}{wxsocketclient},\rtfsp
+\helpref{wxSocketBase}{wxsocketbase},
+\helpref{wxSocketClient}{wxsocketclient},
\helpref{wxSocketServer}{wxsocketserver}
\latexignore{\rtfignore{\wxheading{Members}}}
\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}
%
{\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
\wxheading{See also}
-\helpref{wxSocketServer::Accept}{wxsocketserveraccept}\\
+\helpref{wxSocketServer::Accept}{wxsocketserveraccept},
\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
-
\docparam{label}{The new label to set. It may contain newline characters.}
-
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
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
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
\helpref{wxDropTarget::GetData}{wxdroptargetwxdroptarget} method which fills
the data object.
-
This chapter contains a selection of topic overviews.
-\input tsamples.tex
+%\input tsamples.tex
\input tapp.tex
\input tstring.tex
\input tcontain.tex
\wxheading{Derived from}
-\helpref{wxDataObjectSimple}{wxdataobjectsimple}
+\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\
\helpref{wxDataObject}{wxdataobject}
\wxheading{Include files}
\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}
the member variable. If you want to process the text on the fly you may wish to
override this function.
-
[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]
projects / wxWidgets.git / commitdiff
