tbx  0.7.3
Public Member Functions | List of all members
tbx::DragEndedEvent Class Reference

Event information for Drag ended event. More...

#include <draggable.h>

Inheritance diagram for tbx::DragEndedEvent:
tbx::EventInfo

Public Member Functions

 DragEndedEvent (IdBlock &id_block, PollBlock &data)
 Construct the event from the information returned by the toolbox. More...
 
bool toolbox_ids () const
 Returns true if toolbox ids are returned at end of drag.
 
Object object () const
 Returns toolbox object at end of drag if toolbox_ids is true. More...
 
Component component () const
 Return toolbox component at end of drag if toolbox_ids is true. More...
 
WindowHandle window_handle () const
 Returns WIMP Window handle if toolbox_ids if false.
 
IconHandle icon_handle () const
 Return WIMP icon handle if toolbox_ids is false.
 
int x () const
 x coordinate of drag finish
 
int y () const
 y coordinate of drag finish
 
PointerInfo where () const
 Return drag information as PointerInfo class.
 
- Public Member Functions inherited from tbx::EventInfo
 EventInfo (const IdBlock &id_block, PollBlock &data)
 Contruct the event information from the id_block and data update by the toolbox.
 
const IdBlockid_block () const
 IdBlock for the current event. More...
 

Additional Inherited Members

- Protected Attributes inherited from tbx::EventInfo
PollBlock_data
 raw data from the event
 

Detailed Description

Event information for Drag ended event.

A bit set on the draggable object determines if the result will be toolbox object/component or Window/Icon WIMP handles.

Even when the toolbox object/component is requested, WIMP handles will be returned if the toolbox items can not be determined.

Constructor & Destructor Documentation

tbx::DragEndedEvent::DragEndedEvent ( IdBlock id_block,
PollBlock data 
)
inline

Construct the event from the information returned by the toolbox.

Parameters
id_blockBlock containing objects/components for the event
dataAdditional data for the event.

Member Function Documentation

Component tbx::DragEndedEvent::component ( ) const
inline

Return toolbox component at end of drag if toolbox_ids is true.

Component null is returned if object can't be determined or drag did not end on a component

Object tbx::DragEndedEvent::object ( ) const
inline

Returns toolbox object at end of drag if toolbox_ids is true.

Object null is returned if object can not be determined


The documentation for this class was generated from the following files: