IDMSourcePrepareEvent

The IDMSourcePrepareEvent class represents objects that the target sends to the source when rendering preparation is required for a drag item prior to source rendering for the item. Objects of this class are constructed by the source handler, IDMSourceHandler. An object of this class is constructed for each drag item when source preparation is required.

Objects of this class provide all of the attributes inherited from IDMSourceRenderEvent. In addition, functions are provided to return the following information to the target:


IDMSourcePrepareEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


[view class]
~IDMSourcePrepareEvent
public:
virtual ~IDMSourcePrepareEvent()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IDMSourcePrepareEvent
public:
IDMSourcePrepareEvent(const IEvent& event)

Constructs objects of this class from a generic IEvent object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Alternate Window

Use these members to set and query the alternate source window. For example, the alternate source window can be used to implement source rendering on a secondary thread.


[view class]
alternateWindow
public:
virtual IWindow* alternateWindow() const

Returns a pointer to the alternate source window object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
alternateWindowHandle
public:
virtual IWindowHandle alternateWindowHandle() const

Returns the handle of the alternate source window object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setAlternateWindowHandle
public:
IDMSourcePrepareEvent& setAlternateWindowHandle( const IWindowHandle& window )

Sets the handle of the alternate source window object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Rendering

Use these members to provide the render preparation support. The results of the preparation are returned to the target.


[view class]
noSourceRendering
public:
bool noSourceRendering() const

Returns true if only the target can perform the rendering. The default is false.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setNoSourceRendering
public:
IDMSourcePrepareEvent& setNoSourceRendering(bool flag)

Sets the no-source-rendering flag that indicates that only the target can perform the rendering.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setTargetCanRetry
public:
IDMSourcePrepareEvent& setTargetCanRetry(bool flag)

Sets the retry flag that indicates if the target can retry a failed rendering with a different rendering mechanism and format.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
targetCanRetry
public:
bool targetCanRetry() const

Returns true if the target can retry a failed rendering with a different rendering mechanism and format. The default is false.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IDMSourcePrepareEvent - Inherited Member Functions and Data

Inherited Public Functions

IDMEvent
IDMSourceRenderEvent
IEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data