Package org.gnome.gtk

Class StringFilter

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.Filter

org.gnome.gtk.StringFilter

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class StringFilter
extends 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 setExpression(org.gnome.gtk.Expression), and they are compared against a search term set with setSearch(java.lang.String).

GtkStringFilter has several different modes of comparison - it can match the whole string, just a prefix, or any substring. Use setMatchMode(org.gnome.gtk.StringFilterMatchMode) choose a mode.

It is also possible to make case-insensitive comparisons, with setIgnoreCase(boolean).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringFilter.Builder<B extends StringFilter.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	StringFilter.StringFilterClass

Nested classes/interfaces inherited from class org.gnome.gtk.Filter

Filter.ChangedCallback, Filter.FilterClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
StringFilter()	Calls StringFilter(org.gnome.gtk.Expression) with expression = null
StringFilter(MemorySegment address)	Create a StringFilter proxy instance for the provided memory address.
StringFilter(@Nullable Expression expression)	Creates a new string filter.

Method Summary

Modifier and Type	Method	Description
protected StringFilter	asParent()	Returns this instance as if it were its parent type.
static StringFilter.Builder<? extends StringFilter.Builder>	builder()	A StringFilter.Builder object constructs a StringFilter with the specified properties.
Expression	getExpression()	Gets the expression that the string filter uses to obtain strings from items.
boolean	getIgnoreCase()	Returns whether the filter ignores case differences.
StringFilterMatchMode	getMatchMode()	Returns the match mode that the filter is using.
String	getSearch()	Gets the search term.
static Type	getType()	Get the GType of the StringFilter class
void	setExpression(@Nullable Expression expression)	Sets the expression that the string filter uses to obtain strings from items.
void	setIgnoreCase(boolean ignoreCase)	Sets whether the filter ignores case differences.
void	setMatchMode(StringFilterMatchMode mode)	Sets the match mode for the filter.
void	setSearch(@Nullable String search)	Sets the string to search for.

Methods inherited from class org.gnome.gtk.Filter

changed, emitChanged, getMemoryLayout, getStrictness, match, onChanged

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StringFilter

public StringFilter(MemorySegment address)

Create a StringFilter proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

StringFilter

public StringFilter(@Nullable
 @Nullable Expression expression)

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.

Parameters:

expression - The expression to evaluate

StringFilter

public StringFilter()

Calls StringFilter(org.gnome.gtk.Expression) with expression = null

Method Details

getType

public static Type getType()

Get the GType of the StringFilter class

Returns:

the GType

asParent

protected StringFilter asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Filter

getExpression

public Expression getExpression()

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

Returns:

a GtkExpression

getIgnoreCase

public boolean getIgnoreCase()

Returns whether the filter ignores case differences.

Returns:

true if the filter ignores case

getMatchMode

public StringFilterMatchMode getMatchMode()

Returns the match mode that the filter is using.

Returns:

the match mode of the filter

getSearch

public String getSearch()

Gets the search term.

Returns:

The search term

setExpression

public void setExpression(@Nullable
 @Nullable Expression expression)

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

The expression must have a value type of G_TYPE_STRING.

Parameters:

expression - a GtkExpression

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

Sets whether the filter ignores case differences.

Parameters:

ignoreCase - true to ignore case

setMatchMode

public void setMatchMode(StringFilterMatchMode mode)

Sets the match mode for the filter.

Parameters:

mode - the new match mode

setSearch

public void setSearch(@Nullable
 @Nullable String search)

Sets the string to search for.

Parameters:

search - The string to search for or null to clear the search

builder

public static StringFilter.Builder<? extends StringFilter.Builder> builder()

A StringFilter.Builder object constructs a StringFilter with the specified properties. Use the various set...() methods to set properties, and finish construction with StringFilter.Builder.build().