2004-11-05 22:25:40 +01:00
<Type Name= "FileFilter" FullName= "Gtk.FileFilter" >
<TypeSignature Language= "C#" Value= "public class FileFilter : Gtk.Object, IWrapper, IDisposable" 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 >
2004-12-02 07:33:01 +01:00
<summary > This class sets up a filter to include or exclude particular
kinds of files; useful in file selection dialogs.</summary>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
<Base >
<BaseTypeName > Gtk.Object</BaseTypeName>
</Base>
<Interfaces >
<Interface >
<InterfaceName > GLib.IWrapper</InterfaceName>
</Interface>
<Interface >
<InterfaceName > System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members >
<Member MemberName= "Finalize" >
<MemberSignature Language= "C#" Value= "protected override void Finalize ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Override this method to accomplish certain tasks before object destruction.</summary>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "AddMimeType" >
<MemberSignature Language= "C#" Value= "public void AddMimeType (string mime_type);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "mime_type" Type= "System.String" />
</Parameters>
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Adds a rule allowing a given MIME type to a filter.</summary>
2004-11-05 22:25:40 +01:00
<param name= "mime_type" > a <see cref= "T:System.String" /> </param>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "AddPattern" >
<MemberSignature Language= "C#" Value= "public void AddPattern (string pattern);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "pattern" Type= "System.String" />
</Parameters>
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Adds a rule allowing a shell style glob to a filter.</summary>
2004-11-05 22:25:40 +01:00
<param name= "pattern" > a <see cref= "T:System.String" /> </param>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Filter" >
<MemberSignature Language= "C#" Value= "public bool Filter (Gtk.FileFilterInfo filter_info);" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Boolean</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "filter_info" Type= "Gtk.FileFilterInfo" />
</Parameters>
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Tests whether a file should be displayed according to this filter.</summary>
2004-11-05 22:25:40 +01:00
<param name= "filter_info" > a <see cref= "T:Gtk.FileFilterInfo" /> </param>
2004-12-02 07:33:01 +01:00
<returns > a <see cref= "T:System.Boolean" /> , TRUE if the file should be displayed.</returns>
<remarks >
The <see cref= "T:Gtk.FileFilterInfo" /> structure
2004-12-29 19:36:31 +01:00
<paramref name= "filter_info" /> should include
the fields returned from <see cref= "M:Gtk.FileFilter.GetNeeded" /> .
2004-12-02 07:33:01 +01:00
This function will not typically be used by applications; it
is intended principally for use in the implementation of
2004-12-29 19:36:31 +01:00
<see cref= "T:Gtk.FileChooser" /> .
2004-12-02 07:33:01 +01:00
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "protected FileFilter (GLib.GType gtype);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "gtype" Type= "GLib.GType" />
</Parameters>
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Protected constructor.</summary>
2004-11-05 22:25:40 +01:00
<param name= "gtype" > a <see cref= "T:GLib.GType" /> </param>
<returns > a <see cref= "T:Gtk.FileFilter" /> </returns>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public FileFilter (IntPtr raw);" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Constructor for internal use only.</summary>
2004-11-05 22:25:40 +01:00
<param name= "raw" > a <see cref= "T:System.IntPtr" /> </param>
<returns > a <see cref= "T:Gtk.FileFilter" /> </returns>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public FileFilter ();" />
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs >
2004-12-02 07:33:01 +01:00
<summary > Creates a new file filter with no rules attached to it.</summary>
2004-11-05 22:25:40 +01:00
<returns > a <see cref= "T:Gtk.FileFilter" /> </returns>
2004-12-02 07:33:01 +01:00
<remarks >
A newly-created filter doesn't accept any files, so is not
particularly useful until you add rules with
2004-12-29 19:36:31 +01:00
<see cref= "M:Gtk.FileFilter.AddMimeType" /> ,
<see cref= "M:Gtk.FileFilter.AddPattern" /> , or
<see cref= "M:Gtk.FileFilter.AddCustom" /> .
2004-12-02 07:33:01 +01:00
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-29 16:12:34 +01:00
<summary > The <see cref= "T:GLib.GType" /> of this object.</summary>
2004-11-05 22:25:40 +01:00
<returns > a <see cref= "T:GLib.GType" /> </returns>
2004-12-29 19:36:31 +01:00
<remarks />
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Name" >
<MemberSignature Language= "C#" Value= "public string Name { set; get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-02 07:33:01 +01:00
<summary > The human-readable name of the filter.</summary>
2004-11-05 22:25:40 +01:00
<returns > a <see cref= "T:System.String" /> </returns>
2004-12-02 07:33:01 +01:00
<remarks >
This is the string that will be displayed in the file selector
user interface if there is a selectable list of filters.
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
<Member MemberName= "Needed" >
<MemberSignature Language= "C#" Value= "public Gtk.FileFilterFlags Needed { get; };" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.FileFilterFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-12-02 07:33:01 +01:00
<summary >
Gets the fields that need to be filled in for the structure
2004-12-29 19:36:31 +01:00
passed to <see cref= "M:Gtk.FileFilter.Filter" /> .
2004-12-02 07:33:01 +01:00
</summary>
2004-12-29 19:36:31 +01:00
<returns > a <see cref= "T:Gtk.FileFilterFlags" /> , flags that list the needed fields when calling <see cref= "M:Gtk.FileFilter.Filter" /> .</returns>
2004-12-02 07:33:01 +01:00
<remarks >
This function will not typically be used by applications; it
is intended principally for use in the implementation of
2004-12-29 19:36:31 +01:00
<see cref= "T:Gtk.FileChooser" /> .
2004-12-02 07:33:01 +01:00
</remarks>
2004-11-05 22:25:40 +01:00
</Docs>
</Member>
2004-11-15 18:02:37 +01:00
<Member MemberName= "AddCustom" >
2005-04-06 17:47:17 +02:00
<MemberSignature Language= "C#" Value= "public void AddCustom (Gtk.FileFilterFlags needed, Gtk.FileFilterFunc func);" />
2004-11-15 18:02:37 +01:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "needed" Type= "Gtk.FileFilterFlags" />
<Parameter Name= "func" Type= "Gtk.FileFilterFunc" />
</Parameters>
<Docs >
2005-04-06 17:47:17 +02:00
<summary > Adds a rule to a filter that allows files based on a custom callback function.</summary>
2004-11-15 18:02:37 +01:00
<param name= "needed" > a <see cref= "T:System.Int32" /> </param>
<param name= "func" > a <see cref= "T:Gtk.FileFilterFunc" /> </param>
2004-12-02 07:33:01 +01:00
<remarks >
2004-12-29 19:36:31 +01:00
The bitfield <paramref name= "needed" /> which is passed in provides information
2004-12-02 07:33:01 +01:00
about what sorts of information that the filter function needs;
this allows GTK+ to avoid retrieving expensive information when
it isn't needed by the filter.
</remarks>
2004-11-15 18:02:37 +01:00
</Docs>
</Member>
2005-04-21 19:10:54 +02:00
<Member MemberName= "AddPixbufFormats" >
<MemberSignature Language= "C#" Value= "public void AddPixbufFormats ();" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
<remarks > To be added</remarks>
</Docs>
</Member>
2004-11-05 22:25:40 +01:00
</Members>
2005-04-21 19:10:54 +02:00
</Type>