Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "[ A widget containing a tree/grid view of application preferences.  Provides a list to view preference information and ability to edit the preferences using popup floating widgets.  Also allows to restore preferences to their defaults. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-06-25 04:16:34 -0800 (Fri, 25 Jun 2021) $" revision: "$Revision: 105580 $" class interface PREFERENCES_GRID_CONTROL create make (a_preferences: like preferences) -- New view. require -- from PREFERENCE_VIEW preferences_not_void: a_preferences /= Void ensure -- from PREFERENCE_VIEW preferences_set: preferences = a_preferences make_with_hidden (a_preferences: like preferences; a_show_hidden_flag: BOOLEAN) -- Create with a_preferences -- and show hidden preferences if a_show_hidden_flag is True. -- (from PREFERENCE_VIEW) require -- from PREFERENCE_VIEW preferences_not_void: a_preferences /= Void ensure -- from PREFERENCE_VIEW preferences_set: preferences = a_preferences hidden_set: show_hidden_preferences = a_show_hidden_flag feature -- Initialization make (a_preferences: like preferences) -- New view. require -- from PREFERENCE_VIEW preferences_not_void: a_preferences /= Void ensure -- from PREFERENCE_VIEW preferences_set: preferences = a_preferences make_with_hidden (a_preferences: like preferences; a_show_hidden_flag: BOOLEAN) -- Create with a_preferences -- and show hidden preferences if a_show_hidden_flag is True. -- (from PREFERENCE_VIEW) require -- from PREFERENCE_VIEW preferences_not_void: a_preferences /= Void ensure -- from PREFERENCE_VIEW preferences_set: preferences = a_preferences hidden_set: show_hidden_preferences = a_show_hidden_flag feature -- Access Alt_text: STRING_8 = "Alt" -- (from PREFERENCES_GRID_CONSTANTS) apply_or_close_button: EV_BUTTON auto_value: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) close_button_action: detachable PROCEDURE -- Action called when "Close" button is pressed. Ctrl_text: STRING_8 = "Ctrl" -- (from PREFERENCES_GRID_CONSTANTS) description_location: EV_TEXT_FIELD description_text: EV_TEXT display_hidden_button: EV_CHECK_BUTTON 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 export_button: EV_BUTTON f_switch_to_flat_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) f_switch_to_tree_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) filter_box: EV_HORIZONTAL_BOX filter_text_box: EV_TEXT_FIELD filter_value_check_box: EV_CHECK_BUTTON generating_type: TYPE [detachable PREFERENCES_GRID_CONTROL] -- 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 grid_container: EV_VERTICAL_BOX import_button: EV_BUTTON l_apply: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_building_flat_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_building_tree_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_close: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_count_preferences (a_count: READABLE_STRING_GENERAL): STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) require -- from PREFERENCES_GRID_CONSTANTS a_count_not_void: a_count /= Void l_description: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_display_hidden_preferences: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_display_window: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_export_preferences: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_filter: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_filter_value: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_flat_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_import_preferences: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_importing_preferences: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_literal_value: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_matches_of_total_preferences (a_count: INTEGER_32; a_total_count: INTEGER_32): STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_name: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_no_default_value: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_request_restart: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_restore_default: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_restore_defaults: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_status: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_tree_or_flat_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_tree_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_type: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) l_updating_the_view: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) no_description_text: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) p_default_value: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) parent_window: detachable EV_WINDOW -- Parent window.  Used to display this view relative to. note option: stable parent_window_of (w: EV_WIDGET): detachable EV_WINDOW -- Computed parent window of w. Pixmaps_extension_cell: CELL [STRING_8] -- Extension for pixmaps. -- (from PREFERENCES_GRID_CONSTANTS) Pixmaps_path_cell: CELL [PATH] -- Path where pixmaps for the preference window should be looked for. -- By default it looks in pixmaps in the current directory, but -- it is possible to change the contents of this cell to change this path. -- (from PREFERENCES_GRID_CONSTANTS) Preference_window_icon: STRING_8 = "icon_preference_window" -- Base name of the file that contains the icon of the preferences window. -- (from PREFERENCES_GRID_CONSTANTS) preferences_title: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) preferenese_root: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) restore_button: EV_BUTTON restore_preference_string: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) Shared_environment: EV_ENVIRONMENT -- Shared EV_ENVIRONMENT object. -- (from EV_SHARED_APPLICATION) Shift_text: STRING_8 = "Shift" -- (from PREFERENCES_GRID_CONSTANTS) Shortcut_delimiter: STRING_8 = "+" -- (from PREFERENCES_GRID_CONSTANTS) shortcut_modification_denied: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) show_dialog_modal (w: EV_ANY) -- Show dlg modal to parent_window if not Void -- (from PREFERENCE_VIEW) require -- from PREFERENCE_VIEW w_is_a_dialog: attached {EV_STANDARD_DIALOG} w or attached {EV_DIALOG} w split_area: EV_VERTICAL_SPLIT_AREA status_box: EV_HORIZONTAL_BOX status_label: EV_LABEL user_value: STRING_32 -- (from PREFERENCES_GRID_CONSTANTS) view_toggle_button: EV_TOOL_BAR_BUTTON W_preferences_delayed_resources: STRING_32 -- Texts used in the dialog that tells the user -- they have to restart the application to use the new preferences. -- (from PREFERENCES_GRID_CONSTANTS) widget: EV_WIDGET -- Main widget 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: PREFERENCES_GRID_CONTROL): 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: PREFERENCES_GRID_CONTROL): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "" (other: PREFERENCES_GRID_CONTROL): 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 -- Conversion dialog_unit_to_pixels (a_size: INTEGER_32): INTEGER_32 -- Convert a_size dialog units into pixels. -- Used to get the same look&feel under all platforms -- (from EV_LAYOUT_CONSTANTS) feature -- Duplication copy (other: PREFERENCES_GRID_CONTROL) -- 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: PREFERENCES_GRID_CONTROL) -- 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: PREFERENCES_GRID_CONTROL -- 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: PREFERENCES_GRID_CONTROL) -- 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: PREFERENCES_GRID_CONTROL -- 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: PREFERENCES_GRID_CONTROL -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable PREFERENCES_GRID_CONTROL -- 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 -- Access (border constants) Default_border_size: INTEGER_32 -- Default size for borders -- (from EV_LAYOUT_CONSTANTS) Large_border_size: INTEGER_32 -- Default size for borders -- (from EV_LAYOUT_CONSTANTS) Small_border_size: INTEGER_32 -- Small size for borders -- (from EV_LAYOUT_CONSTANTS) feature -- Access (button size constants) Default_button_height: INTEGER_32 -- Default height for buttons -- (from EV_LAYOUT_CONSTANTS) Default_button_width: INTEGER_32 -- Default width for buttons -- (from EV_LAYOUT_CONSTANTS) feature -- Access (padding constants) Default_padding_size: INTEGER_32 -- Default size for padding -- (from EV_LAYOUT_CONSTANTS) Small_padding_size: INTEGER_32 -- Small size for padding -- (from EV_LAYOUT_CONSTANTS) Tiny_padding_size: INTEGER_32 -- Tiny size for padding -- (from EV_LAYOUT_CONSTANTS) feature -- Events on_apply_or_close -- Close button has been pushed: apply the changes then close -- the Preferences Window. on_show feature -- Operation set_default_size_for_button (a_button: EV_BUTTON) -- Set the default size for a_button. -- (from EV_LAYOUT_CONSTANTS) set_default_width_for_button (a_button: EV_BUTTON) -- Set the default width for a_button. -- (from EV_LAYOUT_CONSTANTS) feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- 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 show_hidden_preferences: BOOLEAN -- Should preferences marked as hidden by visible in this view? -- (from PREFERENCE_VIEW) feature -- Status Setting set_close_button_action (p: like close_button_action) -- Set close button action to p. set_filter_icon_down (a_icon: EV_PIXMAP) -- Set the grid's header arrow down icon require icon_not_void: a_icon /= Void set_filter_icon_up (a_icon: EV_PIXMAP) -- Set the grid's header arrow up icon require icon_not_void: a_icon /= Void set_folder_icon (a_icon: EV_PIXMAP) -- Set the folder node icon require icon_not_void: a_icon /= Void set_parent_window (p: attached like parent_window) -- Set parent_window set_root_icon (a_icon: EV_PIXMAP) -- Set the root node icon require icon_not_void: a_icon /= Void set_show_full_preference_name (a_flag: BOOLEAN) -- Set 'show_full_preference_name' set_show_hidden_preferences (a_flag: BOOLEAN) -- Set show_hidden_preferences. -- (from PREFERENCE_VIEW) ensure -- from PREFERENCE_VIEW value_set: show_hidden_preferences = a_flag invariant has_preferences: preferences /= Void -- from PREFERENCE_VIEW has_preferences: preferences /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note ca_ignore: "CA011", "CA011: too many arguments", "CA033", "CA033: very large class" 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 PREFERENCES_GRID_CONTROL
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org