[][src]Trait gtk::SearchBarExt

pub trait SearchBarExt: 'static {
    fn connect_entry<P: IsA<Entry>>(&self, entry: &P);
fn get_search_mode(&self) -> bool;
fn get_show_close_button(&self) -> bool;
fn handle_event(&self, event: &Event) -> bool;
fn set_search_mode(&self, search_mode: bool);
fn set_show_close_button(&self, visible: bool);
fn get_property_search_mode_enabled(&self) -> bool;
fn set_property_search_mode_enabled(&self, search_mode_enabled: bool);
fn connect_property_search_mode_enabled_notify<F: Fn(&Self) + 'static>(
        f: F
    ) -> SignalHandlerId;
fn connect_property_show_close_button_notify<F: Fn(&Self) + 'static>(
        f: F
    ) -> SignalHandlerId; }

Trait containing all SearchBar methods.



Required methods

fn connect_entry<P: IsA<Entry>>(&self, entry: &P)

Connects the Entry widget passed as the one to be used in this search bar. The entry should be a descendant of the search bar. This is only required if the entry isn’t the direct child of the search bar (as in our main example).


a Entry

fn get_search_mode(&self) -> bool

Returns whether the search mode is on or off.


whether search mode is toggled on

fn get_show_close_button(&self) -> bool

Returns whether the close button is shown.


whether the close button is shown

fn handle_event(&self, event: &Event) -> bool

This function should be called when the top-level window which contains the search bar received a key event.

If the key event is handled by the search bar, the bar will be shown, the entry populated with the entered text and GDK_EVENT_STOP will be returned. The caller should ensure that events are not propagated further.

If no entry has been connected to the search bar, using SearchBarExt::connect_entry, this function will return immediately with a warning.

Showing the search bar on key presses

static gboolean
on_key_press_event (GtkWidget *widget,
                    GdkEvent  *event,
                    gpointer   user_data)
  GtkSearchBar *bar = GTK_SEARCH_BAR (user_data);
  return gtk_search_bar_handle_event (bar, event);

static void
create_toplevel (void)
  GtkWidget *window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  GtkWindow *search_bar = gtk_search_bar_new ();

 // Add more widgets to the window...

  g_signal_connect (window,
                    G_CALLBACK (on_key_press_event),


a GdkEvent containing key press events


GDK_EVENT_STOP if the key press event resulted in text being entered in the search entry (and revealing the search bar if necessary), GDK_EVENT_PROPAGATE otherwise.

fn set_search_mode(&self, search_mode: bool)

Switches the search mode on or off.


the new state of the search mode

fn set_show_close_button(&self, visible: bool)

Shows or hides the close button. Applications that already have a “search” toggle button should not show a close button in their search bar, as it duplicates the role of the toggle button.


whether the close button will be shown or not

fn get_property_search_mode_enabled(&self) -> bool

fn set_property_search_mode_enabled(&self, search_mode_enabled: bool)

fn connect_property_search_mode_enabled_notify<F: Fn(&Self) + 'static>(
    f: F
) -> SignalHandlerId

fn connect_property_show_close_button_notify<F: Fn(&Self) + 'static>(
    f: F
) -> SignalHandlerId

Loading content...


impl<O: IsA<SearchBar>> SearchBarExt for O[src]

Loading content...