Automatic generation produced by ISE Eiffel
note description: "General editor preferences." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2023-03-13 08:29:54 -0800 (Mon, 13 Mar 2023) $" revision: "$Revision: 106674 $" class interface EDITOR_DATA create make (a_preferences: PREFERENCES) -- Create require preferences_not_void: a_preferences /= Void ensure preferences_not_void: preferences /= Void feature -- Access current_class: DOCUMENT_CLASS -- Current document class -- (from DOCUMENT_TYPE_MANAGER) require -- from DOCUMENT_TYPE_MANAGER current_class_set: current_class_set Default_document_class: DOCUMENT_CLASS -- Default text class -- (from DOCUMENT_TYPE_MANAGER) font: EV_FONT -- Font used in the editor -- (from SHARED_EDITOR_FONT) require -- from SHARED_EDITOR_FONT has_font: has_font font_offset: INTEGER_32 -- (from SHARED_EDITOR_FONT) font_width: INTEGER_32 -- Width of character in the editor. -- (from SHARED_EDITOR_FONT) require -- from SHARED_EDITOR_FONT is_fixed_width: is_fixed_width generating_type: TYPE [EDITOR_DATA] -- 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 header_font: EV_FONT -- Font used in the header control -- (from SHARED_EDITOR_FONT) require -- from SHARED_EDITOR_FONT has_header_fontn: has_header_font is_fixed_width: BOOLEAN -- Is `font` a fixed-width font? -- (from SHARED_EDITOR_FONT) keyword_font: EV_FONT -- Keyword Font used in the editor -- (from SHARED_EDITOR_FONT) require -- from SHARED_EDITOR_FONT has_keyword_font: has_keyword_font line_height: INTEGER_32 -- Height of a line in the editor -- (from SHARED_EDITOR_FONT) feature -- Comparison frozen deep_equal (a: 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: 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: EDITOR_DATA): 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: EDITOR_DATA): 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: 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: EDITOR_DATA): 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: EDITOR_DATA) -- 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: EDITOR_DATA) -- 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: EDITOR_DATA -- 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: EDITOR_DATA) -- 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: EDITOR_DATA -- 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: EDITOR_DATA -- 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: EDITOR_DATA -- 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 -- Color ids Comments_background_color_id: INTEGER_32 = 16 -- Color used to display comments background -- (from EDITOR_TOKEN_IDS) Comments_text_color_id: INTEGER_32 = 15 -- Color used to display comments -- (from EDITOR_TOKEN_IDS) Cursor_line_highlight_color_id: INTEGER_32 = 23 -- Background color used to highlight line with cursor in it -- (from EDITOR_TOKEN_IDS) Focus_out_selection_background_color_id: INTEGER_32 = 8 -- Background color used to display selected text when focus losed -- (from EDITOR_TOKEN_IDS) Highlight_background_color_id: INTEGER_32 = 22 -- Background color used to highlight lines -- (from EDITOR_TOKEN_IDS) Highlight_text_color_id: INTEGER_32 = 21 -- Background color used to highlight lines -- (from EDITOR_TOKEN_IDS) Keyword_background_color_id: INTEGER_32 = 12 -- Background color used to display keywords -- (from EDITOR_TOKEN_IDS) Keyword_text_color_id: INTEGER_32 = 11 -- Color used to display keywords -- (from EDITOR_TOKEN_IDS) Line_number_text_color_id: INTEGER_32 = 3 -- Color for line number text -- (from EDITOR_TOKEN_IDS) Link_background_color_id: INTEGER_32 = 25 -- Background color for links -- (from EDITOR_TOKEN_IDS) Link_color_id: INTEGER_32 = 24 -- Link color id -- (from EDITOR_TOKEN_IDS) Margin_background_color_id: INTEGER_32 = 1 -- Color for margin background -- (from EDITOR_TOKEN_IDS) Margin_separator_color_id: INTEGER_32 = 2 -- Color for margin separator -- (from EDITOR_TOKEN_IDS) max_color_id: INTEGER_32 -- Maximal id of color. -- (from EDITOR_TOKEN_IDS) Mouse_over_link_background_color_id: INTEGER_32 = 27 -- Link color when mouse is over -- (from EDITOR_TOKEN_IDS) Mouse_over_link_color_id: INTEGER_32 = 26 -- Link color when mouse is over -- (from EDITOR_TOKEN_IDS) Normal_background_color_id: INTEGER_32 = 5 -- Background color used to display normal text -- (from EDITOR_TOKEN_IDS) Normal_text_color_id: INTEGER_32 = 4 -- Color used to display normal text -- (from EDITOR_TOKEN_IDS) Number_background_color_id: INTEGER_32 = 18 -- Background color used to display numbers -- (from EDITOR_TOKEN_IDS) Number_text_color_id: INTEGER_32 = 17 -- Color used to display numbers -- (from EDITOR_TOKEN_IDS) Operator_background_color_id: INTEGER_32 = 20 -- Background color used to display operator -- (from EDITOR_TOKEN_IDS) Operator_text_color_id: INTEGER_32 = 19 -- Color used to display operator -- (from EDITOR_TOKEN_IDS) Quoted_feature_background_color_id: INTEGER_32 = 28 -- (from EDITOR_TOKEN_IDS) Quoted_feature_text_color_id: INTEGER_32 = 27 -- (from EDITOR_TOKEN_IDS) Selection_background_color_id: INTEGER_32 = 7 -- Background color used to display selected text when has focus -- (from EDITOR_TOKEN_IDS) Selection_text_color_id: INTEGER_32 = 6 -- Color used to display selected text -- (from EDITOR_TOKEN_IDS) Spaces_background_color_id: INTEGER_32 = 14 -- Background color used to display spaces -- (from EDITOR_TOKEN_IDS) Spaces_text_color_id: INTEGER_32 = 13 -- Color used to display spaces -- (from EDITOR_TOKEN_IDS) String_background_color_id: INTEGER_32 = 10 -- Background color used to display strings -- (from EDITOR_TOKEN_IDS) String_text_color_id: INTEGER_32 = 9 -- Color used to display strings -- (from EDITOR_TOKEN_IDS) feature -- Constants Family_modern: INTEGER_32 = 5 -- (from EV_FONT_CONSTANTS) Family_roman: INTEGER_32 = 2 -- (from EV_FONT_CONSTANTS) Family_sans: INTEGER_32 = 3 -- (from EV_FONT_CONSTANTS) Family_screen: INTEGER_32 = 1 -- (from EV_FONT_CONSTANTS) Family_typewriter: INTEGER_32 = 4 -- (from EV_FONT_CONSTANTS) Shape_italic: INTEGER_32 = 11 -- (from EV_FONT_CONSTANTS) Shape_regular: INTEGER_32 = 10 -- (from EV_FONT_CONSTANTS) Weight_black: INTEGER_32 = 9 -- (from EV_FONT_CONSTANTS) Weight_bold: INTEGER_32 = 8 -- (from EV_FONT_CONSTANTS) Weight_regular: INTEGER_32 = 7 -- (from EV_FONT_CONSTANTS) Weight_thin: INTEGER_32 = 6 -- (from EV_FONT_CONSTANTS) feature -- Contract support valid_family (a_family: INTEGER_32): BOOLEAN -- Is a_family a valid family value. -- (from EV_FONT_CONSTANTS) valid_shape (a_shape: INTEGER_32): BOOLEAN -- Is a_shape a valid shape value. -- (from EV_FONT_CONSTANTS) valid_weight (a_weight: INTEGER_32): BOOLEAN -- Is a_weight a valid weight value. -- (from EV_FONT_CONSTANTS) feature -- Element Change register_document (a_type_name: STRING_8; a_class: DOCUMENT_CLASS) -- Register new document type -- (from DOCUMENT_TYPE_MANAGER) feature -- Font ids Editor_font_id: INTEGER_32 = 1 -- (from EDITOR_TOKEN_IDS) Keyword_font_id: INTEGER_32 = 2 -- (from EDITOR_TOKEN_IDS) max_font_id: INTEGER_32 -- Maximal id of font -- (from EDITOR_TOKEN_IDS) feature -- Misc Dark_gray: EV_COLOR Plain_black: EV_COLOR Plain_gray: EV_COLOR Plain_white: EV_COLOR 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: 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 -- Preferences automatic_update_preference: BOOLEAN_PREFERENCE -- If the text has been modified by an external editor, should we -- reload the file automatically if no change has been made here? blinking_cursor_preference: BOOLEAN_PREFERENCE -- Indicates if editor cursor should blick comments_background_color_preference: COLOR_PREFERENCE -- Background color used to display comments comments_text_color_preference: COLOR_PREFERENCE -- Color used to display comments cursor_line_highlight_color_preference: COLOR_PREFERENCE -- Cursor line highlight color editor_font_preference: FONT_PREFERENCE -- Current text font. focus_out_selection_background_color_preference: COLOR_PREFERENCE -- Background color used to display selected text when focus losed font_zoom_factor_preference: INTEGER_PREFERENCE -- Zoom factor which setting by ctrl + mouse wheel header_font_preference: FONT_PREFERENCE -- Font for header panel tabs preference highlight_background_color_preference: COLOR_PREFERENCE -- Highlight background color highlight_text_color_preference: COLOR_PREFERENCE -- Highlight text color keyword_background_color_preference: COLOR_PREFERENCE -- Background color used to display keywords keyword_font_preference: FONT_PREFERENCE -- Font for keywords. keyword_text_color_preference: COLOR_PREFERENCE -- Color used to display keywords left_margin_width_preference: INTEGER_PREFERENCE -- Width of left margin in pixels (not the breakpoint/line number margin margin) line_number_text_color_preference: COLOR_PREFERENCE -- Color for line number text link_background_color_preference: COLOR_PREFERENCE -- Background color for links link_color_preference: COLOR_PREFERENCE -- Link color margin_background_color_preference: COLOR_PREFERENCE -- Color for margin background margin_separator_color_preference: COLOR_PREFERENCE -- Color for margin separator mouse_over_link_background_color_preference: COLOR_PREFERENCE -- Mouse over background color for links mouse_over_link_color_preference: COLOR_PREFERENCE -- Mouse over link color mouse_wheel_scroll_full_page_preference: BOOLEAN_PREFERENCE -- Should a mouse wheel scroll event scroll full page? mouse_wheel_scroll_size_preference: INTEGER_PREFERENCE -- Number of lines to scroll when a mouse wheel scroll event is received. -- Overriden by `mouse_wheel_scroll_full_page`. normal_background_color_preference: COLOR_PREFERENCE -- Background color used to display normal text normal_text_color_preference: COLOR_PREFERENCE -- Color used to display normal text number_background_color_preference: COLOR_PREFERENCE -- Background color used to display numbers number_text_color_preference: COLOR_PREFERENCE -- Color used to display numbers operator_background_color_preference: COLOR_PREFERENCE -- Background color used to display operator operator_text_color_preference: COLOR_PREFERENCE -- Color used to display operator quadruple_click_enabled_preference: BOOLEAN_PREFERENCE -- is quadruple click (select all) enabled ? quoted_feature_background_color_preference: COLOR_PREFERENCE -- Background color used to display quoted feature in comments quoted_feature_text_color_preference: COLOR_PREFERENCE -- Color used to display quoted feature in comments remove_trailing_white_space_preference: BOOLEAN_PREFERENCE -- Indicates if trailing white space should be removed from lines during editing scrolling_common_line_count_preference: INTEGER_PREFERENCE -- Number of common lines staying on screen after scrolling -- by one page up or down. selection_background_color_preference: COLOR_PREFERENCE -- Background color used to display selected text when has focus selection_text_color_preference: COLOR_PREFERENCE -- Color used to display selected text show_line_numbers_preference: BOOLEAN_PREFERENCE -- Indicates if line numbers should be shown in the editor smart_home_preference: BOOLEAN_PREFERENCE -- Indicates if editor should go to the beginning on the first non-whitespace character, on a line, when the HOME key is pressed smart_indentation_preference: BOOLEAN_PREFERENCE -- Is smart indentation enabled? spaces_background_color_preference: COLOR_PREFERENCE -- Background color used to display spaces spaces_text_color_preference: COLOR_PREFERENCE -- Color used to display spaces string_background_color_preference: COLOR_PREFERENCE -- Background color used to display strings string_text_color_preference: COLOR_PREFERENCE -- Color used to display strings tabulation_spaces_preference: INTEGER_PREFERENCE use_buffered_line_preference: BOOLEAN_PREFERENCE -- Use buffered line when drawing? use_tab_for_indentation_preference: BOOLEAN_PREFERENCE -- Use tabulations (not spaces) for auto-indenting? feature -- Query current_class_set: BOOLEAN -- Is `current_class` set? -- (from DOCUMENT_TYPE_MANAGER) get_class_from_type (a_type: READABLE_STRING_GENERAL): DOCUMENT_CLASS -- Get the document class from the type -- (from DOCUMENT_TYPE_MANAGER) require -- from DOCUMENT_TYPE_MANAGER known_type: known_document_type (a_type) ensure -- from DOCUMENT_TYPE_MANAGER has_result: Result /= Void has_font: BOOLEAN -- Is `header_font` set? -- (from SHARED_EDITOR_FONT) has_header_font: BOOLEAN -- Is `header_font` set? -- (from SHARED_EDITOR_FONT) has_keyword_font: BOOLEAN -- Is `header_font` set? -- (from SHARED_EDITOR_FONT) initialized: BOOLEAN -- Have preferences been set and ready to be used? -- (from SHARED_EDITOR_DATA) known_document_type (a_type: READABLE_STRING_GENERAL): BOOLEAN -- Is a_type a known document type? -- (from DOCUMENT_TYPE_MANAGER) feature -- Resources editor_preferences: EDITOR_DATA -- Editor preferences -- (from SHARED_EDITOR_DATA) Panel_manager: TEXT_PANEL_MANAGER -- List of open panels -- (from SHARED_EDITOR_DATA) feature -- Status Setting set_current_document_class (doc_class: like current_class) -- Update the current document class to reflect type of text loaded in text panel -- (from DOCUMENT_TYPE_MANAGER) feature -- Value automatic_update: BOOLEAN -- If the text has been modified by an external editor, should we -- reload the file automatically if no change has been made here? blinking_cursor: BOOLEAN -- Indicates if editor cursor should blick color_of_id (a_id: INTEGER_32): EV_COLOR -- Color of a_id require a_id_positive: a_id > 0 ensure color_of_id_not_void: Result /= Void comments_background_color: EV_COLOR -- Color used to display comments background comments_text_color: EV_COLOR -- Color used to display comments cursor_line_highlight_color: EV_COLOR -- Background color used to highlight line with cursor in it focus_out_selection_background_color: EV_COLOR -- Background color used to display selected text when focus losed font_of_id (a_id: INTEGER_32): EV_FONT -- Font of a_id require a_id_positive: a_id > 0 ensure font_of_id_not_void: Result /= Void highlight_background_color: EV_COLOR -- Background color used to highlight lines highlight_text_color: EV_COLOR -- Text color used to highlight lines keyword_background_color: EV_COLOR -- Background color used to display keywords keyword_text_color: EV_COLOR -- Color used to display keywords left_margin_width: INTEGER_32 -- Width of left margin in pixels (not the breakpoint/line number margin margin) line_number_text_color: EV_COLOR -- Color for line number text link_background_color: EV_COLOR -- Background color for links link_color: EV_COLOR -- Color for links margin_background_color: EV_COLOR -- Color for margin background margin_separator_color: EV_COLOR -- Color for margin separator mouse_over_link_background_color: EV_COLOR -- Color for links when mouse is over. mouse_over_link_color: EV_COLOR -- Color for links when mouse is over. mouse_wheel_scroll_full_page: BOOLEAN -- Should a mouse wheel scroll event scroll full page? mouse_wheel_scroll_size: INTEGER_32 -- Number of lines to scroll when a mouse wheel scroll event is received. -- Overriden by `mouse_wheel_scroll_full_page`. normal_background_color: EV_COLOR -- Background color used to display normal text normal_text_color: EV_COLOR -- Color used to display normal text number_background_color: EV_COLOR -- Background color used to display numbers number_text_color: EV_COLOR -- Color used to display numbers operator_background_color: EV_COLOR -- Background color used to display operator operator_text_color: EV_COLOR -- Color used to display operator quadruple_click_enabled: BOOLEAN -- is quadruple click (select all) enabled ? quoted_feature_background_color: EV_COLOR -- Color used to display quoted feature in comments background quoted_feature_text_color: EV_COLOR -- Color used to display quoted feature in comments remove_trailing_white_space: BOOLEAN -- Indicates if trailing white space should be removed from lines during editing scrolling_common_line_count: INTEGER_32 -- Number of common lines staying on screen after scrolling -- by one page up or down. selection_background_color: EV_COLOR -- Background color used to display selected text when has focus selection_text_color: EV_COLOR -- Color used to display selected text show_line_numbers: BOOLEAN -- Indicates if the editor should display the line numbers smart_home: BOOLEAN -- Indicates if editor should go to the beginning on the first non-whitespace character, on a line, when the HOME key is pressed smart_indentation: BOOLEAN -- Is smart indentation enabled? spaces_background_color: EV_COLOR -- Background color used to display spaces spaces_text_color: EV_COLOR -- Color used to display spaces string_background_color: EV_COLOR -- Background color used to display strings string_text_color: EV_COLOR -- Color used to display strings tabulation_spaces: INTEGER_32 -- Number of space characters in a tabulation. -- TODO: neilc. Make sure user does not enter a negative value for this. ensure tabulation_spaces_positive: Result > 0 use_buffered_line: BOOLEAN use_tab_for_indentation: BOOLEAN -- Use tabulations (not spaces) for auto-indenting? invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from EDITOR_TOKEN_IDS invariant_clause: True 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 EDITOR_DATA -- Generated by Eiffel Studio --
For more details: eiffel.org