Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype SearchBar = SearchBar (ManagedPtr SearchBar)
- class (GObject o, IsDescendantOf SearchBar o) => IsSearchBar o
- toSearchBar :: (MonadIO m, IsSearchBar o) => o -> m SearchBar
- searchBarConnectEntry :: (HasCallStack, MonadIO m, IsSearchBar a, IsEntry b) => a -> b -> m ()
- searchBarGetSearchMode :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> m Bool
- searchBarGetShowCloseButton :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> m Bool
- searchBarHandleEvent :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> Event -> m Bool
- searchBarNew :: (HasCallStack, MonadIO m) => m SearchBar
- searchBarSetSearchMode :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> Bool -> m ()
- searchBarSetShowCloseButton :: (HasCallStack, MonadIO m, IsSearchBar a) => a -> Bool -> m ()
- constructSearchBarSearchModeEnabled :: (IsSearchBar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getSearchBarSearchModeEnabled :: (MonadIO m, IsSearchBar o) => o -> m Bool
- setSearchBarSearchModeEnabled :: (MonadIO m, IsSearchBar o) => o -> Bool -> m ()
- constructSearchBarShowCloseButton :: (IsSearchBar o, MonadIO m) => Bool -> m (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 # | |
GObject SearchBar Source # | |
Defined in GI.Handy.Objects.SearchBar | |
ManagedPtrNewtype SearchBar Source # | |
Defined in GI.Handy.Objects.SearchBar | |
TypedObject SearchBar Source # | |
Defined in GI.Handy.Objects.SearchBar | |
HasParentTypes SearchBar Source # | |
Defined in GI.Handy.Objects.SearchBar | |
IsGValue (Maybe SearchBar) Source # | Convert |
Defined in GI.Handy.Objects.SearchBar | |
type ParentTypes SearchBar Source # | |
Defined in GI.Handy.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.Handy.Objects.SearchBar |
toSearchBar :: (MonadIO m, IsSearchBar o) => o -> m SearchBar Source #
Methods
Click to display all available methods, including inherited ones
Methods
activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, connectEntry, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, handleEvent, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.
Getters
getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSearchMode, getSensitive, getSettings, getShowCloseButton, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSearchMode, setSensitive, setShowCloseButton, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
connectEntry
searchBarConnectEntry Source #
:: (HasCallStack, MonadIO m, IsSearchBar a, IsEntry 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).
Since: 0.0.6
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.
Since: 0.0.6
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.
Since: 0.0.6
handleEvent
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> Event |
|
-> m Bool | Returns: |
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 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
searchBarConnectEntry
, this function will return
immediately with a warning.
Showing the search bar on key presses
C code
static gboolean on_key_press_event (GtkWidget *widget, GdkEvent *event, gpointer user_data) { HdySearchBar *bar = HDY_SEARCH_BAR (user_data); return hdy_search_bar_handle_event (self, event); } static void create_toplevel (void) { GtkWidget *window = gtk_window_new (GTK_WINDOW_TOPLEVEL); GtkWindow *search_bar = hdy_search_bar_new (); // Add more widgets to the window... g_signal_connect (window, "key-press-event", G_CALLBACK (on_key_press_event), search_bar); }
Since: 0.0.6
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
.
Since: 0.0.6
setSearchMode
searchBarSetSearchMode Source #
:: (HasCallStack, MonadIO m, IsSearchBar a) | |
=> a |
|
-> Bool |
|
-> m () |
Switches the search mode on or off.
Since: 0.0.6
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.
Since: 0.0.6
Properties
searchModeEnabled
Whether the search mode is on and the search bar shown.
See searchBarSetSearchMode
for details.
constructSearchBarSearchModeEnabled :: (IsSearchBar o, MonadIO m) => Bool -> m (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 toolbar.
constructSearchBarShowCloseButton :: (IsSearchBar o, MonadIO m) => Bool -> m (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 ]