Automatic generation produced by ISE Eiffel
note description: "[ Editable: no Scroll bars: yes Cursor: no Keyboard: no Mouse: no ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-11-15 04:15:31 -0900 (Mon, 15 Nov 2021) $" revision: "$Revision: 105945 $" class interface TEXT_PANEL create default_create -- Default creation feature -- Initialization default_create -- Default creation initialize_buffer_settings feature -- Access Console_encoding: ENCODING -- Console encoding. -- (from SYSTEM_ENCODINGS) ensure -- from SYSTEM_ENCODINGS instance_free: class console_encoding_not_void: Result /= Void current_class: DOCUMENT_CLASS -- Current document class -- (from DOCUMENT_TYPE_MANAGER) require -- from DOCUMENT_TYPE_MANAGER current_class_set: current_class_set cursors: EDITOR_CURSORS note option: stable date_of_file_when_loaded: INTEGER_32 -- Date of current file when it was loaded. Default_document_class: DOCUMENT_CLASS -- Default text class -- (from DOCUMENT_TYPE_MANAGER) display_scrollbars: BOOLEAN assign set_display_scrollbars -- Should scrollbars be display automatically? editor_drawing_area: EV_DRAWING_AREA -- (from TEXT_PANEL_IMP) editor_viewport: EV_VIEWPORT -- (from TEXT_PANEL_IMP) encoding: ENCODING -- Returns user encoding if `user_encoding` is set by `set_encoding`. -- Otherwise returns encodinge valuated when text was loaded. ev_application: EV_APPLICATION -- Current application if created yet. -- (from EV_SHARED_APPLICATION) require -- from EV_SHARED_APPLICATION application_exists: attached Shared_environment.application same_processor_as_application: Shared_environment.is_application_processor ev_separate_application: separate EV_APPLICATION -- Current application if created yet. -- (from EV_SHARED_APPLICATION) require -- from EV_SHARED_APPLICATION application_exists: attached Shared_environment.application file_path: PATH -- Name of the currently opened file, if any. first_line_displayed: INTEGER_32 -- First line currently displayed on the screen. flip_count: INTEGER_32 -- How many times has the `editor_viewport` been flipped? generating_type: TYPE [TEXT_PANEL] -- 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 horizontal_scrollbar: EV_HORIZONTAL_SCROLL_BAR -- (from TEXT_PANEL_IMP) icons: EDITOR_ICONS note option: stable inner_hbox: EV_HORIZONTAL_BOX -- (from TEXT_PANEL_IMP) is_checking_modifications: BOOLEAN -- Are document modifications being checked? is_initialized: BOOLEAN -- Is current text panel properly initialized? I.e. ready for use. Iso_8859_1: ENCODING -- ISO-8859-1 encoding. -- (from SYSTEM_ENCODINGS) ensure -- from SYSTEM_ENCODINGS instance_free: class main_vbox: EV_VERTICAL_BOX -- (from TEXT_PANEL_IMP) margin: MARGIN_WIDGET note option: stable margin_container: EV_CELL -- (from TEXT_PANEL_IMP) new_text_displayed: like text_displayed -- New instance of `text_displayed` for Current. ensure new_text_not_void: Result /= Void register_observers -- Register observers for `text_displayed` scroll_cell: EV_CELL -- (from TEXT_PANEL_IMP) scroll_vbox: EV_VERTICAL_BOX -- (from TEXT_PANEL_IMP) Shared_environment: EV_ENVIRONMENT -- Shared EV_ENVIRONMENT object. -- (from EV_SHARED_APPLICATION) size_of_file_when_loaded: INTEGER_32 -- Number of bytes in current file when it was loaded. System_encoding: ENCODING -- System encoding. -- (from SYSTEM_ENCODINGS) ensure -- from SYSTEM_ENCODINGS instance_free: class system_encoding_not_void: Result /= Void text_displayed: TEXT -- Text currently displayed on the screen. Utf16: ENCODING -- UTF16 Encoding. -- (from SYSTEM_ENCODINGS) ensure -- from SYSTEM_ENCODINGS instance_free: class utf16_not_void: Result /= Void Utf32: ENCODING -- UTF32 Encoding. -- (from SYSTEM_ENCODINGS) ensure -- from SYSTEM_ENCODINGS instance_free: class utf32_not_void: Result /= Void Utf8: ENCODING -- UTF8 Encoding. -- (from SYSTEM_ENCODINGS) ensure -- from SYSTEM_ENCODINGS instance_free: class utf8_not_void: Result /= Void vertical_scrollbar: EV_VERTICAL_SCROLL_BAR -- (from TEXT_PANEL_IMP) wide_text: STRING_32 -- Image of text in Current. widget: EV_HORIZONTAL_BOX -- Result is widget with which Current is implemented -- (from TEXT_PANEL_IMP) 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: TEXT_PANEL): 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: TEXT_PANEL): 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: TEXT_PANEL): 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 last_detection_successful: BOOLEAN -- Was last detection successful? -- (from ENCODING_DETECTOR) 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 -- Status setting disable_line_numbers -- Disable line numbers ensure line_numbers_disabled: not line_numbers_enabled enable_line_numbers -- Enable line numbers ensure line_numbers_enabled: line_numbers_enabled refresh_line_number_display -- Refresh margin display in Current. -- Was declared in {TEXT_PANEL} as synonym of `refresh_margin`. ensure widget_displayed: has_margin = margin_container.is_show_requested refresh_margin -- Refresh margin display in Current. -- Was declared in {TEXT_PANEL} as synonym of `refresh_line_number_display`. ensure widget_displayed: has_margin = margin_container.is_show_requested set_focus -- Give the focus to the editor area. toggle_view_invisible_symbols -- Toggle `view_invisible_symbols`. ensure view_invisible_symbols_set: view_invisible_symbols = not old view_invisible_symbols feature -- Duplication copy (other: TEXT_PANEL) -- 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: TEXT_PANEL) -- 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: TEXT_PANEL -- 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: TEXT_PANEL) -- 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: TEXT_PANEL -- 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: TEXT_PANEL -- 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: TEXT_PANEL -- 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 -- Implementation buffered_drawable_height: INTEGER_32 -- Default size of drawable used for scrolling purposes. buffered_drawable_width: INTEGER_32 -- Default size of drawable used for scrolling purposes. buffered_line: EV_PIXMAP -- Buffer large enough to hold line information. common_line_count: INTEGER_32 -- Number of lines in common when performing a page down/page up operation. continue_editing -- Continue editing document -- Note: Called from the reload request prompt require file_loaded: file_loaded file_exists: file_exists text_is_fully_loaded: text_is_fully_loaded file_date_ticks: INTEGER_32 -- Retrieve file last modified date in the number of ticks require file_loaded: file_loaded file_exists: file_exists file_exists: BOOLEAN -- Does file exist? require file_loaded: file_loaded file_size: INTEGER_32 -- Retrieve file count require file_loaded: file_loaded file_exists: file_exists internal_focus_requested: BOOLEAN -- Should give focus after text has been fully loaded? internal_userset_data: like userset_data -- Buffered userset data last_vertical_scroll_bar_value: INTEGER_32 -- Last value of vertical_scroll_bar used within vertical_scroll_bar_changed. See -- comment of last_horizontal_scroll_bar_value for details of it's use. on_paint: BOOLEAN set_buffered_drawable_size (a_width, a_height: INTEGER_32) -- Set `buffered_drawable_width` and `buffered_drawable_height` to a_width and a_height. update_line_and_token_info -- Update all tokens for correct width. viewable_height: INTEGER_32 -- Height of Current available to view displayed items. Does -- not include width of any displayed scroll bars and/or header if shown. viewable_width: INTEGER_32 -- Width of Current available to view displayed items. Does -- not include width of any displayed scroll bars. feature -- Basic Operations check_document_modifications_and_reload -- Check document modifications and reload as necessary. require not_is_checking_modifications: not is_checking_modifications file_loaded: file_loaded ensure is_checking_modifications_is_false: not is_checking_modifications clear_window -- Wipe out the text area. flush -- Load texts immediately load_file_path (a_filename: PATH) -- Load contents of a_filename require filename_not_void: a_filename /= Void load_text (a_text: READABLE_STRING_GENERAL) -- Display a_text. -- a_text is not necessarily in UTF-32, it can be specified by `set_encoding`. on_font_changed -- Recompute token information for for loaded text. redraw_current_screen -- Redraw the current screen. Do not scroll or move the cursor, just redraw. refresh -- Update display. refresh_now -- Update display without waiting for next idle reset -- Reinitialize Current so that it can receive a new content. feature -- Basic operation show -- Show Current. -- (from TEXT_PANEL_IMP) feature -- Buffer size Default_buffered_drawable_height: INTEGER_32 = 15000 -- Default size of drawable used for scrolling purposes. -- (from TEXT_PANEL_CONSTANTS) Default_buffered_drawable_width: INTEGER_32 = 15000 -- (from TEXT_PANEL_CONSTANTS) 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 -- Encoding detector Default_encoding: ENCODING -- Detected encoding ensure -- from ENCODING_DETECTOR last_detection_successful_implies_not_void: last_detection_successful implies Result /= Void detect (a_string: READABLE_STRING_GENERAL) -- Detect `detected_encoding` of a_string. -- Current is used as a simple encoding detector -- that returns `system_encoding`. -- So, `last_detection_successful` is always true. require -- from ENCODING_DETECTOR a_string_not_void: a_string /= Void ensure -- from ENCODING_DETECTOR detected_encoding_set_when_found: last_detection_successful implies Default_encoding /= Void feature -- File Properties date_when_checked: INTEGER_32 -- Date of the open file when checked for the latest time file_date_already_checked: BOOLEAN -- Has the date of the file already been checked? file_is_up_to_date: BOOLEAN -- Is the open file up to date? set_reference_window (a_window: like reference_window) -- Set reference window feature -- Graphical interface font: EV_FONT -- Font used to display the text line_height: INTEGER_32 -- Height of lines in pixels pointer_style: EV_POINTER_STYLE -- Pointer style over the text. reference_window: EV_WINDOW -- Window which error dialogs will be shown relative to. Void if not set using `set_reference_window`. show_warning_message (a_message: READABLE_STRING_GENERAL) -- Show a_message in a dialog window -- |Use {READABLE_STRING_GENERAL}, following Vision2 interface. userset_fonts: SPECIAL [EV_FONT] -- Font set via set_font feature -- Memory management recycle -- Recycle Current, but leave Current in an unstable state, -- so that we know whether we're still referenced or not. ensure not_initialized: not is_initialized 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 -- Pick and Drop drop_actions: EV_PND_ACTION_SEQUENCE -- Actions performed when user drops a stone on the text_area. 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 -- Query changed: BOOLEAN -- Has the content of the editor changed since it was -- loaded or saved? current_class_set: BOOLEAN -- Is `current_class` set? -- (from DOCUMENT_TYPE_MANAGER) editor_x: INTEGER_32 -- editor_viewport absolute position. editor_y: INTEGER_32 -- editor_viewport absolute position. file_loaded: BOOLEAN -- Has a file been loaded into the text panel? 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_focus: BOOLEAN -- Does the text panel have focus? has_icons: BOOLEAN -- Has `icons` set? has_margin: BOOLEAN -- Should margin be displayed? initialized: BOOLEAN -- Have preferences been set and ready to be used? -- (from SHARED_EDITOR_DATA) is_empty: BOOLEAN -- Is the text panel blank? is_in_editor_panel (a_screen_x, a_screen_y: INTEGER_32): BOOLEAN -- Is point at absolute coordinates (a_screen_x, a_screeny) in the editor? is_offset_valid: BOOLEAN -- If viewport offset vaild? is_unix_file: BOOLEAN -- Is current file a Unix file? (i.e. is "%N" line separator?) is_windows_file: BOOLEAN -- Is current file a Windows file? (i.e. is "%R%N" line separator?) known_document_type (a_type: READABLE_STRING_GENERAL): BOOLEAN -- Is a_type a known document type? -- (from DOCUMENT_TYPE_MANAGER) left_margin_width: INTEGER_32 -- Width of left margin line_numbers_enabled: BOOLEAN -- Is it permitted to show line numbers in Current? line_numbers_visible: BOOLEAN -- Are line numbers currently visible number_of_lines: INTEGER_32 number_of_lines_displayed: INTEGER_32 -- Number of lines currently displayed on the screen. number_of_lines_displayed_from_text: INTEGER_32 -- Number of lines currently displayed on the screen, excluding the white space visible below the actual text. text_is_fully_loaded: BOOLEAN -- Is current text still being loaded? view_invisible_symbols: BOOLEAN -- Are the spaces, the tabulations and the end_of_line characters visible? 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 display_line_with_context (l_number: INTEGER_32) -- display line number l_number in the editor -- center display on this line if it is not yet displayed -- scroll otherwise. require line_number_is_valid: 0 < l_number and then l_number <= number_of_lines text_loaded: text_is_fully_loaded on_focus -- Editor received focus 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) set_cursors (a_cursors: like cursors) -- Sets `cursors` with a_cursors require a_cursors_not_void: a_cursors /= Void ensure cursors_set: cursors = a_cursors set_display_scrollbars (a_display: BOOLEAN) -- Set `display_scrollbars` with a_display. -- Show or hide the scrollbars accordingly. set_editor_width (a_width: INTEGER_32) -- If a_width is greater than `editor_width`, assign a_width to `editor_width` -- update display if necessary. set_encoding (a_encoding: like user_encoding) -- Set `encoding` with a_encoding ensure encoding_set: user_encoding = a_encoding set_first_line_displayed (fld: INTEGER_32; refresh_if_necessary: BOOLEAN) -- Assign fld to `first_line_displayed`. require fld_large_enough: fld > 0 fld_small_enough: fld <= text_displayed.number_of_lines.max (1) fld_in_range: vertical_scrollbar.value_range.has (fld) set_font_offset (a_offset: INTEGER_32) -- Set font_offset set_fonts (a_fonts: like userset_fonts) -- Set userset_font with a_font. set_icons (a_icons: like icons) -- Sets `icons` with a_icons require a_icons_not_void: a_icons /= Void ensure icons_set: icons = a_icons set_left_margin_width (a_width: like left_margin_width) -- Set `left_margin_width` with a_width. -- Set with zero to use preference value. set_line_height (a_height: like line_height) -- Set userset_font_height set_offset (an_offset: INTEGER_32) -- Assign an_offset to `offset` and update scrollbar if necessary. set_text (a_text: like text_displayed; a_filename: STRING_8) -- Set `text_displayed` to `text`. If text is associated to a file store then -- a_filename should be that file. require text_not_void: a_text /= Void setup_editor (first_line_to_display: INTEGER_32) -- Update Current to display at line first_line_to_display on current text. invariant offset_view: is_initialized implies is_offset_valid buffered_line_not_void: is_initialized implies buffered_line /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2021, 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 TEXT_PANEL -- Generated by Eiffel Studio --
For more details: eiffel.org