indexing
	description: "This structure identifies a tool for which text is to be displayed and receives the text for the tool. This structure is used with the Ttn_needtext notification message."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class interface
	WEL_TOOLTIP_TEXT

create 

	make
			-- Allocate item
			-- (from WEL_STRUCTURE)
		ensure -- from WEL_STRUCTURE
			not_shared: not shared

	make_by_nmhdr (a_nmhdr: WEL_NMHDR)
			-- Make the structure with a_nmhdr.
		require
			a_nmhdr_not_void: a_nmhdr /= void

	make_by_pointer (a_pointer: POINTER)
			-- Set item with a_pointer.
			-- Since item is shared, it does not need
			-- to be freed.
			-- Caution: a_pointer must be a pointer
			-- coming from Windows.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			item_set: item = a_pointer
			shared: shared

feature -- Access

	flags: INTEGER
			-- Flag that indicates how to interpret id_from
			-- member of hdr.
			-- See class WEL_TTF_CONSTANTS for the different values.

	hdr: WEL_NMHDR
			-- Information about the Wm_notify message.
		ensure
			result_not_void: Result /= void

	instance: WEL_INSTANCE
			-- Instance that contains a string resource to be
			-- used as the text.

	item: POINTER
			-- Generic Windows handle or structure pointer.
			-- Can be a HWND, HICON, RECT *, WNDCLASS *, etc...
			-- (from WEL_ANY)

	text: STRING
			-- Text of the tooltip
		require
			text_id_not_set: not text_id_set
		ensure
			result_not_void: Result /= void

	text_id: INTEGER
			-- String resource identifier for the text
		require
			text_id_set: text_id_set
	
feature -- Measurement

	structure_size: INTEGER
			-- Size to allocate (in bytes)
		ensure -- from WEL_STRUCTURE
			positive_result: Result > 0
	
feature -- Status report

	exists: BOOLEAN
			-- Does the item exist?
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			Result = (item /= default_pointer)

	shared: BOOLEAN
			-- Is item shared by another object?
			-- If False (by default), item will
			-- be destroyed by destroy_item.
			-- If True, item will not be destroyed.
			-- (from WEL_ANY)

	text_id_set: BOOLEAN
			-- Is text equal to a resource string identifer?
	
feature -- Status setting

	set_shared
			-- Set shared to True.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			shared: shared

	set_unshared
			-- Set shared to False.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			unshared: not shared
	
feature -- Element change

	set_flags (a_flags: INTEGER)
			-- Set flags with a_flags.
		require
			positive_flags: a_flags >= 0
		ensure
			flags_set: flags = a_flags

	set_instance (an_instance: WEL_INSTANCE)
			-- Set instance with an_instance.
		require
			an_instance_not_void: an_instance /= void
		ensure
			instance_set: instance.item = an_instance.item

	set_item (an_item: POINTER)
			-- Set item with an_item
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			item_set: item = an_item

	set_text (a_text: STRING)
			-- Set text with a_text.
		require
			text_not_void: a_text /= void
		ensure
			text_set: text.is_equal (a_text)

	set_text_id (an_id: INTEGER)
			-- Set text with a string resource identifier an_id.
		ensure
			text_id_set: text_id = an_id
	
feature -- Removal

	dispose
			-- Destroy the inner structure of Current.
			--
			-- This function should be called by the GC when the
			-- object is collected or by the user if Current is
			-- no more usefull.
			-- (from WEL_ANY)
	
feature -- Conversion

	to_integer: INTEGER
			-- Converts item to an integer.
			-- (from WEL_ANY)
		ensure -- from WEL_ANY
			Result = cwel_pointer_to_integer (item)
	
feature -- Basic operations

	initialize
			-- Fill Current with zeros.
			-- (from WEL_STRUCTURE)
		require -- from WEL_STRUCTURE
			exists: exists

	initialize_with_character (a_character: CHARACTER)
			-- Fill current with a_character.
			-- (from WEL_STRUCTURE)
		require -- from WEL_STRUCTURE
			exists: exists

	memory_copy (source_pointer: POINTER; length: INTEGER)
			-- Copy length bytes from source_pointer to item.
			-- (from WEL_STRUCTURE)
		require -- from WEL_STRUCTURE
			length_small_enough: length <= structure_size
			length_large_enough: length > 0
			exists: exists
	
invariant

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class WEL_TOOLTIP_TEXT