Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
SearchBar
is a container made to have a search entry (possibly
with additional connex widgets, such as drop-down menus, or buttons)
built-in. 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
searchBarSetKeyCaptureWidget
. 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 searchBarConnectEntry
.
The following example shows you how to create a more complex search
entry.
CSS nodes
plain code
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.
Creating a search bar
Synopsis
- newtype SearchBar = SearchBar (ManagedPtr SearchBar)
- class (GObject o, IsDescendantOf SearchBar o) => IsSearchBar o
- toSearchBar :: (MonadIO m, IsSearchBar o) => o -> m SearchBar
- noSearchBar :: Maybe SearchBar
- searchBarConnectEntry :: (HasCallStack, MonadIO m, IsSearchBar a, IsEditable b) => a -> b -> m ()
- searchBarGetKeyCaptureWidget :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> m Widget
- searchBarGetSearchMode :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> m Bool
- searchBarGetShowCloseButton :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> m Bool
- searchBarNew :: (HasCallStack, MonadIO m) => m SearchBar
- searchBarSetKeyCaptureWidget :: (HasCallStack, MonadIO m, IsSearchBar a, IsWidget b) => a -> Maybe b -> m ()
- searchBarSetSearchMode :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> Bool -> m ()
- searchBarSetShowCloseButton :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> Bool -> m ()
- constructSearchBarSearchModeEnabled :: IsSearchBar o => Bool -> IO (GValueConstruct o)
- getSearchBarSearchModeEnabled :: (MonadIO m, IsSearchBar o) => o -> m Bool
- setSearchBarSearchModeEnabled :: (MonadIO m, IsSearchBar o) => o -> Bool -> m ()
- constructSearchBarShowCloseButton :: IsSearchBar o => Bool -> IO (GValueConstruct o)
- getSearchBarShowCloseButton :: (MonadIO m, IsSearchBar o) => o -> m Bool
- setSearchBarShowCloseButton :: (MonadIO m, IsSearchBar o) => o -> Bool -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq SearchBar Source # | |
IsGValue SearchBar Source # | Convert |
GObject SearchBar Source # | |
Defined in GI.Gtk.Objects.SearchBar gobjectType :: IO GType # | |
HasParentTypes SearchBar Source # | |
Defined in GI.Gtk.Objects.SearchBar | |
type ParentTypes SearchBar Source # | |
Defined in GI.Gtk.Objects.SearchBar |
class (GObject o, IsDescendantOf SearchBar o) => IsSearchBar o Source #
Type class for types which can be safely cast to SearchBar
, for instance with toSearchBar
.
Instances
(GObject o, IsDescendantOf SearchBar o) => IsSearchBar o Source # | |
Defined in GI.Gtk.Objects.SearchBar |
toSearchBar :: (MonadIO m, IsSearchBar o) => o -> m SearchBar Source #
Methods
Overloaded methods
connectEntry
searchBarConnectEntry Source #
:: (HasCallStack, MonadIO m, IsSearchBar a, IsEditable b) | |
=> a |
|
-> b |
|
-> m () |
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).
getKeyCaptureWidget
searchBarGetKeyCaptureWidget Source #
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> m Widget | Returns: The key capture widget. |
Gets the widget that bar
is capturing key events from.
getSearchMode
searchBarGetSearchMode Source #
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> m Bool | Returns: whether search mode is toggled on |
Returns whether the search mode is on or off.
getShowCloseButton
searchBarGetShowCloseButton Source #
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> m Bool | Returns: whether the close button is shown |
Returns whether the close button is shown.
new
:: (HasCallStack, MonadIO m) | |
=> m SearchBar | Returns: a new |
Creates a SearchBar
. You will need to tell it about
which widget is going to be your text entry using
searchBarConnectEntry
.
setKeyCaptureWidget
searchBarSetKeyCaptureWidget Source #
:: (HasCallStack, MonadIO m, IsSearchBar a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
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.
setSearchMode
searchBarSetSearchMode Source #
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> Bool |
|
-> m () |
Switches the search mode on or off.
setShowCloseButton
searchBarSetShowCloseButton Source #
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> Bool |
|
-> m () |
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.
Properties
searchModeEnabled
Whether the search mode is on and the search bar shown.
See searchBarSetSearchMode
for details.
constructSearchBarSearchModeEnabled :: IsSearchBar o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “search-mode-enabled
” property. This is rarely needed directly, but it is used by new
.
getSearchBarSearchModeEnabled :: (MonadIO m, IsSearchBar o) => o -> m Bool Source #
Get the value of the “search-mode-enabled
” property.
When overloading is enabled, this is equivalent to
get
searchBar #searchModeEnabled
setSearchBarSearchModeEnabled :: (MonadIO m, IsSearchBar o) => o -> Bool -> m () Source #
Set the value of the “search-mode-enabled
” property.
When overloading is enabled, this is equivalent to
set
searchBar [ #searchModeEnabled:=
value ]
showCloseButton
Whether to show the close button in the search bar.
constructSearchBarShowCloseButton :: IsSearchBar o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “show-close-button
” property. This is rarely needed directly, but it is used by new
.
getSearchBarShowCloseButton :: (MonadIO m, IsSearchBar o) => o -> m Bool Source #
Get the value of the “show-close-button
” property.
When overloading is enabled, this is equivalent to
get
searchBar #showCloseButton
setSearchBarShowCloseButton :: (MonadIO m, IsSearchBar o) => o -> Bool -> m () Source #
Set the value of the “show-close-button
” property.
When overloading is enabled, this is equivalent to
set
searchBar [ #showCloseButton:=
value ]