Struct FileFilter 

pub struct FileFilter { /* private fields */ }

]|

Implements

[trait@glib::ObjectExt], BuildableExt, BuildableExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl FileFilter

pub fn new() -> FileFilter

GtkFileFilter filter = gtk_file_filter_new (); gtk_file_filter_add_pattern (filter, “”); ]|

Returns

a new FileFilter

pub fn from_gvariant(variant: &Variant) -> FileFilter

Deserialize a file filter from an a{sv} variant in the format produced by to_gvariant().

variant

an a{sv} glib::Variant

Returns

a new FileFilter object

pub fn add_custom<P: Fn(&FileFilterInfo) -> bool + 'static>( &self, needed: FileFilterFlags, func: P, )

Adds rule to a filter that allows files based on a custom callback function. The bitfield 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.

needed

bitfield of flags indicating the information that the custom filter function needs.

func

callback function; if the function returns true, then the file will be displayed.

notify

function to call to free data when it is no longer needed.

pub fn add_mime_type(&self, mime_type: &str)

Adds a rule allowing a given mime type to self.

mime_type

name of a MIME type

pub fn add_pattern(&self, pattern: &str)

Adds a rule allowing a shell style glob to a filter.

pattern

a shell style glob

pub fn add_pixbuf_formats(&self)

Adds a rule allowing image files in the formats supported by GdkPixbuf.

pub fn filter(&self, filter_info: &FileFilterInfo) -> bool

Tests whether a file should be displayed according to self. The FileFilterInfo filter_info should include the fields returned from needed().

This function will not typically be used by applications; it is intended principally for use in the implementation of FileChooser.

filter_info

a FileFilterInfo containing information about a file.

Returns

true if the file should be displayed

pub fn name(&self) -> Option<GString>

Gets the human-readable name for the filter. See set_name().

Returns

The human-readable name of the filter, or None. This value is owned by GTK+ and must not be modified or freed.

pub fn needed(&self) -> FileFilterFlags

Gets the fields that need to be filled in for the FileFilterInfo passed to filter()

This function will not typically be used by applications; it is intended principally for use in the implementation of FileChooser.

Returns

bitfield of flags indicating needed fields when calling filter()

pub fn set_name(&self, name: Option<&str>)

Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters.

name

the human-readable-name for the filter, or None to remove any existing name.

pub fn to_gvariant(&self) -> Option<Variant>

Serialize a file filter to an a{sv} variant.

Returns

a new, floating, glib::Variant

Trait Implementations

impl Clone for FileFilter

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileFilter

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FileFilter

impl HasParamSpec for FileFilter

type ParamSpec = ParamSpecObject

type SetValue = FileFilter

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, FileFilter>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileFilter

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IsA<Buildable> for FileFilter

impl Ord for FileFilter

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for FileFilter

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FileFilter

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<OT: ObjectType> PartialOrd<OT> for FileFilter

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FileFilter

fn static_type() -> Type

Returns the type identifier of Self.