--- /dev/null
+\section{\class{wxBitmapDataObject}}\label{wxbitmapdataobject}
+
+ wxBitmapDataObject is a specialization of wxDataObject for bitmaps.
+
+\wxheading{Derived from}
+
+\helpref{wxDataObject}{wxdataobject}
+
+\wxheading{See also}
+
+\helpref{wxDataObject}{wxdataobject}, \helpref{wxBitmap}{wxbitmap}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxBitmapDataObject::wxBitmapDataObject}\label{wxbitmapdataobjectwxbitmapdataobject}
+
+\func{}{wxBitmapDataObject}{\void}
+
+Constructor. TODO: shouldn't there be a constructor taking a wxBitmap?
+
+\membersection{wxBitmapDataObject::GetFormat}\label{wxbitmapdataobjectgetformat}
+
+\func{virtual wxDataFormat}{GetFormat}{\void}
+
+Returns wxDF\_BITMAP.
+
+\membersection{wxBitmapDataObject::SetBitmap}\label{wxbitmapdataobjectsetbitmap}
+
+\func{virtual void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}
+
+Sets the bitmap for the data object.
+
+\membersection{wxBitmapDataObject::GetBitmap}\label{wxbitmapdataobjectgetbitmap}
+
+\constfunc{virtual wxBitmap}{GetBitmap}{\void}
+
+Returns the bitmap associated with the data object.
+
\overview{Database classes overview}{odbcoverview}
-wxWindows provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
-product.
+wxWindows provides two alternative sets of classes for accessing Microsoft's ODBC (Open Database Connectivity)
+product. The new version by Remstar is documented in a separate manual.
+The older classes are as follows:
\begin{twocollist}\itemsep=0pt
\twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class}
\twocolitem{\helpref{wxRecordSet}{wxrecordset}}{Class representing one or more record}
\end{twocollist}
+{\large {\bf Drag and drop and clipboard classes}}
+
+\overview{Drag and drop and clipboard overview}{wxdndoverview}
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class}
+\twocolitem{\helpref{wxFileDropTarget}{wxfiledroptarget}}{File drop target class}
+\twocolitem{\helpref{wxTextDropTarget}{wxtextdroptarget}}{Text drop target class}
+\twocolitem{\helpref{wxDropSource}{wxdropsource}}{Drop source class}
+\twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class}
+\twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class}
+\twocolitem{\helpref{wxFileDataObject}{wxtextdataobject}}{File data object class}
+\twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class}
+\twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class}
+\end{twocollist}
+
{\large {\bf File related classes}}
wxWindows has several small classes to work with disk files, see \helpref{file classes
\twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
\twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class}
\end{twocollist}
+
\input button.tex
\input bitmap.tex
\input bbutton.tex
+\input bmpdatob.tex
\input brush.tex
\input calclevt.tex
\input checkbox.tex
\input crtslock.tex
\input cursor.tex
\input database.tex
+\input dataobj.tex
\input date.tex
\input datstrm.tex
\input dc.tex
\input docprfrm.tex
\input doctempl.tex
\input dropevt.tex
+\input dropsrc.tex
+\input droptrgt.tex
\input eraseevt.tex
\input event.tex
\input evthand.tex
\input expr.tex
\input file.tex
+\input fildatob.tex
\input filedlg.tex
+\input fildrptg.tex
\input filehist.tex
\input filetype.tex
\input focusevt.tex
\input taskbar.tex
\input text.tex
\input textdlg.tex
+\input txtdrptg.tex
\input valtext.tex
-% \input tempfile.tex
-% \input textfile.tex
+\input tempfile.tex
+\input txtdatob.tex
+\input textfile.tex
\input thread.tex
\input time.tex
\input timer.tex
\section{\class{wxClipboard}}\label{wxclipboard}
-There is one wxClipboard object referenced by the pointer
-wxTheClipboard, initialized by calling \helpref{wxInitClipboard}{wxinitclipboard}.
-Under X, clipboard manipulation must be done by using this class, and
-such code will work under MS Windows also. Under MS Windows, you have the
-alternative of using the normal clipboard functions.
-
-The documentation for this class will be expanded in due course. At present,
-wxClipboard is only used in the wxMediaWindow add-on library.
+A class for manipulating the clipboard. Note that this is not compatible with the
+clipboard class from wxWindows 1.xx, which has the same name but a different implementation.
+
+To use the clipboard, construct a wxClipboard object on the stack and
+call \helpref{wxClipboard::Open}{wxclipboardopen}. If this operation returns TRUE, you
+now own the clipboard. Call \helpref{wxClipboard::SetData}{wxclipboardsetdata} to put data
+on the clipboard (one or more times), or \helpref{wxClipboard::GetData}{wxclipboardgetdata} to
+retrieve data from the clipboard. Call \helpref{wxClipboard::Close}{wxclipboardclose} to close
+the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
+
+For example:
+
+\begin{verbatim}
+ wxClipboard clipboard;
+
+ // Write some text to the clipboard
+ if (clipboard.Open())
+ {
+ wxTextDataObject object("Some text");
+ clipboard.SetData(& object);
+ clipboard.Close();
+ }
+
+ // Read some text
+ if (clipboard.Open() && clipboard.IsSupportedFormat(wxDF_TEXT))
+ {
+ wxTextDataObject object;
+ clipboard.GetData(& object);
+ clipboard.Close();
+
+ wxMessageBox(object.GetText());
+ }
+\end{verbatim}
\wxheading{Derived from}
\wxheading{See also}
-\helpref{wxClipboardClient}{wxclipboardclient}, \helpref{wxInitClipboard}{wxinitclipboard}.
+\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDataObject}{wxdataobject}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxClipboard::GetClipboardClient}
-
-\func{wxClipboardClient *}{GetClipboardClient}{\void}
-
-Get the clipboard client directly. Will be NULL if clipboard data
-is a string, or if some other application owns the clipboard.
-This can be useful for shortcutting data translation, if the
-clipboard user can check for a specific client.
-
-\membersection{wxClipboard::GetClipboardData}
-
-\func{char*}{GetClipboardData}{\param{const wxString\& }{format}, \param{long *}{length}, \param{long}{ time}}
-
-Get data from the clipboard.
+\membersection{wxClipboard::wxClipboard}
-\membersection{wxClipboard::GetClipboardString}
+\func{}{wxClipboard}{\void}
-\func{wxString}{GetClipboardString}{\param{long}{ time}}
+Constructor.
-Get the data from the clipboard in the format ``TEXT".
+\membersection{wxClipboard::\destruct{wxClipboard}}
-\membersection{wxClipboard::SetClipboardClient}
+\func{}{\destruct{wxClipboard}}{\void}
-\func{void}{SetClipboardClient}{\param{wxClipboardClient *}{client}, \param{long}{ time}}
+Destructor.
-Set the clipboard data owner.
+\membersection{wxClipboard::Clear}\label{wxclipboardclear}
-\membersection{wxClipboard::SetClipboardString}
+\func{void}{Clear}{\void}
-\func{void}{SetClipboardString}{\param{const wxString\& }{data}, \param{long}{ time}}
+Clears the global clipboard object and the system's clipboard if possible.
-Set the clipboard string; does not require a client.
+\membersection{wxClipboard::Close}\label{wxclipboardclose}
-\section{\class{wxClipboardClient}}\label{wxclipboardclient}
+\func{bool}{Close}{\void}
-Implemented under X and MS Windows, a clipboard client holds data
-belonging to the clipboard. For plain text, a client is not necessary.
+Call this function to close the clipboard, having opened it with \helpref{wxClipboard::Close}{wxclipboardclose}.
-wxClipboardClient is an abstract class for which the virtual functions
-BeingReplaced and GetData must be overridden.
+\membersection{wxClipboard::GetData}\label{wxclipboardgetdata}
-\wxheading{Derived from}
-
-\helpref{wxObject}{wxobject}
+\func{bool}{GetData}{\param{wxDataObject*}{ data}}
-\wxheading{See also}
-
-\helpref{wxClipboard}{wxclipboard}, \helpref{wxInitClipboard}{wxinitclipboard}.
+Call this function to fill {\it data} with data on the clipboard, if available in the required
+format.
-\latexignore{\rtfignore{\wxheading{Members}}}
+\membersection{wxClipboard::IsSupportedFormat}\label{wxclipboardissupportedformat}
-\membersection{wxClipboardClient::formats}
+\func{bool}{IsSupportedFormat}{\param{wxDataFormat}{ format}, \param{const wxString\&}{ id = ""}}
-\member{wxStringList}{formats}
+Returns TRUE if the given format is available on the clipboard.
-This list should be filled in with strings indicating the formats
-this client can provide. Almost all clients will provide``TEXT".
-Format names should be 4 characters long, so things will work
-out on the Macintosh.
+\wxheading{Parameters}
-\membersection{wxClipboardClient::BeingReplaced}
+\docparam{format}{The format. See \helpref{wxDataObject}{wxdataobject} for a list of formats.}
-\func{void}{BeingReplaced}{\void}
+\docparam{id}{ If {\it format} is wxDF\_PRIVATE, {\it id} is the identifier of the private data format.}
-This method is called when the client is losing the selection.
+\membersection{wxClipboard::Open}\label{wxclipboardopen}
-\membersection{wxClipboardClient::GetData}
+\func{bool}{Open}{\void}
-\func{char*}{GetData}{\param{const wxString\& }{format}, \param{long *}{size}}
+Call this function to open the clipboard before calling \helpref{wxClipboard::SetData}{wxclipboardsetdata}
+and \helpref{wxClipboard::GetData}{wxclipboardgetdata}.
-This method is called when someone wants the data this client is
-supplying to the clipboard.
+Call \helpref{wxClipboard::Close}{wxclipboardclose} when you have finished with the clipboard. You
+should keep the clipboard open for only a very short time.
-{\it format} is a string indicating the
-format of the data - one of the strings from the ``formats"
-list.
+\membersection{wxClipboard::SetData}\label{wxclipboardsetdata}
-{\it size} should be filled with the size of the resulting
-data. In the case of text, {\it size} does not count the
-NULL terminator.
+\func{bool}{SetData}{\param{wxDataObject*}{ data}}
+Call this function to set a data object to the clipboard. This function can be called several times
+to put different formats on the clipboard.
--- /dev/null
+\section{\class{wxDataObject}}\label{wxdataobject}
+
+A wxDataObject represents data that can be copied to or from the clipboard, or
+dragged and dropped.
+
+There are several predefined data object classes, such as \helpref{wxFileDataObject}{wxfiledataobject},
+\helpref{wxTextDataObject}{wxtextdataobject}, and \helpref{wxBitmapDataObject}{wxbitmapdataobject}.
+
+You may also derive your own data object classes for user-defined types.
+
+TODO: how do user-defined types work?
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{Types}
+
+\index{wxDataFormat}The following symbols are interchangable with the
+Windows equivalents.
+
+\begin{verbatim}
+enum wxDataFormat
+{
+ wxDF_TEXT = 1, /* CF_TEXT */
+ wxDF_BITMAP = 2, /* CF_BITMAP */
+ wxDF_METAFILE = 3, /* CF_METAFILEPICT */
+ wxDF_DIB = 8, /* CF_DIB */
+ wxDF_OEMTEXT = 7, /* CF_OEMTEXT */
+ wxDF_FILENAME = 15, /* CF_HDROP */
+ wxDF_PRIVATE = 20
+};
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{wxFileDataObject}{wxfiledataobject},
+\helpref{wxTextDataObject}{wxtextdataobject},
+\helpref{wxBitmapDataObject}{wxbitmapdataobject},
+\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropTarget}{wxdroptarget},
+\helpref{wxDropSource}{wxdropsource},
+\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxDataObject::wxDataObject}\label{wxdataobjectwxdataobject}
+
+\func{}{wxDataObject}{\void}
+
+Constructor.
+
+\membersection{wxDataObject::\destruct{wxDataObject}}\label{wxdataobjectdtor}
+
+\func{}{\destruct{wxDataObject}}{\void}
+
+Destructor.
+
+\membersection{wxDataObject::GetFormat}\label{wxdataobjectgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\void}
+
+Returns the format of the object. See \helpref{Types}{wxdataobject}.
+
This class is used for drop files events, that is, when files have been dropped
onto the window. This functionality is currently only available under Windows.
+Important note: this is a separate implementation to the more general
+drag and drop implementation documented \helpref{here}{wxdndoverview}. It uses the
+older, Windows message-based approach of dropping files.
+
\wxheading{Derived from}
\helpref{wxEvent}{wxevent}\\
--- /dev/null
+\section{\class{wxDropSource}}\label{wxdropsource}
+
+\overview{Overview}{wxdndoverview}
+
+This class represents a source for a drag and drop operation.
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{Types}
+
+\index{wxDragResult}wxDragResult is defined as follows:
+
+{\small\begin{verbatim}
+enum wxDragResult
+ {
+ wxDragError, // error prevented the d&d operation from completing
+ wxDragNone, // drag target didn't accept the data
+ wxDragCopy, // the data was successfully copied
+ wxDragMove, // the data was successfully moved
+ wxDragCancel // the operation was cancelled by user (not an error)
+ };
+\end{verbatim}%
+}
+
+\wxheading{See also}
+
+\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropTarget}{wxdroptarget},
+\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxDropSource::wxDropSource}\label{wxdropsourcewxdropsource}
+
+\func{}{wxDropSource}{\param{wxWindow }{*win = NULL}}
+
+Default/wxGTK-specific constructor. If you use the default constructor you must
+call \helpref{wxDropSource::SetData}{wxdropsourcesetdata} later.
+
+{\it win} is only used by wxGTK. TODO: in what circumstances?
+
+\func{}{wxDropSource}{\param{wxDataObject }{\&data}, \param{wxWindow }{*win = NULL}}
+
+\wxheading{Parameters}
+
+\docparam{data}{A reference to the \helpref{data object}{wxdataobject} associated with the drop source.}
+
+\docparam{win}{Only used by wxGTK. TODO}
+
+\membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor}
+
+\func{virtual }{\destruct{wxDropSource}}{\void}
+
+\membersection{wxDropSource::SetData}\label{wxdropsourcesetdata}
+
+\func{void}{SetData}{\param{wxDataObject }{\&data}}
+
+Sets the data \helpref{data object}{wxdataobject} associated with the drop source.
+
+\membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
+
+\func{virtual wxDragResult}{DoDragDrop}{\param{bool }{bAllowMove = FALSE}}
+
+Do it (call this in response to a mouse button press, for example).
+
+If {\bf bAllowMove} is FALSE, data can only be copied.
+
+\membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
+
+\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{bScrolling}}
+
+Overridable: you may give some custom UI feedback during the drag and drop operation
+in this function. It is called on each mouse move, so your implementation must not be too
+slow.
+
+\wxheading{Parameters}
+
+\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove.}
+
+\docparam{bScrolling}{TRUE if the window is scrolling.}
+
+\wxheading{Return value}
+
+Return FALSE if you want default feedback, or TRUE if you implement your own
+feedback.
+
--- /dev/null
+\section{\class{wxDropTarget}}\label{wxdroptarget}
+
+\overview{Overview}{wxdndoverview}
+
+This class represents a target for a drag and drop operation.
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{See also}
+
+\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
+\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxDropTarget::wxDropTarget}\label{wxdroptargetwxdroptarget}
+
+\func{}{wxDropTarget}{\void}
+
+Constructor.
+
+\membersection{wxDropTarget::\destruct{wxDropTarget}}\label{wxdroptargetdtor}
+
+\func{}{\destruct{wxDropTarget}}{\void}
+
+Destructor.
+
+\membersection{wxDropTarget::GetFormatCount}\label{wxdroptargetgetformatcount}
+
+\constfunc{virtual size\_t}{GetFormatCount}{\void}
+
+Override this to indicate how many formats you support.
+
+\membersection{wxDropTarget::GetFormat}\label{wxdroptargetgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
+
+Override this to indicate what kind of data you support.
+
+\membersection{wxDropTarget::OnEnter}\label{wxdroptargetonenter}
+
+\func{virtual void}{OnEnter}{\void}
+
+Called when the mouse enters the drop target.
+
+\membersection{wxDropTarget::OnDrop}\label{wxdroptargetondrop}
+
+\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void* }{data}, \param{size\_t }{size}}
+
+Called when the user drops a data object on the target. Return FALSE to veto the operation.
+
+\wxheading{Parameters}
+
+\docparam{x}{The x coordinate of the mouse.}
+
+\docparam{y}{The y coordinate of the mouse.}
+
+\docparam{data}{The data being dropped.}
+
+\docparam{size}{The size of the data being dropped.}
+
+\wxheading{Return value}
+
+Return TRUE to accept the data, FALSE to veto the operation.
+
+\membersection{wxDropTarget::OnLeave}\label{wxdroptargetonleave}
+
+\func{virtual void}{OnLeave}{\void}
+
+Called when the mouse leaves the drop target.
--- /dev/null
+\section{\class{wxFileDataObject}}\label{wxfiledataobject}
+
+wxFileDataObject is a specialization of wxDataObject for file names.
+
+\wxheading{Derived from}
+
+\helpref{wxDataObject}{wxdataobject}
+
+\wxheading{See also}
+
+\helpref{wxDataObject}{wxdataobject}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxFileDataObject::wxFileDataObject}\label{wxfiledataobjectwxfiledataobject}
+
+\func{}{wxFileDataObject}{\void}
+
+Constructor.
+
+\membersection{wxFileDataObject::GetFormat}\label{wxfiledataobjectgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\void}
+
+Returns wxDF\_FILENAME.
+
+\membersection{wxFileDataObject::AddFile}\label{wxfiledataobjectaddfile}
+
+\func{virtual void}{AddFile}{\param{const wxString\& }{file}}
+
+Adds a filename to the data object.
+
+\membersection{wxFileDataObject::GetFiles}\label{wxfiledataobjectgetfiles}
+
+\constfunc{virtual wxString}{GetFiles}{\void}
+
+Returns files as a zero-separated list.
+
--- /dev/null
+\section{\class{wxFileDropTarget}}\label{wxfiledroptarget}
+
+ A drop target which accepts files (dragged from File Manager or Explorer).
+
+\wxheading{Derived from}
+
+\helpref{wxDropTarget}{wxdroptarget}
+
+\wxheading{See also}
+
+\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
+\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxTextDropTarget}{wxtextdroptarget}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxFileDropTarget::wxFileDropTarget}\label{wxfiledroptargetwxfiledroptarget}
+
+\func{}{wxFileDropTarget}{\void}
+
+Constructor.
+
+\membersection{wxFileDropTarget::GetFormatCount}\label{wxfiledroptargetgetformatcount}
+
+\func{virtual size\_t}{GetFormatCount}{\void}
+
+See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
+appropriately for files.
+
+\membersection{wxFileDropTarget::GetFormat}\label{wxfiledroptargetgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
+
+See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
+appropriately for files.
+
+\membersection{wxFileDropTarget::OnDrop}\label{wxfiledroptargetondrop}
+
+\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
+
+See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
+appropriately for files, and calls \helpref{wxFileDropTarget::OnDropFiles}{wxfiledroptargetondropfiles}.
+
+\membersection{wxFileDropTarget::OnDropFiles}\label{wxfiledroptargetondropfiles}
+
+\func{virtual bool}{OnDropFiles}{\param{long }{x}, \param{long }{y}, \param{size\_t }{nFiles}, \param{const char * const}{files[]}}
+
+Override this function to receive dropped files.
+
+\wxheading{Parameters}
+
+\docparam{x}{The x coordinate of the mouse.}
+
+\docparam{y}{The y coordinate of the mouse.}
+
+\docparam{nFiles}{The number of files being dropped.}
+
+\docparam{files}{An array of filenames.}
+
+\wxheading{Return value}
+
+Return TRUE to accept the data, FALSE to veto the operation.
+
--- /dev/null
+automatically generated by HelpGen from privatedataobject.tex at 13/Jan/99 12:50:12
+\section{\class{wxPrivateDataObject}}\label{wxprivatedataobject}
+
+
+ ----------------------------------------------------------------------------
+ wxPrivateDataObject is a specialization of wxDataObject for app specific data
+ ----------------------------------------------------------------------------
+
+\wxheading{Derived from}
+
+\helpref{wxDataObject}{wxdataobject}
+
+\wxheading{Data structures}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxPrivateDataObject::wxPrivateDataObject}\label{wxprivatedataobjectwxprivatedataobject}
+
+\constfunc{virtual }{wxPrivateDataObject}{\void}
+
+\membersection{wxPrivateDataObject::\destruct{wxPrivateDataObject}}\label{wxprivatedataobjectdtor}
+
+\constfunc{virtual }{\destruct{wxPrivateDataObject}}{\void}
+
+\membersection{wxPrivateDataObject::GetFormat}\label{wxprivatedataobjectgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\void}
+
+\membersection{wxPrivateDataObject::SetId}\label{wxprivatedataobjectsetid}
+
+\constfunc{virtual void}{SetId}{\param{const wxString\& }{id}}
+
+ the string ID identifies the format of clipboard or DnD data. a word
+ processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
+ to the clipboard - the latter with the Id "WXWORD\_FORMAT".
+
+\membersection{wxPrivateDataObject::GetId}\label{wxprivatedataobjectgetid}
+
+\constfunc{virtual wxString}{GetId}{\void}
+
+\membersection{wxPrivateDataObject::SetData}\label{wxprivatedataobjectsetdata}
+
+\constfunc{virtual void}{SetData}{\param{const char }{*data}, \param{size\_t }{size}}
+
+ will make internal copy
+
+\membersection{wxPrivateDataObject::GetDataSize}\label{wxprivatedataobjectgetdatasize}
+
+\constfunc{virtual size\_t}{GetDataSize}{\void}
+
+\membersection{wxPrivateDataObject::GetData}\label{wxprivatedataobjectgetdata}
+
+\constfunc{virtual char*}{GetData}{\void}
+
\wxheading{See also}
-\helpref{wxSocketBase}{wxsocketbase}\\
-\helpref{wxIPV4address}{wxipv4address}\\
-\helpref{wxIPV6address}{wxipv6address}\\
-\helpref{wxunixaddress}{wxunixaddress}
+\helpref{wxSocketBase}{wxsocketbase}
+%\helpref{wxIPV4address}{wxipv4address}\\
+%\helpref{wxIPV6address}{wxipv6address}\\
+%\helpref{wxunixaddress}{wxunixaddress}
% ----------------------------------------------------------------------------
% Members
\section{Drag-and-drop and clipboard overview}\label{wxdndoverview}
-Classes: \helpref{wxDataObject}{wxdataobject}
-
-% \helpref{wxTextDataObject}{wxtextdataobject}
-% \helpref{wxDropSource}{wxdropsource}
-% \helpref{wxDropTarget}{wxdroptarget}
-% \helpref{wxTextDropTarget}{wxtextdroptarget}
-% \helpref{wxFileDropTarget}{wxfiledroptarget}
+Classes: \helpref{wxDataObject}{wxdataobject},
+\helpref{wxTextDataObject}{wxtextdataobject},
+\helpref{wxDropSource}{wxdropsource},
+\helpref{wxDropTarget}{wxdroptarget},
+\helpref{wxTextDropTarget}{wxtextdroptarget},
+\helpref{wxFileDropTarget}{wxfiledroptarget}
Samples: see the dnd sample.
-Headers: <wx/dataobj.h>, <wx/dropsrc.h and <wx/droptgt.h>>
+Headers: <wx/dataobj.h>, <wx/dropsrc.h and <wx/droptgt.h> or <wx/dnd.h>
(note that wxUSE\_DRAG\_AND\_DROP must be defined in setup.h)
This overview describes wxWindows support for drag and drop and clipboard
are called - see below.
\item {\bf Processing the result:} DoDragDrop() returns an {\it effect code} which
-is one of the values of \helpref{wxDragResult}{wxdragresult} enum. Codes
+is one of the values of \helpref{wxDragResult}{wxdropsource} enum. Codes
of wxDragError, wxDragNone and wxDragCancel have the obvious meaning and mean
that there is nothing to do on the sending end (except of possibly logging the
error in the first case). wxDragCopy means that the data has been successfully
which are well handled by wxTextFile.
The typical things you may do with wxTextFile in order are:
+
\begin{itemize}\itemsep=0pt
\item Create and open it: this is done with \helpref{Open}{wxtextfileopen}
function which opens the file (name may be specified either as Open argument or
but looks more like array addressing) or with "sequential access" functions
which include \helpref{GetFirstLine}{wxtextfilegetfirstline}/
\helpref{GetNextLine}{wxtextfilegetnextline} and also
-\helpref{GetLastLine}{getlastline}/\helpref{GetPrevLine}{wxtextfilegetprevline}.
+\helpref{GetLastLine}{wxtextfilegetlastline}/\helpref{GetPrevLine}{wxtextfilegetprevline}.
For the sequential access functions the current line number is maintained: it is
returned by \helpref{GetCurrentLine}{wxtextfilegetcurrentline} and may be
changed with \helpref{GoToLine}{wxtextfilegotoline}.
Default constructor, use Open(string) to initialize the object.
\membersection{wxTextFile::wxTextFile}\label{wxtextfilector}
+
\constfunc{}{wxTextFile}{\param{const wxString\& }{strFile}}
Constructor does not load the file into memory, use Open() to do it.
\membersection{wxTextFile::Exists}\label{wxtextfileexists}
+
\constfunc{bool}{Exists}{\void}
Return TRUE if file exists - the name of the file should have been specified
in the constructor before calling Exists().
\membersection{wxTextFile::Open}\label{wxtextfileopen}
+
\constfunc{bool}{Open}{\void}
Open() opens the file with the name which was given in the \helpref{constructor}{wxtextfilector}
and also loads file in memory on success.
\membersection{wxTextFile::Open}\label{wxtextfileopenname}
+
\constfunc{bool}{Open}{\param{const wxString\& }{strFile}}
Same as \helpref{Open()}{wxtextfileopen} but allows to specify the file name
(must be used if the default constructor was used to create the object).
\membersection{wxTextFile::Close}\label{wxtextfileclose}
+
\constfunc{bool}{Close}{\void}
Closes the file and frees memory, {\bf losing all changes}. Use \helpref{Write()}{wxtextfilewrite}
if you want to save them.
\membersection{wxTextFile::IsOpened}\label{wxtextfileisopened}
+
\constfunc{bool}{IsOpened}{\void}
Returns TRUE if the file is currently opened.
\membersection{wxTextFile::GetLineCount}\label{wxtextfilegetlinecount}
+
\constfunc{size\_t}{GetLineCount}{\void}
Get the number of lines in the file.
\membersection{wxTextFile::GetLine}\label{wxtextfilegetline}
+
\constfunc{wxString\&}{GetLine}{\param{size\_t }{n}}
Retrieves the line number {\it n} from the file. The returned line may be
modified but you shouldn't add line terminator at the end - this will be done
by wxTextFile.
-\membersection{wxTextFile::operator[]}\label{wxtextfileoperator[]}
+\membersection{wxTextFile::operator[]}\label{wxtextfileoperatorarray}
+
\constfunc{wxString\&}{operator[]}{\param{size\_t }{n}}
The same as \helpref{GetLine}{wxtextfilegetline}.
\membersection{wxTextFile::GetCurrentLine}\label{wxtextfilegetcurrentline}
+
\constfunc{size\_t}{GetCurrentLine}{\void}
Returns the current line: it has meaning only when you're using
GoToLine().
\membersection{wxTextFile::GoToLine}\label{wxtextfilegotoline}
+
\constfunc{void}{GoToLine}{\param{size\_t }{n}}
Changes the value returned by \helpref{GetCurrentLine}{wxtextfilegetcurrentline}
and used by \helpref{GetFirstLine()}{wxtextfilegetfirstline}()/\helpref{GetNextLine()}{wxtextfilegetnextline}.
\membersection{wxTextFile::Eof}\label{wxtextfileeof}
+
\constfunc{bool}{Eof}{\void}
Returns TRUE if the current line is the last one.
\membersection{wxTextFile::GetFirstLine}\label{wxtextfilegetfirstline}
+
\constfunc{wxString\&}{GetFirstLine}{\void}
This method together with \helpref{GetNextLine()}{wxtextfilegetnextline}
\end{verbatim}
\membersection{wxTextFile::GetNextLine}\label{wxtextfilegetnextline}
+
\func{wxString\&}{GetNextLine}{\void}
Gets the next line (see \helpref{GetFirstLine}{wxtextfilegetfirstline} for
the example).
\membersection{wxTextFile::GetPrevLine}\label{wxtextfilegetprevline}
+
\func{wxString\&}{GetPrevLine}{\void}
Gets the previous line in the file.
\membersection{wxTextFile::GetLastLine}\label{wxtextfilegetlastline}
+
\func{wxString\&}{GetLastLine}{\void}
Gets the last line of the file.
\membersection{wxTextFile::GetLineType}\label{wxtextfilegetlinetype}
+
\constfunc{wxTextFileType}{GetLineType}{\param{size\_t }{n}}
Get the type of the line (see also \helpref{GetEOL}{wxtextfilegeteol})
\membersection{wxTextFile::GuessType}\label{wxtextfileguesstype}
+
\constfunc{wxTextFileType}{GuessType}{\void}
Guess the type of file (which is supposed to be opened). If sufficiently
be returned. If the detection mechanism fails wxTextFileType\_None is returned.
\membersection{wxTextFile::GetName}\label{wxtextfilegetname}
+
\constfunc{const char*}{GetName}{\void}
Get the name of the file.
\membersection{wxTextFile::AddLine}\label{wxtextfileaddline}
+
\constfunc{void}{AddLine}{\param{const wxString\& }{str}, \param{wxTextFileType }{type = typeDefault}}
Adds a line to the end of file.
\membersection{wxTextFile::InsertLine}\label{wxtextfileinsertline}
+
\constfunc{void}{InsertLine}{\param{const wxString\& }{str}, \param{size\_t }{n}, \param{wxTextFileType }{type = typeDefault}}
Insert a line before the line number {\it n}.
\membersection{wxTextFile::RemoveLine}\label{wxtextfileremoveline}
+
\constfunc{void}{RemoveLine}{\param{size\_t }{n}}
Delete one line from the file.
\membersection{wxTextFile::Write}\label{wxtextfilewrite}
+
\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}}
Change the file on disk. The {\it typeNew} parameter allows to change the
convert, for example, DOS files to Unix.
\membersection{wxTextFile::GetEOL}\label{wxtextfilegeteol}
+
\constfunc{static const char*}{GetEOL}{\param{wxTextFileType }{type = typeDefault}}
Get the line termination string corresponding to given constant. {\it typeDefault} is
Unix and wxTextFileType\_Mac under Mac.
\membersection{wxTextFile::\destruct{wxTextFile}}\label{wxtextfiledtor}
+
\constfunc{}{\destruct{wxTextFile}}{\void}
Destructor does nothing.
+
\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}
+% Vadim: let's not have references to documentation that doesn't exist yet.
+% The docs are allowed to be incomplete, but not containing bad links!
+Classes: \helpref{wxLog}{wxlog}, wxLogStderr,
+wxLogOstream, wxLogTextCtrl, wxLogWindow, wxLogGui, 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
\input tstring.tex
\input tdnd.tex
\input tthreads.tex
-% \input tfile.tex
+\input tfile.tex
\input tusage.tex
--- /dev/null
+\section{\class{wxTextDataObject}}\label{wxtextdataobject}
+
+ wxTextDataObject is a specialization of wxDataObject for text data.
+
+\wxheading{Derived from}
+
+\helpref{wxDataObject}{wxdataobject}
+
+\wxheading{See also}
+
+\helpref{wxDataObject}{wxdataobject}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxTextDataObject::wxTextDataObject}\label{wxtextdataobjectwxtextdataobject}
+
+\func{}{wxTextDataObject}{\void}
+
+Default constructor.
+
+\func{}{wxTextDataObject}{\param{const wxString\& }{strText}}
+
+Constructor, passing text.
+
+\membersection{wxTextDataObject::GetFormat}\label{wxtextdataobjectgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\void}
+
+Returns wxDF\_TEXT.
+
+\membersection{wxTextDataObject::SetText}\label{wxtextdataobjectsettext}
+
+\func{virtual void}{SetText}{\param{const wxString\& }{strText}}
+
+Sets the text associated with the data object.
+
+\membersection{wxTextDataObject::GetText}\label{wxtextdataobjectgettext}
+
+\constfunc{virtual wxString}{GetText}{\void}
+
+Returns the text associated with the data object.
+
--- /dev/null
+\section{\class{wxTextDropTarget}}\label{wxtextdroptarget}
+
+A predefined drop target for dealing with text data.
+
+\wxheading{Derived from}
+
+\helpref{wxDropTarget}{wxdroptarget}
+
+\wxheading{See also}
+
+\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
+\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxTextDropTarget::wxTextDropTarget}\label{wxtextdroptargetwxtextdroptarget}
+
+\func{}{wxTextDropTarget}{\void}
+
+Constructor.
+
+\membersection{wxTextDropTarget::GetFormatCount}\label{wxtextdroptargetgetformatcount}
+
+\constfunc{virtual size\_t}{GetFormatCount}{\void}
+
+See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
+appropriately for text.
+
+\membersection{wxTextDropTarget::GetFormat}\label{wxtextdroptargetgetformat}
+
+\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
+
+See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
+appropriately for text.
+
+\membersection{wxTextDropTarget::OnDrop}\label{wxtextdroptargetondrop}
+
+\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
+
+See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
+appropriately for text, and calls \helpref{wxTextDropTarget::OnDropText}{wxtextdroptargetondroptext}.
+
+\membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext}
+
+\func{virtual bool}{OnDropText}{\param{long }{x}, \param{long }{y}, \param{const char }{*data}}
+
+Override this function to receive dropped text.
+
+\wxheading{Parameters}
+
+\docparam{x}{The x coordinate of the mouse.}
+
+\docparam{y}{The y coordinate of the mouse.}
+
+\docparam{data}{The data being dropped: a NULL-terminated string.}
+
+\wxheading{Return value}
+
+Return TRUE to accept the data, FALSE to veto the operation.
Returns a pointer to the button which is the default for this window, or NULL.
+\membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget}
+
+\constfunc{wxDropTarget*}{GetDropTarget}{\void}
+
+Returns the associated drop target, which may be NULL.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget},
+\helpref{Drag and drop overview}{wxdndoverview}
+
\membersection{wxWindow::GetEventHandler}\label{wxwindowgeteventhandler}
\constfunc{wxEvtHandler*}{GetEventHandler}{\void}
the constraints automatically in OnSize; otherwise, you must
override OnSize and call Layout explicitly.
+\membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget}
+
+\func{void}{SetDropTarget}{\param{wxDropTarget*}{ target}}
+
+Associates a drop target with this window.
+
+If the window already has a drop target, it is deleted.
+
+\wxheading{See also}
+
+\helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget},
+\helpref{Drag and drop overview}{wxdndoverview}
+
\membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}
\func{virtual void}{SetFocus}{\void}
- Implement missing wxImage functions for Motif.
+- wxClipboard
+
Low Priority
------------
- add the driver code to src/motif/helphtml.cpp (a frame, toolbar,
history list).
-- Copy and paste, drag and drop. Use a standard X drag
+- Drag and drop. Use a standard X drag
and drop standard - see http://www.cco.caltech.edu/~jafl/xdnd/
or use Motif drag and drop as described here:
http://www.motifzone.com/tmd/articles/DnD/dnd.html
Add headers to VC++ project files.
-Test GLCanvas.
+Implement Robert's wxClipboard.
Distribution naming?
argument, so instead just allow controls loaded from native
resource to deal with this style and call default processing.
-Better clipboard support (as per Robert's class).
-
wxWizard class?
Doc/view - have some standard views/docs e.g. wxTextView.
return wxString(path + 2);
#endif
}
- return wxString("");
+ // Yes, this should return the path, not an empty string, otherwise
+ // we get "thing.txt" -> "".
+ return path1;
}
// Return just the directory, or NULL if no directory
-mkdir $(DOCDIR)\html\wx
-start /w tex2rtf $(DOCDIR)\latex\wx\manual.tex $(DOCDIR)\html\wx\wx.htm -twice -html
-erase $(DOCDIR)\html\wx\*.con
- -erase $(DOCDIR)\html\wx\*.ref
- -erase $(DOCDIR)\latex\wx\*.con
- -erase $(DOCDIR)\latex\wx\*.ref
- cd $(THISDIR)
+# -erase $(DOCDIR)\html\wx\*.ref
+# -erase $(DOCDIR)\latex\wx\*.con
+# -erase $(DOCDIR)\latex\wx\*.ref
+# cd $(THISDIR)
$(DOCDIR)\html\porting\port.htm: $(DOCDIR)\latex\porting\porting.tex
cd $(DOCDIR)\latex\porting
}
wxString baseclass = *i;
- derived << "\\helpref{" << baseclass << "}"
- "{ " << baseclass.MakeLower() << "}";
+ derived << "\\helpref{" << baseclass << "}";
+ derived << "{" << baseclass.MakeLower() << "}";
}
}
totalText << derived << "\n\n";
funcname = dtor;
}
- totalText.Printf("\\membersection{%s::%s}\\label{%s}\n"
+ totalText.Printf("\\membersection{%s::%s}\\label{%s}\n\n"
"\\%sfunc{%s%s}{%s}{",
classname, funcname,
MakeLabel(classname, funcname).c_str(),
projects / wxWidgets.git / commitdiff
