FBEventDragAndDrop Class Reference

FBEventDragAndDrop Class Reference

#include <fbcontrols.h>

Class Description

Drag and drop interface.

Definition at line 504 of file fbcontrols.h.

+ Inheritance diagram for FBEventDragAndDrop:

Public Member Functions

 FBEventDragAndDrop (HKEventBase pEvent)
 Constructor. More...
 
virtual ~FBEventDragAndDrop ()
 
virtual void Accept ()
 Accept a drag and drop sequence. More...
 
virtual void Add (FBComponent *pComponent, int pId=0)
 Add an item to the drag and drop list. More...
 
virtual FBComponentGet (int pIndex)
 Get the FBComponent specified by pIndex from the Drag and Drop list. More...
 
virtual void Clear ()
 Clear drag and drop list. More...
 
virtual int GetCount ()
 Get the number of items in the DragAndDrop list. More...
 
- Public Member Functions inherited from FBEvent
 FBEvent (HKEvent pEvent)
 Constructor. More...
 

Public Attributes

FBPropertyDragAndDropState State
 Property: Drag and drop sub-event. More...
 
FBPropertyInt PosX
 Property: X position of mouse. More...
 
FBPropertyInt PosY
 Property: Y position of mouse. More...
 
FBPropertykReference Data [2]
 Property: User specified reference. More...
 
- Public Attributes inherited from FBEvent
FBPropertyInt Type
 Read Only Property: Type of event. More...
 

Constructor & Destructor Documentation

Constructor.

Parameters
pEventBase event (internal) to obtain information from.
virtual ~FBEventDragAndDrop ( )
inlinevirtual

Definition at line 512 of file fbcontrols.h.

512 {}

Member Function Documentation

virtual void Accept ( )
virtual

Accept a drag and drop sequence.

This will cause the region in question to accept a drag and drop action when this event occurs.

virtual void Add ( FBComponent pComponent,
int  pId = 0 
)
virtual

Add an item to the drag and drop list.

Parameters
pComponentItem to add to the list.
pIdUser-defined reference for the item (default = 0 ).
virtual void Clear ( )
virtual

Clear drag and drop list.

virtual FBComponent* Get ( int  pIndex)
virtual

Get the FBComponent specified by pIndex from the Drag and Drop list.

Parameters
pIndexIndex in list where to get FBComponent.
Returns
Handle to FBComponent in list at pIndex.
virtual int GetCount ( )
virtual

Get the number of items in the DragAndDrop list.

Returns
Number of items in DragAndDrop list.

Member Data Documentation

Property: User specified reference.

(for example, FBSpread:row)

Definition at line 544 of file fbcontrols.h.

Property: X position of mouse.

Definition at line 542 of file fbcontrols.h.

Property: Y position of mouse.

Definition at line 543 of file fbcontrols.h.

Property: Drag and drop sub-event.

Definition at line 541 of file fbcontrols.h.


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