wxDataObjectComposite Class Reference
[Clipboard and Drag & Drop]

#include <wx/dataobj.h>

Inheritance diagram for wxDataObjectComposite:
Inheritance graph
[legend]

Detailed Description

wxDataObjectComposite is the simplest wxDataObject derivation which may be used to support multiple formats.

It contains several wxDataObjectSimple objects and supports any format supported by at least one of them. Only one of these data objects is preferred (the first one if not explicitly changed by using the second parameter of Add()) and its format determines the preferred format of the composite data object as well.

See wxDataObject documentation for the reasons why you might prefer to use wxDataObject directly instead of wxDataObjectComposite for efficiency reasons.

Library:  wxCore
Category:  Clipboard and Drag & Drop
See also:
Drag and Drop Overview, wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxBitmapDataObject

Public Member Functions

 wxDataObjectComposite ()
 The default constructor.
void Add (wxDataObjectSimple *dataObject, bool preferred=false)
 Adds the dataObject to the list of supported objects and it becomes the preferred object if preferred is true.
wxDataFormat GetReceivedFormat () const
 Report the format passed to the SetData() method.

List of all members.


Constructor & Destructor Documentation

wxDataObjectComposite::wxDataObjectComposite (  ) 

The default constructor.


Member Function Documentation

void wxDataObjectComposite::Add ( wxDataObjectSimple dataObject,
bool  preferred = false 
)

Adds the dataObject to the list of supported objects and it becomes the preferred object if preferred is true.

wxDataFormat wxDataObjectComposite::GetReceivedFormat (  )  const

Report the format passed to the SetData() method.

This should be the format of the data object within the composite that recieved data from the clipboard or the DnD operation. You can use this method to find out what kind of data object was recieved.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]