IDMSourceRenderEvent

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

In addition to the standard IEvent attributes of event and window identifiers, objects of this class also have the following attributes:


IDMSourceRenderEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Constructs objects of this class from a generic IEvent object.

Exception

IInvalidRequest The object for the source render event was not created. The drag transfer information may be invalid.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Rendering

Use these members to set and query attributes related to source rendering.


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

Returns a pointer to the alternate source window object. For example, the alternate window can be used to implement source rendering on a secondary thread.

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. For example, the alternate window can be used to implement source rendering on a secondary thread.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
canRetry
public:
virtual bool canRetry() const

Returns true if the renderer processing the event can retry processing the event if a failure occurs. This flag is passed to the target renderer by IDMSourceRenderer::informTargetOfCompletion. The default is false.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
completion
public:
virtual IDM::RenderCompletion completion() const

Returns the flag that indicates if the rendering completed. This flag is passed to the target renderer by IDMSourceRenderer::informTargetOfCompletion. The default is IDM::renderOk.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
dragItem
public:
virtual IDMItem::Handle dragItem() const

Returns the handle of the drag item that is being rendered.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
selectedFormat
public:
virtual IString selectedFormat() const

Returns the selected rendering format.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
selectedMechanism
public:
virtual IString selectedMechanism() const

Returns the selected rendering mechanism.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setCompletion
public:
virtual IDMSourceRenderEvent& setCompletion( IDM::RenderCompletion code )

Sets the completion flag that indicates if the rendering completed successfully.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setRetry
public:
virtual IDMSourceRenderEvent& setRetry( bool allowRetry = true )

Sets the flag that indicates that the renderer processing the event can retry a failed rendering.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setTargetInfo
public:
virtual IDMSourceRenderEvent& setTargetInfo( unsigned long info )

Sets information that is passed to the target renderer.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
targetInfo
public:
virtual unsigned long targetInfo() const

Returns the target-defined information.
Note: This is an extra member the source and target can use to pass additional information to each other. You can use it to implement the specialized behavior for user-defined rendering mechanisms and formats.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
targetName
public:
virtual IString targetName() const

Returns the target render-to name. For example, the source can use this member to indicate to the target where it has placed the data it has rendered (that is, the name of a shared memory segment or file).

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Returns a pointer to the target window object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Returns the handle of the target window object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IDMSourceRenderEvent - Inherited Member Functions and Data

Inherited Public Functions

IDMEvent
IEvent

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data