Automatic generation produced by ISE Eiffel
note description: "EiffelVision pixmap. Common attributes between all different EV_PIXMAP Windows implementations." 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 $" deferred class interface EV_PIXMAP_IMP_STATE feature -- Access cursor: detachable WEL_CURSOR -- Current pixmap in HCURSOR format. Void if none. generating_type: TYPE [detachable EV_PIXMAP_IMP_STATE] -- 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 ensure result_not_void: Result /= Void get_mask_bitmap: detachable WEL_BITMAP -- Monochrome bitmap used as mask. -- -- The number of references if incremented when calling -- this feature, call WEL_BITMAP.decrement_reference require mask_in_use: has_mask ensure result_not_void: Result /= Void has_mask: BOOLEAN -- Has the current pixmap a mask? ensure has_mask_implies_mask_bitmap_not_void: Result implies get_mask_bitmap /= Void icon: detachable WEL_ICON -- Current pixmap in HICON format. Void if none. palette: detachable WEL_PALETTE -- Current palette used. Void if none. feature -- Measurement height: INTEGER_32 -- Height of the pixmap in pixels. width: INTEGER_32 -- Width of the pixmap in pixels. 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_STATE): 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_STATE): 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_STATE): 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 -- Duplication copy (other: EV_PIXMAP_IMP_STATE) -- 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_PIXMAP_IMP_STATE) -- 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_STATE -- 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_STATE) -- 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_STATE -- 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_STATE -- 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_PIXMAP_IMP_STATE -- 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 -- 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 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 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 -- Misc. build_cursor: WEL_CURSOR -- Build a WEL_CURSOR from bitmap and mask_bitmap. ensure result_not_void: Result /= Void build_icon: WEL_ICON -- Build a WEL_ICON from bitmap and mask_bitmap. ensure 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. gdi_compact -- Spare GDI resource by freeing icons, cursors, ... that -- can be reloaded from file. init_from_pixel_buffer (a_pixel_buffer: EV_PIXEL_BUFFER) -- Initialize from a_pixel_buffer raw_image_data: EV_RAW_IMAGE_DATA -- RGBA representation of Current. 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 -- Query is_file_name_valid (a_file_name: READABLE_STRING_GENERAL): BOOLEAN -- Is a_file_name valid? 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. require a_format_not_void: a_format /= Void a_filename_not_void: a_file_path /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) 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_STATE -- Generated by Eiffel Studio --
For more details: eiffel.org