Automatic generation produced by ISE Eiffel
note description: "[ Character format containing color, font and effects information for text formatting. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2009-06-03 16:11:49 -0800 (Wed, 03 Jun 2009) $" revision: "$Revision: 79073 $" class interface EV_CHARACTER_FORMAT create default_create -- Standard creation procedure. -- (from EV_ANY) require -- from ANY True ensure then -- from EV_ANY is_coupled: implementation /= Void is_initialized: is_initialized default_create_called: default_create_called is_in_default_state: is_in_default_state make_with_font (a_font: EV_FONT) -- Create Current with font a_font. require font_not_void: a_font /= Void ensure font_set: font.is_equal (a_font) make_with_font_and_color (a_font: EV_FONT; a_color, a_background_color: EV_COLOR) -- Create Current with font a_font, color a_color and -- background_color a_background_color. require font_not_void: a_font /= Void color_not_void: a_color /= Void background_color_not_void: a_background_color /= Void ensure font_set: font.is_equal (a_font) color_set: color.is_equal (a_color) make_with_values (a_font: EV_FONT; a_color, a_background_color: EV_COLOR; an_effect: EV_CHARACTER_FORMAT_EFFECTS) -- Create Current with font a_font, color a_color, background color a_background_color and effects an_effect. require font_not_void: a_font /= Void color_not_void: a_color /= Void background_color_not_void: a_background_color /= Void effect_not_void: an_effect /= Void ensure font_set: font.is_equal (a_font) color_set: color.is_equal (a_color) effect_set: effects.is_equal (an_effect) feature -- Access background_color: EV_COLOR -- Background color of the current format. require not_destroyed: not is_destroyed ensure result_not_void: Result /= Void color: EV_COLOR -- Color of the current format. require not_destroyed: not is_destroyed ensure result_not_void: Result /= Void data: detachable ANY -- Arbitrary user data may be stored here. -- (from EV_ANY) effects: EV_CHARACTER_FORMAT_EFFECTS -- Character format effects applicable to `font`. require not_destroyed: not is_destroyed ensure result_not_void: Result /= Void font: EV_FONT -- Font of the current format. require not_destroyed: not is_destroyed ensure result_not_void: Result /= Void generating_type: TYPE [detachable EV_CHARACTER_FORMAT] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: EV_CHARACTER_FORMAT): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: EV_CHARACTER_FORMAT): 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 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 -- Element change is_equal (other: like Current): BOOLEAN -- Is Current considered equal to other? require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result out: STRING_8 -- New string containing terse printable representation -- of current object ensure -- from ANY out_not_void: Result /= Void set_background_color (a_color: EV_COLOR) -- Make a_color the new background_color. require not_destroyed: not is_destroyed color_not_void: a_color /= Void ensure color_set: background_color.is_equal (a_color) set_color (a_color: EV_COLOR) -- Make a_color the new color. require not_destroyed: not is_destroyed color_not_void: a_color /= Void ensure color_set: color.is_equal (a_color) 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_effects (an_effect: EV_CHARACTER_FORMAT_EFFECTS) -- Make an_effect the new `effects`. require not_destroyed: not is_destroyed effect_not_void: an_effect /= Void ensure effects_set: effects.is_equal (an_effect) set_font (a_font: EV_FONT) -- Make a_font the new font. require not_destroyed: not is_destroyed font_not_void: a_font /= Void ensure font_set: font.is_equal (a_font) feature -- Duplication copy (other: like Current) -- Update current object using fields of object attached -- to other, so as to yield equal objects. require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: EV_CHARACTER_FORMAT) -- 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: EV_CHARACTER_FORMAT -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: EV_CHARACTER_FORMAT) -- 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: EV_CHARACTER_FORMAT -- 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: EV_CHARACTER_FORMAT -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable EV_CHARACTER_FORMAT -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class 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) ensure -- from ANY instance_free: class io_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Status Report is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY) ensure -- from EV_ANY bridge_ok: Result = implementation.is_destroyed invariant font_not_void: font /= Void color_not_void: color /= Void effects_not_void: effects /= Void -- from EV_ANY is_initialized: is_initialized default_create_called: default_create_called is_coupled: default_create_called implies (implementation.interface = Current or (attached {EV_ENVIRONMENT} Current and then attached implementation.interface)) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note 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_CHARACTER_FORMAT -- Generated by Eiffel Studio --
For more details: eiffel.org