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:
You can construct and destruct objects of this class.
![]() |
public:
virtual ~IDMSourcePrepareEvent()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IDMSourcePrepareEvent(const IEvent& event)
Constructs objects of this class from a generic IEvent object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
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.
![]() |
public:
virtual IWindow* alternateWindow() const
Returns a pointer to the alternate source window object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IWindowHandle alternateWindowHandle() const
Returns the handle of the alternate source window object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IDMSourcePrepareEvent& setAlternateWindowHandle( const IWindowHandle& window )
Sets the handle of the alternate source window object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to provide the render preparation support. The results of the preparation are returned to the target.
![]() |
public:
bool noSourceRendering() const
Returns true if only the target can perform the rendering. The default is false.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IDMSourcePrepareEvent& setNoSourceRendering(bool flag)
Sets the no-source-rendering flag that indicates that only the target can perform the rendering.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
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.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~IDMEvent()
IDMEvent(const IEvent& event)
virtual ~IDMSourceRenderEvent()
virtual bool canRetry() const
virtual IDM::RenderCompletion completion() const
virtual IDMItem::Handle dragItem() const
IDMSourceRenderEvent(const IEvent& event)
virtual IString selectedFormat() const
virtual IString selectedMechanism() const
virtual IDMSourceRenderEvent& setCompletion( IDM::RenderCompletion code )
virtual IDMSourceRenderEvent& setRetry( bool allowRetry = true )
virtual IDMSourceRenderEvent& setTargetInfo( unsigned long info )
virtual unsigned long targetInfo() const
virtual IString targetName() const
virtual IWindow* targetWindow() const
virtual IWindowHandle targetWindowHandle() const
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent(const IEvent& event)
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(const IEventResult& eventResult)
IEvent& setResult(bool eventResult)
virtual IWindow* window() const