GtkSharp/doc/en/Gtk/FileChooser.xml
Shane Landrum c01ab2e2ef 2004-12-14 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileChooser.xml: Added full docs.
	* en/Gtk/FileChooserDialog.xml
	* en/Gtk/FileChooserEmbed.xml
	* en/Gtk/FileChooserAction.xml
	* en/Gtk/FileChooserWidget.xml
	* en/Gtk/FileChooserEntry.xml
	* en/Gtk/FileChooserDefault.xml
	* en/Gtk/FileChooserError.xml
	* en/Gtk/FileChooserProp.xml: Began working on docs.


svn path=/trunk/gtk-sharp/; revision=37765
2004-12-15 00:19:32 +00:00

712 lines
27 KiB
XML

<Type Name="FileChooser" FullName="Gtk.FileChooser">
<TypeSignature Language="C#" Value="public abstract interface FileChooser" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Class for a file-chooser dialog.</summary>
<remarks/>
</Docs>
<Base />
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="SetCurrentFolderUri">
<MemberSignature Language="C#" Value="public virtual bool SetCurrentFolderUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
Sets the current folder for the chooser from an URI.
</summary>
<param name="uri">a <see cref="T:System.String" />, the URI to use</param>
<returns>a <see cref="T:System.Boolean" />, true if the folder could be changed successfully, false otherwise</returns>
<remarks>
The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
</remarks>
</Docs>
</Member>
<Member MemberName="UnselectAll">
<MemberSignature Language="C#" Value="public virtual void UnselectAll ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Unselects all the files in the current folder of a file chooser.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="SetFilename">
<MemberSignature Language="C#" Value="public virtual bool SetFilename (string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>
Sets <paramref name="filename"/> as the current filename for
the file chooser;
If the file name isn't in the current folder of the file chooser, then the
current folder of the file chooser will be changed to the folder containing
<paramref name="filename"/>.
</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" />, true if both the
folder could be changed and the file was
selected successfully, false otherwise. </returns>
<remarks>
This is equivalent to a sequence of
<see cref="M:Gtk.FileChooser.UnselectAll"/>
followed by <see cref="M:Gtk.FileChooser.SelectFilename"/>.
Note that the file must exist, or nothing will be done except
for the directory change. To pre-enter a filename for the user, as in
a save-as dialog, use <see cref="M:Gtk.FileChooser.SetCurrentFilename"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveShortcutFolderUri">
<MemberSignature Language="C#" Value="public virtual bool RemoveShortcutFolderUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
Removes a folder URI from a file chooser's list of shortcut folders.
</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
See also <see cref="M:Gtk.FileChooser.AddShortcutFolderUri"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="AddShortcutFolderUri">
<MemberSignature Language="C#" Value="public virtual bool AddShortcutFolderUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
Adds a folder URI to be displayed with the shortcut folders in a file
chooser.
</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" />, true if the folder
could be added successfully, false otherwise.</returns>
<remarks>
Note that shortcut folders do not get saved, as they are provided
by the application. For example, you can use this to add a
"file:///usr/share/mydrawprogram/Clipart" folder to the volume list.
</remarks>
</Docs>
</Member>
<Member MemberName="SelectAll">
<MemberSignature Language="C#" Value="public virtual void SelectAll ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Selects all the files in the current folder of a file chooser.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SelectUri">
<MemberSignature Language="C#" Value="public virtual bool SelectUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
Selects the file at <paramref name="uri"/>. If the URI doesn't refer to a
file in the current folder of the file chooser, then the current folder of
the file chooser will be changed to the folder that's part of <paramref name="uri"/> .
</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" />, true if both the
folder could be changed and the URI was
selected successfully, false otherwise.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RemoveFilter">
<MemberSignature Language="C#" Value="public virtual void RemoveFilter (Gtk.FileFilter filter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="Gtk.FileFilter" />
</Parameters>
<Docs>
<summary>Removes <paramref name="filter"/> from the list of filters that the user can select between.</summary>
<param name="filter">a <see cref="T:Gtk.FileFilter" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="AddShortcutFolder">
<MemberSignature Language="C#" Value="public virtual bool AddShortcutFolder (string folder);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="folder" Type="System.String" />
</Parameters>
<Docs>
<summary>Adds a folder to be displayed with the shortcut folders in a file chooser.</summary>
<param name="folder">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
Note that shortcut folders do not get saved, as they are provided by the
application. For example, you can use this to add a
"/usr/share/mydrawprogram/Clipart" folder to the volume list.
</remarks>
</Docs>
</Member>
<Member MemberName="SelectFilename">
<MemberSignature Language="C#" Value="public virtual bool SelectFilename (string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>Selects a filename.</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
If the file name isn't in the current
folder of the file chooser, then the current folder of the file chooser will
be changed to the folder containing <paramref name="filename"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="UnselectFilename">
<MemberSignature Language="C#" Value="public virtual void UnselectFilename (string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>
Unselects a currently selected filename.
</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<remarks>
If the filename is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
</remarks>
</Docs>
</Member>
<Member MemberName="AddFilter">
<MemberSignature Language="C#" Value="public virtual void AddFilter (Gtk.FileFilter filter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="Gtk.FileFilter" />
</Parameters>
<Docs>
<summary>
Adds <paramref name="filter"/> to the list of filters that the
user can select between.
</summary>
<param name="filter">a <see cref="T:Gtk.FileFilter" /></param>
<remarks>
When a filter is selected, only files that are passed by that
filter are displayed.
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveShortcutFolder">
<MemberSignature Language="C#" Value="public virtual bool RemoveShortcutFolder (string folder);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="folder" Type="System.String" />
</Parameters>
<Docs>
<summary>Removes a folder from a file chooser's list of shortcut folders.</summary>
<param name="folder">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>See also <see cref="M:Gtk.FileChooser.AddShortcutFolder"/>.</remarks>
</Docs>
</Member>
<Member MemberName="UnselectUri">
<MemberSignature Language="C#" Value="public virtual void UnselectUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
Unselects the file referred to by <paramref name="uri"/>.
</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<remarks>
If the file is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
</remarks>
</Docs>
</Member>
<Member MemberName="SetCurrentFolder">
<MemberSignature Language="C#" Value="public virtual bool SetCurrentFolder (string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>
Sets the current folder for the file chooser from a local filename.
</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
</remarks>
</Docs>
</Member>
<Member MemberName="SetUri">
<MemberSignature Language="C#" Value="public virtual bool SetUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<summary>
Sets the file referred to by <paramref name="uri"/> as the
current file for the the file chooser.
</summary>
<param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" />, true if both the folder
could be changed and the URI was
selected successfully, false otherwise.</returns>
<remarks>
If the file name isn't in the current folder of the file chooser,
then the current folder of the file chooser will be changed to the folder containing
<paramref name="uri"/>. This is equivalent to a sequence of
<see cref="M:Gtk.FileChooser.UnselectAll"/>
followed by <see cref="M:Gtk.FileChooser.SelectUri"/>.
Note that the file must exist, or nothing will be done except
for the directory change. To pre-enter a filename for the user, as in
a save-as dialog, use <see cref="M:Gtk.FileChooser.SetCurrentFilename"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="CurrentFolderUri">
<MemberSignature Language="C#" Value="public virtual string CurrentFolderUri { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The file chooser's current folder, if set from a URI.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="ExtraWidget">
<MemberSignature Language="C#" Value="public virtual Gtk.Widget ExtraWidget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>An application-supplied widget to provide extra options to the user.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CurrentName">
<MemberSignature Language="C#" Value="public virtual string CurrentName { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Property to represent the current name in the file selector,
as if entered by the user.
</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>
Note that the name passed in here is a UTF-8
string rather than a filename. This function is meant for
such uses as a suggested name in a "Save As..." dialog.
</remarks>
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="public virtual Gtk.FileFilter Filter { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileFilter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The currently-applied file filter.</summary>
<returns>a <see cref="T:Gtk.FileFilter" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="LocalOnly">
<MemberSignature Language="C#" Value="public virtual bool LocalOnly { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Sets whether only local files can be selected in the
file selector.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
If true (the default),
then the selected file are files are guaranteed to be
accessible through the operating systems native file
file system and therefore the application only
needs to worry about the filename functions in
<see cref="T:Gtk.FileChooser"/>, like
<see cref="M:Gtk.FileChooser.GetFilename"/>,
rather than the URI functions like
<see cref="M:Gtk.FileChooser.GetUri"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="PreviewWidgetActive">
<MemberSignature Language="C#" Value="public virtual bool PreviewWidgetActive { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Sets whether the preview widget set by <see cref="M:Gtk.FileChooser.SetPreviewWidget"/>
should be shown for the current filename.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks> When this property is set to false, the file chooser
may display an internally generated preview of the current file
or it may display no preview at all.</remarks>
</Docs>
</Member>
<Member MemberName="PreviewFilename">
<MemberSignature Language="C#" Value="public virtual string PreviewFilename { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Internal function; gets the filename that should be previewed in a custom preview.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>Not for general programmer use.</remarks>
</Docs>
</Member>
<Member MemberName="Uri">
<MemberSignature Language="C#" Value="public virtual string Uri { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The URI for the currently selected file in
the file selector. </summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>
If multiple files are selected,
one of the filenames will be returned at random.
If the file chooser is in folder mode, this function returns the
selected folder.
</remarks>
</Docs>
</Member>
<Member MemberName="UsePreviewLabel">
<MemberSignature Language="C#" Value="public virtual bool UsePreviewLabel { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Sets whether the file chooser should display a stock label with the name of
the file that is being previewed; the default is true.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
Applications that
want to draw the whole preview area themselves should set this
to false and display the name themselves in their preview widget.
</remarks>
</Docs>
</Member>
<Member MemberName="Filename">
<MemberSignature Language="C#" Value="public virtual string Filename { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The current filename selected by the file chooser.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PreviewUri">
<MemberSignature Language="C#" Value="public virtual string PreviewUri { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The URI that should be previewed in a custom preview widget. </summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SelectMultiple">
<MemberSignature Language="C#" Value="public virtual bool SelectMultiple { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Sets whether multiple files can be selected in the file selector.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>
This is only relevant if the action is set to be
<see cref="M:Gtk.FileChooserAction.Open"/> or
<see cref="M:Gtk.FileChooserAction.Save"/>.
It cannot be set with either of the folder actions.
</remarks>
</Docs>
</Member>
<Member MemberName="PreviewWidget">
<MemberSignature Language="C#" Value="public virtual Gtk.Widget PreviewWidget { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
An application-supplied widget to use to display a custom preview
of the currently selected file.
</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>
<para>
To implement a preview, after setting the
preview widget, you connect to the
<see cref="E:Gtk.FileChooser.SelectionChanged"/>
signal, and check
<see cref="P:Gtk.FileChooser.PreviewFilename"/> or
<see cref="P:Gtk.FileChooser.PreviewUri"/>
on each change. If you can
display a preview of the new file, update your widget and
set the preview active using
<see cref="P:Gtk.FileChooser.PreviewWidgetActive"/>
Otherwise, set the preview inactive.
</para>
<para>
When there is no application-supplied preview widget, or the
application-supplied preview widget is not active, the file chooser
may display an internally generated preview of the current file or
it may display no preview at all.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Action">
<MemberSignature Language="C#" Value="public virtual Gtk.FileChooserAction Action { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileChooserAction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Sets the type of operation that that the chooser is performing; the
user interface is adapted to suit the selected action.
</summary>
<returns>a <see cref="T:Gtk.FileChooserAction" /></returns>
<remarks>
For example,
an option to create a new folder might be shown if the action is
<see cref="M:Gtk.FileChooserAction.Save"/> but not if the action is
<see cref="M:Gtk.FileChooserAction.Open"/>.
</remarks>
</Docs>
</Member>
<Member MemberName="CurrentFolder">
<MemberSignature Language="C#" Value="public virtual string CurrentFolder { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The current folder for the file chooser, when the chooser has selected a local filename.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SelectionChanged">
<MemberSignature Language="C#" Value="public virtual event EventHandler SelectionChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>This event is fired every time the selected file changes.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="FileActivated">
<MemberSignature Language="C#" Value="public virtual event EventHandler FileActivated;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
This signal is emitted when the user "activates" a file in the file
chooser.
</summary>
<remarks>
This event can happen by double-clicking on a file in the file list, or
by pressing Enter.
Normally you do not need to connect to this signal. It is used internally
by the file chooser code to know when to activate the default button in the dialog.
</remarks>
</Docs>
</Member>
<Member MemberName="UpdatePreview">
<MemberSignature Language="C#" Value="public virtual event EventHandler UpdatePreview;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
This signal is emitted when the preview in a file chooser should be
regenerated. For example, this can happen when the currently
selected file changes.
</summary>
<remarks>
<para>You should use this signal if you want your file chooser to have
a preview widget.</para>
<para>Once you have installed a preview widget with
<see cref="P:Gtk.FileChooser.PreviewWidget"/>, you should update it when this
signal is emitted. You can use the properties
<see cref="P:Gtk.FileChooser.PreviewFilename"/> or
<see cref="P:Gtk.FileChooser.PreviewUri"/>
to get the name of the file to preview.
Your widget may not be able to preview all kinds of files; your callback
must set <see cref="P:Gtk.FileChooser.PreviewWidgetActive"/> to inform the file
chooser about whether the preview was generated successfully or not.
</para>
<para>
TODO: insert example from gtkfilechooser-preview in gtk+ docs.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="CurrentFolderChanged">
<MemberSignature Language="C#" Value="public virtual event EventHandler CurrentFolderChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
This signal is emitted when the current folder in a file chooser
changes.
</summary>
<remarks>
This event can happen due to the user performing some action that
changes folders, such as selecting a bookmark or visiting a folder on the
file list. It can also happen as a result of calling a function to
explicitly change the current folder in a file chooser.
Normally you do not need to connect to this signal, unless you need to keep
track of which folder a file chooser is showing.
</remarks>
</Docs>
</Member>
</Members>
</Type>