X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b1462dfa3496ba7288691376c1de4c890d90787c..3af706cc3164bacc24899e0fc827c28e7ea812b6:/docs/latex/wx/custdobj.tex diff --git a/docs/latex/wx/custdobj.tex b/docs/latex/wx/custdobj.tex index eb1bf4ab11..2a7b7391c0 100644 --- a/docs/latex/wx/custdobj.tex +++ b/docs/latex/wx/custdobj.tex @@ -1,6 +1,6 @@ \section{\class{wxCustomDataObject}}\label{wxcustomdataobject} -wxCustomDataObject is a specialization of +wxCustomDataObject is a specialization of \helpref{wxDataObjectSimple}{wxdataobjectsimple} for some application-specific data in arbitrary (either custom or one of the standard ones). The only restriction is that it is supposed that this data can be @@ -8,8 +8,8 @@ copied bitwise (i.e. with {\tt memcpy()}), so it would be a bad idea to make it contain a C++ object (though C struct is fine). By default, wxCustomDataObject stores the data inside in a buffer. To put the -data into the buffer you may use either -\helpref{SetData}{wxcustomdataobjectsetdata} or +data into the buffer you may use either +\helpref{SetData}{wxcustomdataobjectsetdata} or \helpref{TakeData}{wxcustomdataobjecttakedata} depending on whether you want the object to make a copy of data or not. @@ -20,15 +20,15 @@ the virtual functions mentioned below. \wxheading{Virtual functions to override} This class may be used as is, but if you don't want store the data inside the -object but provide it on demand instead, you should override -\helpref{GetSize}{wxcustomdataobjectgetsize}, -\helpref{GetData}{wxcustomdataobjectgetdata} and +object but provide it on demand instead, you should override +\helpref{GetSize}{wxcustomdataobjectgetsize}, +\helpref{GetData}{wxcustomdataobjectgetdata} and \helpref{SetData}{wxcustomdataobjectsetdata} (or may be only the first two or only the last one if you only allow reading/writing the data) \wxheading{Derived from} -\helpref{wxDataObjectSimple}{wxdataobjectsimple} +\helpref{wxDataObjectSimple}{wxdataobjectsimple}\\ \helpref{wxDataObject}{wxdataobject} \wxheading{Include files} @@ -46,7 +46,7 @@ only the last one if you only allow reading/writing the data) \func{}{wxCustomDataObject}{\param{const wxDataFormat\& }{format = wxFormatInvalid}} The constructor accepts a {\it format} argument which specifies the (single) -format supported by this object. If it isn't set here, +format supported by this object. If it isn't set here, \helpref{SetFormat}{wxdataobjectsimplesetformat} should be used. \membersection{wxCustomDataObject::\destruct{wxCustomDataObject}}\label{wxcustomdataobjectdtor} @@ -69,14 +69,11 @@ The default version just uses the operator new. \membersection{wxCustomDataObject::Free}\label{wxcustomdataobjectfree} -\pythonnote{This method expects a string in wxPython. You can pass -nearly any object by pickling it first.} - \func{virtual void}{Free}{\void} This function is called when the data is freed, you may override it to anything you want (or may be nothing at all). The default version calls operator -delete\[\] on the data. +delete$[]$ on the data. \membersection{wxCustomDataObject::GetSize}\label{wxcustomdataobjectgetsize} @@ -93,18 +90,21 @@ Returns a pointer to the data. \membersection{wxCustomDataObject::SetData}\label{wxcustomdataobjectsetdata} \func{virtual void}{SetData}{ - \param{size\_t }{size}, - \param{const void }{*data} -} + \param{size\_t }{size}, \param{const void }{*data}} Set the data. The data object will make an internal copy. +\pythonnote{This method expects a string in wxPython. You can pass +nearly any object by pickling it first.} + \membersection{wxCustomDataObject::TakeData}\label{wxcustomdataobjecttakedata} \func{virtual void}{TakeData}{ - \param{size\_t }{size}, - \param{const void }{*data} -} + \param{size\_t }{size}, \param{const void }{*data}} Like \helpref{SetData}{wxcustomdataobjectsetdata}, but doesn't copy the data - instead the object takes ownership of the pointer. + +\pythonnote{This method expects a string in wxPython. You can pass +nearly any object by pickling it first.} +