indexing
description: "Facilities for pick and drop mechanism.%NDecendents can act both as pick and drop sources and as targets.%NWhen the user picks a pebble from a source and drops on a target,the drop_actions of the target receive the pebble as input.%NThe user interface can be either pick and drop or drag and drop,selected by `set_pick_and_drop' and `set_drag_and_drop'."
legal: "See notice at end of class."
example: "Create two buttons one with the string %"Hello world!%" as pebbleand the other with agent io.put_string as a drop action.%NPicking the first button and dropping on the second will print:%N%"Hello world!%".%Nb1, b2: BUTTON%Ncreate b1; create b2%Nb1.set_pebble (%"Hello world!%")%Nb2.drop_actions.extend (agent io.put_string)"
status: "See notice at end of class."
keywords: "pick and drop, drag and drop, source, PND, DND"
date: "$Date$"
revision: "$Revision$"
deferred class interface
EV_PICK_AND_DROPABLE
feature
accept_cursor: EV_POINTER_STYLE
`Result'
pebble
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure EV_ABSTRACT_PICK_AND_DROPABLE
result_not_void: Result /= Void
ensure then
bridge_ok: Result = implementation.accept_cursor
data: ANY
EV_ANY
deny_cursor: EV_POINTER_STYLE
`Result'
pebble
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure EV_ABSTRACT_PICK_AND_DROPABLE
result_not_void: Result /= Void
ensure then
bridge_ok: Result = implementation.deny_cursor
generating_type: STRING_8
ANY
generator: STRING_8
ANY
frozen id_object (an_id: INTEGER_32): IDENTIFIED
`an_id'
IDENTIFIED
ensure IDENTIFIED
consistent: Result = Void or else Result.object_id = an_id
frozen object_id: INTEGER_32
IDENTIFIED
ensure IDENTIFIED
valid_id: id_object (Result) = Current
pebble: ANY
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure then
bridge_ok: Result = implementation.pebble
pebble_function: FUNCTION [ANY, TUPLE, ANY]
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure then
bridge_ok: Result = implementation.pebble_function
pebble_positioning_enabled: BOOLEAN
`True'
pebble_x_positionpebble_y_position
`False'
require
not_destroyed: not is_destroyed
ensure then
bridge_ok: Result = implementation.pebble_positioning_enabled
pebble_x_position: INTEGER_32
`Current'
require
not_destroyed: not is_destroyed
ensure then
bridge_ok: Result = implementation.pebble_x_position
pebble_y_position: INTEGER_32
`Current'
require
not_destroyed: not is_destroyed
ensure then
bridge_ok: Result = implementation.pebble_y_position
target_name: STRING_GENERAL
`Current'
EV_ABSTRACT_PICK_AND_DROPABLE
feature
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
frozen equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
frozen standard_is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
feature
conforms_to (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
mode_is_drag_and_drop: BOOLEAN
require
not_destroyed: not is_destroyed
ensure then
bridge_ok: Result = implementation.mode_is_drag_and_drop
mode_is_pick_and_drop: BOOLEAN
require
not_destroyed: not is_destroyed
ensure then
bridge_ok: Result = implementation.mode_is_pick_and_drop
mode_is_target_menu: BOOLEAN
require
not_destroyed: not is_destroyed
ensure then
bridge_ok: Result = implementation.mode_is_target_menu
same_type (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
feature
disable_pebble_positioning
`False'pebble_positioning_enabled
require
not_destroyed: not is_destroyed
ensure
pebble_positioning_updated: not pebble_positioning_enabled
enable_pebble_positioning
`True'pebble_positioning_enabled
pebble_x_positionpebble_y_position
`Current'
require
not_destroyed: not is_destroyed
ensure
pebble_positioning_updated: pebble_positioning_enabled
remove_pebble
pebble`Void'pebble_function
ensure EV_ABSTRACT_PICK_AND_DROPABLE
pebble_removed: pebble = Void and pebble_function = Void
set_accept_cursor (a_cursor: like accept_cursor)
`a_cursor'
pebble
require EV_ABSTRACT_PICK_AND_DROPABLE
a_cursor_not_void: a_cursor /= Void
ensure EV_ABSTRACT_PICK_AND_DROPABLE
accept_cursor_assigned: accept_cursor.is_equal (a_cursor)
set_deny_cursor (a_cursor: like deny_cursor)
`a_cursor'
require EV_ABSTRACT_PICK_AND_DROPABLE
a_cursor_not_void: a_cursor /= Void
ensure EV_ABSTRACT_PICK_AND_DROPABLE
deny_cursor_assigned: deny_cursor.is_equal (a_cursor)
set_drag_and_drop_mode
require
not_destroyed: not is_destroyed
ensure
drag_and_drop_set: mode_is_drag_and_drop
set_pebble (a_pebble: like pebble)
`a_pebble'pebble
set_pebble_function
require EV_ABSTRACT_PICK_AND_DROPABLE
a_pebble_not_void: a_pebble /= Void
ensure EV_ABSTRACT_PICK_AND_DROPABLE
pebble_assigned: pebble = a_pebble
set_pebble_function (a_function: FUNCTION [ANY, TUPLE, ANY])
`a_function'pebble
pebble
`a_function'
set_pebble
require EV_ABSTRACT_PICK_AND_DROPABLE
a_function_not_void: a_function /= Void
a_function_takes_two_integer_open_operands: a_function.valid_operands ([1, 1])
ensure EV_ABSTRACT_PICK_AND_DROPABLE
pebble_function_assigned: pebble_function = a_function
set_pebble_position (a_x, a_y: INTEGER_32)
`Current'
`True'
require
not_destroyed: not is_destroyed
ensure
pebble_position_assigned: pebble_x_position = a_x and pebble_y_position = a_y
set_pick_and_drop_mode
require
not_destroyed: not is_destroyed
ensure
pick_and_drop_set: mode_is_pick_and_drop
set_target_menu_mode
require
not_destroyed: not is_destroyed
ensure
target_menu_mode_set: mode_is_target_menu
set_target_name (a_name: STRING_GENERAL)
`a_name'target_name
EV_ABSTRACT_PICK_AND_DROPABLE
require EV_ABSTRACT_PICK_AND_DROPABLE
a_name_not_void: a_name /= Void
ensure EV_ABSTRACT_PICK_AND_DROPABLE
target_name_assigned: a_name /= target_name and a_name.is_equal (target_name)
feature
set_data (some_data: like data)
`some_data'data
EV_ANY
require EV_ANY
not_destroyed: not is_destroyed
ensure EV_ANY
data_assigned: data = some_data
feature
copy (other: like Current)
`other'
EV_ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
frozen deep_copy (other: like Current)
copy`other'deep_twin
ANY
require ANY
other_not_void: other /= Void
ensure ANY
deep_equal: deep_equal (Current, other)
frozen deep_twin: like Current
ANY
ensure ANY
deep_equal: deep_equal (Current, Result)
frozen standard_copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_standard_equal: standard_is_equal (other)
frozen standard_twin: like Current
`other'
ANY
ensure ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
frozen twin: like Current
`Current'
twincopycopy
ANY
ensure ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
feature
frozen default: like Current
ANY
frozen default_pointer: POINTER
`POINTER'
`p'default
`p'`POINTER'
ANY
default_rescue
ANY
frozen do_nothing
ANY
feature
destroy
`Current'
EV_ANY
ensure EV_ANY
is_destroyed: is_destroyed
feature
conforming_pick_actions: EV_NOTIFY_ACTION_SEQUENCE
EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
not_void: Result /= Void
drop_actions: EV_PND_ACTION_SEQUENCE
EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
not_void: Result /= Void
pick_actions: EV_PND_START_ACTION_SEQUENCE
pebble
EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
require EV_ABSTRACT_PICK_AND_DROPABLE
True
ensure EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
not_void: Result /= Void
pick_ended_actions: EV_PND_FINISHED_ACTION_SEQUENCE
`Current'
EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
ensure EV_PICK_AND_DROPABLE_ACTION_SEQUENCES
not_void: Result /= Void
feature
io: STD_FILES
ANY
out: STRING_8
ANYtagged_out
ANY
print (some: ANY)
`some'
ANY
frozen tagged_out: STRING_8
ANYout
ANY
feature
operating_environment: OPERATING_ENVIRONMENT
ANY
feature
is_destroyed: BOOLEAN
`Current'
EV_ANY
ensure EV_ANY
bridge_ok: Result = implementation.is_destroyed
feature
pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE
EV_ABSTRACT_PICK_AND_DROPABLE
invariant
user_interface_modes_mutually_exclusive: mode_is_pick_and_drop.to_integer + mode_is_drag_and_drop.to_integer + mode_is_target_menu.to_integer = 1
EV_ANY
is_initialized: is_initialized
is_coupled: implementation /= Void and then implementation.interface = Current
default_create_called: default_create_called
ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
indexing
copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
source: "[
Eiffel Software
356 Storke Road, Goleta, CA 93117 USA
Telephone 805-685-1006, Fax 805-685-6869
Website http://www.eiffel.com
Customer support http://support.eiffel.com
]"
end EV_PICK_AND_DROPABLE