Gtk.Custom_Filter

Description

Determines whether to include items with a callback.

Get_Type

function Get_Type return Glib.GType

Return Value

Gtk_Custom_Filter

type Gtk_Custom_Filter is access all Gtk_Custom_Filter_Record'Class;

Gtk_Custom_Filter_Func

type Gtk_Custom_Filter_Func is access function (Item : Glib.Object.GObject) return Boolean;

User function that is called to determine if the Item should be matched. If the filter matches the item, this function must return true. If the item should be filtered out, false must be returned.

Parameters

Item

the item to be matched

Return Value

true to keep the item around

Gtk_Custom_Filter_New

function Gtk_Custom_Filter_New
  (Match_Func : Gtk_Custom_Filter_Func)
return Gtk_Custom_Filter

Creates a new filter using the given function to filter items. If Match_Func is NULL, the filter matches all items. If the filter func changes its filtering behavior, [methodGtk.Filter.changed] needs to be called.

Parameters

Match_Func

function to filter items

Return Value

Gtk_Custom_Filter_Record

type Gtk_Custom_Filter_Record is new Gtk_Filter_Record with null record;

Gtk_New

procedure Gtk_New
  (Self       : out Gtk_Custom_Filter;
   Match_Func : Gtk_Custom_Filter_Func)

Creates a new filter using the given function to filter items. If Match_Func is NULL, the filter matches all items. If the filter func changes its filtering behavior, [methodGtk.Filter.changed] needs to be called. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self

Match_Func

function to filter items

Initialize

procedure Initialize
  (Self       : not null access Gtk_Custom_Filter_Record'Class;
   Match_Func : Gtk_Custom_Filter_Func)

Creates a new filter using the given function to filter items. If Match_Func is NULL, the filter matches all items. If the filter func changes its filtering behavior, [methodGtk.Filter.changed] needs to be called. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters

Self

Match_Func

function to filter items

Set_Filter_Func

procedure Set_Filter_Func
  (Self       : not null access Gtk_Custom_Filter_Record;
   Match_Func : Gtk_Custom_Filter_Func)

Sets the function used for filtering items. If Match_Func is NULL, the filter matches all items. If the filter func changes its filtering behavior, [methodGtk.Filter.changed] needs to be called. If a previous function was set, its User_Destroy will be called.

Parameters

Self

Match_Func

function to filter items