indexing
description: "[
Supplies the identifiers and application-supplied data for two
items in a sorted, owner-drawn list box or combo box.
Whenever an application adds a new item to an owner-drawn
list box or combo box created with the CBS_SORT or LBS_SORT
style, the system sends the owner a Wm_compareitem message.
The `lparam' parameter of the message contains a long pointer
to a COMPAREITEMSTRUCT structure. Upon receiving the message,
the owner compares the two items and returns a value indicating
which item sorts before the other.
]"
legal: "See notice at end of class."
status: "See notice at end of class."
date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
revision: "$Revision: 56675 $"
class interface
WEL_COMPARE_ITEM_STRUCT
create
make_by_pointer (a_pointer: POINTER)
item`a_pointer'
item
`a_pointer'
WEL_ANY
ensure WEL_ANY
item_set: item = a_pointer
shared: shared
feature
ctl_id: INTEGER_32
ctl_type: INTEGER_32
generating_type: STRING_8
ANY
generator: STRING_8
ANY
item: POINTER
WEL_ANY
item_data_1: POINTER
item_data_2: POINTER
item_id_1: INTEGER_32
item_id_2: INTEGER_32
locale_id: INTEGER_32
window_item: WEL_CONTROL
feature
structure_size: INTEGER_32
ensure WEL_STRUCTURE
positive_result: Result > 0
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))
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
exists: BOOLEAN
item
WEL_ANY
ensure WEL_ANY
Result = (item /= default_pointer)
foreground_window: WEL_WINDOW
WEL_WINDOWS_ROUTINES
is_window (hwnd: POINTER): BOOLEAN
`hwnd'
WEL_WINDOWS_ROUTINES
key_down (virtual_key: INTEGER_32): BOOLEAN
WEL_WINDOWS_ROUTINES
key_locked (virtual_key: INTEGER_32): BOOLEAN
WEL_WINDOWS_ROUTINES
key_to_string (key_data: INTEGER_32): STRING_32
`virtual_key'
WEL_WINDOWS_ROUTINES
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))
shared: BOOLEAN
item
item
destroy_item
item
WEL_ANY
system_directory: STRING_32
WEL_WINDOWS_ROUTINES
ensure WEL_WINDOWS_ROUTINES
result_not_void: Result /= Void
tick_count: INTEGER_32
WEL_WINDOWS_ROUTINES
ensure WEL_WINDOWS_ROUTINES
positive_result: Result >= 0
window_of_item (hwnd: POINTER): WEL_WINDOW
`hwnd'
WEL_WINDOWS_ROUTINES
require WEL_WINDOWS_ROUTINES
hwnd_not_null: hwnd /= default_pointer
is_window_pointer: is_window (hwnd)
ensure WEL_WINDOWS_ROUTINES
is_wel_window: Result /= Void implies (create {INTERNAL}).type_conforms_to ((create {INTERNAL}).dynamic_type (Result), (create {INTERNAL}).dynamic_type_from_string ("WEL_WINDOW"))
windows_directory: STRING_32
WEL_WINDOWS_ROUTINES
ensure WEL_WINDOWS_ROUTINES
result_not_void: Result /= Void
feature
set_shared
shared
WEL_ANY
ensure WEL_ANY
shared: shared
set_unshared
shared
WEL_ANY
ensure WEL_ANY
unshared: not shared
feature
set_item (an_item: POINTER)
item`an_item'
WEL_ANY
ensure WEL_ANY
item_set: item = an_item
feature
dispose
`Current'
`Current'
WEL_ANY
feature
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
copy (other: like Current)
`other'
WEL_STRUCTURE
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
frozen default: like Current
ANY
frozen default_pointer: POINTER
`POINTER'
`p'default
`p'`POINTER'
ANY
default_rescue
ANY
frozen do_nothing
ANY
hide_cursor
WEL_WINDOWS_ROUTINES
initialize
WEL_STRUCTURE
require WEL_STRUCTURE
exists: exists
initialize_with_character (a_character: CHARACTER_8)
`a_character'
WEL_STRUCTURE
require WEL_STRUCTURE
exists: exists
is_equal (other: like Current): BOOLEAN
`other'
WEL_STRUCTURE
require ANY
other_not_void: other /= Void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
memory_copy (source_pointer: POINTER; length: INTEGER_32)
`length'`source_pointer'item
WEL_STRUCTURE
require WEL_STRUCTURE
length_small_enough: length <= structure_size
length_large_enough: length > 0
exists: exists
message_beep_asterisk
WEL_WINDOWS_ROUTINES
message_beep_exclamation
WEL_WINDOWS_ROUTINES
message_beep_hand
WEL_WINDOWS_ROUTINES
message_beep_ok
WEL_WINDOWS_ROUTINES
message_beep_question
WEL_WINDOWS_ROUTINES
output_debug_string (s: STRING_GENERAL)
`s'
WEL_WINDOWS_ROUTINES
require WEL_WINDOWS_ROUTINES
s_not_void: s /= Void
resource_string_id (an_id: INTEGER_32): STRING_32
`an_id'
WEL_WINDOWS_ROUTINES
ensure WEL_WINDOWS_ROUTINES
result_not_void: Result /= Void
set_cursor_position_absolute (x, y: INTEGER_32)
`x'`y'
WEL_WINDOWS_ROUTINES
show_cursor
WEL_WINDOWS_ROUTINES
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
invariant
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 WEL_COMPARE_ITEM_STRUCT