Automatic generation produced by ISE Eiffel
note description: "Ancestor of WEL_OPEN_FILE_DIALOG and WEL_SAVE_FILE_DIALOG." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2021-04-05 15:52:49 -0800 (Mon, 05 Apr 2021) $" revision: "$Revision: 105261 $" deferred class interface WEL_FILE_DIALOG feature -- Access file_extension_offset: INTEGER_32 -- Specifies the offset from the beginning of the path -- to the file name extension in the string `file_name`. require selected: selected ensure result_greater_than_or_equal_to_one: Result >= 1 file_name_offset: INTEGER_32 -- Specifies the offset from the beginning of the path -- to the file name in the string `file_name`. require selected: selected ensure result_greater_than_or_equal_to_one: Result >= 1 file_path: PATH -- Full file path of selected file. ensure result_not_void: Result /= Void file_title: STRING_32 -- Title of the selected file (without path). require selected: selected ensure result_not_void: Result /= Void filter_index: INTEGER_32 -- Index of the selected filter require selected: selected ensure positive_result: Result >= 0 flags: INTEGER_32 -- Dialog box creation flags. -- Can be a combination of the values defined in -- class WEL_OFN_CONSTANTS. generating_type: TYPE [detachable WEL_FILE_DIALOG] -- 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) Max_file_name_length: INTEGER_32 = 1024 -- Maximum file name length multiple_file_paths: ARRAYED_LIST [PATH] -- return the full path name of all selected files. require multiple_files_flag_set: has_flag ({WEL_OFN_CONSTANTS}.ofn_allowmultiselect) has_explorer_flag: has_flag ({WEL_OFN_CONSTANTS}.ofn_explorer) ensure result_not_void: Result /= Void title: STRING_32 -- Title of the current dialog ensure result_not_void: Result /= Void feature -- Measurement Structure_size: INTEGER_32 -- Size to allocate (in bytes) 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_FILE_DIALOG): 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_FILE_DIALOG): 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_flag (a_flags: INTEGER_32): BOOLEAN -- Is a_flags set in `flags`? -- See class WEL_OFN_CONSTANTS for a_flags values. 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)) selected: BOOLEAN -- Has the user selected something (file, color, etc.)? -- If True, the Ok button has been chosen. If False, -- the Cancel button has been chosen. -- (from WEL_STANDARD_DIALOG) 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_flag (a_flags: INTEGER_32) -- Add a_flags to `flags`. -- See class WEL_OFN_CONSTANTS for a_flags values. ensure has_flag: has_flag (a_flags) remove_flag (a_flags: INTEGER_32) -- Remove a_flags from `flags`. -- See class WEL_OFN_CONSTANTS for a_flags values. ensure has_not_flag: not has_flag (a_flags) set_default_extension (extension: READABLE_STRING_GENERAL) -- Set the default extension with extension. -- This extension will be automatically added to the -- file name if the user fails to type an extension. require extension_not_void: extension /= Void set_default_title -- Set the title bar with the default value ("Save As" -- or "Open") ensure default_title_set: title.is_empty set_file_path (a_file_path: PATH) -- Set `file_path` with a_file_path and initialize -- the file name edit control. require a_file_path_not_void: a_file_path /= Void ensure file_name_set: file_path ~ a_file_path set_filter (filter_names, filter_patterns: ARRAY [READABLE_STRING_GENERAL]) -- Set the file type combo box. -- filter_names is an array of string containing -- the filter names and filter_patterns is an -- array of string containing the filter patterns. -- Example: -- filter_names = <<"Text file", "All file">> -- filter_patterns = <<"*.txt", "*.*">> require filter_names_not_void: filter_names /= Void filter_patterns_not_void: filter_patterns /= Void same_count: filter_names.count = filter_patterns.count set_filter_index (a_filter_index: INTEGER_32) -- Set `filter_index` with a_filter_index. require positive_filter_index: a_filter_index >= 0 ensure filter_index_set: filter_index = a_filter_index set_flags (a_flags: INTEGER_32) -- Set `flags` with a_flags. -- See class WEL_OFN_CONSTANTS for a_flags values. ensure flags_set: flags = a_flags set_initial_path (directory: PATH) -- Set the initial directory with directory. require directory_not_void: directory /= Void set_initial_path_as_current -- Set the initial directory as the current one. set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item set_title (a_title: READABLE_STRING_GENERAL) -- Set `title` with a_title and use this string to -- display the title. require a_title_not_void: a_title /= Void ensure title_set: title.same_string_general (a_title) 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_FILE_DIALOG) -- 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_FILE_DIALOG -- 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_FILE_DIALOG) -- 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_FILE_DIALOG -- 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_FILE_DIALOG -- 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 activate (a_parent: WEL_COMPOSITE_WINDOW) -- Activate the dialog box (modal mode) with -- a_parent as owner. -- (from WEL_STANDARD_DIALOG) require -- from WEL_STANDARD_DIALOG exists: exists a_parent_not_void: a_parent /= Void a_parent_exists: a_parent.exists 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_FILE_DIALOG) -- 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_FILE_DIALOG -- 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 structure_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_FILE_DIALOG): 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 str_file_name_not_void: str_file_name /= Void str_file_name_exists: str_file_name.Exists str_file_title_not_void: str_file_title /= Void str_file_title_exists: str_file_title.Exists str_title_not_void: str_title /= Void str_title_exists: str_title.Exists -- 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 WEL_FILE_DIALOG -- Generated by Eiffel Studio --
For more details: eiffel.org