    indexing
    	description: "[
    		Objects that represent a tab associated with a notebook item. These objects may
    		not be created directly but instead returned from a notebook via `item_tab'.
    		If widget is subsequently removed from notebook, `Current' is automatically
    		destroyed and is no longer usuable.
    	]"
    	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
    	EV_NOTEBOOK_TAB

    create {EV_NOTEBOOK_I}
    	make_with_widgets (a_notebook: EV_NOTEBOOK; a_widget: EV_WIDGET)
    			-- Create `Current' with notebook `a_notebook' and widget `a_widget'.
    			-- Not exported as you may only query  a notebook tab from a notebook
    			-- via `item_tab'.
    		require
    			notebook_not_void: a_notebook /= Void
    			widget_not_void: a_widget /= Void
    			notebook_has_widget: a_notebook.has (a_widget)
    		ensure
    			notebook_set: notebook = a_notebook
    			widget_set: widget = a_widget

    feature -- Access

    	data: ANY
    			-- Arbitrary user data may be stored here.
    			-- (from EV_ANY)

    	generating_type: STRING_8
    			-- Name of current object's generating type
    			-- (type of which it is a direct instance)
    			-- (from ANY)

    	generator: STRING_8
    			-- Name of current object's generating class
    			-- (base class of the type of which it is a direct instance)
    			-- (from ANY)

    	notebook: EV_NOTEBOOK
    			-- Notebook in which `Current' is displayed.
    		require
    			not_destroyed: not is_destroyed
    		ensure
    			result_not_void: Result /= Void

    	pixmap: EV_PIXMAP
    			-- Copy of image displayed on `Current'.
    			-- Void if none.
    			-- (from EV_PIXMAPABLE)
    		require -- from EV_PIXMAPABLE
    			not_destroyed: not is_destroyed
    		ensure -- from EV_PIXMAPABLE
    			bridge_ok: (Result = Void and implementation.pixmap = Void) or Result.is_equal (implementation.pixmap)

    	text: STRING_32
    			-- Text displayed in textable.
    			-- (from EV_TEXTABLE)
    		require -- from EV_TEXTABLE
    			not_destroyed: not is_destroyed
    		ensure -- from EV_TEXTABLE
    			bridge_ok: equal (Result, implementation.text)
    			not_void: Result /= Void
    			cloned: Result /= implementation.text
    			no_carriage_returns: not Result.has ('%R')

    	widget: EV_WIDGET
    			-- Widget to which `Current' is associated.
    		require
    			not_destroyed: not is_destroyed
    		ensure
    			result_not_void: Result /= Void

    feature -- Comparison

    	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
    			-- Are `some' and `other' either both void
    			-- or attached to isomorphic object structures?
    			-- (from ANY)
    		ensure -- from 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
    			-- Are `some' and `other' either both void or attached
    			-- to objects considered equal?
    			-- (from ANY)
    		ensure -- from 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
    			-- Is `other' attached to an object considered
    			-- equal to current object?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from 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
    			-- Are `some' and `other' either both void or attached to
    			-- field-by-field identical objects of the same type?
    			-- Always uses default object comparison criterion.
    			-- (from ANY)
    		ensure -- from 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
    			-- Is `other' attached to an object of the same type
    			-- as current object, and field-by-field identical to it?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			same_type: Result implies same_type (other)
    			symmetric: Result implies other.standard_is_equal (Current)

    feature -- Status report

    	conforms_to (other: ANY): BOOLEAN
    			-- Does type of current object conform to type
    			-- of `other' (as per Eiffel: The Language, chapter 13)?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void

    	is_destroyed: BOOLEAN
    			-- Is `Current' no longer usable?
    		ensure -- from EV_ANY
    			bridge_ok: Result = implementation.is_destroyed

    	is_selectable: BOOLEAN
    			-- May enable_select be called?
    			-- (from EV_SELECTABLE)
    		require -- from EV_SELECTABLE
    			not_destroyed: not is_destroyed

    	is_selected: BOOLEAN
    			-- Is selected?
    			-- (from EV_SELECTABLE)
    		require -- from EV_SELECTABLE
    			not_destroyed: not is_destroyed
    		ensure -- from EV_SELECTABLE
    			bridge_ok: is_selectable implies Result = implementation.is_selected

    	same_type (other: ANY): BOOLEAN
    			-- Is type of current object identical to type of `other'?
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			definition: Result = (conforms_to (other) and other.conforms_to (Current))

    feature -- Status setting

    	enable_select
    			-- Make is_selected True.
    			-- (from EV_SELECTABLE)
    		require -- from EV_SELECTABLE
    			not_destroyed: not is_destroyed
    			is_selectable: is_selectable
    		ensure -- from EV_SELECTABLE
    			is_selected: is_selected

    feature -- Element change

    	remove_pixmap
    			-- Remove image displayed on `Current'.
    			-- (from EV_PIXMAPABLE)
    		require -- from EV_PIXMAPABLE
    			not_destroyed: not is_destroyed
    		ensure -- from EV_PIXMAPABLE
    			pixmap_removed: pixmap = Void

    	remove_text
    			-- Make text `is_empty'.
    			-- (from EV_TEXTABLE)
    		require -- from EV_TEXTABLE
    			not_destroyed: not is_destroyed
    		ensure -- from EV_TEXTABLE
    			text_empty: text.is_empty

    	set_data (some_data: like data)
    			-- Assign `some_data' to data.
    			-- (from EV_ANY)
    		require -- from EV_ANY
    			not_destroyed: not is_destroyed
    		ensure -- from EV_ANY
    			data_assigned: data = some_data

    	set_pixmap (a_pixmap: EV_PIXMAP)
    			-- Display image of `a_pixmap' on `Current'.
    			-- Image of pixmap will be a copy of `a_pixmap'.
    			-- Image may be scaled in some descendents, i.e EV_TREE_ITEM
    			-- See EV_TREE.set_pixmaps_size.
    			-- (from EV_PIXMAPABLE)
    		require -- from EV_PIXMAPABLE
    			not_destroyed: not is_destroyed
    			pixmap_not_void: a_pixmap /= Void

    	set_text (a_text: STRING_GENERAL)
    			-- Assign `a_text' to text.
    			-- (from EV_TEXTABLE)
    		require -- from EV_TEXTABLE
    			not_destroyed: not is_destroyed
    			a_text_not_void: a_text /= Void
    			no_carriage_returns: not a_text.has_code (('%R').natural_32_code)
    		ensure -- from EV_TEXTABLE
    			text_cloned: text.is_equal (a_text) and then text /= a_text

    feature -- Duplication

    	copy (other: like Current)
    			-- Update current object using fields of object attached
    			-- to `other', so as to yield equal objects.
    			-- (from EV_ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    			type_identity: same_type (other)
    		ensure -- from ANY
    			is_equal: is_equal (other)

    	frozen deep_copy (other: like Current)
    			-- Effect equivalent to that of:
    			--		copy (`other' . deep_twin)
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, other)

    	frozen deep_twin: like Current
    			-- New object structure recursively duplicated from Current.
    			-- (from ANY)
    		ensure -- from ANY
    			deep_equal: deep_equal (Current, Result)

    	frozen standard_copy (other: like Current)
    			-- Copy every field of `other' onto corresponding field
    			-- of current object.
    			-- (from ANY)
    		require -- from ANY
    			other_not_void: other /= Void
    			type_identity: same_type (other)
    		ensure -- from ANY
    			is_standard_equal: standard_is_equal (other)

    	frozen standard_twin: like Current
    			-- New object field-by-field identical to `other'.
    			-- Always uses default copying semantics.
    			-- (from ANY)
    		ensure -- from ANY
    			standard_twin_not_void: Result /= Void
    			equal: standard_equal (Result, Current)

    	frozen twin: like Current
    			-- New object equal to `Current'
    			-- twin calls copy; to change copying/twining semantics, redefine copy.
    			-- (from ANY)
    		ensure -- from ANY
    			twin_not_void: Result /= Void
    			is_equal: Result.is_equal (Current)

    feature -- Basic operations

    	frozen default: like Current
    			-- Default value of object's type
    			-- (from ANY)

    	frozen default_pointer: POINTER
    			-- Default value of type `POINTER'
    			-- (Avoid the need to write `p'.default for
    			-- some `p' of type `POINTER'.)
    			-- (from ANY)

    	default_rescue
    			-- Process exception for routines with no Rescue clause.
    			-- (Default: do nothing.)
    			-- (from ANY)

    	frozen do_nothing
    			-- Execute a null action.
    			-- (from ANY)

    feature -- Command

    	destroy
    			-- Destroy underlying native toolkit object.
    			-- Render `Current' unusable.
    			-- (from EV_ANY)
    		ensure -- from EV_ANY
    			is_destroyed: is_destroyed

    feature -- Output

    	io: STD_FILES
    			-- Handle to standard file setup
    			-- (from ANY)

    	out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of tagged_out.
    			-- (from ANY)

    	print (some: ANY)
    			-- Write terse external representation of `some'
    			-- on standard output.
    			-- (from ANY)

    	frozen tagged_out: STRING_8
    			-- New string containing terse printable representation
    			-- of current object
    			-- Was declared in ANY as synonym of out.
    			-- (from ANY)

    feature -- Platform

    	operating_environment: OPERATING_ENVIRONMENT
    			-- Objects available from the operating system
    			-- (from ANY)

    invariant
    	notebook_not_void: is_usable implies notebook /= Void
    	widget_not_void: is_usable implies widget /= Void

    		-- from EV_ANY
    	is_initialized: is_initialized
    	is_coupled: implementation /= Void and then implementation.interface = Current
    	default_create_called: default_create_called

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

    		-- from EV_TEXTABLE
    	text_not_void: is_usable implies text /= Void

    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 -- class EV_NOTEBOOK_TAB