Package wx :: Class DataObjectSimple
[frames | no frames]

Type DataObjectSimple

object --+    
         |    
DataObject --+
             |
            DataObjectSimple

Known Subclasses:
BitmapDataObject, CustomDataObject, FileDataObject, MetafileDataObject, PyDataObjectSimple, TextDataObject

wx.DataObjectSimple is a wx.DataObject which only supports one format. This is the simplest possible wx.DataObject implementation.

This is still an "abstract base class" meaning that you can't use it directly. You either need to use one of the predefined base classes, or derive your own class from wx.PyDataObjectSimple.


Method Summary
DataObjectSimple __init__(self, format)
Constructor accepts the supported format (none by default) which may also be set later with SetFormat.
  __repr__(self)
String GetDataHere(self)
Returns the data bytes from the data object as a string, returns None on failure.
size_t GetDataSize(self)
Get the size of our data.
DataFormat GetFormat(self)
Returns the (one and only one) format supported by this object.
bool SetData(self, data)
Copy the data value to the data object.
  SetFormat(self, format)
Sets the supported format.
    Inherited from DataObject
  __del__(self)
[formats] GetAllFormats(self, dir)
Returns a list of all the wx.DataFormats that this dataobject supports in the given direction.
size_t GetFormatCount(self, dir)
Returns the number of available formats for rendering or setting the data.
DataFormat GetPreferredFormat(self, dir)
Returns the preferred format for either rendering the data (if dir is Get, its default value) or for setting it.
bool IsSupported(self, format, dir)
Returns True if this format is supported.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Class Variable Summary
    Inherited from DataObject
int Both = 3                                                                     
int Get = 1                                                                     
int Set = 2                                                                     

Method Details

__init__(self, format=FormatInvalid)
(Constructor)

Constructor accepts the supported format (none by default) which may also be set later with SetFormat.

Parameters:
format
           (type=DataFormat)

Returns:
DataObjectSimple
Overrides:
wx.DataObject.__init__

GetDataHere(self)

Returns the data bytes from the data object as a string, returns None on failure. Must be implemented in the derived class if the object supports rendering its data.

Returns:
String
Overrides:
wx.DataObject.GetDataHere

GetDataSize(self)

Get the size of our data.

Returns:
size_t
Overrides:
wx.DataObject.GetDataSize

GetFormat(self)

Returns the (one and only one) format supported by this object. It is assumed that the format is supported in both directions.

Returns:
DataFormat

SetData(self, data)

Copy the data value to the data object. Must be implemented in the derived class if the object supports setting its data.

Parameters:
data
           (type=String)

Returns:
bool
Overrides:
wx.DataObject.SetData

SetFormat(self, format)

Sets the supported format.

Parameters:
format
           (type=DataFormat)


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:47:29 2007 http://epydoc.sf.net