OssoABookLiveSearch

OssoABookLiveSearch — A widget for manipulating contact filters.

Synopsis

                    OssoABookLiveSearch;
GtkWidget*          osso_abook_live_search_new          (void);
void                osso_abook_live_search_append_text  (OssoABookLiveSearch *livesearch,
                                                         const char *utf8);
const char*         osso_abook_live_search_get_text     (OssoABookLiveSearch *livesearch);
void                osso_abook_live_search_set_filter   (OssoABookLiveSearch *livesearch,
                                                         OssoABookFilterModel *filter);
void                osso_abook_live_search_widget_hook  (OssoABookLiveSearch *livesearch,
                                                         GtkWidget *widget,
                                                         GtkTreeView *kb_focus);
void                osso_abook_live_search_widget_unhook
                                                        (OssoABookLiveSearch *livesearch);
void                osso_abook_live_search_save_state   (OssoABookLiveSearch *livesearch,
                                                         GKeyFile *key_file);
void                osso_abook_live_search_restore_state
                                                        (OssoABookLiveSearch *livesearch,
                                                         GKeyFile *key_file);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkToolbar
                                 +----OssoABookLiveSearch

Implemented Interfaces

OssoABookLiveSearch implements AtkImplementorIface, GtkBuildable and GtkToolShell.

Properties

  "filter"                   OssoABookFilterModel*  : Read / Write

Description

This widget provides a user interface for manipulating OssoABookFilterModel instances.

Details

OssoABookLiveSearch

typedef struct _OssoABookLiveSearch OssoABookLiveSearch;

All the fields of this structure are private to the object's implementation and should never be accessed directly.


osso_abook_live_search_new ()

GtkWidget*          osso_abook_live_search_new          (void);

Creates and returns a new OssoABookLiveSearch widget.

Returns : The newly created live search widget.

osso_abook_live_search_append_text ()

void                osso_abook_live_search_append_text  (OssoABookLiveSearch *livesearch,
                                                         const char *utf8);

Appends a string to the entry text in the live search widget.

livesearch : An OssoABookLiveSearch widget
utf8 : The text to append. This text is copied internally, and utf8 can be freed later by the caller.

osso_abook_live_search_get_text ()

const char*         osso_abook_live_search_get_text     (OssoABookLiveSearch *livesearch);

Retrieves the text contents of the OssoABookLiveSearch widget.

livesearch : An OssoABookLiveSearch widget
Returns : a pointer to the text contents of the widget as a string. This string points to an internal widget buffer and must not be freed, modified or stored.

osso_abook_live_search_set_filter ()

void                osso_abook_live_search_set_filter   (OssoABookLiveSearch *livesearch,
                                                         OssoABookFilterModel *filter);

Sets the filter for livesearch.

livesearch : An OssoABookLiveSearch widget
filter : a OssoABookFilterModel, or NULL

osso_abook_live_search_widget_hook ()

void                osso_abook_live_search_widget_hook  (OssoABookLiveSearch *livesearch,
                                                         GtkWidget *widget,
                                                         GtkTreeView *kb_focus);

This function must be called after an OssoABookLiveSearch widget is constructed to set the hook widget and the focus widget for livesearch. After that, the OssoABookLiveSearch widget can be packed into a container and used.

livesearch : An OssoABookLiveSearch widget
hook_widget : A widget on which we listen for key events
kb_focus : The widget which we grab focus on

osso_abook_live_search_widget_unhook ()

void                osso_abook_live_search_widget_unhook
                                                        (OssoABookLiveSearch *livesearch);

This function unsets the hook and focus widgets which were set earlier using osso_abook_live_search_widget_hook().

livesearch : An OssoABookLiveSearch widget

osso_abook_live_search_save_state ()

void                osso_abook_live_search_save_state   (OssoABookLiveSearch *livesearch,
                                                         GKeyFile *key_file);

Saves the live search text to a GKeyFile.

livesearch : An OssoABookLiveSearch widget
key_file : The key file to save to

osso_abook_live_search_restore_state ()

void                osso_abook_live_search_restore_state
                                                        (OssoABookLiveSearch *livesearch,
                                                         GKeyFile *key_file);

Restores a live search widget's text from a GKeyFile.

livesearch : An OssoABookLiveSearch widget
key_file : The key file to read from

Property Details

The "filter" property

  "filter"                   OssoABookFilterModel*  : Read / Write

Model filter.