1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
|
<Type Name="FileFilter" FullName="Gtk.FileFilter">
<TypeSignature Language="C#" Maintainer="auto" Value="public class FileFilter : GLib.InitiallyUnowned" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FileFilter extends GLib.InitiallyUnowned" />
<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>
</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>
<Base>
<BaseTypeName>GLib.InitiallyUnowned</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>This class sets up a filter to include or exclude particular
kinds of files; useful in file selection dialogs.</summary>
<remarks>
<para> Simple example showing FileFilter within the FileChooserDialog example:
<example><code lang="C#">
public class MainWindow: Gtk.Window {
protected virtual void OnBtnLoadFileClicked(object sender, System.EventArgs e)
{
Gtk.FileChooserDialog fc=
new Gtk.FileChooserDialog("Choose the file to open",
this,
FileChooserAction.Open,
Gtk.Stock.Cancel,ResponseType.Cancel,
Gtk.Stock.Open,ResponseType.Accept);
//filter begins here...
FileFilter filter = new FileFilter();
filter.Name = "PNG and JPEG images";
filter.AddMimeType("image/png");
filter.AddPattern("*.png");
filter.AddMimeType("image/jpeg");
filter.AddPattern("*.jpg");
fc.AddFilter(filter);
//second filter
filter = new FileFilter();
filter.Name = "PNG Images (*.png)";
filter.AddMimeType("image/png");
filter.AddPattern("*.png");
fc.AddFilter(filter);
//end filter code
if (fc.Run() == (int)ResponseType.Accept)
{
System.Console.WriteLine
}
//Don't forget to call Destroy() or the FileChooserDialog window won't get closed.
fc.Destroy();
}
</code></example></para>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates a new file filter with no rules attached to it.</summary>
<remarks>
A newly-created filter doesn't accept any files, so is not
particularly useful until you add rules with
<see cref="M:Gtk.FileFilter.AddMimeType" />,
<see cref="M:Gtk.FileFilter.AddPattern" />, or
<see cref="M:Gtk.FileFilter.AddCustom" />.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileFilter (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<summary>Constructor for internal use only.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AddCustom">
<MemberSignature Language="C#" Value="public void AddCustom (Gtk.FileFilterFlags needed, Gtk.FileFilterFunc func);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddCustom(valuetype Gtk.FileFilterFlags needed, class Gtk.FileFilterFunc func) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="needed" Type="Gtk.FileFilterFlags" />
<Parameter Name="func" Type="Gtk.FileFilterFunc" />
</Parameters>
<Docs>
<param name="needed">a <see cref="T:System.Int32" /></param>
<param name="func">a <see cref="T:Gtk.FileFilterFunc" /></param>
<summary>Adds a rule to a filter that allows files based on a custom callback function.</summary>
<remarks>
The bitfield <paramref name="needed" /> which is passed in provides information
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>
</Docs>
</Member>
<Member MemberName="AddMimeType">
<MemberSignature Language="C#" Value="public void AddMimeType (string mime_type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddMimeType(string mime_type) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mime_type" Type="System.String" />
</Parameters>
<Docs>
<param name="mime_type">a <see cref="T:System.String" /></param>
<summary>Adds a rule allowing a given MIME type to a filter.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AddPattern">
<MemberSignature Language="C#" Value="public void AddPattern (string pattern);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddPattern(string pattern) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pattern" Type="System.String" />
</Parameters>
<Docs>
<param name="pattern">a <see cref="T:System.String" /></param>
<summary>Adds a rule allowing a shell style glob to a filter.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AddPixbufFormats">
<MemberSignature Language="C#" Value="public void AddPixbufFormats ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddPixbufFormats() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="public bool Filter (Gtk.FileFilterInfo filter_info);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Filter(valuetype Gtk.FileFilterInfo filter_info) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter_info" Type="Gtk.FileFilterInfo" />
</Parameters>
<Docs>
<param name="filter_info">a <see cref="T:Gtk.FileFilterInfo" /></param>
<summary>Tests whether a file should be displayed according to this filter.</summary>
<returns>a <see cref="T:System.Boolean" />, TRUE if the file should be displayed.</returns>
<remarks>
The <see cref="T:Gtk.FileFilterInfo" /> structure
<paramref name="filter_info" /> should include
the fields returned from <see cref="M:Gtk.FileFilter.GetNeeded" />.
This function will not typically be used by applications; it
is intended principally for use in the implementation of
<see cref="T:Gtk.FileChooser" />.
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The <see cref="T:GLib.GType" /> of this object.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The human-readable name of the filter.</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>
This is the string that will be displayed in the file selector
user interface if there is a selectable list of filters.
</remarks>
</Docs>
</Member>
<Member MemberName="Needed">
<MemberSignature Language="C#" Value="public Gtk.FileFilterFlags Needed { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.FileFilterFlags Needed" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.FileFilterFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the fields that need to be filled in for the structure
passed to <see cref="M:Gtk.FileFilter.Filter" />.
</summary>
<value>a <see cref="T:Gtk.FileFilterFlags" />, flags that list the needed fields when calling <see cref="M:Gtk.FileFilter.Filter" />.</value>
<remarks>
This function will not typically be used by applications; it
is intended principally for use in the implementation of
<see cref="T:Gtk.FileChooser" />.
</remarks>
</Docs>
</Member>
</Members>
</Type>
|