Automatic generation produced by ISE Eiffel
note description: "Eiffel Vision pixmap. Mswindows implementation for a%Nsimple pixmap (not drawable, not self-displayable)" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2023-11-21 03:48:49 -0900 (Tue, 21 Nov 2023) $" revision: "$Revision: 107415 $" class interface EV_PIXMAP_IMP create make -- Initialize Current to 1x1. ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) feature -- Initialization init_from_pixel_buffer (a_pixel_buffer: EV_PIXEL_BUFFER) -- Redefine require -- from EV_PIXMAP_I not_void: a_pixel_buffer /= Void require -- from EV_PIXMAP_IMP_STATE True init_from_pointer_style (a_pointer_style: EV_POINTER_STYLE) -- Initialize from not void a_pointer_style. require -- from EV_PIXMAP_I not_void: a_pointer_style /= Void make -- Initialize Current to 1x1. ensure -- from EV_ANY_I is_initialized: get_state_flag (Is_initialized_flag) old_make (an_interface: attached like interface) -- Create Current empty. 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 accept_cursor: detachable EV_POINTER_STYLE -- Accept cursor set by user. -- To be displayed when the screen pointer is over a target that accepts -- `pebble` during pick and drop. -- (from EV_PICK_AND_DROPABLE_I) actual_drop_target_agent: detachable FUNCTION [INTEGER_32, INTEGER_32, detachable EV_ABSTRACT_PICK_AND_DROPABLE] -- Overrides default drop target on a certain position. -- If Void, will use the default drop target. -- Always void if Current is not a widget. -- (from EV_WIDGET_I) arc_cosine (v: REAL_32): REAL_32 -- Trigonometric arccosine of radian v -- in the range [0, pi] -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class arc_sine (v: REAL_32): REAL_32 -- Trigonometric arcsine of radian v -- in the range [-pi/2, +pi/2] -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class arc_tangent (v: REAL_32): REAL_32 -- Trigonometric arctangent of radian v -- in the range [-pi/2, +pi/2] -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class frozen background_color: EV_COLOR -- Color displayed behind foreground features. -- (from EV_COLORIZABLE_I) ceiling (v: REAL_32): REAL_32 -- Least integral value greater than or equal to v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class Check_instruction: INTEGER_32 = 7 -- Exception code for violated check -- (from EXCEP_CONST) Class_invariant: INTEGER_32 = 6 -- Exception code for violated class invariant -- (from EXCEP_CONST) Com_exception: INTEGER_32 = 28 -- Exception code for a COM error. -- (from EXCEP_CONST) configurable_target_menu_handler: detachable PROCEDURE [EV_MENU, ARRAYED_LIST [EV_PND_TARGET_DATA], EV_PICK_AND_DROPABLE, detachable ANY] -- (from EV_PICK_AND_DROPABLE_I) cosine (v: REAL_32): REAL_32 -- Trigonometric cosine of radian v approximated -- in the range [-pi/4, +pi/4] -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class Create_on_deferred: INTEGER_32 = 17 -- Create on deferred -- (from EXCEP_CONST) cursor: detachable WEL_CURSOR -- Current cursor used. Void if none. default_key_processing_handler: detachable PREDICATE [EV_KEY] -- Agent used to determine whether the default key processing should occur for Current. -- If agent returns True then default key processing continues as normal, False prevents -- default key processing from occurring. -- (from EV_WIDGET_I) deny_cursor: detachable EV_POINTER_STYLE -- Deny cursor set by user. -- To be displayed when the screen pointer is not over a valid target. -- (from EV_PICK_AND_DROPABLE_I) Developer_exception: INTEGER_32 = 24 -- Exception code for developer exception -- (from EXCEP_CONST) Dollar_applied_to_melted_feature: INTEGER_32 = 26 -- $ applied to melted feature -- (from EXCEP_CONST) Eiffel_runtime_fatal_error: INTEGER_32 = 25 -- Eiffel run-time fatal error -- (from EXCEP_CONST) Eiffel_runtime_panic: INTEGER_32 = 13 -- Eiffel run-time panic -- (from EXCEP_CONST) Euler: REAL_64 = 2.7182818284590452353602874713526625 -- Logarithm base -- (from MATH_CONST) Exception_in_signal_handler: INTEGER_32 = 20 -- Exception in signal handler -- (from EXCEP_CONST) Exception_manager: EXCEPTION_MANAGER -- Exception manager -- (from EXCEPTION_MANAGER_FACTORY) ensure -- from EXCEPTION_MANAGER_FACTORY instance_free: class exception_manager_not_void: Result /= Void exp (x: REAL_32): REAL_32 -- Exponential of v. -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class External_exception: INTEGER_32 = 18 -- Exception code for operating system error -- which does not set the errno variable -- (Unix-specific) -- (from EXCEP_CONST) Floating_point_exception: INTEGER_32 = 5 -- Exception code for floating point exception -- (from EXCEP_CONST) floor (v: REAL_32): REAL_32 -- Greatest integral value less than or equal to v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class frozen foreground_color: EV_COLOR -- Color of foreground features like text. -- (from EV_COLORIZABLE_I) generating_type: TYPE [detachable EV_PIXMAP_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 get_bitmap: WEL_BITMAP -- Current bitmap used. -- -- The number of references if incremented when calling -- this feature, call WEL_BITMAP.decrement_reference require -- from EV_PIXMAP_IMP_STATE True ensure -- from EV_PIXMAP_IMP_STATE result_not_void: Result /= Void ensure then result_not_void: Result /= Void get_mask_bitmap: detachable WEL_BITMAP -- Monochrome bitmap used as mask. Void if none. -- -- The number of references if incremented when calling -- this feature, call WEL_BITMAP.decrement_reference require -- from EV_PIXMAP_IMP_STATE mask_in_use: has_mask ensure -- from EV_PIXMAP_IMP_STATE result_not_void: Result /= Void has_mask: BOOLEAN -- Has Current a mask? ensure -- from EV_PIXMAP_IMP_STATE has_mask_implies_mask_bitmap_not_void: Result implies get_mask_bitmap /= Void help_context: detachable FUNCTION [EV_HELP_CONTEXT] -- Agent that evaluates to help context sent to help engine when help is requested -- (from EV_HELP_CONTEXTABLE_I) ensure -- from EV_HELP_CONTEXTABLE_I current_if_exists: internal_help_context /= Void implies Result = internal_help_context icon: detachable WEL_ICON -- Current icon used. Void if none. Incorrect_inspect_value: INTEGER_32 = 9 -- Exception code for inspect value which is not one -- of the inspect constants, if there is no Else_part -- (from EXCEP_CONST) internal_pointer_style: EV_POINTER_STYLE -- Cursor displayed when screen pointer is over current widget, -- as seen from interface. -- (from EV_WIDGET_I) Io_exception: INTEGER_32 = 21 -- Exception code for I/O error -- (from EXCEP_CONST) is_dock_executing: BOOLEAN -- Is Current in the process of a dockable transport? -- (from EV_DOCKABLE_SOURCE_I) is_dockable: BOOLEAN -- Is Current dockable? -- (from EV_DOCKABLE_SOURCE_I) is_external_docking_enabled: BOOLEAN -- Is Current able to be docked into an EV_DOCKABLE_DIALOG -- When there is no valid EV_DRAGABLE_TARGET upon completion -- of the transport? -- (from EV_DOCKABLE_SOURCE_I) is_external_docking_relative: BOOLEAN -- Will dockable dialog displayed when Current is docked externally -- be displayed relative to parent window of Current? -- Otherwise displayed as a standard window. -- (from EV_DOCKABLE_SOURCE_I) log (v: REAL_32): REAL_32 -- Natural logarithm of v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class log10 (v: REAL_32): REAL_32 -- Base 10 logarithm of v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class log_2 (v: REAL_32): REAL_32 -- Base 2 logarithm of v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class Loop_invariant: INTEGER_32 = 11 -- Exception code for violated loop invariant -- (from EXCEP_CONST) Loop_variant: INTEGER_32 = 10 -- Exception code for non-decreased loop variant -- (from EXCEP_CONST) No_more_memory: INTEGER_32 = 2 -- Exception code for failed memory allocation -- (from EXCEP_CONST) not_external_docking_enabled: BOOLEAN -- Attribute used for is_externally_dockable. We must implement -- is_externally_dockable this way as we have no easy solution to -- assign True to is_externally_dockable. -- (from EV_DOCKABLE_SOURCE_I) not_is_external_docking_relative: BOOLEAN -- Will dockable dialog displayed when Current is docked externally -- be displayed relative to parent window of Current? -- Otherwise displayed as a standard window. -- Internal reversed value of `is_external_docking_relative` as we cannot -- easily initialize a BOOLE to True in this case. -- (from EV_DOCKABLE_SOURCE_I) Number_of_codes: INTEGER_32 = 31 -- How many codes are there to represent exceptions? -- (from EXCEP_CONST) Old_exception: INTEGER_32 = 30 -- Old exception code. -- (from EXCEP_CONST) Operating_system_exception: INTEGER_32 = 22 -- Exception code for operating system error -- which sets the errno variable -- (Unix-specific) -- (from EXCEP_CONST) original_parent_position: INTEGER_32 -- Original position in parent. Required -- to restore widget later. -- (from EV_DOCKABLE_SOURCE_I) Out_of_memory: INTEGER_32 = 15 -- Out of memory (cannot be ignored) -- (from EXCEP_CONST) palette: detachable WEL_PALETTE -- Current palette used. Void if none. pebble: detachable ANY -- Data to be transported by pick and drop mechanism. -- (from EV_PICK_AND_DROPABLE_I) pebble_function: detachable FUNCTION [detachable ANY] -- Returns data to be transported by pick and drop mechanism. -- (from EV_PICK_AND_DROPABLE_I) pebble_positioning_enabled: BOOLEAN -- If True then pick and drop start coordinates are -- `pebble_x_position`, `pebble_y_position`. -- If False then pick and drop start coordinates are -- the pointer coordinates. -- (from EV_PICK_AND_DROPABLE_I) pebble_x_position: INTEGER_32 -- Initial x position for pick and drop relative to Current. -- (from EV_PICK_AND_DROPABLE_I) pebble_y_position: INTEGER_32 -- Initial y position for pick and drop relative to Current. -- (from EV_PICK_AND_DROPABLE_I) Pi: REAL_64 = 3.1415926535897932384626433832795029 -- (from MATH_CONST) Pi_2: REAL_64 = 1.5707963267948966192313216916397514 -- (from MATH_CONST) Pi_4: REAL_64 = 0.7853981633974483096156608458198757 -- (from MATH_CONST) Postcondition: INTEGER_32 = 4 -- Exception code for violated postcondition -- (from EXCEP_CONST) Precondition: INTEGER_32 = 3 -- Exception code for violated precondition -- (from EXCEP_CONST) rabs (v: REAL_32): REAL_32 -- Absolute value of v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class real_source: detachable EV_DOCKABLE_SOURCE -- Result is EV_DOCKABLE_SOURCE which should be -- dragged when docking begins on Current. -- (from EV_DOCKABLE_SOURCE_I) real_target: detachable EV_DOCKABLE_TARGET -- Result is target used during a dockable transport if -- mouse pointer is above Current. -- (from EV_WIDGET_I) Rescue_exception: INTEGER_32 = 14 -- Exception code for exception in rescue clause -- (from EXCEP_CONST) Resumption_failed: INTEGER_32 = 16 -- Resumption failed (retry did not succeed) -- (from EXCEP_CONST) Retrieve_exception: INTEGER_32 = 23 -- Exception code for retrieval error -- may be raised by retrieved in IO_MEDIUM. -- (from EXCEP_CONST) Routine_failure: INTEGER_32 = 8 -- Exception code for failed routine -- (from EXCEP_CONST) Runtime_check_exception: INTEGER_32 = 29 -- Exception code for runtime check being violated. -- (from EXCEP_CONST) Runtime_io_exception: INTEGER_32 = 27 -- Exception code for I/O error raised by runtime functions -- such as store/retrieve, file access... -- (from EXCEP_CONST) Serialization_exception: INTEGER_32 = 31 -- Serialization exception code. -- (from EXCEP_CONST) Signal_exception: INTEGER_32 = 12 -- Exception code for operating system signal -- (from EXCEP_CONST) sine (v: REAL_32): REAL_32 -- Trigonometric sine of radian v approximated -- in range [-pi/4, +pi/4] -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class sqrt (v: REAL_32): REAL_32 -- Square root of v -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class Sqrt2: REAL_64 = 1.4142135623730950488016887242096981 -- Square root of 2 -- (from MATH_CONST) tangent (v: REAL_32): REAL_32 -- Trigonometric tangent of radian v approximated -- in range [-pi/4, +pi/4] -- (from SINGLE_MATH) ensure -- from SINGLE_MATH instance_free: class update_content -- Update the content of bitmap, `icon`, ... -- if needed. update_needed: BOOLEAN -- Is an update needed? valid_code (c: INTEGER_32): BOOLEAN -- Is c a valid code to represent some kind of exceptions? -- (from EXCEP_CONST) Void_assigned_to_expanded: INTEGER_32 = 19 -- Exception code for assignment of void value -- to expanded entity -- (from EXCEP_CONST) Void_call_target: INTEGER_32 = 1 -- Exception code for feature applied to void reference -- (from EXCEP_CONST) feature -- Measurement dpi: NATURAL_32 -- Window dpi. -- (from EV_POSITIONED_I) height: INTEGER_32 -- Height of Current. require -- from EV_DRAWABLE_I True require -- from EV_POSITIONED_I True require -- from EV_PIXMAP_IMP_STATE True ensure -- from EV_DRAWABLE_I positive: Result > 0 width: INTEGER_32 -- Width of Current. require -- from EV_DRAWABLE_I True require -- from EV_POSITIONED_I True require -- from EV_PIXMAP_IMP_STATE True ensure -- from EV_DRAWABLE_I positive: Result > 0 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_PIXMAP_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_PIXMAP_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_PIXMAP_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 assertion_violation: BOOLEAN -- Is last exception originally due to a violated -- assertion or non-decreasing variant? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class exception_class_name: detachable STRING_8 -- Name of the class that includes the recipient -- of original form of last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class closest_dockable_target: detachable EV_DOCKABLE_TARGET -- Result is first dockable target that `is_dockable` found by recursively -- searching up through the parenting structure from the widget -- currently underneath the pointer position. -- Result will be Void if a dockable target is not found. -- (from EV_DOCKABLE_SOURCE_I) ensure -- from EV_DOCKABLE_SOURCE_I result_is_dockable: Result /= Void implies Result.is_docking_enabled 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 developer_exception_name: detachable STRING_8 -- Name of last developer-raised exception -- (from EXCEPTIONS) require -- from EXCEPTIONS applicable: is_developer_exception ensure -- from EXCEPTIONS instance_free: class exception: INTEGER_32 -- Code of last exception that occurred -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class exception_trace: detachable STRING_8 -- String representation of the exception trace -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class get_next_target (a_widget: EV_WIDGET): detachable EV_DOCKABLE_TARGET -- Result is next dockable target that is `is_dockable` found by -- recursively seraching up the parenting structure from current_target. -- Result will be Void if none. -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I a_widget_not_void: a_widget /= Void ensure -- from EV_DOCKABLE_SOURCE_I result_is_dockable: Result /= Void implies Result.is_docking_enabled internal_non_sensitive: BOOLEAN -- Is Current not sensitive to input as seen -- from `interface`? -- (from EV_SENSITIVE_I) is_destroyed: BOOLEAN -- Is Current no longer usable? -- (from EV_ANY_I) is_developer_exception: BOOLEAN -- Is the last exception originally due to -- a developer exception? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_developer_exception_of_name (name: detachable STRING_8): BOOLEAN -- Is the last exception originally due to a developer -- exception of name name? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_signal: BOOLEAN -- Is last exception originally due to an external -- event (operating system signal)? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_system_exception: BOOLEAN -- Is last exception originally due to an -- external event (operating system error)? -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class is_transport_enabled: BOOLEAN -- Is the transport mechanism enabled? -- (from EV_PICK_AND_DROPABLE_I) meaning (except: INTEGER_32): detachable STRING_8 -- A message in English describing what except is -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class mode_is_configurable_target_menu: BOOLEAN -- Is the transport mechanism a configurable target menu? -- (from EV_PICK_AND_DROPABLE_I) mode_is_drag_and_drop: BOOLEAN -- Is the transport mechanism drag and drop? -- (from EV_PICK_AND_DROPABLE_I) mode_is_pick_and_drop: BOOLEAN -- Is the transport mechanism pick and drop? -- (from EV_PICK_AND_DROPABLE_I) mode_is_target_menu: BOOLEAN -- Is the transport mechanism a target menu? -- (from EV_PICK_AND_DROPABLE_I) original_class_name: detachable STRING_8 -- Name of the class that includes the recipient -- of original form of last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class original_exception: INTEGER_32 -- Original code of last exception that triggered -- current exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class original_recipient_name: detachable STRING_8 -- Name of the routine whose execution was -- interrupted by original form of last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class original_tag_name: detachable STRING_8 -- Assertion tag for original form of last -- assertion violation. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class recipient_name: detachable STRING_8 -- Name of the routine whose execution was -- interrupted by last exception -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class 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)) tag_name: detachable STRING_8 -- Tag of last violated assertion clause -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class user_is_sensitive: BOOLEAN -- Is the object sensitive to user input. -- (from EV_SENSITIVE_I) feature -- Status setting catch (code: INTEGER_32) -- Make sure that any exception of code code will be -- caught. This is the default. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class die (code: INTEGER_32) -- Terminate execution with exit status code, -- without triggering an exception. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS False instance_free: class disable_dockable -- Ensure Current is not dockable -- (from EV_DOCKABLE_SOURCE_I) ensure -- from EV_DOCKABLE_SOURCE_I not_is_dockable: not is_dockable disable_external_docking -- Forbid Current to be docked into an EV_DOCKABLE_DIALOG -- When there is no valid EV_DRAGABLE_TARGET upon completion -- of the transport? -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I is_dockable: is_dockable ensure -- from EV_DOCKABLE_SOURCE_I not_externally_dockable: not is_external_docking_enabled disable_external_docking_relative -- Assign False to `is_external_docking_relative`, ensuring that -- a dockable dialog displayed when Current is docked externally -- is displayed as a standard window. -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I external_docking_enabled: is_external_docking_enabled ensure -- from EV_DOCKABLE_SOURCE_I external_docking_not_relative: not is_external_docking_relative disable_pebble_positioning -- Assign False to `pebble_positioning_enabled`. -- (from EV_PICK_AND_DROPABLE_I) enable_dockable -- Allow Current to be dockable -- (from EV_DOCKABLE_SOURCE_I) ensure -- from EV_DOCKABLE_SOURCE_I is_dockable: is_dockable enable_external_docking -- Allow Current to be docked into an EV_DOCKABLE_DIALOG -- When there is no valid EV_DRAGABLE_TARGET upon completion -- of the transport? -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I is_dockable: is_dockable ensure -- from EV_DOCKABLE_SOURCE_I is_externally_dockable: is_external_docking_enabled enable_external_docking_relative -- Assign True to `is_external_docking_relative`, ensuring that -- a dockable dialog displayed when Current is docked externally -- is displayed relative to the top level window. -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I external_docking_enabled: is_external_docking_enabled ensure -- from EV_DOCKABLE_SOURCE_I external_docking_not_relative: is_external_docking_relative enable_pebble_positioning -- Assign True to `pebble_positioning_enabled`. -- (from EV_PICK_AND_DROPABLE_I) ignore (code: INTEGER_32) -- Make sure that any exception of code code will be -- ignored. This is not the default. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class message_on_failure -- Print an exception history table -- in case of failure. -- This is the default. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class no_message_on_failure -- Do not print an exception history table -- in case of failure. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class exception_raise (name: detachable READABLE_STRING_GENERAL) -- Raise a developer exception of name name. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class raise_retrieval_exception (name: detachable READABLE_STRING_GENERAL) -- Raise a retrieval exception of name name. -- (from EXCEPTIONS) ensure -- from EXCEPTIONS instance_free: class remove_default_key_processing_handler -- Ensure `default_key_processing_handler` is Void. -- (from EV_WIDGET_I) ensure -- from EV_WIDGET_I default_key_processing_handler_removed: default_key_processing_handler = Void remove_pebble -- Remove `pebble`. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I pebble_removed: pebble = Void and pebble_function = Void is_transport_disabled: not is_transport_enabled remove_real_source -- Ensure `real_source` is Void. -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I is_dockable: is_dockable ensure -- from EV_DOCKABLE_SOURCE_I real_source_void: real_source = Void remove_real_target -- Ensure `real_target` is Void. -- (from EV_WIDGET_I) ensure -- from EV_WIDGET_I real_target_void: real_target = Void reset_pebble_function -- Reset any values created by calling `pebble_function`. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I pebble_function_preserved: pebble_function = old pebble_function pebble_without_function: pebble_function = Void implies (pebble = old pebble) pebble_with_function: pebble_function /= Void implies pebble = Void set_accept_cursor (a_cursor: like accept_cursor) -- Set a_cursor to be displayed when the screen pointer is over a -- target that accepts `pebble` during pick and drop. -- (from EV_PICK_AND_DROPABLE_I) set_configurable_target_menu_handler (a_handler: like configurable_target_menu_handler) -- Set Configurable Target Menu Handler to a_handler. -- (from EV_PICK_AND_DROPABLE_I) set_configurable_target_menu_mode -- Set transport mechanism to a configurable target_menu. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_target_menu: mode_is_configurable_target_menu set_default_key_processing_handler (a_handler: like default_key_processing_handler) -- Assign `default_key_processing_handler` to a_handler. -- (from EV_WIDGET_I) set_deny_cursor (a_cursor: like deny_cursor) -- Set a_cursor to be displayed when the screen pointer is over a -- target that doesn't accept `pebble` during pick and drop. -- (from EV_PICK_AND_DROPABLE_I) set_drag_and_drop_mode -- Set transport mechanism to drag and drop, -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_drag_and_drop: mode_is_drag_and_drop set_pebble_position (a_x, a_y: INTEGER_32) -- Set the initial position for pick and drop relative to Current. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I pick_x_assigned: pick_x.to_integer_32 = a_x pick_y_assigned: pick_y.to_integer_32 = a_y set_pick_and_drop_mode -- Set transport mechanism to pick and drop, -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_pick_and_drop: mode_is_pick_and_drop set_real_source (dockable_source: EV_DOCKABLE_SOURCE) -- Set dockable_source to be the widget moved when a -- drag begins on Current. -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I is_dockable: is_dockable dockable_source_not_void: dockable_source /= Void ensure -- from EV_DOCKABLE_SOURCE_I real_source_assigned: real_source = dockable_source set_real_target (a_target: EV_DOCKABLE_TARGET) -- Assign a_target to `real_target`. -- (from EV_WIDGET_I) require -- from EV_WIDGET_I target_not_void: a_target /= Void ensure -- from EV_WIDGET_I assigned: real_target = a_target set_target_menu_mode -- Set transport mechanism to a target_menu. -- (from EV_PICK_AND_DROPABLE_I) ensure -- from EV_PICK_AND_DROPABLE_I mode_is_target_menu: mode_is_target_menu show_configurable_target_menu (a_x, a_y: INTEGER_32) -- Show the configurable target menu at position a_x, a_y relative to Current. -- (from EV_PICK_AND_DROPABLE_I) stretch (new_width, new_height: INTEGER_32) -- Stretch the image to fit in size -- new_width by new_height. require -- from EV_PIXMAP_I x_coordinate_valid: new_width > 0 y_coordinate_valid: new_height > 0 user_disable_sensitive -- Make object desensitive to user input. -- (from EV_SENSITIVE_I) ensure -- from EV_SENSITIVE_I is_desensitive: not user_is_sensitive user_enable_sensitive -- Make object sensitive to user input. -- (from EV_SENSITIVE_I) ensure -- from EV_SENSITIVE_I is_sensitive_if_parent_sensitive: (has_parent and then parent_is_sensitive) implies attached_interface.implementation.is_sensitive is_sensitive_if_orphaned: not has_parent implies attached_interface.implementation.is_sensitive feature -- Element change remove_help_context -- Remove key press action associated with EV_APPLICATION.help_key. -- (from EV_HELP_CONTEXTABLE_I) require -- from EV_HELP_CONTEXTABLE_I help_context_not_void: help_context /= Void ensure -- from EV_HELP_CONTEXTABLE_I no_help_context: internal_help_context = Void set_help_context (an_help_context: like help_context) -- Assign a_help_context to `help_context`. -- Assign an_help_context to `help_context`. -- (from EV_HELP_CONTEXTABLE_I) require -- from EV_HELP_CONTEXTABLE_I an_help_context_not_void: an_help_context /= Void ensure -- from EV_HELP_CONTEXTABLE_I help_context_assigned: attached help_context as l_help_context and then l_help_context ~ an_help_context feature -- Duplication copy (other: EV_PIXMAP_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 copy_pixmap (other_interface: EV_PIXMAP) -- Update Current to have same appearence as other. -- (So as to satisfy `is_equal`.) frozen deep_copy (other: EV_PIXMAP_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_PIXMAP_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_PIXMAP_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_PIXMAP_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_PIXMAP_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 close_dockable_dialog (dockable_dialog: EV_DOCKABLE_DIALOG) -- Close request received by dockable_dialog so -- restore widget contained back to its original position -- in its old parent if possible. -- We must fire dock_ended actions. -- (from EV_DOCKABLE_SOURCE_I) ensure -- from EV_DOCKABLE_SOURCE_I dockable_dialog_destroyed: dockable_dialog.is_destroyed complete_dock -- Complete a dock from `source_being_docked`. -- (from EV_DOCKABLE_SOURCE_I) require -- from EV_DOCKABLE_SOURCE_I source_being_docked: source_being_docked /= Void ensure -- from EV_DOCKABLE_SOURCE_I not_dock_executing: not is_dock_executing insert_separator_not_parented: Insert_sep.parent = Void insert_label_not_parented: Insert_label.parent = Void frozen default: detachable EV_PIXMAP_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 flush -- Execute any delayed calls to `expose_actions` without waiting -- for next idle. -- (from EV_PIXMAP_I) feature -- Inapplicable Drag_cursor: EV_POINTER_STYLE -- Cursor used when Current is being transported. -- (from EV_DOCKABLE_SOURCE_I) feature -- Implementation disable_initialized -- Ensure `is_initialized` = False. require -- from EV_PIXMAP_IMP_LOADER True require -- from EV_ANY_I True ensure -- from EV_ANY_I not_is_initialized: not get_state_flag (Is_initialized_flag) sub_pixmap (area: EV_RECTANGLE): EV_PIXMAP -- Pixmap region of Current represented by rectangle area require -- from EV_DRAWABLE_I area_not_void: area /= Void ensure -- from EV_DRAWABLE_I result_not_void: Result /= Void feature -- Access EV_DRAGABLE_SOURCE. dockable_dialog_target: detachable EV_DOCKABLE_DIALOG -- A dockable dialog that will be created as -- necessary. This is not a local, to avoid it -- being garbage collected. -- (from EV_SHARED_TRANSPORT_I) Global_drag_targets: ARRAYED_LIST [INTEGER_32] -- Shortcut to EV_APPLICATION.pnd_targets. -- (from EV_SHARED_TRANSPORT_I) frozen Insert_label: EV_CELL -- Label used to indicate where Current will be placed in target. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I result_not_void: Result /= Void Insert_label_imp: EV_CELL_I -- Once access to implementation of `insert_label`. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I Result /= Void Insert_sep: EV_TOOL_BAR_SEPARATOR -- Once access to a separator used to indicate the insertion position -- when moving tool bar items. -- (from EV_SHARED_TRANSPORT_I) Insert_sep_imp: EV_TOOL_BAR_SEPARATOR_I -- Once access to implementation of `insert_sep`. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I Result /= Void Internal_screen: EV_SCREEN -- Once access to an EV_SCREEN. -- (from EV_SHARED_TRANSPORT_I) original_x_offset: INTEGER_16 -- Original x_offset and original_y_offset of transport -- realtive to widget. Only used for dragable transports. -- (from EV_SHARED_TRANSPORT_I) original_y_offset: INTEGER_16 -- Original x_offset and original_y_offset of transport -- realtive to widget. Only used for dragable transports. -- (from EV_SHARED_TRANSPORT_I) originating_source: detachable EV_DOCKABLE_SOURCE_I -- Dragable source that originated the transport of source_being_dragged. -- (from EV_SHARED_TRANSPORT_I) remove_insert_label -- Remove `insert_label` from its current `parent`. -- We must handle a special case for cells. If the parent is a cell, -- then we remove the cell from its parent, and then restore it. -- Otherwise, when the label, removed, the cell keeps it size, and cells -- are normally used with `real_target` when the cell must -- not be visible. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I not_parented: Insert_label.parent = Void remove_insert_sep -- Ensure inset_sep is not parented. -- (from EV_SHARED_TRANSPORT_I) ensure -- from EV_SHARED_TRANSPORT_I not_parented: Insert_sep.parent = Void source_being_docked: detachable EV_DOCKABLE_SOURCE_I -- Dragable source currently being transported. May be a -- WIDGET_IMP or an EV_TOOL_BAR_BUTTON_IMP. -- (from EV_SHARED_TRANSPORT_I) feature -- Access EV_PICK_AND_DROPABLE. Default_accept_cursor: EV_POINTER_STYLE -- Used in lieu of a user defined `accept_cursor`. -- (from EV_SHARED_TRANSPORT_I) Default_deny_cursor: EV_POINTER_STYLE -- Used in lieu of a user defined `deny_cursor`. -- (from EV_SHARED_TRANSPORT_I) Default_pixmaps: EV_STOCK_PIXMAPS -- Default pixmaps -- (from EV_SHARED_TRANSPORT_I) Global_pnd_targets: HASH_TABLE [INTEGER_32, INTEGER_32] -- Shortcut to EV_APPLICATION.pnd_targets. -- (from EV_SHARED_TRANSPORT_I) rubber_band_is_drawn: BOOLEAN -- Is a rubber band line currently on the screen? -- (from EV_SHARED_TRANSPORT_I) feature -- Access common. pointer_x: INTEGER_16 -- (from EV_SHARED_TRANSPORT_I) pointer_y: INTEGER_16 -- (from EV_SHARED_TRANSPORT_I) feature -- Basic Operation refresh_now -- Force Current to be redrawn immediately. feature -- Constants Drawing_mode_and: INTEGER_32 = 3 -- Drawing mode where bitwise AND is performed when a -- pixel is drawn. -- -- T\S | 0 | 1 | -- ------------- -- 0 | 0 | 0 | -- ------------- -- 1 | 0 | 1 | -- (from EV_DRAWABLE_CONSTANTS) Drawing_mode_copy: INTEGER_32 = 0 -- Normal drawing mode. -- -- T\S | 0 | 1 | -- ------------- -- 0 | 0 | 1 | -- ------------- -- 1 | 0 | 1 | -- (from EV_DRAWABLE_CONSTANTS) Drawing_mode_invert: INTEGER_32 = 2 -- Drawing mode where bits are inverted before drawn. -- -- T\S | 0 | 1 | -- ------------- -- 0 | 1 | 0 | -- ------------- -- 1 | 1 | 0 | -- (from EV_DRAWABLE_CONSTANTS) Drawing_mode_or: INTEGER_32 = 4 -- Drawing mode where bitwise OR is performed when a -- pixel is drawn. -- -- T\S | 0 | 1 | -- ------------- -- 0 | 0 | 1 | -- ------------- -- 1 | 1 | 1 | -- (from EV_DRAWABLE_CONSTANTS) Drawing_mode_xor: INTEGER_32 = 1 -- Drawing mode where bitwise XOR is performed when a -- pixel is drawn. -- -- T\S | 0 | 1 | -- ------------- -- 0 | 0 | 1 | -- ------------- -- 1 | 1 | 0 | -- (from EV_DRAWABLE_CONSTANTS) feature -- Contract support valid_drawing_mode (a_mode: INTEGER_32): BOOLEAN -- Is a_mode a valid drawing mode? -- (from EV_DRAWABLE_CONSTANTS) feature -- Delegated features clear -- Erase Current with `background_color`. clear_rectangle (x1, y1, a_width, a_height: INTEGER_32) -- Draw rectangle with upper-left corner on (x, y) -- with size a_width and a_height in `background_color`. clip_area: detachable EV_RECTANGLE -- Clip area used to clip drawing. -- If set to Void, no clipping is applied. dashed_line_style: BOOLEAN -- Are lines drawn dashed? disable_dashed_line_style -- Draw lines solid. ensure -- from EV_DRAWABLE_I dashed_line_style_disabled: is_usable implies not attached_interface.dashed_line_style disable_transport -- Deactivate pick/drag and drop mechanism. ensure -- from EV_PICK_AND_DROPABLE_I is_transport_disabled: not is_transport_enabled draw_arc (a_x: INTEGER_32; a_y: INTEGER_32; a_vertical_radius: INTEGER_32; a_horizontal_radius: INTEGER_32; a_start_angle: REAL_32; an_aperture: REAL_32) -- Draw a part of an ellipse centered on (x, 'y') with -- size a_vertical_radius and a_horizontal_radius. -- Start at a_start_angle and stop at a_start_angle -- + an_aperture. -- Angles are measured in radians. require -- from EV_DRAWABLE_I a_bounding_width_positive_or_zero: a_vertical_radius >= 0 a_bounding_width_positive_or_zero: a_horizontal_radius >= 0 draw_ellipse (a_x: INTEGER_32; a_y: INTEGER_32; a_vertical_radius: INTEGER_32; a_horizontal_radius: INTEGER_32) -- Draw an ellipse centered on (x, 'y') with -- size a_vertical_radius and a_horizontal_radius. require -- from EV_DRAWABLE_I a_bounding_width_positive_or_zero: a_vertical_radius >= 0 a_bounding_height_positive_or_zero: a_horizontal_radius >= 0 draw_ellipsed_text (a_x, a_y: INTEGER_32; a_text: READABLE_STRING_GENERAL; clipping_width: INTEGER_32) -- Draw a_text at (x, 'y') using `font`. require -- from EV_DRAWABLE_I a_text_not_void: a_text /= Void clipping_width_positive: clipping_width >= 0 draw_ellipsed_text_top_left (a_x, a_y: INTEGER_32; a_text: READABLE_STRING_GENERAL; clipping_width: INTEGER_32) -- Draw a_text with top left corner at (x, y) using `font`. require -- from EV_DRAWABLE_I a_text_not_void: a_text /= Void clipping_width_positive: clipping_width >= 0 draw_pie_slice (a_x: INTEGER_32; a_y: INTEGER_32; a_vertical_radius: INTEGER_32; a_horizontal_radius: INTEGER_32; a_start_angle: REAL_32; an_aperture: REAL_32) -- Draw a part of an ellipse centered on (x, 'y') with -- size a_vertical_radius and a_horizontal_radius. -- Start at a_start_angle and stop at a_start_angle + -- an_aperture. -- The arc is then closed by two segments through (x, 'y'). -- Angles are measured in radians. require -- from EV_DRAWABLE_I a_bounding_width_positive_or_zero: a_vertical_radius >= 0 a_bounding_height_positive_or_zero: a_horizontal_radius >= 0 draw_pixmap (a_x: INTEGER_32; a_y: INTEGER_32; a_pixmap: EV_PIXMAP) -- Draw a_pixmap with upper-left corner on (x, 'y'). require -- from EV_DRAWABLE_I a_pixmap_not_void: a_pixmap /= Void draw_point (a_x, a_y: INTEGER_32) -- Draw point at position (x, 'y') on Current. draw_polyline (points: ARRAY [EV_COORDINATE]; is_closed: BOOLEAN) -- Draw line segments between subsequent points in -- points. If is_closed draw line segment between first -- and last point in points. require -- from EV_DRAWABLE_I points_not_void: points /= Void draw_rectangle (a_x: INTEGER_32; a_y: INTEGER_32; a_width: INTEGER_32; a_height: INTEGER_32) -- Draw rectangle with upper-left corner on (x, 'y') -- with size a_width and a_height. require -- from EV_DRAWABLE_I a_width_positive_or_zero: a_width >= 0 a_height_positive_or_zero: a_height >= 0 draw_rotated_text (a_x, a_y: INTEGER_32; a_angle: REAL_32; a_text: STRING_8) -- Draw a_text at (x, 'y') using `font`. require -- from EV_DRAWABLE_I a_text_not_void: a_text /= Void draw_segment (x1, y1, x2, y2: INTEGER_32) -- Draw line segment from (x1, 'y1') to (x2, 'y2'). draw_straight_line (x1, y1, x2, y2: INTEGER_32) -- Draw infinite straight line through (x1, 'y1') and -- (x2, 'y2'). draw_sub_pixel_buffer (x, y: INTEGER_32; a_pixel_buffer: EV_PIXEL_BUFFER; area: EV_RECTANGLE) -- Draw area of a_pixel_buffer with upper-left corner on (x, y). require -- from EV_DRAWABLE_I a_pixel_buffer_not_void: a_pixel_buffer /= Void a_pixel_buffer_not_destroyed: not a_pixel_buffer.is_destroyed area_not_void: area /= Void draw_sub_pixmap (a_x: INTEGER_32; a_y: INTEGER_32; a_pixmap: EV_PIXMAP; area: EV_RECTANGLE) -- Draw area of a_pixmap with upper-left corner on (x, y). require -- from EV_DRAWABLE_I a_pixmap_not_void: a_pixmap /= Void a_pixmap_not_destroyed: not a_pixmap.is_destroyed area_not_void: area /= Void draw_text (a_x, a_y: INTEGER_32; a_text: READABLE_STRING_GENERAL) -- Draw a_text at (x, 'y') using `font`. require -- from EV_DRAWABLE_I a_text_not_void: a_text /= Void draw_text_top_left (a_x, a_y: INTEGER_32; a_text: READABLE_STRING_GENERAL) -- Draw a_text with top left corner at (x, y) using `font`. require -- from EV_DRAWABLE_I a_text_not_void: a_text /= Void drawing_mode: INTEGER_32 -- Result is logical operation on pixels when drawing. enable_dashed_line_style -- Draw lines dashed. ensure -- from EV_DRAWABLE_I dashed_line_style_enabled: is_usable implies attached_interface.dashed_line_style enable_transport -- Enable Pick/Drag and Drop. require -- from EV_PICK_AND_DROPABLE_I pebble_not_void: pebble /= Void or pebble_function /= Void ensure -- from EV_PICK_AND_DROPABLE_I is_transport_enabled: is_transport_enabled fill_ellipse (a_x: INTEGER_32; a_y: INTEGER_32; a_vertical_radius: INTEGER_32; a_horizontal_radius: INTEGER_32) -- Draw an ellipse centered on (x, 'y') with -- size a_vertical_radius and a_horizontal_radius. -- Fill with `background_color`. require -- from EV_DRAWABLE_I a_bounding_width_positive_or_zero: a_vertical_radius >= 0 a_bounding_height_positive_or_zero: a_horizontal_radius >= 0 fill_pie_slice (a_x: INTEGER_32; a_y: INTEGER_32; a_vertical_radius: INTEGER_32; a_horizontal_radius: INTEGER_32; a_start_angle: REAL_32; an_aperture: REAL_32) -- Draw a part of an ellipse centered on (x, 'y') with -- size a_vertical_radius and a_horizontal_radius. -- Start at a_start_angle and stop at a_start_angle -- + an_aperture. -- The arc is then closed by two segments through (x, 'y'). -- Angles are measured in radians. Fill with `background_color`. require -- from EV_DRAWABLE_I a_bounding_width_positive_or_zero: a_vertical_radius >= 0 a_bounding_height_positive_or_zero: a_horizontal_radius >= 0 fill_polygon (points: ARRAY [EV_COORDINATE]) -- Draw line segments between subsequent points in points. -- Fill with `background_color`. require -- from EV_DRAWABLE_I points_not_void: points /= Void fill_rectangle (a_x: INTEGER_32; a_y: INTEGER_32; a_width: INTEGER_32; a_height: INTEGER_32) -- Draw rectangle with upper-left corner on (x, 'y') -- with size a_width and a_height. Fill with -- `background_color`. require -- from EV_DRAWABLE_I a_width_positive_or_zero: a_width >= 0 a_height_positive_or_zero: a_height >= 0 font: EV_FONT -- Character appearance on Current. ensure -- from EV_FONTABLE_I not_void: Result /= Void has_capture: BOOLEAN -- Does widget have capture? has_focus: BOOLEAN -- Does widget have the keyboard focus? hide -- Request that Current not be displayed. internal_disable_dockable -- Platform specific implementation of disable_drag. -- Does nothing in this implementation. internal_enable_dockable -- Platform specific implementation of enable_drag. -- Does nothing in this implementation. is_displayed: BOOLEAN -- Is Current visible on the screen? -- False if Current is entirely obscured by another window. is_show_requested: BOOLEAN -- Will Current be displayed when its parent is? -- See also `is_displayed`. line_width: INTEGER_32 -- Result is line width of Current. minimum_height: INTEGER_32 -- Minimum vertical size in pixels. minimum_width: INTEGER_32 -- Minimum horizontal size in pixels. parent: detachable EV_CONTAINER -- Container widget that contains Current. -- (Void if Current is not in a container) pointer_position: EV_COORDINATE -- Position of the screen pointer relative to Current. ensure -- from EV_WIDGET_I result_not_void: Result /= Void pointer_style: detachable EV_POINTER_STYLE -- Cursor displayed when screen pointer is over current widget. redraw -- Force Current to redraw itself. remove_clipping -- Do not apply any clipping. ensure -- from EV_DRAWABLE_I clip_area_void: is_usable implies attached_interface.clip_area = Void remove_tile -- Do not apply a tile when filling. ensure -- from EV_DRAWABLE_I tile_void: is_usable implies attached_interface.tile = Void reset_for_buffering (a_width, a_height: INTEGER_32) -- Resets the size of the pixmap without keeping original image or clearing background. require -- from EV_PIXMAP_I width_valid: a_width > 0 height_valid: a_height > 0 reset_minimum_height -- Reset the minimum height. reset_minimum_size -- Reset the minimum size (width and height). reset_minimum_width -- Reset the minimum width. screen_x: INTEGER_32 -- Horizontal offset relative to screen. require -- from EV_POSITIONED_I True screen_y: INTEGER_32 -- Vertical offset relative to screen. require -- from EV_POSITIONED_I True set_actual_drop_target_agent (an_agent: like actual_drop_target_agent) -- Assign an_agent to `actual_drop_target_agent`. require -- from EV_WIDGET_I an_agent_not_void: an_agent /= Void ensure -- from EV_WIDGET_I assigned: actual_drop_target_agent = an_agent set_anti_aliasing (value: BOOLEAN) -- Enable (if value) or disable (if not value) anti-aliasing (if supported) when drawing. set_background_color (a_color: EV_COLOR) -- Assign a_color to `background_color`. require -- from EV_COLORIZABLE_I a_color_not_void: a_color /= Void ensure -- from EV_COLORIZABLE_I background_color_assigned: is_initialized implies background_color.is_equal (a_color) set_clip_area (an_area: EV_RECTANGLE) -- Assign an_area to the area which will be refreshed. require -- from EV_DRAWABLE_I an_area_not_void: an_area /= Void ensure -- from EV_DRAWABLE_I clip_area_assigned: is_usable implies attached attached_interface.clip_area as l_clip_area and then an_area.is_equal (l_clip_area) set_clip_region (a_region: EV_REGION) -- Assign a_region to the area which will be refreshed. require -- from EV_DRAWABLE_I a_region_not_void: a_region /= Void set_drawing_mode (a_mode: INTEGER_32) -- Set drawing mode to a_logical_mode. require -- from EV_DRAWABLE_I a_mode_valid: valid_drawing_mode (a_mode) ensure -- from EV_DRAWABLE_I drawing_mode_assigned: is_usable implies attached_interface.drawing_mode = a_mode set_focus -- Grab keyboard focus. set_font (a_font: EV_FONT) -- Assign a_font to `font`. require -- from EV_FONTABLE_I a_font_not_void: a_font /= Void ensure -- from EV_FONTABLE_I assigned: is_usable implies font.is_equal (a_font) set_foreground_color (a_color: EV_COLOR) -- Assign a_color to `foreground_color`. require -- from EV_COLORIZABLE_I a_color_not_void: a_color /= Void ensure -- from EV_COLORIZABLE_I foreground_color_assigned: is_initialized implies foreground_color.is_equal (a_color) set_line_width (a_width: INTEGER_32) -- Assign a_width to `line_width`. require -- from EV_DRAWABLE_I a_width_positive_or_zero: a_width >= 0 ensure -- from EV_DRAWABLE_I line_width_assigned: is_usable implies attached_interface.line_width = a_width set_minimum_height (a_minimum_height: INTEGER_32) -- Set the minimum vertical size to a_minimum_height in pixels. require -- from EV_WIDGET_I a_minimum_height_positive: a_minimum_height >= 0 ensure -- from EV_WIDGET_I minimum_height_assigned: is_usable implies ((a_minimum_height > 0 implies attached_interface.minimum_height = a_minimum_height) or (a_minimum_height = 0 implies (attached_interface.minimum_height <= 1))) set_minimum_size (a_minimum_width: INTEGER_32; a_minimum_height: INTEGER_32) -- Set the minimum horizontal size to a_minimum_width in pixels. -- Set the minimum vertical size to a_minimum_height in pixels. require -- from EV_WIDGET_I a_minimum_width_positive: a_minimum_width >= 0 a_minimum_height_positive: a_minimum_height >= 0 ensure -- from EV_WIDGET_I minimum_width_assigned: is_usable implies ((a_minimum_width > 0 implies attached_interface.minimum_width = a_minimum_width) or (a_minimum_width = 0 implies (attached_interface.minimum_width <= 1))) minimum_height_assigned: is_usable implies ((a_minimum_height > 0 implies attached_interface.minimum_height = a_minimum_height) or (a_minimum_height = 0 implies (attached_interface.minimum_height <= 1))) set_minimum_width (a_minimum_width: INTEGER_32) -- Set the minimum horizontal size to a_minimum_width in pixels. require -- from EV_WIDGET_I a_minimum_width_positive: a_minimum_width >= 0 ensure -- from EV_WIDGET_I minimum_width_assigned: is_usable implies ((a_minimum_width > 0 implies attached_interface.minimum_width = a_minimum_width) or (a_minimum_width = 0 implies (attached_interface.minimum_width <= 1))) set_pebble (a_pebble: ANY) -- Assign a_pebble to `pebble`. require -- from EV_PICK_AND_DROPABLE_I a_pebble_not_void: a_pebble /= Void ensure -- from EV_PICK_AND_DROPABLE_I pebble_assigned: pebble = a_pebble is_transport_enabled: is_transport_enabled set_pebble_function (a_function: FUNCTION [detachable ANY]) -- Set a_function to compute `pebble`. require -- from EV_PICK_AND_DROPABLE_I a_function_not_void: a_function /= Void ensure -- from EV_PICK_AND_DROPABLE_I pebble_function_assigned: pebble_function = a_function is_transport_enabled: is_transport_enabled set_size (new_width, new_height: INTEGER_32) -- Resize the current bitmap. If the new size -- is smaller than the old one, the bitmap is -- clipped. require -- from EV_PIXMAP_I x_coordinate_valid: new_width > 0 y_coordinate_valid: new_height > 0 set_tile (a_pixmap: EV_PIXMAP) -- Set tile used to fill figures. -- Set to Void to use `background_color` to fill. require -- from EV_DRAWABLE_I a_pixmap_not_void: a_pixmap /= Void ensure -- from EV_DRAWABLE_I tile_assigned: is_usable implies attached_interface.tile /= Void set_tooltip (a_text: READABLE_STRING_GENERAL) -- Set `tooltip` to a_text. require -- from EV_TOOLTIPABLE_I a_tooltip_not_void: a_text /= Void show -- Request that Current be displayed. tile: detachable EV_PIXMAP -- Pixmap that is used instead of background_color. -- If set to Void, `background_color` is used to fill. tooltip: STRING_32 -- Text displayed when user moves mouse over widget. x_position: INTEGER_32 -- Horizontal offset relative to parent `x_position` in pixels. y_position: INTEGER_32 -- Vertical offset relative to parent `y_position` in pixels. feature -- Event handling conforming_pick_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when a pebble that fits here is picked. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void dock_ended_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed after a dock completes from Current. -- Either to a dockable target or a dockable dialog. -- (from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I) ensure -- from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I not_void: Result /= Void dock_started_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when `pebble` is picked up. -- (from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I) ensure -- from EV_DOCKABLE_SOURCE_ACTION_SEQUENCES_I not_void: Result /= Void dpi_changed_actions: EV_DPI_ACTION_SEQUENCE -- Actions to be performed when dpi changes. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void drop_actions: EV_PND_ACTION_SEQUENCE -- Actions to be performed when a pebble is dropped here. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void expose_actions: EV_GEOMETRY_ACTION_SEQUENCE -- Actions to be performed when an area needs to be redrawn. -- (from EV_DRAWABLE_ACTION_SEQUENCES_I) ensure -- from EV_DRAWABLE_ACTION_SEQUENCES_I not_void: Result /= Void file_drop_actions: EV_LITE_ACTION_SEQUENCE [LIST [STRING_32]] -- Actions to be performed when an OS file drop occurs on Current. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void focus_in_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when keyboard focus is gained. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void focus_out_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when keyboard focus is lost. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void init_dpi_changed_actions (a_dpi_changed_actions: like dpi_changed_actions) -- Initialize a_dpi_changed_actions accordingly to the current widget. init_file_drop_actions (a_file_drop_actions: like file_drop_actions) -- Initialize a_file_drop_actions accordingly to the current widget. init_resize_actions (a_resize_actions: like resize_actions) -- Initialize a_resize_actions accordingly to the current widget. key_press_actions: EV_KEY_ACTION_SEQUENCE -- Actions to be performed when a keyboard key is pressed. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void key_press_string_actions: EV_KEY_STRING_ACTION_SEQUENCE -- Actions to be performed when a keyboard press generates a displayable character. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void key_release_actions: EV_KEY_ACTION_SEQUENCE -- Actions to be performed when a keyboard key is released. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void mouse_wheel_actions: EV_INTEGER_ACTION_SEQUENCE -- Actions to be performed when mouse wheel is rotated. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void pick_actions: EV_PND_START_ACTION_SEQUENCE -- Actions to be performed when `pebble` is picked up. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void pick_ended_actions: EV_PND_FINISHED_ACTION_SEQUENCE -- Actions to be performed when a transport from Current ends. -- (from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I) ensure -- from EV_PICK_AND_DROPABLE_ACTION_SEQUENCES_I not_void: Result /= Void pointer_button_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is pressed. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void pointer_button_release_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer button is released. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void pointer_double_press_actions: EV_POINTER_BUTTON_ACTION_SEQUENCE -- Actions to be performed when screen pointer is double clicked. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void pointer_enter_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen pointer enters widget. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void pointer_leave_actions: EV_NOTIFY_ACTION_SEQUENCE -- Actions to be performed when screen pointer leaves widget. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void pointer_motion_actions: EV_POINTER_MOTION_ACTION_SEQUENCE -- Actions to be performed when screen pointer moves. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void resize_actions: EV_GEOMETRY_ACTION_SEQUENCE -- Actions to be performed when size changes. -- (from EV_WIDGET_ACTION_SEQUENCES_I) ensure -- from EV_WIDGET_ACTION_SEQUENCES_I not_void: Result /= Void feature -- Loading/Saving read_from_named_path (file_path: PATH) -- Load the pixmap described in file_path. -- Exceptions "No such file or directory", -- "Unable to retrieve icon information", -- "Unable to load the file". require -- from EV_PIXMAP_I file_path_not_void: file_path /= Void file_path_not_empty: not file_path.is_empty set_default_colors -- Set foreground and background color to their default values. set_mask (a_mask: EV_BITMAP) -- Set mask of Current to a_mask. require -- from EV_PIXMAP_I mask_not_void: a_mask /= Void mask_same_dimensions: a_mask.width = width and then a_mask.height = height set_with_default -- Initialize the pixmap with the default pixmap (Vision2 logo). -- Exceptions "Unable to retrieve icon information". feature -- Misc. build_cursor: WEL_CURSOR -- Build a WEL_CURSOR from bitmap and mask_bitmap. -- (from EV_PIXMAP_IMP_STATE) ensure -- from EV_PIXMAP_IMP_STATE result_not_void: Result /= Void build_icon: WEL_ICON -- Build a WEL_ICON from bitmap and mask_bitmap. -- (from EV_PIXMAP_IMP_STATE) ensure -- from EV_PIXMAP_IMP_STATE result_not_void: Result /= Void copy_events_from_other (other: EV_PIXMAP_IMP_STATE) -- Copy all events from other to Current. -- Note that other is EV_PIXMAP_I and not EV_PIXMAP_IMP, -- as we need to use this in cases where other will -- not conform to EV_PIXMAP_IMP. -- (from EV_PIXMAP_IMP_STATE) gdi_compact -- Free GDI resource than can be reloaded. raw_image_data: EV_RAW_IMAGE_DATA -- RGBA representation of Current. -- (from EV_PIXMAP_IMP_STATE) require -- from EV_PIXMAP_I True feature -- Navigation disable_tabable_from -- Make `is_tabable_from` False. ensure -- from EV_TAB_CONTROLABLE_I not_is_tabable_from: not is_tabable_from disable_tabable_to -- Make `is_tabable_to` False. ensure -- from EV_TAB_CONTROLABLE_I not_is_tabable_to: not is_tabable_to enable_tabable_from -- Make `is_tabable_from` True. ensure -- from EV_TAB_CONTROLABLE_I is_tabable_from: is_tabable_from enable_tabable_to -- Make `is_tabable_to` True. ensure -- from EV_TAB_CONTROLABLE_I is_tabable_to: is_tabable_to internal_tabable_info: NATURAL_8 -- Storage for `is_tabable_from` and `is_tabable_to`. is_tabable_from: BOOLEAN -- Is Current able to be tabbed from? is_tabable_to: BOOLEAN -- Is Current able to be tabbed to? 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 -- Pixmap Filename pixmap_filename: detachable PATH -- Filename for the pixmap. -- * Void if no file is associated with Current. -- * Empty string for the default pixmap. 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 -- Query is_file_name_valid (a_file_name: READABLE_STRING_GENERAL): BOOLEAN -- Is a_file_name valid? -- (from EV_PIXMAP_I) require -- from EV_PIXMAP_IMP_STATE True feature -- Saving save_to_named_path (a_format: EV_GRAPHICAL_FORMAT; a_file_path: PATH) -- Save Current to a_file_path in a_format format. -- (from EV_PIXMAP_IMP_STATE) require -- from EV_PIXMAP_I a_format_not_void: a_format /= Void a_filepath_not_void: a_file_path /= Void require -- from EV_PIXMAP_IMP_STATE a_format_not_void: a_format /= Void a_filename_not_void: a_file_path /= Void feature -- Session drawing_session_depth: INTEGER_32 -- (from EV_DRAWABLE_I) end_drawing_session -- End a drawing session. -- Used for optimization, to group sequence of drawings. -- note: as a drawing session can be inside another drawing session -- `end_drawing_session` has to be called as many time as `start_drawing_session` was called. -- (from EV_DRAWABLE_I) require -- from EV_DRAWABLE_I drawing_session_depth > 0 is_in_drawing_session: BOOLEAN -- Is inside a start/end drawing session? -- (from EV_DRAWABLE_I) is_in_top_drawing_session: BOOLEAN -- Is in the top start/end drawing session? -- i.e: not inside another similar drawing session. -- (from EV_DRAWABLE_I) start_drawing_session -- Start a drawing session. -- Used for optimization, to group sequence of drawings. -- note: as a drawing session can be inside another drawing session -- `end_drawing_session` has to be called as many time as `start_drawing_session` was called. -- (from EV_DRAWABLE_I) ensure -- from EV_DRAWABLE_I drawing_session_depth > 0 invariant not_both_icon_and_cursor: not (attached private_icon and attached private_cursor) bitmap_reference_tracked: attached private_bitmap as l_private_bitmap implies l_private_bitmap.reference_tracked palette_reference_tracked: attached private_palette as l_private_palette implies l_private_palette.reference_tracked mask_reference_tracked: attached private_mask_bitmap as l_private_mask_bitmap implies l_private_mask_bitmap.reference_tracked icon_reference_tracked: attached private_icon as l_private_icon implies l_private_icon.reference_tracked cursor_reference_tracked: attached private_cursor as l_private_cursor implies l_private_cursor.reference_tracked -- 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) -- from EV_WIDGET_I is_displayed_implies_show_requested: is_usable and is_displayed implies is_show_requested -- from EV_PICK_AND_DROPABLE_I user_interface_modes_mutually_exclusive: mode_is_pick_and_drop.to_integer + mode_is_drag_and_drop.to_integer + mode_is_target_menu.to_integer = 1 pebble_function_takes_two_integer_open_operands: attached pebble_function as l_pebble_function implies l_pebble_function.valid_operands ([1, 1]) -- from EV_POSITIONED_I minimum_width_positive_or_zero: is_usable implies minimum_width >= 0 minimum_height_positive_or_zero: is_usable implies minimum_height >= 0 -- from EV_DOCKABLE_SOURCE_I widget_or_item_source: not (widget_source_being_docked /= Void and item_source_being_docked /= Void) dock_executing: is_dock_executing implies widget_source_being_docked /= Void or item_source_being_docked /= Void note copyright: "Copyright (c) 1984-2023, 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_PIXMAP_IMP -- Generated by Eiffel Studio --
For more details: eiffel.org