Package RASCAL.ToolboxDraggable

Description	ToolboxDraggable related types and methods.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
RASCAL.Toolbox
RASCAL.OS
System.Unsigned_Types
Interfaces.C

Use clauses
RASCAL.Toolbox
RASCAL.OS
System.Unsigned_Types
Interfaces.C

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Draggable_Generate_drag_started		16#1#	constant
Flags
Draggable_Sprite		16#2#	constant
Draggable_Text		16#4#	constant
Draggable_Type		16#38#	constant
Draggable_Type_shift		16#3#	constant
Draggable_Type_drag		16#0#	constant
Draggable_Type_click_drag		16#1#	constant
Draggable_Type_click_double_drag		16#2#	constant
Draggable_Use_toolbox_ids		16#40#	constant
Draggable_Drop_shadow		16#80#	constant
Draggable_No_dither		16#100#	constant
Draggable_Drag_started_adjust		16#1#	constant
Draggable_Drag_started_select		16#4#	constant
Draggable_Drag_started_shift		16#8#	constant
Draggable_Drag_started_ctrl		16#10#	constant
Draggable_Drag_ended_toolbox_ids		16#1#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Draggable_State	(Deselected, Selected)
Toolbox_Draggable_DragStarted_Pointer	access Toolbox_Draggable_DragStarted
Toolbox_Draggable_DragEnded_Pointer	access Toolbox_Draggable_DragEnded

Toolbox_Draggable_DragStarted	record
Event is raised when the user starts a drag of a draggable object.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Draggable_DragStarted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Draggable_DragStarted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Draggable_DragStarted_Pointer

Toolbox_Draggable_DragEnded	record
Event is raised when the user finishes a drag of a draggable object.
*Component*	*Type*	*Default*
Y	Integer
X	Integer
Icon	Icon_handle_Type
Window	Wimp_Handle_Type
Header	Toolbox_Event_Header

ATEL_Toolbox_Draggable_DragEnded	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Draggable_DragEnded, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Draggable_DragEnded_Pointer

Pragmas
Convention	(C, Toolbox_Draggable_DragStarted)
Convention	(C, Toolbox_Draggable_DragEnded)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_State	function
*Return*	Draggable_State
Returns the draggable's state.

*Parameter name*	*Type*	*Mode*	*Default*
Draggable	Object_ID	in
Component	Object_ID	in

Get_Sprite	function
*Return*	String
Returns the name of the sprite currently used for the draggable object.

*Parameter name*	*Type*	*Mode*	*Default*
Draggable	Object_ID	in
Component	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Text	function
*Return*	String
Returns the text being displayed in the draggable object.

*Parameter name*	*Type*	*Mode*	*Default*
Draggable	Object_ID	in
Component	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_State	procedure
Sets the draggable's state to either selected or deselected.

*Parameter name*	*Type*	*Mode*	*Default*
Draggable	Object_ID	in
Component	Object_ID	in
State	Draggable_State	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Sprite	procedure
Sets the name of the sprite which will be used for this draggable object.

*Parameter name*	*Type*	*Mode*	*Default*
Draggable	Object_ID	in
Component	Object_ID	in
Sprite	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Text	procedure
Sets the text that will be displayed in the draggable object.

*Parameter name*	*Type*	*Mode*	*Default*
Draggable	Object_ID	in
Component	Object_ID	in
Text	string	in
Flags	System.Unsigned_Types.Unsigned	in	0