mirror of
				https://github.com/godotengine/godot.git
				synced 2025-11-03 23:21:15 +00:00 
			
		
		
		
	Filled missing Doc for String and FileDialog
This commit is contained in:
		
							parent
							
								
									4c1a5d9cfe
								
							
						
					
					
						commit
						e4b2a20cd6
					
				
					 2 changed files with 9 additions and 2 deletions
				
			
		| 
						 | 
					@ -17,7 +17,7 @@
 | 
				
			||||||
			<argument index="0" name="filter" type="String">
 | 
								<argument index="0" name="filter" type="String">
 | 
				
			||||||
			</argument>
 | 
								</argument>
 | 
				
			||||||
			<description>
 | 
								<description>
 | 
				
			||||||
				Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images");
 | 
									Add a custom filter. Example: [code]add_filter("*.png ; PNG Images")[/code]
 | 
				
			||||||
			</description>
 | 
								</description>
 | 
				
			||||||
		</method>
 | 
							</method>
 | 
				
			||||||
		<method name="clear_filters">
 | 
							<method name="clear_filters">
 | 
				
			||||||
| 
						 | 
					@ -31,12 +31,14 @@
 | 
				
			||||||
			<return type="void">
 | 
								<return type="void">
 | 
				
			||||||
			</return>
 | 
								</return>
 | 
				
			||||||
			<description>
 | 
								<description>
 | 
				
			||||||
 | 
									Clear currently selected items in the dialog.
 | 
				
			||||||
			</description>
 | 
								</description>
 | 
				
			||||||
		</method>
 | 
							</method>
 | 
				
			||||||
		<method name="get_line_edit">
 | 
							<method name="get_line_edit">
 | 
				
			||||||
			<return type="LineEdit">
 | 
								<return type="LineEdit">
 | 
				
			||||||
			</return>
 | 
								</return>
 | 
				
			||||||
			<description>
 | 
								<description>
 | 
				
			||||||
 | 
									Returns the LineEdit for the selected file.
 | 
				
			||||||
			</description>
 | 
								</description>
 | 
				
			||||||
		</method>
 | 
							</method>
 | 
				
			||||||
		<method name="get_vbox">
 | 
							<method name="get_vbox">
 | 
				
			||||||
| 
						 | 
					@ -56,6 +58,7 @@
 | 
				
			||||||
	</methods>
 | 
						</methods>
 | 
				
			||||||
	<members>
 | 
						<members>
 | 
				
			||||||
		<member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access">
 | 
							<member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access">
 | 
				
			||||||
 | 
								The file system access scope. See enum [code]Access[/code] constants.
 | 
				
			||||||
		</member>
 | 
							</member>
 | 
				
			||||||
		<member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir">
 | 
							<member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir">
 | 
				
			||||||
			The current working directory of the file dialog.
 | 
								The current working directory of the file dialog.
 | 
				
			||||||
| 
						 | 
					@ -67,13 +70,16 @@
 | 
				
			||||||
			The currently selected file path of the file dialog.
 | 
								The currently selected file path of the file dialog.
 | 
				
			||||||
		</member>
 | 
							</member>
 | 
				
			||||||
		<member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters">
 | 
							<member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters">
 | 
				
			||||||
 | 
								Set file type filters. This example shows only .png and .gd files [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))[/code].
 | 
				
			||||||
		</member>
 | 
							</member>
 | 
				
			||||||
		<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode">
 | 
							<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode">
 | 
				
			||||||
 | 
								Set dialog to open or save mode, changes selection behavior. See enum [code]Mode[/code] constants.
 | 
				
			||||||
		</member>
 | 
							</member>
 | 
				
			||||||
		<member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title">
 | 
							<member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title">
 | 
				
			||||||
			If [code]true[/code], changing the [code]mode[/code] property will set the window title accordingly (e. g. setting mode to [code]MODE_OPEN_FILE[/code] will change the window title to "Open a File").
 | 
								If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e. g. setting mode to [code]MODE_OPEN_FILE[/code] will change the window title to "Open a File").
 | 
				
			||||||
		</member>
 | 
							</member>
 | 
				
			||||||
		<member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files">
 | 
							<member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files">
 | 
				
			||||||
 | 
								If [code]true[/code], the dialog will show hidden files.
 | 
				
			||||||
		</member>
 | 
							</member>
 | 
				
			||||||
	</members>
 | 
						</members>
 | 
				
			||||||
	<signals>
 | 
						<signals>
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -671,6 +671,7 @@
 | 
				
			||||||
			<return type="PoolByteArray">
 | 
								<return type="PoolByteArray">
 | 
				
			||||||
			</return>
 | 
								</return>
 | 
				
			||||||
			<description>
 | 
								<description>
 | 
				
			||||||
 | 
									Returns the SHA-256 hash of the string as an array of bytes.
 | 
				
			||||||
			</description>
 | 
								</description>
 | 
				
			||||||
		</method>
 | 
							</method>
 | 
				
			||||||
		<method name="sha256_text">
 | 
							<method name="sha256_text">
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue