ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-12-29 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/FileChooserEmbed.xml
	* en/Gtk/FileChooserDialog.xml
	* en/Gtk/FileChooserWidget.xml
	* en/Gtk/FileFilter.xml
	* en/Gtk/FileFilterFlags.xml
	* en/Gtk/FileChooser.xml: file chooser and filter docs.


svn path=/trunk/gtk-sharp/; revision=38156
This commit is contained in:
Shane Landrum 2004-12-29 15:12:34 +00:00
parent db2ab91013
commit d912969793
7 changed files with 529 additions and 189 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ChangeLog
View file

@ -1,3 +1,12 @@
2004-12-29 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileChooserEmbed.xml
* en/Gtk/FileChooserDialog.xml
* en/Gtk/FileChooserWidget.xml
* en/Gtk/FileFilter.xml
* en/Gtk/FileFilterFlags.xml
* en/Gtk/FileChooser.xml: file chooser and filter docs.
2004-12-28 Jeroen Zwartepoorte <jeroen@xs4all.nl> 2004-12-28 Jeroen Zwartepoorte <jeroen@xs4all.nl>
* en/Gnome.Vfs/*.xml: more docs. * en/Gnome.Vfs/*.xml: more docs.

14
doc/en/Gtk/FileChooser.xml
View file

@ -1,4 +1,4 @@
<Type Name="FileChooser" FullName="Gtk.FileChooser"> <Type Name="FileChooser" FullName="Gtk.FileChooser">e
<TypeSignature Language="C#" Value="public abstract interface FileChooser" Maintainer="auto" /> <TypeSignature Language="C#" Value="public abstract interface FileChooser" Maintainer="auto" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
@ -9,8 +9,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>Class for a file-chooser dialog.</summary> <summary>Interface for a file-chooser.</summary>
<remarks/> <remarks>See <see cref="M:Gtk.FileChooserWidget"/> for an actual implementation.</remarks>
</Docs> </Docs>
<Base /> <Base />
<Interfaces> <Interfaces>
@ -499,7 +499,7 @@
Applications that Applications that
want to draw the whole preview area themselves should set this want to draw the whole preview area themselves should set this
to false and display the name themselves in their preview widget. to false and display the name themselves in their preview widget.
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Filename"> <Member MemberName="Filename">
@ -545,7 +545,7 @@
<see cref="M:Gtk.FileChooserAction.Open"/> or <see cref="M:Gtk.FileChooserAction.Open"/> or
<see cref="M:Gtk.FileChooserAction.Save"/>. <see cref="M:Gtk.FileChooserAction.Save"/>.
It cannot be set with either of the folder actions. It cannot be set with either of the folder actions.
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PreviewWidget"> <Member MemberName="PreviewWidget">
@ -594,8 +594,8 @@
<Docs> <Docs>
<summary> <summary>
Sets the type of operation that that the chooser is performing; the Sets the type of operation that that the chooser is performing; the
user interface is adapted to suit the selected action. user interface is adapted to suit the selected action.
</summary> </summary>
<returns>a <see cref="T:Gtk.FileChooserAction" /></returns> <returns>a <see cref="T:Gtk.FileChooserAction" /></returns>
<remarks> <remarks>
For example, For example,

349
doc/en/Gtk/FileChooserDialog.xml
View file

@ -10,8 +10,7 @@
<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> <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> <Docs>
<summary>A dialog box for choosing files.</summary> <summary>A dialog box for choosing files.</summary>
<remarks> <remarks>Similar to <see cref="T:Gtk.FileChooserWidget"/> but in a dialog.</remarks>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName> <BaseTypeName>Gtk.Dialog</BaseTypeName>
@ -55,11 +54,15 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="uri">a <see cref="T:System.String" /></param> Sets the current folder for the chooser from an URI.
<returns>a <see cref="T:System.Boolean" /></returns> </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> <remarks>
</remarks> The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnselectAll"> <Member MemberName="UnselectAll">
@ -70,9 +73,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Unselects all the files in the current folder of a file chooser.</summary>
<remarks> <remarks/>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetFilename"> <Member MemberName="SetFilename">
@ -85,11 +87,26 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <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> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="RemoveShortcutFolderUri"> <Member MemberName="RemoveShortcutFolderUri">
@ -102,11 +119,14 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</remarks> See also <see cref="M:Gtk.FileChooser.AddShortcutFolderUri"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddShortcutFolderUri"> <Member MemberName="AddShortcutFolderUri">
@ -119,11 +139,18 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, true if the folder
could be added successfully, false otherwise.</returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="SelectAll"> <Member MemberName="SelectAll">
@ -134,7 +161,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Selects all the files in the current folder of a file chooser.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -149,9 +176,15 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <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>
</remarks> </remarks>
</Docs> </Docs>
@ -166,10 +199,10 @@
<Parameter Name="filter" Type="Gtk.FileFilter" /> <Parameter Name="filter" Type="Gtk.FileFilter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="filter">a <see cref="T:Gtk.FileFilter" /></param>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddShortcutFolder"> <Member MemberName="AddShortcutFolder">
@ -182,11 +215,14 @@
<Parameter Name="folder" Type="System.String" /> <Parameter Name="folder" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="folder">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="SelectFilename"> <Member MemberName="SelectFilename">
@ -199,11 +235,14 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Selects a filename.</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="UnselectFilename"> <Member MemberName="UnselectFilename">
@ -216,10 +255,14 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Unselects a currently selected filename.
</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<remarks> <remarks>
</remarks> If the filename is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddFilter"> <Member MemberName="AddFilter">
@ -232,10 +275,15 @@
<Parameter Name="filter" Type="Gtk.FileFilter" /> <Parameter Name="filter" Type="Gtk.FileFilter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="filter">a <see cref="T:Gtk.FileFilter" /></param>
<remarks> <remarks>
</remarks> When a filter is selected, only files that are passed by that
filter are displayed.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveShortcutFolder"> <Member MemberName="RemoveShortcutFolder">
@ -248,11 +296,10 @@
<Parameter Name="folder" Type="System.String" /> <Parameter Name="folder" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Removes a folder from a file chooser's list of shortcut folders.</summary>
<param name="folder">a <see cref="T:System.String" /></param> <param name="folder">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>See also <see cref="M:Gtk.FileChooser.AddShortcutFolder"/>.</remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnselectUri"> <Member MemberName="UnselectUri">
@ -265,10 +312,14 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Unselects the file referred to by <paramref name="uri"/>.
</summary>
<param name="uri">a <see cref="T:System.String" /></param> <param name="uri">a <see cref="T:System.String" /></param>
<remarks> <remarks>
</remarks> If the file is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetCurrentFolder"> <Member MemberName="SetCurrentFolder">
@ -281,11 +332,15 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets the current folder for the file chooser from a local filename.
</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</remarks> The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetUri"> <Member MemberName="SetUri">
@ -298,10 +353,25 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <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>
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.FileChooserDialog.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.FileChooserDialog.SetCurrentFilename"/>.
</remarks>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -361,7 +431,7 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.FileChooserDialog" /></returns> <returns>a <see cref="T:Gtk.FileChooserDialog" /></returns>
<remarks> <remarks>
@ -376,8 +446,8 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for internal use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object.</param>
<returns>a <see cref="T:Gtk.FileChooserDialog" /></returns> <returns>a <see cref="T:Gtk.FileChooserDialog" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -393,10 +463,10 @@
<Parameter Name="action" Type="Gtk.FileChooserAction" /> <Parameter Name="action" Type="Gtk.FileChooserAction" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="title">a <see cref="T:System.String" /></param> <param name="title">a <see cref="T:System.String" />, title for the dialog</param>
<param name="parent">a <see cref="T:Gtk.Window" /></param> <param name="parent">a <see cref="T:Gtk.Window" />, parent window</param>
<param name="action">a <see cref="T:System.Int32" /></param> <param name="action">a <see cref="T:Gtk.FileChooserAction" />, the action this dialog should be doing</param>
<returns>a <see cref="T:Gtk.FileChooserDialog" /></returns> <returns>a <see cref="T:Gtk.FileChooserDialog" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -436,7 +506,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:GLib.GType" /> of this object. </summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -450,7 +520,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The file chooser's current folder, if set from a URI.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -464,7 +534,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An application-supplied widget to provide extra options to the user.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -477,10 +547,16 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="Filter"> <Member MemberName="Filter">
@ -491,7 +567,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The currently-applied file filter.</summary>
<returns>a <see cref="T:Gtk.FileFilter" /></returns> <returns>a <see cref="T:Gtk.FileFilter" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -505,10 +581,22 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets whether only local files can be selected in the
file selector.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="PreviewWidgetActive"> <Member MemberName="PreviewWidgetActive">
@ -519,10 +607,14 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks> When this property is set to false, the file chooser
</remarks> may display an internally generated preview of the current file
or it may display no preview at all.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PreviewFilename"> <Member MemberName="PreviewFilename">
@ -533,10 +625,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal function; gets the filename that should be previewed in a custom preview.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>Not for general programmer use.</remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Uri"> <Member MemberName="Uri">
@ -547,10 +638,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The URI for the currently selected file in
the file selector. </summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="UsePreviewLabel"> <Member MemberName="UsePreviewLabel">
@ -561,10 +657,16 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="Filename"> <Member MemberName="Filename">
@ -575,7 +677,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The current filename selected by the file chooser.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -589,7 +691,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The URI that should be previewed in a custom preview widget. </summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -603,10 +705,16 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets whether multiple files can be selected in the file selector.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="PreviewWidget"> <Member MemberName="PreviewWidget">
@ -617,10 +725,32 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="Action"> <Member MemberName="Action">
@ -631,10 +761,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:Gtk.FileChooserAction" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="CurrentFolder"> <Member MemberName="CurrentFolder">
@ -645,7 +782,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -659,7 +796,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The filenames selected by this widget.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -673,7 +810,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The URIs selected by this dialog.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -687,7 +824,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The filters currently in use by this dialog for patterns of files to display.</summary>
<returns>a <see cref="T:Gtk.FileFilter[]" /></returns> <returns>a <see cref="T:Gtk.FileFilter[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -701,7 +838,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The shortcut folders currently in use for this dialog.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -715,7 +852,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The shortcut URIs currently allowed for this dialog.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -729,9 +866,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This event is fired every time the selected file changes.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FileActivated"> <Member MemberName="FileActivated">
@ -742,9 +879,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
This signal is emitted when the user "activates" a file in the file
chooser.
</summary>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="UpdatePreview"> <Member MemberName="UpdatePreview">
@ -755,9 +900,29 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="CurrentFolderChanged"> <Member MemberName="CurrentFolderChanged">
@ -768,10 +933,20 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
This signal is emitted when the current folder in a file chooser
changes.
</summary>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

4
doc/en/Gtk/FileChooserEmbed.xml
View file

@ -9,7 +9,7 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>An interface allowing file choosers to be embedded in other widgets.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
<Base /> <Base />
@ -28,7 +28,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when the default size of the file chooser object changes.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>

332
doc/en/Gtk/FileChooserWidget.xml
View file

@ -9,7 +9,7 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>Widget to allow the selection of files from a directory.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -43,7 +43,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Override to accomplish actions that must happen before object destruction.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -58,11 +58,15 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="uri">a <see cref="T:System.String" /></param> Sets the current folder for the chooser from an URI.
<returns>a <see cref="T:System.Boolean" /></returns> </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> <remarks>
</remarks> The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnselectAll"> <Member MemberName="UnselectAll">
@ -73,9 +77,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Unselects all the files in the current folder of a file chooser.</summary>
<remarks> <remarks/>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetFilename"> <Member MemberName="SetFilename">
@ -88,11 +91,26 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <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> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="RemoveShortcutFolderUri"> <Member MemberName="RemoveShortcutFolderUri">
@ -105,11 +123,14 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</remarks> See also <see cref="M:Gtk.FileChooser.AddShortcutFolderUri"/>.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddShortcutFolderUri"> <Member MemberName="AddShortcutFolderUri">
@ -122,11 +143,18 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" />, true if the folder
could be added successfully, false otherwise.</returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="SelectAll"> <Member MemberName="SelectAll">
@ -137,7 +165,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Selects all the files in the current folder of a file chooser.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -152,9 +180,15 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <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>
</remarks> </remarks>
</Docs> </Docs>
@ -169,10 +203,10 @@
<Parameter Name="filter" Type="Gtk.FileFilter" /> <Parameter Name="filter" Type="Gtk.FileFilter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="filter">a <see cref="T:Gtk.FileFilter" /></param>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddShortcutFolder"> <Member MemberName="AddShortcutFolder">
@ -185,11 +219,14 @@
<Parameter Name="folder" Type="System.String" /> <Parameter Name="folder" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="folder">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="SelectFilename"> <Member MemberName="SelectFilename">
@ -202,11 +239,14 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Selects a filename.</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="UnselectFilename"> <Member MemberName="UnselectFilename">
@ -219,10 +259,14 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Unselects a currently selected filename.
</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<remarks> <remarks>
</remarks> If the filename is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AddFilter"> <Member MemberName="AddFilter">
@ -235,10 +279,15 @@
<Parameter Name="filter" Type="Gtk.FileFilter" /> <Parameter Name="filter" Type="Gtk.FileFilter" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="filter">a <see cref="T:Gtk.FileFilter" /></param>
<remarks> <remarks>
</remarks> When a filter is selected, only files that are passed by that
filter are displayed.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RemoveShortcutFolder"> <Member MemberName="RemoveShortcutFolder">
@ -251,11 +300,10 @@
<Parameter Name="folder" Type="System.String" /> <Parameter Name="folder" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Removes a folder from a file chooser's list of shortcut folders.</summary>
<param name="folder">a <see cref="T:System.String" /></param> <param name="folder">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>See also <see cref="M:Gtk.FileChooser.AddShortcutFolder"/>.</remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UnselectUri"> <Member MemberName="UnselectUri">
@ -268,10 +316,14 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Unselects the file referred to by <paramref name="uri"/>.
</summary>
<param name="uri">a <see cref="T:System.String" /></param> <param name="uri">a <see cref="T:System.String" /></param>
<remarks> <remarks>
</remarks> If the file is not in the current directory, does not exist, or
is otherwise not currently selected, does nothing.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetCurrentFolder"> <Member MemberName="SetCurrentFolder">
@ -284,11 +336,15 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets the current folder for the file chooser from a local filename.
</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</remarks> The user will be shown the full contents of the current folder,
plus user interface elements for navigating to other folders.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetUri"> <Member MemberName="SetUri">
@ -301,9 +357,14 @@
<Parameter Name="uri" Type="System.String" /> <Parameter Name="uri" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <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> <param name="uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <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>
</remarks> </remarks>
</Docs> </Docs>
@ -376,7 +437,7 @@
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Protected constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.FileChooserWidget" /></returns> <returns>a <see cref="T:Gtk.FileChooserWidget" /></returns>
<remarks> <remarks>
@ -391,8 +452,8 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for internal use.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to underlying C object</param>
<returns>a <see cref="T:Gtk.FileChooserWidget" /></returns> <returns>a <see cref="T:Gtk.FileChooserWidget" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -406,8 +467,8 @@
<Parameter Name="action" Type="Gtk.FileChooserAction" /> <Parameter Name="action" Type="Gtk.FileChooserAction" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="action">a <see cref="T:System.Int32" /></param> <param name="action">a <see cref="T:Gtk.FileChooserAction" />, the action this chooser will perform</param>
<returns>a <see cref="T:Gtk.FileChooserWidget" /></returns> <returns>a <see cref="T:Gtk.FileChooserWidget" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -422,9 +483,9 @@
<Parameter Name="backend" Type="System.String" /> <Parameter Name="backend" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<param name="action">a <see cref="T:System.Int32" /></param> <param name="action">a <see cref="T:Gtk.FileChooserAction" />, the action this widget should perform</param>
<param name="backend">a <see cref="T:System.String" /></param> <param name="backend">a <see cref="T:System.String" />, the filesystem back-end to use.</param>
<returns>a <see cref="T:Gtk.FileChooserWidget" /></returns> <returns>a <see cref="T:Gtk.FileChooserWidget" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -438,7 +499,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:GLib.GType" /> for this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -452,7 +513,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The file chooser's current folder, if set from a URI.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -466,7 +527,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An application-supplied widget to provide extra options to the user.</summary>
<returns>a <see cref="T:Gtk.Widget" /></returns> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -479,10 +540,16 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="Filter"> <Member MemberName="Filter">
@ -493,7 +560,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The currently-applied file filter.</summary>
<returns>a <see cref="T:Gtk.FileFilter" /></returns> <returns>a <see cref="T:Gtk.FileFilter" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -507,10 +574,22 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets whether only local files can be selected in the
file selector.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="PreviewWidgetActive"> <Member MemberName="PreviewWidgetActive">
@ -521,10 +600,14 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks> When this property is set to false, the file chooser
</remarks> may display an internally generated preview of the current file
or it may display no preview at all.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PreviewFilename"> <Member MemberName="PreviewFilename">
@ -535,10 +618,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Internal function; gets the filename that should be previewed in a custom preview.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>Not for general programmer use.</remarks>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Uri"> <Member MemberName="Uri">
@ -549,10 +631,15 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The URI for the currently selected file in
the file selector. </summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="UsePreviewLabel"> <Member MemberName="UsePreviewLabel">
@ -563,10 +650,16 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="Filename"> <Member MemberName="Filename">
@ -577,7 +670,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The current filename selected by the file chooser.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -591,7 +684,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The URI that should be previewed in a custom preview widget. </summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -605,10 +698,16 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets whether multiple files can be selected in the file selector.
</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="PreviewWidget"> <Member MemberName="PreviewWidget">
@ -619,10 +718,32 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="Action"> <Member MemberName="Action">
@ -633,10 +754,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:Gtk.FileChooserAction" /></returns>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="CurrentFolder"> <Member MemberName="CurrentFolder">
@ -647,7 +775,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <returns>a <see cref="T:System.String" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -661,7 +789,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The filenames selected by this widget.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -675,7 +803,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The URIs selected by this widget.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -689,7 +817,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The filters currently in use by this widget for patterns of files to display.</summary>
<returns>a <see cref="T:Gtk.FileFilter[]" /></returns> <returns>a <see cref="T:Gtk.FileFilter[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -703,7 +831,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The shortcut folders currently in use for this widget.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -717,7 +845,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The shortcut URIs currently allowed for this widget.</summary>
<returns>a <see cref="T:System.String[]" /></returns> <returns>a <see cref="T:System.String[]" /></returns>
<remarks> <remarks>
</remarks> </remarks>
@ -731,9 +859,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>This event is fired every time the selected file changes.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="FileActivated"> <Member MemberName="FileActivated">
@ -744,9 +872,17 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
This signal is emitted when the user "activates" a file in the file
chooser.
</summary>
<remarks> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="UpdatePreview"> <Member MemberName="UpdatePreview">
@ -757,9 +893,29 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <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> <remarks>
</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> </Docs>
</Member> </Member>
<Member MemberName="CurrentFolderChanged"> <Member MemberName="CurrentFolderChanged">
@ -770,7 +926,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when the chooser changes the folder it's looking at.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -783,10 +939,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when the size of the widget changes.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

2
doc/en/Gtk/FileFilter.xml
View file

@ -144,7 +144,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks/> <remarks/>
</Docs> </Docs>

8
doc/en/Gtk/FileFilterFlags.xml
View file

@ -41,7 +41,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The filename.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -54,7 +54,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A URI.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -67,7 +67,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The filename to display.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -80,7 +80,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>The MIME type of the file.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>