Automatic generation produced by ISE Eiffel
note description: "Objects that allow access to the operating %Nsystem clipboard." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-03-27 09:23:22 -0800 (Mon, 27 Mar 2017) $" revision: "$Revision: 100056 $" class interface EV_CLIPBOARD_IMP create make -- Initialize Current. ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) feature -- Initialization destroy -- Destroy underlying native toolkit objects. -- Render Current unusable. -- Any feature calls after a call to destroy are -- invalid. ensure -- from EV_ANY_I is_in_destroy_set: is_in_destroy is_destroyed_set: is_destroyed make -- Initialize Current. ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) old_make (an_interface: attached like interface) -- Create Current with interface an_interface. require -- from EV_ANY_I an_interface_not_void: an_interface /= Void ensure -- from EV_ANY_I interface_assigned: interface = an_interface base_make_called: base_make_called feature -- Access clipboard_open: BOOLEAN -- Is clipboard open? -- (from WEL_CLIPBOARD) generating_type: TYPE [detachable EV_CLIPBOARD_IMP] -- 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 has_text: BOOLEAN -- Does the clipboard currently contain text? is_clipboard_format_available (format: INTEGER_32): BOOLEAN -- (from WEL_CLIPBOARD) last_string: STRING_32 -- Text retrieved from Clipboard -- Only valid after a successfull call to -- `retrieve_clipboard_text` -- (from WEL_CLIPBOARD) text: STRING_32 -- Text content of clipboard. ensure -- from EV_CLIPBOARD_I result_not_void: Result /= Void 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_CLIPBOARD_IMP): 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) is_equal (other: EV_CLIPBOARD_IMP): 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 ~ Current consistent: standard_is_equal (other) implies Result 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_CLIPBOARD_IMP): 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? -- (from EV_ANY_I) 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 -- Duplication copy (other: EV_CLIPBOARD_IMP) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) 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_CLIPBOARD_IMP) -- 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_CLIPBOARD_IMP -- 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_CLIPBOARD_IMP) -- 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_CLIPBOARD_IMP -- 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_CLIPBOARD_IMP -- 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_CLIPBOARD_IMP -- 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 -- Element Change close_clipboard -- Close clipboard. -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD clipboard_open: clipboard_open empty_clipboard -- Empty clipboard. -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD clipboard_open: clipboard_open open_clipboard (window: detachable WEL_WINDOW) -- Open clipboard for window. If Void, -- clipboard is opened to the current task. -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD window_exists: window /= Void implies window.exists retrieve_clipboard_text -- Retrieves text from the clipboard -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD clipboard_open: clipboard_open text_available: is_clipboard_format_available ({WEL_CLIPBOARD_CONSTANTS}.cf_unicodetext) ensure -- from WEL_CLIPBOARD last_string_not_void: last_string /= Void retrieve_clipboard_text_discarding_carriage_return -- Retrieves text from the clipboard -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD clipboard_open: clipboard_open text_available: is_clipboard_format_available ({WEL_CLIPBOARD_CONSTANTS}.cf_unicodetext) ensure -- from WEL_CLIPBOARD last_string_not_void: last_string /= Void set_clipboard_text (a_text: READABLE_STRING_GENERAL) -- Assign a_text to the clipboard -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD clipboard_open: clipboard_open a_text_not_void: a_text /= Void set_clipboard_text_with_newline_conversion (a_text: READABLE_STRING_GENERAL) -- Assign a_text to the clipboard guaranteeing that all newline (linefeed) characters '%N' -- are prepended with a carriage return character '%R'. -- (from WEL_CLIPBOARD) require -- from WEL_CLIPBOARD clipboard_open: clipboard_open a_text_not_void: a_text /= Void feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_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 Setting set_text (a_text: READABLE_STRING_GENERAL) -- Assign a_text to clipboard. require -- from EV_CLIPBOARD_I text_not_void: a_text /= Void ensure -- from EV_CLIPBOARD_I text_cloned: text.same_string_general (a_text) and then text /= a_text invariant -- from EV_CLIPBOARD_I not_has_text_implies_text_empty: not has_text implies text.is_empty -- from EV_ANY_I interface_coupled: is_usable implies interface /= Void and then attached_interface.implementation = Current base_make_called: is_usable implies base_make_called -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2017, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., 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_CLIPBOARD_IMP -- Generated by Eiffel Studio --
For more details: eiffel.org