Gtk.StringFilter – gtk4 – Vala Binding Reference

Description:

[ CCode ( type_id = "gtk_string_filter_get_type ()" ) ]
public class StringFilter : Filter

`GtkStringFilter` determines whether to include items by comparing strings to a fixed search term.

The strings are obtained from the items by evaluating a `GtkExpression` set with [[email protected]_expression], and they are compared against a search term set with [[email protected]_search].

`GtkStringFilter` has several different modes of comparison - it can match the whole string, just a prefix, or any substring. Use [ [email protected]_match_mode] choose a mode.

It is also possible to make case-insensitive comparisons, with [[email protected]_ignore_case].

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Expression expression { get; set; }

The expression to evaluate on item to get a string to compare with.

public bool ignore_case { get; set; }

If matching is case sensitive.

public StringFilterMatchMode match_mode { get; set; }

If exact matches are necessary or if substrings are allowed.

public string search { get; set; }

The search term.

Creation methods:

public StringFilter (owned Expression? expression)

Creates a new string filter.

Methods:

public unowned Expression? get_expression ()

Gets the expression that the string filter uses to obtain strings from items.

public bool get_ignore_case ()

Returns whether the filter ignores case differences.

public StringFilterMatchMode get_match_mode ()

Returns the match mode that the filter is using.

public unowned string? get_search ()

Gets the search term.

public void set_expression (Expression? expression)

Sets the expression that the string filter uses to obtain strings from items.

public void set_ignore_case (bool ignore_case)

Sets whether the filter ignores case differences.

public void set_match_mode (StringFilterMatchMode mode)

Sets the match mode for the filter.

public void set_search (string? search)

Sets the string to search for.

Inherited Members:

All known members inherited from class Gtk.Filter

changed

get_strictness

match

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref