Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Exported types
- Methods
- getEllipsizeMode
- getExpand
- getHomogeneous
- getIconSize
- getIsImportant
- getOrientation
- getProxyMenuItem
- getReliefStyle
- getTextAlignment
- getTextOrientation
- getTextSizeGroup
- getToolbarStyle
- getUseDragWindow
- getVisibleHorizontal
- getVisibleVertical
- new
- rebuildMenu
- retrieveProxyMenuItem
- setExpand
- setHomogeneous
- setIsImportant
- setProxyMenuItem
- setTooltipMarkup
- setTooltipText
- setUseDragWindow
- setVisibleHorizontal
- setVisibleVertical
- toolbarReconfigured
- Properties
- Signals
GtkToolItems
are widgets that can appear on a toolbar. To
create a toolbar item that contain something else than a button, use
toolItemNew
. Use containerAdd
to add a child
widget to the tool item.
For toolbar items that contain buttons, see the ToolButton
,
ToggleToolButton
and RadioToolButton
classes.
See the Toolbar
class for a description of the toolbar widget, and
ToolShell
for a description of the tool shell interface.
Synopsis
- newtype ToolItem = ToolItem (ManagedPtr ToolItem)
- class (GObject o, IsDescendantOf ToolItem o) => IsToolItem o
- toToolItem :: (MonadIO m, IsToolItem o) => o -> m ToolItem
- toolItemGetEllipsizeMode :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m EllipsizeMode
- toolItemGetExpand :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Bool
- toolItemGetHomogeneous :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Bool
- toolItemGetIconSize :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Int32
- toolItemGetIsImportant :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Bool
- toolItemGetOrientation :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Orientation
- toolItemGetProxyMenuItem :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Text -> m (Maybe Widget)
- toolItemGetReliefStyle :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m ReliefStyle
- toolItemGetTextAlignment :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Float
- toolItemGetTextOrientation :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Orientation
- toolItemGetTextSizeGroup :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m SizeGroup
- toolItemGetToolbarStyle :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m ToolbarStyle
- toolItemGetUseDragWindow :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Bool
- toolItemGetVisibleHorizontal :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Bool
- toolItemGetVisibleVertical :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Bool
- toolItemNew :: (HasCallStack, MonadIO m) => m ToolItem
- toolItemRebuildMenu :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m ()
- toolItemRetrieveProxyMenuItem :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m Widget
- toolItemSetExpand :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Bool -> m ()
- toolItemSetHomogeneous :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Bool -> m ()
- toolItemSetIsImportant :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Bool -> m ()
- toolItemSetProxyMenuItem :: (HasCallStack, MonadIO m, IsToolItem a, IsWidget b) => a -> Text -> Maybe b -> m ()
- toolItemSetTooltipMarkup :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Text -> m ()
- toolItemSetTooltipText :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Text -> m ()
- toolItemSetUseDragWindow :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Bool -> m ()
- toolItemSetVisibleHorizontal :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Bool -> m ()
- toolItemSetVisibleVertical :: (HasCallStack, MonadIO m, IsToolItem a) => a -> Bool -> m ()
- toolItemToolbarReconfigured :: (HasCallStack, MonadIO m, IsToolItem a) => a -> m ()
- constructToolItemIsImportant :: (IsToolItem o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolItemIsImportant :: (MonadIO m, IsToolItem o) => o -> m Bool
- setToolItemIsImportant :: (MonadIO m, IsToolItem o) => o -> Bool -> m ()
- constructToolItemVisibleHorizontal :: (IsToolItem o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolItemVisibleHorizontal :: (MonadIO m, IsToolItem o) => o -> m Bool
- setToolItemVisibleHorizontal :: (MonadIO m, IsToolItem o) => o -> Bool -> m ()
- constructToolItemVisibleVertical :: (IsToolItem o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolItemVisibleVertical :: (MonadIO m, IsToolItem o) => o -> m Bool
- setToolItemVisibleVertical :: (MonadIO m, IsToolItem o) => o -> Bool -> m ()
- type C_ToolItemCreateMenuProxyCallback = Ptr () -> Ptr () -> IO CInt
- type ToolItemCreateMenuProxyCallback = IO Bool
- afterToolItemCreateMenuProxy :: (IsToolItem a, MonadIO m) => a -> ToolItemCreateMenuProxyCallback -> m SignalHandlerId
- genClosure_ToolItemCreateMenuProxy :: MonadIO m => ToolItemCreateMenuProxyCallback -> m (GClosure C_ToolItemCreateMenuProxyCallback)
- mk_ToolItemCreateMenuProxyCallback :: C_ToolItemCreateMenuProxyCallback -> IO (FunPtr C_ToolItemCreateMenuProxyCallback)
- noToolItemCreateMenuProxyCallback :: Maybe ToolItemCreateMenuProxyCallback
- onToolItemCreateMenuProxy :: (IsToolItem a, MonadIO m) => a -> ToolItemCreateMenuProxyCallback -> m SignalHandlerId
- wrap_ToolItemCreateMenuProxyCallback :: ToolItemCreateMenuProxyCallback -> C_ToolItemCreateMenuProxyCallback
- type C_ToolItemToolbarReconfiguredCallback = Ptr () -> Ptr () -> IO ()
- type ToolItemToolbarReconfiguredCallback = IO ()
- afterToolItemToolbarReconfigured :: (IsToolItem a, MonadIO m) => a -> ToolItemToolbarReconfiguredCallback -> m SignalHandlerId
- genClosure_ToolItemToolbarReconfigured :: MonadIO m => ToolItemToolbarReconfiguredCallback -> m (GClosure C_ToolItemToolbarReconfiguredCallback)
- mk_ToolItemToolbarReconfiguredCallback :: C_ToolItemToolbarReconfiguredCallback -> IO (FunPtr C_ToolItemToolbarReconfiguredCallback)
- noToolItemToolbarReconfiguredCallback :: Maybe ToolItemToolbarReconfiguredCallback
- onToolItemToolbarReconfigured :: (IsToolItem a, MonadIO m) => a -> ToolItemToolbarReconfiguredCallback -> m SignalHandlerId
- wrap_ToolItemToolbarReconfiguredCallback :: ToolItemToolbarReconfiguredCallback -> C_ToolItemToolbarReconfiguredCallback
Exported types
Memory-managed wrapper type.
Instances
Eq ToolItem Source # | |
GObject ToolItem Source # | |
Defined in GI.Gtk.Objects.ToolItem | |
ManagedPtrNewtype ToolItem Source # | |
Defined in GI.Gtk.Objects.ToolItem toManagedPtr :: ToolItem -> ManagedPtr ToolItem | |
TypedObject ToolItem Source # | |
Defined in GI.Gtk.Objects.ToolItem | |
HasParentTypes ToolItem Source # | |
Defined in GI.Gtk.Objects.ToolItem | |
IsGValue (Maybe ToolItem) Source # | Convert |
Defined in GI.Gtk.Objects.ToolItem gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ToolItem -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ToolItem) | |
type ParentTypes ToolItem Source # | |
Defined in GI.Gtk.Objects.ToolItem |
class (GObject o, IsDescendantOf ToolItem o) => IsToolItem o Source #
Type class for types which can be safely cast to ToolItem
, for instance with toToolItem
.
Instances
(GObject o, IsDescendantOf ToolItem o) => IsToolItem o Source # | |
Defined in GI.Gtk.Objects.ToolItem |
toToolItem :: (MonadIO m, IsToolItem o) => o -> m ToolItem 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, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, doSetRelatedAction, 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, 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, rebuildMenu, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, retrieveProxyMenuItem, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, toolbarReconfigured, 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, getEllipsizeMode, getEvents, getExpand, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getIconSize, getInternalChild, getIsImportant, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getProxyMenuItem, getQdata, getRealized, getReceivesDefault, getRelatedAction, getReliefStyle, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTextAlignment, getTextOrientation, getTextSizeGroup, getToolbarStyle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseActionAppearance, getUseDragWindow, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleHorizontal, getVisibleVertical, getVisual, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setExpand, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setIsImportant, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setProxyMenuItem, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setRelatedAction, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseActionAppearance, setUseDragWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisibleHorizontal, setVisibleVertical, setVisual, setWindow.
getEllipsizeMode
toolItemGetEllipsizeMode Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m EllipsizeMode | Returns: a |
Returns the ellipsize mode used for toolItem
. Custom subclasses of
ToolItem
should call this function to find out how text should
be ellipsized.
Since: 2.20
getExpand
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether toolItem
is allocated extra space.
See toolItemSetExpand
.
Since: 2.4
getHomogeneous
toolItemGetHomogeneous Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether toolItem
is the same size as other homogeneous
items. See toolItemSetHomogeneous
.
Since: 2.4
getIconSize
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Int32 | Returns: a |
Returns the icon size used for toolItem
. Custom subclasses of
ToolItem
should call this function to find out what size icons
they should use.
Since: 2.4
getIsImportant
toolItemGetIsImportant Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether toolItem
is considered important. See
toolItemSetIsImportant
Since: 2.4
getOrientation
toolItemGetOrientation Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Orientation | Returns: a |
Returns the orientation used for toolItem
. Custom subclasses of
ToolItem
should call this function to find out what size icons
they should use.
Since: 2.4
getProxyMenuItem
toolItemGetProxyMenuItem Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Text |
|
-> m (Maybe Widget) | Returns: The |
If menuItemId
matches the string passed to
toolItemSetProxyMenuItem
return the corresponding MenuItem
.
Custom subclasses of ToolItem
should use this function to
update their menu item when the ToolItem
changes. That the
menuItemIds
must match ensures that a ToolItem
will not inadvertently change a menu item that they did not create.
Since: 2.4
getReliefStyle
toolItemGetReliefStyle Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m ReliefStyle | Returns: a |
Returns the relief style of toolItem
. See buttonSetRelief
.
Custom subclasses of ToolItem
should call this function in the handler
of the ToolItem
::toolbar_reconfigured
signal to find out the
relief style of buttons.
Since: 2.4
getTextAlignment
toolItemGetTextAlignment Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Float | Returns: a |
Returns the text alignment used for toolItem
. Custom subclasses of
ToolItem
should call this function to find out how text should
be aligned.
Since: 2.20
getTextOrientation
toolItemGetTextOrientation Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Orientation | Returns: a |
Returns the text orientation used for toolItem
. Custom subclasses of
ToolItem
should call this function to find out how text should
be orientated.
Since: 2.20
getTextSizeGroup
toolItemGetTextSizeGroup Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m SizeGroup | Returns: a |
Returns the size group used for labels in toolItem
.
Custom subclasses of ToolItem
should call this function
and use the size group for labels.
Since: 2.20
getToolbarStyle
toolItemGetToolbarStyle Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m ToolbarStyle | Returns: A |
Returns the toolbar style used for toolItem
. Custom subclasses of
ToolItem
should call this function in the handler of the
GtkToolItem[toolbar_reconfigured](#g:signal:toolbar_reconfigured) signal to find out in what style
the toolbar is displayed and change themselves accordingly
Possibilities are:
ToolbarStyleBoth
, meaning the tool item should show both an icon and a label, stacked verticallyToolbarStyleIcons
, meaning the toolbar shows only iconsToolbarStyleText
, meaning the tool item should only show textToolbarStyleBothHoriz
, meaning the tool item should show both an icon and a label, arranged horizontally
Since: 2.4
getUseDragWindow
toolItemGetUseDragWindow Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether toolItem
has a drag window. See
toolItemSetUseDragWindow
.
Since: 2.4
getVisibleHorizontal
toolItemGetVisibleHorizontal Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the toolItem
is visible on toolbars that are
docked horizontally.
Since: 2.4
getVisibleVertical
toolItemGetVisibleVertical Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Bool | Returns: Whether |
Returns whether toolItem
is visible when the toolbar is docked vertically.
See toolItemSetVisibleVertical
.
Since: 2.4
new
:: (HasCallStack, MonadIO m) | |
=> m ToolItem | Returns: the new |
Creates a new ToolItem
Since: 2.4
rebuildMenu
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m () |
Calling this function signals to the toolbar that the
overflow menu item for toolItem
has changed. If the
overflow menu is visible when this function it called,
the menu will be rebuilt.
The function must be called when the tool item changes what it will do in response to the createMenuProxy signal.
Since: 2.6
retrieveProxyMenuItem
toolItemRetrieveProxyMenuItem Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m Widget | Returns: The |
Returns the MenuItem
that was last set by
toolItemSetProxyMenuItem
, ie. the MenuItem
that is going to appear in the overflow menu.
Since: 2.4
setExpand
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether toolItem
is allocated extra space when there
is more room on the toolbar then needed for the items. The
effect is that the item gets bigger when the toolbar gets bigger
and smaller when the toolbar gets smaller.
Since: 2.4
setHomogeneous
toolItemSetHomogeneous Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether toolItem
is to be allocated the same size as other
homogeneous items. The effect is that all homogeneous items will have
the same width as the widest of the items.
Since: 2.4
setIsImportant
toolItemSetIsImportant Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether toolItem
should be considered important. The ToolButton
class uses this property to determine whether to show or hide its label
when the toolbar style is ToolbarStyleBothHoriz
. The result is that
only tool buttons with the “is_important” property set have labels, an
effect known as “priority text”
Since: 2.4
setProxyMenuItem
toolItemSetProxyMenuItem Source #
:: (HasCallStack, MonadIO m, IsToolItem a, IsWidget b) | |
=> a |
|
-> Text |
|
-> Maybe b |
|
-> m () |
Sets the MenuItem
used in the toolbar overflow menu. The
menuItemId
is used to identify the caller of this function and
should also be used with toolItemGetProxyMenuItem
.
See also createMenuProxy.
Since: 2.4
setTooltipMarkup
toolItemSetTooltipMarkup Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the markup text to be displayed as tooltip on the item.
See widgetSetTooltipMarkup
.
Since: 2.12
setTooltipText
toolItemSetTooltipText Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text to be displayed as tooltip on the item.
See widgetSetTooltipText
.
Since: 2.12
setUseDragWindow
toolItemSetUseDragWindow Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether toolItem
has a drag window. When True
the
toolitem can be used as a drag source through widgetDragSourceSet
.
When toolItem
has a drag window it will intercept all events,
even those that would otherwise be sent to a child of toolItem
.
Since: 2.4
setVisibleHorizontal
toolItemSetVisibleHorizontal Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether toolItem
is visible when the toolbar is docked horizontally.
Since: 2.4
setVisibleVertical
toolItemSetVisibleVertical Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether toolItem
is visible when the toolbar is docked
vertically. Some tool items, such as text entries, are too wide to be
useful on a vertically docked toolbar. If visibleVertical
is False
toolItem
will not appear on toolbars that are docked vertically.
Since: 2.4
toolbarReconfigured
toolItemToolbarReconfigured Source #
:: (HasCallStack, MonadIO m, IsToolItem a) | |
=> a |
|
-> m () |
Properties
isImportant
No description available in the introspection data.
constructToolItemIsImportant :: (IsToolItem o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “is-important
” property. This is rarely needed directly, but it is used by new
.
getToolItemIsImportant :: (MonadIO m, IsToolItem o) => o -> m Bool Source #
Get the value of the “is-important
” property.
When overloading is enabled, this is equivalent to
get
toolItem #isImportant
setToolItemIsImportant :: (MonadIO m, IsToolItem o) => o -> Bool -> m () Source #
Set the value of the “is-important
” property.
When overloading is enabled, this is equivalent to
set
toolItem [ #isImportant:=
value ]
visibleHorizontal
No description available in the introspection data.
constructToolItemVisibleHorizontal :: (IsToolItem o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “visible-horizontal
” property. This is rarely needed directly, but it is used by new
.
getToolItemVisibleHorizontal :: (MonadIO m, IsToolItem o) => o -> m Bool Source #
Get the value of the “visible-horizontal
” property.
When overloading is enabled, this is equivalent to
get
toolItem #visibleHorizontal
setToolItemVisibleHorizontal :: (MonadIO m, IsToolItem o) => o -> Bool -> m () Source #
Set the value of the “visible-horizontal
” property.
When overloading is enabled, this is equivalent to
set
toolItem [ #visibleHorizontal:=
value ]
visibleVertical
No description available in the introspection data.
constructToolItemVisibleVertical :: (IsToolItem o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “visible-vertical
” property. This is rarely needed directly, but it is used by new
.
getToolItemVisibleVertical :: (MonadIO m, IsToolItem o) => o -> m Bool Source #
Get the value of the “visible-vertical
” property.
When overloading is enabled, this is equivalent to
get
toolItem #visibleVertical
setToolItemVisibleVertical :: (MonadIO m, IsToolItem o) => o -> Bool -> m () Source #
Set the value of the “visible-vertical
” property.
When overloading is enabled, this is equivalent to
set
toolItem [ #visibleVertical:=
value ]
Signals
createMenuProxy
type C_ToolItemCreateMenuProxyCallback = Ptr () -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type ToolItemCreateMenuProxyCallback Source #
This signal is emitted when the toolbar needs information from toolItem
about whether the item should appear in the toolbar overflow menu. In
response the tool item should either
- call
toolItemSetProxyMenuItem
with aNothing
pointer and returnTrue
to indicate that the item should not appear in the overflow menu - call
toolItemSetProxyMenuItem
with a new menu item and returnTrue
, or - return
False
to indicate that the signal was not handled by the item. This means that the item will not appear in the overflow menu unless a later handler installs a menu item.
The toolbar may cache the result of this signal. When the tool item changes
how it will respond to this signal it must call toolItemRebuildMenu
to invalidate the cache and ensure that the toolbar rebuilds its overflow
menu.
afterToolItemCreateMenuProxy :: (IsToolItem a, MonadIO m) => a -> ToolItemCreateMenuProxyCallback -> m SignalHandlerId Source #
Connect a signal handler for the createMenuProxy signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
toolItem #createMenuProxy callback
genClosure_ToolItemCreateMenuProxy :: MonadIO m => ToolItemCreateMenuProxyCallback -> m (GClosure C_ToolItemCreateMenuProxyCallback) Source #
Wrap the callback into a GClosure
.
mk_ToolItemCreateMenuProxyCallback :: C_ToolItemCreateMenuProxyCallback -> IO (FunPtr C_ToolItemCreateMenuProxyCallback) Source #
Generate a function pointer callable from C code, from a C_ToolItemCreateMenuProxyCallback
.
noToolItemCreateMenuProxyCallback :: Maybe ToolItemCreateMenuProxyCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ToolItemCreateMenuProxyCallback
onToolItemCreateMenuProxy :: (IsToolItem a, MonadIO m) => a -> ToolItemCreateMenuProxyCallback -> m SignalHandlerId Source #
Connect a signal handler for the createMenuProxy signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
toolItem #createMenuProxy callback
wrap_ToolItemCreateMenuProxyCallback :: ToolItemCreateMenuProxyCallback -> C_ToolItemCreateMenuProxyCallback Source #
Wrap a ToolItemCreateMenuProxyCallback
into a C_ToolItemCreateMenuProxyCallback
.
toolbarReconfigured
type C_ToolItemToolbarReconfiguredCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type ToolItemToolbarReconfiguredCallback = IO () Source #
This signal is emitted when some property of the toolbar that the
item is a child of changes. For custom subclasses of ToolItem
,
the default handler of this signal use the functions
to find out what the toolbar should look like and change themselves accordingly.
afterToolItemToolbarReconfigured :: (IsToolItem a, MonadIO m) => a -> ToolItemToolbarReconfiguredCallback -> m SignalHandlerId Source #
Connect a signal handler for the toolbarReconfigured signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
toolItem #toolbarReconfigured callback
genClosure_ToolItemToolbarReconfigured :: MonadIO m => ToolItemToolbarReconfiguredCallback -> m (GClosure C_ToolItemToolbarReconfiguredCallback) Source #
Wrap the callback into a GClosure
.
mk_ToolItemToolbarReconfiguredCallback :: C_ToolItemToolbarReconfiguredCallback -> IO (FunPtr C_ToolItemToolbarReconfiguredCallback) Source #
Generate a function pointer callable from C code, from a C_ToolItemToolbarReconfiguredCallback
.
noToolItemToolbarReconfiguredCallback :: Maybe ToolItemToolbarReconfiguredCallback Source #
A convenience synonym for
.Nothing
:: Maybe
ToolItemToolbarReconfiguredCallback
onToolItemToolbarReconfigured :: (IsToolItem a, MonadIO m) => a -> ToolItemToolbarReconfiguredCallback -> m SignalHandlerId Source #
Connect a signal handler for the toolbarReconfigured signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
toolItem #toolbarReconfigured callback