FBEventDragAndDrop Class Reference
 
 
 
FBEventDragAndDrop Class Reference

This reference page is linked to from the following overview topics: Events & callbacks.


#include <fbcontrols.h>


Class Description

Drag and drop interface.

Definition at line 504 of file fbcontrols.h.

Inheritance diagram for FBEventDragAndDrop:
FBEvent

Public Member Functions

  FBEventDragAndDrop (HKEventBase pEvent)
  Constructor.
virtual  ~FBEventDragAndDrop ()
virtual void  Accept ()
  Accept a drag and drop sequence.
virtual void  Add (FBComponent *pComponent, int pId=0)
  Add an item to the drag and drop list.
virtual FBComponent Get (int pIndex)
  Get the FBComponent specified by pIndex from the Drag and Drop list.
virtual void  Clear ()
  Clear drag and drop list.
virtual int  GetCount ()
  Get the number of items in the DragAndDrop list.
void  PropertyAdd (FBProperty *)
  Empty function to avoid creating property container object.

Public Attributes

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

Protected Attributes

HKEventBase  mEvent
  Internal Event pointer.

Constructor & Destructor Documentation

FBEventDragAndDrop::FBEventDragAndDrop ( HKEventBase  pEvent )

Constructor.

Parameters:
pEvent Base event (internal) to obtain information from.
virtual FBEventDragAndDrop::~FBEventDragAndDrop ( ) [inline, virtual]

Definition at line 512 of file fbcontrols.h.

{}

Member Function Documentation

virtual void FBEventDragAndDrop::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 FBEventDragAndDrop::Add ( FBComponent pComponent,
int  pId = 0 
) [virtual]

Add an item to the drag and drop list.

Parameters:
pComponent Item to add to the list.
pId User-defined reference for the item (default = 0 ).
virtual FBComponent* FBEventDragAndDrop::Get ( int  pIndex ) [virtual]

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

Parameters:
pIndex Index in list where to get FBComponent.
Returns:
Handle to FBComponent in list at pIndex.
virtual void FBEventDragAndDrop::Clear ( ) [virtual]

Clear drag and drop list.

virtual int FBEventDragAndDrop::GetCount ( ) [virtual]

Get the number of items in the DragAndDrop list.

Returns:
Number of items in DragAndDrop list.
void FBEvent::PropertyAdd ( FBProperty ) [inline, inherited]

Empty function to avoid creating property container object.

Definition at line 907 of file fbcomponent.h.

:

Member Data Documentation

FBPropertyDragAndDropState FBEventDragAndDrop::State

Property: Drag and drop sub-event.

Definition at line 541 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: User specified reference.

(for example, FBSpread:row)

Definition at line 544 of file fbcontrols.h.

Read Only Property: Type of event.

Reimplemented in FBEventAnimationNode, FBEventSceneChange, FBEventTakeChange, and FBEventFileChange.

Definition at line 900 of file fbcomponent.h.

HKEventBase FBEvent::mEvent [protected, inherited]

Internal Event pointer.

Definition at line 904 of file fbcomponent.h.


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