Gtk.Tree_View.Set_Search_Equal_Func_User_Data

Entities

Generic formal parameters

Access Types

Subprograms

Description

Destroy

procedure Destroy (Data : in out User_Data_Type)
Parameters
Data

Gtk_Tree_View_Search_Equal_Func

type Gtk_Tree_View_Search_Equal_Func is access function
  (Model       : Gtk.Tree_Model.Gtk_Tree_Model;
   Column      : Glib.Gint;
   Key         : UTF8_String;
   Iter        : Gtk.Tree_Model.Gtk_Tree_Iter;
   Search_Data : User_Data_Type) return Boolean;

A function used for checking whether a row in Model matches a search key string entered by the user. Note the return value is reversed from what you would normally expect, though it has some similarity to strcmp returning 0 for equal strings.

Parameters
Model

the Gtk.Tree_Model.Gtk_Tree_Model being searched

Column

the search column set by Gtk.Tree_View.Set_Search_Column

Key

the key string to compare with

Iter

a Gtk.Tree_Model.Gtk_Tree_Iter pointing the row of Model that should be compared with Key.

Search_Data

user data from Gtk.Tree_View.Set_Search_Equal_Func

Return Value

False if the row matches, True otherwise.

Set_Search_Equal_Func

procedure Set_Search_Equal_Func
   (Tree_View         : not null access Gtk.Tree_View.Gtk_Tree_View_Record'Class;
    Search_Equal_Func : Gtk_Tree_View_Search_Equal_Func;
    Search_User_Data  : User_Data_Type;
    Search_Destroy    : Glib.G_Destroy_Notify_Address)

Sets the compare function for the interactive search capabilities; note that somewhat like strcmp returning 0 for equality Gtk_Tree_View_Search_Equal_Func returns False on matches.

Parameters
Tree_View
Search_Equal_Func

the compare function to use during the search

Search_User_Data

user data to pass to Search_Equal_Func, or null

Search_Destroy

Destroy notifier for Search_User_Data, or null

User_Data_Type

type User_Data_Type (<>) is private;