# wx.TextDataObject¶

wx.TextDataObject is a specialization of wx.DataObjectSimple for text data.

It can be used without change to paste data into the wx.Clipboard or a wx.DropSource. A user may wish to derive a new class from this class for providing text on-demand in order to minimize memory consumption when offering data in several formats, such as plain text and RTF because by default the text is stored in a string in this class, but it might as well be generated when requested. For this, GetTextLength and GetText will have to be overridden.

Note that if you already have the text inside a string, you will not achieve any efficiency gain by overriding these functions because copying Strings is already a very efficient operation (data is not actually copied because Strings are reference counted).

## Class Hierarchy¶

Inheritance diagram for class TextDataObject:

## Methods Summary¶

 __init__ Constructor, may be used to initialise the text (otherwise SetText should be used later). GetAllFormats Returns a list of wx.DataFormat objects which this data object GetFormat Returns the preferred format supported by this object. GetFormatCount Returns 2 under Mac and wxGTK, where text data coming from the clipboard may be provided as ANSI ( DF_TEXT ) or as Unicode text ( DF_UNICODETEXT , but only when USE_UNICODE==1 ). GetText Returns the text associated with the data object. GetTextLength Returns the data size. SetData SetText Sets the text associated with the data object.

## Class API¶

class wx.TextDataObject(DataObjectSimple)

Possible constructors:

TextDataObject(text="")


TextDataObject is a specialization of DataObjectSimple for text data.

### Methods¶

__init__(self, text="")

Constructor, may be used to initialise the text (otherwise SetText should be used later).

Parameters

text (string) –

GetAllFormats(self, dir=DataObject.Get)

Returns a list of wx.DataFormat objects which this data object supports transferring in the given direction.

GetFormat(self)

Returns the preferred format supported by this object.

This is DF_TEXT or DF_UNICODETEXT depending on the platform and from the build mode (i.e. from USE_UNICODE ).

Return type

wx.DataFormat

GetFormatCount(self, dir=DataObject.Get)

Returns 2 under Mac and wxGTK, where text data coming from the clipboard may be provided as ANSI ( DF_TEXT ) or as Unicode text ( DF_UNICODETEXT , but only when USE_UNICODE==1 ).

Returns 1 under other platforms (e.g. wxMSW) or when building in ANSI mode ( USE_UNICODE==0 ).

Parameters

dir (DataObject.Direction) –

Return type

int

GetText(self)

Returns the text associated with the data object.

You may wish to override this method when offering data on-demand, but this is not required by wxWidgets’ internals. Use this method to get data in text form from the wx.Clipboard.

Return type

string

GetTextLength(self)

Returns the data size.

By default, returns the size of the text data set in the constructor or using SetText . This can be overridden to provide text size data on-demand. It is recommended to return the text length plus 1 for a trailing zero, but this is not strictly required.

Return type

int

SetData(self, format, buf)
Return type

bool

SetText(self, strText)

Sets the text associated with the data object.

This method is called when the data object receives the data and, by default, copies the text into the member variable. If you want to process the text on the fly you may wish to override this function.

Parameters

strText (string) –

### Properties¶

AllFormats

Format

FormatCount

Text

TextLength