Package ch.bailu.gtk.gtk

Class SearchBar

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gobject.InitiallyUnowned
ch.bailu.gtk.gtk.Widget
ch.bailu.gtk.gtk.SearchBar
All Implemented Interfaces:
PointerInterface
public class SearchBar extends Widget
`GtkSearchBar` is a container made to have a search entry.

![An example GtkSearchBar](search-bar.png)

It can also contain additional widgets, such as drop-down menus,
or buttons. The search bar would appear when a search is started
through typing on the keyboard, or the application’s search mode
is toggled on.

For keyboard presses to start a search, the search bar must be told
of a widget to capture key events from through
[method@Gtk.SearchBar.set_key_capture_widget]. This widget will
typically be the top-level window, or a parent container of the
search bar. Common shortcuts such as Ctrl+F should be handled as an
application action, or through the menu items.

You will also need to tell the search bar about which entry you
are using as your search entry using [method@Gtk.SearchBar.connect_entry].

## Creating a search bar

The following example shows you how to create a more complex search
entry.

[A simple example](https://gitlab.gnome.org/GNOME/gtk/tree/main/examples/search-bar.c)

# CSS nodes

```
searchbar
╰── revealer
╰── box
├── [child]
╰── [button.close]
```

`GtkSearchBar` has a main CSS node with name searchbar. It has a child
node with name revealer that contains a node with name box. The box node
contains both the CSS node of the child widget as well as an optional button
node which gets the .close style class applied.

# Accessibility

`GtkSearchBar` uses the %GTK_ACCESSIBLE_ROLE_SEARCH role.

https://docs.gtk.org/gtk4/class.SearchBar.html

  • Constructor Details

    • SearchBar

      public SearchBar(PointerContainer pointer)

    • SearchBar

      public SearchBar()
      Creates a `GtkSearchBar`.

      You will need to tell it about which widget is going to be your text
      entry using [method@Gtk.SearchBar.connect_entry].

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • connectEntry

      public void connectEntry(@Nonnull Editable entry)
      Connects the `GtkEditable widget passed as the one to be used in
      this search bar.

      The entry should be a descendant of the search bar. Calling this
      function manually is only required if the entry isn’t the direct
      child of the search bar (as in our main example).
      Parameters:
      entry - a `GtkEditable`

    • getChild

      public Widget getChild()
      Gets the child widget of @bar.
      Returns:
      the child widget of @bar

    • getKeyCaptureWidget

      public Widget getKeyCaptureWidget()
      Gets the widget that @bar is capturing key events from.
      Returns:
      The key capture widget.

    • getSearchMode

      public boolean getSearchMode()
      Returns whether the search mode is on or off.
      Returns:
      whether search mode is toggled on

    • getShowCloseButton

      public boolean getShowCloseButton()
      Returns whether the close button is shown.
      Returns:
      whether the close button is shown

    • setChild

      public void setChild(@Nullable Widget child)
      Sets the child widget of @bar.
      Parameters:
      child - the child widget

    • setKeyCaptureWidget

      public void setKeyCaptureWidget(@Nullable Widget widget)
      Sets @widget as the widget that @bar will capture key events
      from.

      If key events are handled by the search bar, the bar will
      be shown, and the entry populated with the entered text.

      Note that despite the name of this function, the events
      are only 'captured' in the bubble phase, which means that
      editable child widgets of @widget will receive text input
      before it gets captured. If that is not desired, you can
      capture and forward the events yourself with
      [method@Gtk.EventControllerKey.forward].
      Parameters:
      widget - a `GtkWidget`

    • setSearchMode

      public void setSearchMode(boolean search_mode)
      Switches the search mode on or off.
      Parameters:
      search_mode - the new state of the search mode

    • setShowCloseButton

      public void setShowCloseButton(boolean visible)
      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.
      Parameters:
      visible - whether the close button will be shown or not

    • asAccessible

      public Accessible asAccessible()
      Implements interface Accessible. Call this to get access to interface functions.
      Overrides:
      asAccessible in class Widget
      Returns:
      Accessible

    • asBuildable

      public Buildable asBuildable()
      Implements interface Buildable. Call this to get access to interface functions.
      Overrides:
      asBuildable in class Widget
      Returns:
      Buildable

    • asConstraintTarget

      public ConstraintTarget asConstraintTarget()
      Implements interface ConstraintTarget. Call this to get access to interface functions.
      Overrides:
      asConstraintTarget in class Widget
      Returns:
      ConstraintTarget

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()