1 2@c %start of fragment 3 4@deftp Class <gtk-file-filter> 5Derives from @code{<gtk-object>}. 6 7This class defines no direct slots. 8 9@end deftp 10 11@deffn Function gtk-file-filter-new @result{}@tie{} (ret@tie{}@code{<gtk-file-filter>}) 12Creates a new @code{<gtk-file-filter>} with no rules added to it. Such a filter 13doesn't accept any files, so is not particularly useful until you add rules with 14@code{gtk-file-filter-add-mime-type}, @code{gtk-file-filter-add-pattern}, or 15@code{gtk-file-filter-add-custom}. To create a filter that accepts any file, 16use: 17 18@example 19 20GtkFileFilter *filter = gtk_file_filter_new (); 21gtk_file_filter_add_pattern (filter, "*"); 22@end example 23 24@table @var 25@item ret 26a new @code{<gtk-file-filter>} 27 28@end table 29 30Since 2.4 31 32@end deffn 33 34@deffn Function gtk-file-filter-set-name (self@tie{}@code{<gtk-file-filter>}) (name@tie{}@code{mchars}) 35@deffnx Method set-name 36Sets the human-readable name of the filter; this is the string that will be 37displayed in the file selector user interface if there is a selectable list of 38filters. 39 40@table @var 41@item filter 42a @code{<gtk-file-filter>} 43 44@item name 45the human-readable-name for the filter, or @samp{@code{#f}} to remove any 46existing name. 47 48@end table 49 50Since 2.4 51 52@end deffn 53 54@deffn Function gtk-file-filter-get-name (self@tie{}@code{<gtk-file-filter>}) @result{}@tie{} (ret@tie{}@code{mchars}) 55@deffnx Method get-name 56Gets the human-readable name for the filter. See 57@code{gtk-file-filter-set-name}. 58 59@table @var 60@item filter 61a @code{<gtk-file-filter>} 62 63@item ret 64The human-readable name of the filter, or @samp{@code{#f}}. This value is owned 65by GTK+ and must not be modified or freed. 66 67@end table 68 69Since 2.4 70 71@end deffn 72 73@deffn Function gtk-file-filter-add-mime-type (self@tie{}@code{<gtk-file-filter>}) (mime_type@tie{}@code{mchars}) 74@deffnx Method add-mime-type 75Adds a rule allowing a given mime type to @var{filter}. 76 77@table @var 78@item filter 79A @code{<gtk-file-filter>} 80 81@item mime-type 82name of a MIME type 83 84@end table 85 86Since 2.4 87 88@end deffn 89 90@deffn Function gtk-file-filter-add-pattern (self@tie{}@code{<gtk-file-filter>}) (pattern@tie{}@code{mchars}) 91@deffnx Method add-pattern 92Adds a rule allowing a shell style glob to a filter. 93 94@table @var 95@item filter 96a @code{<gtk-file-filter>} 97 98@item pattern 99a shell style glob 100 101@end table 102 103Since 2.4 104 105@end deffn 106 107@deffn Function gtk-file-filter-add-pixbuf-formats (self@tie{}@code{<gtk-file-filter>}) 108@deffnx Method add-pixbuf-formats 109Adds a rule allowing image files in the formats supported by GdkPixbuf. 110 111@table @var 112@item filter 113a @code{<gtk-file-filter>} 114 115@end table 116 117Since 2.6 118 119@end deffn 120 121@deffn Function gtk-file-filter-get-needed (self@tie{}@code{<gtk-file-filter>}) @result{}@tie{} (ret@tie{}@code{<gtk-file-filter-flags>}) 122@deffnx Method get-needed 123Gets the fields that need to be filled in for the structure passed to 124@code{gtk-file-filter-filter} 125 126This function will not typically be used by applications; it is intended 127principally for use in the implementation of @code{<gtk-file-chooser>}. 128 129@table @var 130@item filter 131a @code{<gtk-file-filter>} 132 133@item ret 134bitfield of flags indicating needed fields when calling 135@code{gtk-file-filter-filter} 136 137@end table 138 139Since 2.4 140 141@end deffn 142 143 144@c %end of fragment 145