Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "Windows Bitmap, which can be loaded from a resource or created from an existing DIB." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2011-01-13 14:53:42 -0900 (Thu, 13 Jan 2011) $" revision: "$Revision: 85350 $" class interface WEL_BITMAP create make_by_id (id: INTEGER_32) -- Load the resource by an id require -- from WEL_RESOURCE valid_id: id > 0 ensure -- from WEL_RESOURCE not_shared: not shared make_by_name (name: READABLE_STRING_GENERAL) -- Load the resource by a name require -- from WEL_RESOURCE name_not_void: name /= Void name_not_empty: not name.is_empty ensure -- from WEL_RESOURCE not_shared: not shared make_by_dib (a_dc: WEL_DC; dib: WEL_DIB; mode: INTEGER_32) -- Create a WEL_BITMAP from a dib in the a_dc -- using mode. See class WEL_DIB_COLORS_CONSTANTS -- for mode values. require a_dc_not_void: a_dc /= Void a_dc_exists: a_dc.exists dib_not_void: dib /= Void dib_exists: dib.exists valid_mode: valid_dib_colors_constant (mode) ensure bitmap_created: item /= item.default make_compatible (a_dc: WEL_DC; a_width, a_height: INTEGER_32) -- Initialize current bitmap to be compatible -- with a_dc and with a_width as width, -- a_height as height. require a_dc_not_void: a_dc /= Void a_dc_exists: a_dc.exists positive_width: a_width >= 0 positive_height: a_height >= 0 make_direct (a_width, a_height, a_planes, a_bits_per_pixel: INTEGER_32; a_data: STRING_8) -- Make a bitmap of dimension a_width x a_height that has a_planes number -- of color planes and a_bits_per_pixel (number of bits to identify color). -- a_data contains color data array. require positive_width: a_width >= 0 positive_height: a_height >= 0 positive_planes: a_planes >= 0 positive_bits_per_pixel: a_bits_per_pixel >= 0 data_not_void: a_data /= Void data_count_big_enough: a_data.count >= 2 * (a_width * a_height * a_bits_per_pixel * a_planes) // 8 make_indirect (a_log_bitmap: WEL_LOG_BITMAP) -- Make a bitmap using a_log_bitmap. require a_log_bitmap_not_void: a_log_bitmap /= Void a_log_bitmap_exists: a_log_bitmap.exists make_by_pointer (a_pointer: POINTER) -- Set item with a_pointer. -- Since item is shared, it does not need -- to be freed. -- Caution: a_pointer must be a pointer -- coming from Windows. -- (from WEL_GDI_ANY) require -- from WEL_ANY True ensure -- from WEL_ANY item_set: item = a_pointer shared: shared make_by_bitmap (a_bitmap: WEL_BITMAP) -- Create a WEL_BITMAP from another WEL_BITMAP. The -- bitmap is copied by value require a_bitmap_not_void: a_bitmap /= Void a_bitmap_exists: a_bitmap.exists make_dib (a_header_info: WEL_BITMAP_INFO_HEADER) -- Create a DIB bitmap section. require a_header_info_not_void: a_header_info /= Void a_header_info_exist: a_header_info.exists ensure bitmap_created: item /= default_pointer ppv_bits_assigned: ppv_bits /= default_pointer feature -- Access Dib_pal_colors: INTEGER_32 = 1 -- (from WEL_DIB_COLORS_CONSTANTS) Dib_rgb_colors: INTEGER_32 = 0 -- (from WEL_DIB_COLORS_CONSTANTS) gdi_objects_count: INTEGER_32 -- Number of GDI object currently allocated by the -- program. -- -- Note: debug option "WEL_GDI_COUNT" should be enabled, otherwise -- this function will return zero. -- (from WEL_GDI_ANY) generating_type: TYPE [detachable WEL_BITMAP] -- 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 height: INTEGER_32 -- Bitmap height require exists: exists ensure positive_result: Result >= 0 Image_bitmap: INTEGER_32 = 0 -- Declared in Windows as IMAGE_BITMAP -- (from WEL_IMAGE_CONSTANTS) Image_cursor: INTEGER_32 = 2 -- Declared in Windows as IMAGE_CURSOR -- (from WEL_IMAGE_CONSTANTS) Image_enhmetafile: INTEGER_32 = 3 -- Declared in Windows as IMAGE_ENHMETAFILE -- (from WEL_IMAGE_CONSTANTS) Image_icon: INTEGER_32 = 1 -- Declared in Windows as IMAGE_ICON -- (from WEL_IMAGE_CONSTANTS) is_made_by_dib: BOOLEAN -- When calling make_by_bitmap, if current made from DIB bitmap? item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) log_bitmap: WEL_LOG_BITMAP -- Log bitmap structure associated to Current require exists: exists ensure result_not_void: Result /= Void ppv_bits: POINTER -- If Current if Created by make_dib, this is the pointer to the location of the DIB bit values. -- Otherwise it's void. width: INTEGER_32 -- Bitmap width require exists: exists ensure positive_result: 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: WEL_BITMAP): 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: WEL_BITMAP): 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: WEL_BITMAP): 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 exists: BOOLEAN -- Does the item exist? -- (from WEL_ANY) require -- from WEL_REFERENCE_TRACKABLE True ensure -- from WEL_ANY Result = (item /= default_pointer) 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)) shared: BOOLEAN -- Is item shared by another object? -- If False (by default), item will -- be destroyed by destroy_item. -- If True, item will not be destroyed. -- (from WEL_ANY) valid_dib_colors_constant (c: INTEGER_32): BOOLEAN -- Is c a valid dib colors constant? -- (from WEL_DIB_COLORS_CONSTANTS) feature -- Status setting set_shared -- Set shared to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_unshared -- Set shared to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared feature -- Element change set_item (an_item: POINTER) -- Set item with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item feature -- Removal delete -- Destroy inner structure of Current. -- To be called when Current is no more needed -- (from WEL_REFERENCE_TRACKABLE) require -- from WEL_REFERENCE_TRACKABLE reference_not_tracked: not reference_tracked ensure -- from WEL_REFERENCE_TRACKABLE destroyed: not shared implies not exists dispose -- Destroy inner structure of Current. -- (from WEL_REFERENCE_TRACKABLE) require -- from DISPOSABLE True ensure then -- from WEL_REFERENCE_TRACKABLE internal_object_id_freed: internal_object_id = 0 feature -- Duplication copy (other: WEL_BITMAP) -- 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: WEL_BITMAP) -- 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: WEL_BITMAP -- 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: WEL_BITMAP) -- 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: WEL_BITMAP -- 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: WEL_BITMAP -- 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 WEL_BITMAP -- 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 eif_current_object_id: INTEGER_32 -- New identifier for Current -- (from IDENTIFIED_ROUTINES) ensure -- from IDENTIFIED_ROUTINES eif_current_object_id: Result > 0 inserted: eif_is_object_id_of_current (Result) eif_id_object (an_id: INTEGER_32): detachable ANY -- Object associated with an_id -- (from IDENTIFIED_ROUTINES) require -- from IDENTIFIED_ROUTINES an_id_non_negative: an_id >= 0 ensure -- from IDENTIFIED_ROUTINES instance_free: class eif_is_object_id_of_current (an_id: INTEGER_32): BOOLEAN -- Is an_id the associated object ID of Current. -- (from IDENTIFIED_ROUTINES) require -- from IDENTIFIED_ROUTINES an_id_non_negative: an_id >= 0 eif_object_id (an_object: ANY): INTEGER_32 -- New identifier for an_object -- (from IDENTIFIED_ROUTINES) ensure -- from IDENTIFIED_ROUTINES instance_free: class eif_object_id_positive: Result > 0 inserted: eif_id_object (Result) = an_object eif_object_id_free (an_id: INTEGER_32) -- Free the entry an_id -- (from IDENTIFIED_ROUTINES) require -- from IDENTIFIED_ROUTINES an_id_non_negative: an_id >= 0 ensure -- from IDENTIFIED_ROUTINES instance_free: class removed: eif_id_object (an_id) = Void set_di_bits (a_dc: WEL_DC; start_line, length: INTEGER_32; dib: WEL_DIB; mode: INTEGER_32) -- Set the bits of the current bitmap to the values -- given in dib, starting at line start_line -- during length lines, using mode. -- See class WEL_DIB_COLORS_CONSTANTS for mode values. require exists: exists a_dc_not_void: a_dc /= Void a_dc_exists: a_dc.exists dib_not_void: dib /= Void dib_exists: dib.exists valid_mode: valid_dib_colors_constant (mode) 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 Report reference_tracked: BOOLEAN -- Are number references of Current tracked? -- (from WEL_REFERENCE_TRACKABLE) references_count: INTEGER_32 -- Number of object referring to current object. -- (from WEL_REFERENCE_TRACKABLE) feature -- Status Setting decrement_reference -- Decrement number of references to current object. -- When number of references reaches zero, -- delete is called if object is not protected. -- (from WEL_REFERENCE_TRACKABLE) require -- from WEL_REFERENCE_TRACKABLE exists: exists tracking_references_started: reference_tracked enable_reference_tracking -- Set references_tracked to True. -- (from WEL_REFERENCE_TRACKABLE) require -- from WEL_REFERENCE_TRACKABLE exists: exists tracking_reference_not_started: not reference_tracked increment_reference -- Increment number of references to current object. -- (from WEL_REFERENCE_TRACKABLE) require -- from WEL_REFERENCE_TRACKABLE exists: exists tracking_references_started: reference_tracked object_id: INTEGER_32 -- Runtime Id of Current. -- (from WEL_REFERENCE_TRACKABLE) invariant -- 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 WEL_BITMAP
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org