Automatic generation produced by ISE Eiffel
note description: "[ Contains information about charformat 2 formating attributes in a rich edit control. Corresponds to the CHARFORMAT2 structure. Some of the reserved attributes or those only used with TOM interfaces are not yet available. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2018-01-22 03:53:58 -0900 (Mon, 22 Jan 2018) $" revision: "$Revision: 101255 $" class interface WEL_CHARACTER_FORMAT2 create make -- Make a char format structure. -- (from WEL_CHARACTER_FORMAT) 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_ANY) ensure -- from WEL_ANY item_set: item = a_pointer shared: shared feature -- Access Aspect_x: INTEGER_32 = 40 -- Relative width of a device pixel -- used for line drawing -- (from WEL_CAPABILITIES_CONSTANTS) Aspect_x_y: INTEGER_32 = 44 -- Diagonal width of a device pixel -- used for line drawing -- (from WEL_CAPABILITIES_CONSTANTS) Aspect_y: INTEGER_32 = 42 -- Relative height of a device pixel -- used for line drawing -- (from WEL_CAPABILITIES_CONSTANTS) Bits_pixel: INTEGER_32 = 12 -- Number of adjacent color bits for each pixel -- (from WEL_CAPABILITIES_CONSTANTS) Cfe_autobackcolor: INTEGER_32 = 67108864 -- The text background color is the value -- of the containing control. -- (from WEL_CFE_CONSTANTS) Cfe_autocolor: INTEGER_32 = 1073741824 -- The text color is the return value of -- GetSysColor (COLOR_WINDOWTEXT). -- (from WEL_CFE_CONSTANTS) Cfe_bold: INTEGER_32 = 1 -- Characters are bold. -- (from WEL_CFE_CONSTANTS) Cfe_italic: INTEGER_32 = 2 -- Characters are italic. -- (from WEL_CFE_CONSTANTS) Cfe_protected: INTEGER_32 = 16 -- Characters are protected; an attempt to modify them -- will cause an EN_PROTECTED notification message. -- (from WEL_CFE_CONSTANTS) Cfe_strikeout: INTEGER_32 = 8 -- Characters are struck out. -- (from WEL_CFE_CONSTANTS) Cfe_underline: INTEGER_32 = 4 -- Characters are underlined. -- (from WEL_CFE_CONSTANTS) Cfm_backcolor: INTEGER_32 = 67108864 -- The crBackColor member is valid -- (from WEL_CFM_CONSTANTS) Cfm_bold: INTEGER_32 = 1 -- The CFE_BOLD value of the dwEffects member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_charset: INTEGER_32 = 134217728 -- The bCharSet member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_color: INTEGER_32 = 1073741824 -- The crTextColor member and the CFE_AUTOCOLOR value -- of the dwEffects member are valid. -- (from WEL_CFM_CONSTANTS) Cfm_face: INTEGER_32 = 536870912 -- The szFaceName member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_italic: INTEGER_32 = 2 -- The CFE_ITALIC value of the dwEffects member is -- valid. -- (from WEL_CFM_CONSTANTS) Cfm_offset: INTEGER_32 = 268435456 -- The yOffset member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_protected: INTEGER_32 = 16 -- The CFE_PROTECTED value of the dwEffects member is -- valid. -- (from WEL_CFM_CONSTANTS) Cfm_revauthor: INTEGER_32 = 32768 -- The bRevAuthor member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_size: INTEGER_32 = -2147483648 -- The size member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_spacing: INTEGER_32 = 2097152 -- The sSpacing member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_strikeout: INTEGER_32 = 8 -- The CFE_STRIKEOUT value of the dwEffects member is -- valid. -- (from WEL_CFM_CONSTANTS) Cfm_underline: INTEGER_32 = 4 -- The CFE_UNDERLINE value of the dwEffects member is -- valid. -- (from WEL_CFM_CONSTANTS) Cfm_underlinetype: INTEGER_32 = 8388608 -- The bUnderlineType member is valid. -- (from WEL_CFM_CONSTANTS) Cfm_weight: INTEGER_32 = 4194304 -- The wWeight member is valid. -- (from WEL_CFM_CONSTANTS) char_set: INTEGER_32 -- Character set value. Can be one of the values -- specified for the `char_set` function of the -- WEL_LOG_FONT structure. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists Clip_caps: INTEGER_32 = 36 -- See class WEL_CLIPPING_CAPABILITIES_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) Color_resolution: INTEGER_32 = 108 -- Color resolution of the device in bits -- (from WEL_CAPABILITIES_CONSTANTS) Curve_caps: INTEGER_32 = 28 -- See class WEL_CURVE_CAPABILITIES_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) Driver_version: INTEGER_32 = 1 -- Version number of the device driver -- (from WEL_CAPABILITIES_CONSTANTS) Dt_bottom: INTEGER_32 = 8 -- Declared in Windows as DT_BOTTOM -- (from WEL_DT_CONSTANTS) Dt_calcrect: INTEGER_32 = 1024 -- Declared in Windows as DT_CALCRECT -- (from WEL_DT_CONSTANTS) Dt_center: INTEGER_32 = 1 -- Declared in Windows as DT_CENTER -- (from WEL_DT_CONSTANTS) Dt_expandtabs: INTEGER_32 = 64 -- Declared in Windows as DT_EXPANDTABS -- (from WEL_DT_CONSTANTS) Dt_externalleading: INTEGER_32 = 512 -- Declared in Windows as DT_EXTERNALLEADING -- (from WEL_DT_CONSTANTS) Dt_hideprefix: INTEGER_32 = 1048576 -- Declared in Windows as DT_HIDEPREFIX -- (from WEL_DT_CONSTANTS) Dt_internal: INTEGER_32 = 4096 -- Declared in Windows as DT_INTERNAL -- (from WEL_DT_CONSTANTS) Dt_left: INTEGER_32 = 0 -- Declared in Windows as DT_LEFT -- (from WEL_DT_CONSTANTS) Dt_noclip: INTEGER_32 = 256 -- Declared in Windows as DT_NOCLIP -- (from WEL_DT_CONSTANTS) Dt_noprefix: INTEGER_32 = 2048 -- Declared in Windows as DT_NOPREFIX -- (from WEL_DT_CONSTANTS) Dt_right: INTEGER_32 = 2 -- Declared in Windows as DT_RIGHT -- (from WEL_DT_CONSTANTS) Dt_singleline: INTEGER_32 = 32 -- Declared in Windows as DT_SINGLELINE -- (from WEL_DT_CONSTANTS) Dt_tabstop: INTEGER_32 = 128 -- Declared in Windows as DT_TABSTOP -- (from WEL_DT_CONSTANTS) Dt_top: INTEGER_32 = 0 -- Declared in Windows as DT_TOP -- (from WEL_DT_CONSTANTS) Dt_vcenter: INTEGER_32 = 4 -- Declared in Windows as DT_VCENTER -- (from WEL_DT_CONSTANTS) Dt_word_ellipsis: INTEGER_32 = 262144 -- Declared in Windows as DT_WORD_ELLIPSIS -- (from WEL_DT_CONSTANTS) Dt_wordbreak: INTEGER_32 = 16 -- Declared in Windows as DT_WORDBREAK -- (from WEL_DT_CONSTANTS) effects: INTEGER_32 -- Character effects. -- See class WEL_CFE_CONSTANTS for values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists face_name: STRING_32 -- Font face name -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT result_not_void: Result /= Void generating_type: TYPE [detachable WEL_CHARACTER_FORMAT2] -- 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_in_pixels: INTEGER_32 -- Character height in pixels -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists height_in_points: INTEGER_32 -- Character height in points. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists height_in_twips: INTEGER_32 -- Character height in twips. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists Himetric_per_inch: INTEGER_32 = 2540 -- Defined as HIMETRIC_PER_INCH in AtlWin.h -- (from WEL_UNIT_CONVERSION) Horizontal_resolution: INTEGER_32 = 8 -- Width of the display, in pixels -- (from WEL_CAPABILITIES_CONSTANTS) Horizontal_size: INTEGER_32 = 4 -- Width of the physical display in millimeters -- (from WEL_CAPABILITIES_CONSTANTS) item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) Line_caps: INTEGER_32 = 30 -- See class WEL_LINE_CAPABILITIES_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) log_font: WEL_LOG_FONT -- Log font representing Current. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT result_not_void: Result /= Void Logical_pixels_x: INTEGER_32 = 88 -- Number of pixels per logical inch along -- the display width -- (from WEL_CAPABILITIES_CONSTANTS) Logical_pixels_y: INTEGER_32 = 90 -- Number of pixels per logical inch along -- the display height -- (from WEL_CAPABILITIES_CONSTANTS) mask: INTEGER_32 -- Valid information or attributes to set. -- See class WEL_CFM_CONSTANTS for values. -- This attribut is automatically set by the -- features set_*. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists Max_face_name_length: INTEGER_32 -- Maximum face name length -- (from WEL_CHARACTER_FORMAT) Num_brushes: INTEGER_32 = 16 -- Number of device-specific brushes -- (from WEL_CAPABILITIES_CONSTANTS) Num_colors: INTEGER_32 = 24 -- Number of entries in the device's color table -- (from WEL_CAPABILITIES_CONSTANTS) Num_fonts: INTEGER_32 = 22 -- Number of device-specific fonts -- (from WEL_CAPABILITIES_CONSTANTS) Num_markers: INTEGER_32 = 20 -- Number of device-specific markers -- (from WEL_CAPABILITIES_CONSTANTS) Num_pens: INTEGER_32 = 18 -- Number of device-specific pens -- (from WEL_CAPABILITIES_CONSTANTS) Num_reserved: INTEGER_32 = 106 -- Number of reserved entries in the system palette -- (from WEL_CAPABILITIES_CONSTANTS) offset: INTEGER_32 -- Character offset from the baseline. If the value -- is positive, the character is a superscript; if it -- is negative, the character is a subscript. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists Pdevice_size: INTEGER_32 = 26 -- Size of the PDEVICE internal structure, in bytes -- (from WEL_CAPABILITIES_CONSTANTS) Physical_offset_x: INTEGER_32 = 112 -- Distance from left edge of the printable area, in -- device units. -- (from WEL_CAPABILITIES_CONSTANTS) Physical_offset_y: INTEGER_32 = 113 -- Distance from top edge of the printable area, in -- device units. -- (from WEL_CAPABILITIES_CONSTANTS) pitch_and_family: INTEGER_32 -- Font pitch and family. This value is the same as -- `pitch_and_family` of the WEL_LOG_FONT structure. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists Planes: INTEGER_32 = 14 -- Number of color planes -- (from WEL_CAPABILITIES_CONSTANTS) Polygonal_caps: INTEGER_32 = 32 -- See class WEL_POLYGONAL_CAPABILITIES_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) Raster_caps: INTEGER_32 = 38 -- See class WEL_RASTER_CAPABILITIES_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) Scaling_factor_x: INTEGER_32 = 114 -- Scaling factor for the x-axis of the printer. -- (from WEL_CAPABILITIES_CONSTANTS) Scaling_factor_y: INTEGER_32 = 115 -- Scaling factor for the y-axis of the printer. -- (from WEL_CAPABILITIES_CONSTANTS) Size_palette: INTEGER_32 = 104 -- Number of entries in the system palette -- (from WEL_CAPABILITIES_CONSTANTS) Technology: INTEGER_32 = 2 -- Device technology. -- See class WEL_DEVICE_TECHNOLOGY_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) Text_caps: INTEGER_32 = 34 -- See class WEL_TEXT_CAPABILITIES_CONSTANTS -- (from WEL_CAPABILITIES_CONSTANTS) text_color: WEL_COLOR_REF -- Text color -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT result_not_void: Result /= Void Vertical_resolution: INTEGER_32 = 10 -- Height of the display, in raster lines -- (from WEL_CAPABILITIES_CONSTANTS) Vertical_size: INTEGER_32 = 6 -- Height of the physical display in millimeters -- (from WEL_CAPABILITIES_CONSTANTS) feature -- Measurement structure_size: INTEGER_32 -- Size to allocate (in bytes) -- (from WEL_CHARACTER_FORMAT) ensure -- from WEL_STRUCTURE 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_CHARACTER_FORMAT2): 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) 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_CHARACTER_FORMAT2): 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 background_color: WEL_COLOR_REF -- Background color, corresponding to the crBackColor member. require exists: exists ensure result_not_void: Result /= Void 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) ensure -- from WEL_ANY Result = (item /= default_pointer) flag_set (flags, mask: INTEGER_32): BOOLEAN -- Is `mask` set in flags? -- (from WEL_BIT_OPERATIONS) has_effects (an_effects: INTEGER_32): BOOLEAN -- Is an_effects set in `effects`? -- See class WEL_CFE_CONSTANTS for an_effects values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists has_mask (a_mask: INTEGER_32): BOOLEAN -- Is a_mask set in `mask`? -- See class WEL_CFM_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists revision_author: INTEGER_32 -- Index used to identify author making a revision, corresponding to the -- bRevAuthor member. require exists: exists 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) spacing: INTEGER_32 -- Spacing, corresponding to the sSpacing member. require exists: exists underline_type: INTEGER_32 -- Type of underline, corresponding to the bUnderlineType member. require exists: exists weight: INTEGER_32 -- Weight, corresponding to the wWeight member. require exists: exists feature -- Status setting set_background_color (color_ref: WEL_COLOR_REF) -- Assign color_ref to `background_color`. require exists: exists color_ref_not_void: color_ref /= Void set_revision_author (an_author: INTEGER_32) -- Assign an_author to `revision_author`. require exists: exists set_shared -- Set `shared` to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_spacing (a_spacing: INTEGER_32) -- Assign a_spacing to `spacing`. require exists: exists set_underline_type (a_type: INTEGER_32) -- Assign a_type to `underline_type`. require exists: exists set_unshared -- Set `shared` to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared set_weight (a_weight: INTEGER_32) -- Assign a_weight to `weight`. require exists: exists feature -- Element change add_effects (an_effects: INTEGER_32) -- Add an_effects to `effects`. -- See class WEL_CFE_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT has_effects: has_effects (an_effects) add_mask (a_mask: INTEGER_32) -- Add a_mask to `mask`. -- See class WEL_CFM_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT has_mask: has_mask (a_mask) remove_effects (an_effects: INTEGER_32) -- Remove an_effects from `effects`. -- See class WEL_CFE_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT has_not_effects: not has_effects (an_effects) remove_mask (a_mask: INTEGER_32) -- Remove a_mask from `mask`. -- See class WEL_CFM_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT has_not_mask: not has_mask (a_mask) set_all_masks -- Set `mask` with all possible values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists set_bold -- Set bold characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists set_char_set (a_char_set: INTEGER_32) -- Set `char_set` with a_char_set. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT char_set_set: char_set = a_char_set set_default_format -- Set Current to default formatting. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists set_effects (an_effects: INTEGER_32) -- Set `effects` with an_effects. -- See class WEL_CFE_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT effects_set: effects = an_effects set_face_name (a_face_name: READABLE_STRING_GENERAL) -- Set `face_name` with a_face_name. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists a_face_name_not_void: a_face_name /= Void valid_count: a_face_name.count <= Max_face_name_length ensure -- from WEL_CHARACTER_FORMAT face_name_set: face_name.same_string_general (a_face_name) set_height_in_pixels (a_height: INTEGER_32) -- Set `height_in_pixels` to a_height in pixels. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT height_set: height_in_pixels = a_height set_height_in_points (a_height: INTEGER_32) -- Set `height_in_points` to a_height in points. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT height_set: height_in_points = a_height set_height_in_twips (a_height: INTEGER_32) -- Set `height_in_twips` to a_height twips. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT height_set: height_in_twips = a_height set_italic -- Set italic characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_mask (a_mask: INTEGER_32) -- Set `mask` with a_mask. -- See class WEL_CFM_CONSTANTS for a_mask values. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT mask_set: mask = a_mask set_offset (an_offset: INTEGER_32) -- Set `offset` with an_offset. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT offset_set: offset = an_offset set_pitch_and_family (a_pitch_and_family: INTEGER_32) -- Set `pitch_and_family` with a_pitch_and_family. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists ensure -- from WEL_CHARACTER_FORMAT pitch_and_family_set: pitch_and_family = a_pitch_and_family set_protected -- Set protected characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists set_strike_out -- Set strike out characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists set_text_color (a_color: WEL_COLOR_REF) -- Set `text_color` with a_text_color. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists a_color_not_void: a_color /= Void ensure -- from WEL_CHARACTER_FORMAT text_color_set: text_color.item = a_color.item set_underline -- Set underline characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists unset_bold -- Unset bold characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists unset_italic -- Unset italic characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists unset_protected -- Unset protected characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists unset_strike_out -- Unset strike out characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists unset_underline -- Unset underline characters. -- (from WEL_CHARACTER_FORMAT) require -- from WEL_CHARACTER_FORMAT exists: exists feature -- Removal dispose -- Destroy the inner structure of Current. -- -- This function should be called by the GC when the -- object is collected or by the user if Current is -- no more usefull. -- (from WEL_ANY) feature -- Duplication frozen deep_copy (other: WEL_CHARACTER_FORMAT2) -- 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_CHARACTER_FORMAT2 -- 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_CHARACTER_FORMAT2) -- 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_CHARACTER_FORMAT2 -- 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_CHARACTER_FORMAT2 -- 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 clear_flag (flags, mask: INTEGER_32): INTEGER_32 -- Clear the `mask` in flags -- (from WEL_BIT_OPERATIONS) ensure -- from WEL_BIT_OPERATIONS flag_unset: not flag_set (Result, mask) copy (other: WEL_CHARACTER_FORMAT2) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen default: detachable WEL_CHARACTER_FORMAT2 -- 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 initialize -- Fill Current with zeros. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists initialize_with_character (a_character: CHARACTER_8) -- Fill current with a_character. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists is_equal (other: WEL_CHARACTER_FORMAT2): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result memory_copy (source_pointer: POINTER; length: INTEGER_32) -- Copy length bytes from source_pointer to `item`. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE length_small_enough: length <= structure_size length_large_enough: length > 0 exists: exists set_flag (flags, mask: INTEGER_32): INTEGER_32 -- Set the `mask` in flags -- (from WEL_BIT_OPERATIONS) ensure -- from WEL_BIT_OPERATIONS flag_set: flag_set (Result, mask) feature -- Basic Operations himetric_to_pixel (a_size_in_himetric: WEL_SIZE): WEL_SIZE -- Convert himetric into pixels. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION non_void_size: a_size_in_himetric /= Void a_size_in_himetric_exists: a_size_in_himetric.exists ensure -- from WEL_UNIT_CONVERSION non_void_result: Result /= Void logical_to_pixel (hdc: WEL_DC; lo: INTEGER_32): INTEGER_32 -- Convert lo expressed in logical unit into pixel unit. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION hdc_not_void: hdc /= Void hdc_exists: hdc.exists logical_to_point (hdc: WEL_DC; lo: INTEGER_32): INTEGER_32 -- Convert a size lo expressed in logical unit into point. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION hdc_not_void: hdc /= Void hdc_exists: hdc.exists map_loghim_to_pixel (x, ppli: INTEGER_32): INTEGER_32 -- Defined as MAP_LOGHIM_TO_PIX in AtlWin.h -- (from WEL_UNIT_CONVERSION) map_pixel_to_loghim (x, ppli: INTEGER_32): INTEGER_32 -- Defined as MAP_PIX_TO_LOGHIM in AtlWin.h -- (from WEL_UNIT_CONVERSION) pixel_to_himetric (a_size_in_pixel: WEL_SIZE): WEL_SIZE -- Convert pixels into himetric. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION non_void_size: a_size_in_pixel /= Void a_size_in_pixel_exists: a_size_in_pixel.exists ensure -- from WEL_UNIT_CONVERSION non_void_result: Result /= Void pixel_to_logical (hdc: WEL_DC; pi: INTEGER_32): INTEGER_32 -- Convert pi expressed in pixel unit into logical unit. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION hdc_not_void: hdc /= Void hdc_exists: hdc.exists pixel_to_point (hdc: WEL_DC; pi: INTEGER_32): INTEGER_32 -- Convert a size pi expressed in pixel into point. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION hdc_not_void: hdc /= Void hdc_exists: hdc.exists point_to_logical (hdc: WEL_DC; pt, divisor: INTEGER_32): INTEGER_32 -- Convert a size pt/divisor expressed in point into logical units. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION hdc_not_void: hdc /= Void hdc_exists: hdc.exists point_to_pixel (hdc: WEL_DC; pt, divisor: INTEGER_32): INTEGER_32 -- Convert a size pt/divisor expressed in point into pixel. -- (from WEL_UNIT_CONVERSION) require -- from WEL_UNIT_CONVERSION hdc_not_void: hdc /= Void hdc_exists: hdc.exists 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 invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2018, 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 WEL_CHARACTER_FORMAT2 -- Generated by Eiffel Studio --
For more details: eiffel.org