class Gtk::StringFilter

Overview

Gtk::StringFilter determines whether to include items by comparing strings to a fixed search term.

The strings are obtained from the items by evaluating a Gtk::Expression set with Gtk::StringFilter#expression=, and they are compared against a search term set with Gtk::StringFilter#search=.

Gtk::StringFilter has several different modes of comparison - it can match the whole string, just a prefix, or any substring. Use Gtk::StringFilter#match_mode= choose a mode.

It is also possible to make case-insensitive comparisons, with Gtk::StringFilter#ignore_case=.

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/string_filter.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Gtk::Filter

==(other : self) ==, changed(change : Gtk::FilterChange) : Nil changed, changed_signal changed_signal, hash(hasher) hash, match(item : GObject::Object) : Bool match, strictness : Gtk::FilterMatch strictness

Constructor methods inherited from class Gtk::Filter

new new

Class methods inherited from class Gtk::Filter

g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(expression : Gtk::Expression | Nil) : self #

Creates a new string filter.

You will want to set up the filter by providing a string to search for and by providing a property to look up on the item.


[View source]
def self.new #

Initialize a new StringFilter.


[View source]
def self.new(*, expression : Gtk::Expression | Nil = nil, ignore_case : Bool | Nil = nil, match_mode : Gtk::StringFilterMatchMode | Nil = nil, search : String | Nil = nil) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def expression : Gtk::Expression | Nil #

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


[View source]
def expression=(expression : Gtk::Expression | Nil) : Nil #

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

The expression must have a value type of %G_TYPE_STRING.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def ignore_case : Bool #

Returns whether the filter ignores case differences.


[View source]
def ignore_case=(ignore_case : Bool) : Nil #

Sets whether the filter ignores case differences.


[View source]
def ignore_case? : Bool #

[View source]
def match_mode : Gtk::StringFilterMatchMode #

Returns the match mode that the filter is using.


[View source]
def match_mode=(mode : Gtk::StringFilterMatchMode) : Nil #

Sets the match mode for the filter.


[View source]
def search : String | Nil #

Gets the search term.


[View source]
def search=(value : String) : String #

[View source]
def search=(value : Nil) : Nil #

Set #search property to nil.


[View source]
def search=(search : String | Nil) : Nil #

Sets the string to search for.


[View source]
def search? : String | Nil #

Same as #search, but can return nil.


[View source]