Automatic generation produced by ISE Eiffel
note description: "Null pen." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2008-12-29 11:27:11 -0900 (Mon, 29 Dec 2008) $" revision: "$Revision: 76420 $" class interface WEL_NULL_PEN create make -- Make a gdi stock object identified by `stock_id`. -- (from WEL_GDI_STOCK) ensure -- from WEL_GDI_STOCK exists: exists shared: shared feature -- Access color: WEL_COLOR_REF -- Pen color -- (from WEL_PEN) require -- from WEL_PEN exists: exists ensure -- from WEL_PEN result_not_void: Result /= Void 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_NULL_PEN] -- 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 item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) log_pen: WEL_LOG_PEN -- Log pen structure associated to Current -- (from WEL_PEN) require -- from WEL_PEN exists: exists ensure -- from WEL_PEN result_not_void: Result /= Void style: INTEGER_32 -- Pen style -- (from WEL_PEN) require -- from WEL_PEN exists: exists ensure -- from WEL_PEN valid_result: valid_pen_style_constant (Result) width: INTEGER_32 -- Pen width -- (from WEL_PEN) require -- from WEL_PEN exists: exists ensure -- from WEL_PEN 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_NULL_PEN): 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_NULL_PEN): 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_NULL_PEN): 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) 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_NULL_PEN) -- 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_NULL_PEN) -- 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_NULL_PEN -- 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_NULL_PEN) -- 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_NULL_PEN -- 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_NULL_PEN -- 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_NULL_PEN -- 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 feature -- Access (Basic style constants) Ps_dash: INTEGER_32 = 1 -- (from WEL_PS_CONSTANTS) Ps_dashdot: INTEGER_32 = 3 -- (from WEL_PS_CONSTANTS) Ps_dashdotdot: INTEGER_32 = 4 -- (from WEL_PS_CONSTANTS) Ps_dot: INTEGER_32 = 2 -- (from WEL_PS_CONSTANTS) Ps_insideframe: INTEGER_32 = 6 -- Mutually exclusive pen style constants. -- (from WEL_PS_CONSTANTS) Ps_null: INTEGER_32 = 5 -- (from WEL_PS_CONSTANTS) Ps_solid: INTEGER_32 = 0 -- (from WEL_PS_CONSTANTS) feature -- Access (Extended Style constants for use in conjunction with {WEL_PEN}.make_from_brush) Ps_alternate: INTEGER_32 = 8 -- Mutually exclusive pen style constants. -- (from WEL_PS_CONSTANTS) Ps_cosmetic: INTEGER_32 = 0 -- (from WEL_PS_CONSTANTS) Ps_endcap_flat: INTEGER_32 = 512 -- Ps_geometric style constants. -- (from WEL_PS_CONSTANTS) Ps_endcap_round: INTEGER_32 = 0 -- (from WEL_PS_CONSTANTS) Ps_endcap_square: INTEGER_32 = 256 -- (from WEL_PS_CONSTANTS) Ps_geometric: INTEGER_32 = 65536 -- Brush type style constants -- (from WEL_PS_CONSTANTS) Ps_join_bevel: INTEGER_32 = 4096 -- (from WEL_PS_CONSTANTS) Ps_join_miter: INTEGER_32 = 8192 -- (from WEL_PS_CONSTANTS) Ps_join_round: INTEGER_32 = 0 -- (from WEL_PS_CONSTANTS) Ps_userstyle: INTEGER_32 = 7 -- (from WEL_PS_CONSTANTS) feature -- Brushes Black_brush: INTEGER_32 = 4 -- (from WEL_STOCK_CONSTANTS) Dkgray_brush: INTEGER_32 = 3 -- (from WEL_STOCK_CONSTANTS) Gray_brush: INTEGER_32 = 2 -- (from WEL_STOCK_CONSTANTS) Hollow_brush: INTEGER_32 = 5 -- Same as `null_brush`. -- (from WEL_STOCK_CONSTANTS) Ltgray_brush: INTEGER_32 = 1 -- (from WEL_STOCK_CONSTANTS) Null_brush: INTEGER_32 = 5 -- (from WEL_STOCK_CONSTANTS) White_brush: INTEGER_32 = 0 -- (from WEL_STOCK_CONSTANTS) feature -- Contract Support valid_extended_pen_style (c: INTEGER_32): BOOLEAN -- Is c a valid style constant when used in conjunction with a WEL_LOG_BRUSH. -- (from WEL_PS_CONSTANTS) valid_pen_style_constant (c: INTEGER_32): BOOLEAN -- Is c a valid pen style constant? -- Only valid for non-extended pen creation. -- (from WEL_PS_CONSTANTS) feature -- Fonts Ansi_fixed_font: INTEGER_32 = 11 -- (from WEL_STOCK_CONSTANTS) Ansi_var_font: INTEGER_32 = 12 -- (from WEL_STOCK_CONSTANTS) Default_gui_font: INTEGER_32 = 17 -- (from WEL_STOCK_CONSTANTS) Device_default_font: INTEGER_32 = 14 -- (from WEL_STOCK_CONSTANTS) Oem_fixed_font: INTEGER_32 = 10 -- (from WEL_STOCK_CONSTANTS) System_fixed_font: INTEGER_32 = 16 -- (from WEL_STOCK_CONSTANTS) System_font: INTEGER_32 = 13 -- (from WEL_STOCK_CONSTANTS) 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 -- Palette Default_palette: INTEGER_32 = 15 -- (from WEL_STOCK_CONSTANTS) feature -- Pens Black_pen: INTEGER_32 = 7 -- (from WEL_STOCK_CONSTANTS) Null_pen: INTEGER_32 = 8 -- (from WEL_STOCK_CONSTANTS) White_pen: INTEGER_32 = 6 -- (from WEL_STOCK_CONSTANTS) 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_NULL_PEN -- Generated by Eiffel Studio --
For more details: eiffel.org