Automatic generation produced by ISE Eiffel
note description: "[ Contains information about paragraph 2 formating attributes in a rich edit control. Corresponds to the PARAFORMAT2 structure. Note that the implementation is using WEL_PARAFORMAT2 due to bugs in Microsoft header files. ]" 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_PARAGRAPH_FORMAT2 create make -- Make a paragraph format structure. -- (from WEL_PARAGRAPH_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 alignment: INTEGER_32 -- Alignment type. -- See class WEL_PFA_CONSTANTS for values. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists border_space: INTEGER_32 -- Space between border and paragraph text in twips. -- Corresponds to wBorderWidth border_width: INTEGER_32 -- Border width in twips. Corresponds to wBorderWidth member. borders: INTEGER_32 -- Border location, style and color. Corresponds to -- wBorder member. effects: INTEGER_32 -- Effects applicable to Current, corresponding to wEffects member. generating_type: TYPE [detachable WEL_PARAGRAPH_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 item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) line_spacing: INTEGER_32 -- Size of spacing between lines. Corresponds to -- dyLineSpacing member. line_spacing_rule: INTEGER_32 -- Type of line spacing. Corresponds to bLineSpacingRule member. mask: INTEGER_32 -- Valid information or attributes to set. -- See class WEL_PFM_CONSTANTS for values. -- This attribut is automatically set by the -- features set_*. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists numbering: INTEGER_32 -- Numbering type -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists numbering_start: INTEGER_32 -- Starting number for numbered paragraphs. -- Corresponds to wNumberingStart member numbering_style: INTEGER_32 -- Numbering style used with numbered paragraphs. -- Corresponds to the wNumberingStyle member. numbering_tab: INTEGER_32 -- Minimum space between paragraph number and -- paragraph text. Corresponds to wNumberingTab mamber. offset: INTEGER_32 -- Indentation of the second line and subsequent -- lines, relative to the starting indentation. The -- first line is indented if this member is negative, -- or outdented is this member is positive. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists Pfa_center: INTEGER_32 = 3 -- Paragraphs are centered. -- (from WEL_PFA_CONSTANTS) Pfa_full_interword: INTEGER_32 = 5 -- Paragraphs are justified by expanding blanks alone. -- (from WEL_PFA_CONSTANTS) Pfa_justify: INTEGER_32 = 4 -- Paragraphs are justified. -- (from WEL_PFA_CONSTANTS) Pfa_left: INTEGER_32 = 1 -- Paragraphs are aligned with the left margin. -- (from WEL_PFA_CONSTANTS) Pfa_right: INTEGER_32 = 2 -- Paragraphs are aligned with the right margin. -- (from WEL_PFA_CONSTANTS) Pfm_alignment: INTEGER_32 = 8 -- The wAlignment member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_border: INTEGER_32 = 2048 -- The wBorderSpace, wBorderWidth and wBorders members are valid. -- (from WEL_PFM_CONSTANTS) Pfm_linespacing: INTEGER_32 = 256 -- The dyLineSpacing member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_numbering: INTEGER_32 = 32 -- The wNumbering member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_numberingstart: INTEGER_32 = 32768 -- The wNumberingStart member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_numberingstyle: INTEGER_32 = 8092 -- The wNumberingStyle member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_numberingtab: INTEGER_32 = 16384 -- The wNumberingTab member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_offset: INTEGER_32 = 4 -- The dxStartIndent member is valid and specifies -- a relative value. -- (from WEL_PFM_CONSTANTS) Pfm_offsetindent: INTEGER_32 = -2147483648 -- The dxOffset member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_rightindent: INTEGER_32 = 2 -- The dxRightIndent member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_shading: INTEGER_32 = 4096 -- The wShadingStyle and wShadingWeight members arevalid. -- (from WEL_PFM_CONSTANTS) Pfm_spaceafter: INTEGER_32 = 128 -- The dySpaceAfter member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_spacebefore: INTEGER_32 = 64 -- The dySpaceBefore member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_startindent: INTEGER_32 = 1 -- The dxStartIndent member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_style: INTEGER_32 = 512 -- The sStyle member is valid. -- (from WEL_PFM_CONSTANTS) Pfm_tabstops: INTEGER_32 = 16 -- The cTabStobs and rgxTabStops members are valid. -- (from WEL_PFM_CONSTANTS) right_indent: INTEGER_32 -- Size of the right indentation, relative to the right -- margin -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists shading_style: INTEGER_32 -- Style and colors used for background shading. -- Corresponds to wShadingStyle member. shading_weight: INTEGER_32 -- Percentage of foreground color used in shading. -- Corresponds to wShadingWeight member. space_after: INTEGER_32 -- Size of spacing after paragraph in twips. Corresponds to -- dySpaceAfter member. space_before: INTEGER_32 -- Size of spacing before paragraph in twips. Corresponds to -- dySpaceBefore member. start_indent: INTEGER_32 -- Indentation of the first line in the paragraph -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists style: INTEGER_32 -- Text style. Corresponds to sStyle member. tabulations: ARRAY [INTEGER_32] -- Contains tab stops -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT result_not_void: Result /= Void feature -- Measurement max_tab_stops: INTEGER_32 -- (from WEL_PARAGRAPH_FORMAT) Structure_size: INTEGER_32 -- Size to allocate (in bytes) require -- from WEL_STRUCTURE True 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_PARAGRAPH_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_PARAGRAPH_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 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_mask (a_mask: INTEGER_32): BOOLEAN -- Is a_mask set in `mask`? -- See class WEL_PFM_CONSTANTS for a_mask values. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT 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) 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 add_mask (a_mask: INTEGER_32) -- Add a_mask to `mask`. -- See class WEL_PFM_CONSTANTS for a_mask values. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT has_mask: has_mask (a_mask) bullet_numbering -- Add bullets. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT bullet_numbering: numbering = pfn_bullet no_numbering -- Remove any numbering. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT no_numbering: numbering = 0 remove_mask (a_mask: INTEGER_32) -- Remove a_mask from `mask`. -- See class WEL_PFM_CONSTANTS for a_mask values. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT has_not_mask: not has_mask (a_mask) set_alignment (an_alignment: INTEGER_32) -- Set `alignment` with an_alignment. -- See class WEL_PFA_CONSTANTS for values. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT alignment_set: alignment = an_alignment set_border_space (a_space: INTEGER_32) -- Set `border_space` to a_space. set_border_width (a_width: INTEGER_32) -- Set `border_width` to a_width. set_borders (a_border: INTEGER_32) -- Set `borders` to a_border. set_center_alignment -- Paragraphs are centered. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT alignment_set: alignment = Pfa_center set_default_tabulation -- Set the default tabulation. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists set_effects (an_effects: INTEGER_32) -- Set `effects` to an_effects. ensure effects_set: effects = an_effects set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_left_alignment -- Paragraphs are aligned with the left margin. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT alignment_set: alignment = Pfa_left set_line_spacing (space: INTEGER_32) -- Set `line_spacing` to space. ensure space_set: line_spacing = space set_line_spacing_rule (a_rule: INTEGER_32) -- Set `line_spacing_rule` to a_rule. set_mask (a_mask: INTEGER_32) -- Set `mask` with a_mask. -- See class WEL_PFM_CONSTANTS for a_mask values. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT mask_set: mask = a_mask set_numbering_start (a_start: INTEGER_32) -- Set `numbering_start` to a_start. set_numbering_style (a_style: INTEGER_32) -- Set `numbering_style` to a_style. set_numbering_tab (a_tab: INTEGER_32) -- Set `numbering_tab` to a_tab. set_offset (an_offset: INTEGER_32) -- Set `offset` with an_offset. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT offset_set: offset = an_offset set_right_alignment -- Paragraphs are aligned with the right margin. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT alignment_set: alignment = Pfa_right set_right_indent (a_right_indent: INTEGER_32) -- Set `right_indent` with a_right_indent. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT right_indent_set: right_indent = a_right_indent set_shading_style (a_style: INTEGER_32) -- Set `shading_style` to a_style. set_shading_weight (a_weight: INTEGER_32) -- Set shading_widget to a_weight. set_space_after (space: INTEGER_32) -- Set `space_after` to space. ensure space_set: space_after = space set_space_before (space: INTEGER_32) -- Set `space_before` to space. ensure space_set: space_before = space set_start_indent (a_start_indent: INTEGER_32) -- Set `start_indent` with a_start_indent. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists ensure -- from WEL_PARAGRAPH_FORMAT start_indent_set: start_indent = a_start_indent set_style (a_style: INTEGER_32) -- Set `style` to a_style. set_tabulation (tab: INTEGER_32) -- Set a tab stop at every tab. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists set_tabulations (tabs: ARRAY [INTEGER_32]) -- Set tabulation stops using the values of tabs. -- (from WEL_PARAGRAPH_FORMAT) require -- from WEL_PARAGRAPH_FORMAT exists: exists tabs_not_void: tabs /= Void tabs_count: tabs.count <= max_tab_stops ensure -- from WEL_PARAGRAPH_FORMAT tabulations_set: tabulations.same_items (tabs) 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_PARAGRAPH_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_PARAGRAPH_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_PARAGRAPH_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_PARAGRAPH_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_PARAGRAPH_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_PARAGRAPH_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_PARAGRAPH_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_PARAGRAPH_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 -- 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-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_PARAGRAPH_FORMAT2 -- Generated by Eiffel Studio --
For more details: eiffel.org