Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
A toolbar is created with a call to toolbarNew
.
A toolbar can contain instances of a subclass of ToolItem
. To add
a ToolItem
to the a toolbar, use toolbarInsert
. To remove
an item from the toolbar use containerRemove
. To add a button
to the toolbar, add an instance of ToolButton
.
Toolbar items can be visually grouped by adding instances of
SeparatorToolItem
to the toolbar. If the GtkToolbar child property
“expand” is TRUE
and the property SeparatorToolItem
:draw
is set to
FALSE
, the effect is to force all following items to the end of the toolbar.
Creating a context menu for the toolbar can be done by connecting to
the Toolbar
::popup-context-menu
signal.
CSS nodes
GtkToolbar has a single CSS node with name toolbar.
- newtype Toolbar = Toolbar (ManagedPtr Toolbar)
- class GObject o => IsToolbar o
- toToolbar :: IsToolbar o => o -> IO Toolbar
- noToolbar :: Maybe Toolbar
- data ToolbarGetDropIndexMethodInfo
- toolbarGetDropIndex :: (HasCallStack, MonadIO m, IsToolbar a) => a -> Int32 -> Int32 -> m Int32
- data ToolbarGetIconSizeMethodInfo
- toolbarGetIconSize :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m IconSize
- data ToolbarGetItemIndexMethodInfo
- toolbarGetItemIndex :: (HasCallStack, MonadIO m, IsToolbar a, IsToolItem b) => a -> b -> m Int32
- data ToolbarGetNItemsMethodInfo
- toolbarGetNItems :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m Int32
- data ToolbarGetNthItemMethodInfo
- toolbarGetNthItem :: (HasCallStack, MonadIO m, IsToolbar a) => a -> Int32 -> m (Maybe ToolItem)
- data ToolbarGetReliefStyleMethodInfo
- toolbarGetReliefStyle :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m ReliefStyle
- data ToolbarGetShowArrowMethodInfo
- toolbarGetShowArrow :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m Bool
- data ToolbarGetStyleMethodInfo
- toolbarGetStyle :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m ToolbarStyle
- data ToolbarInsertMethodInfo
- toolbarInsert :: (HasCallStack, MonadIO m, IsToolbar a, IsToolItem b) => a -> b -> Int32 -> m ()
- toolbarNew :: (HasCallStack, MonadIO m) => m Toolbar
- data ToolbarSetDropHighlightItemMethodInfo
- toolbarSetDropHighlightItem :: (HasCallStack, MonadIO m, IsToolbar a, IsToolItem b) => a -> Maybe b -> Int32 -> m ()
- data ToolbarSetIconSizeMethodInfo
- toolbarSetIconSize :: (HasCallStack, MonadIO m, IsToolbar a) => a -> IconSize -> m ()
- data ToolbarSetShowArrowMethodInfo
- toolbarSetShowArrow :: (HasCallStack, MonadIO m, IsToolbar a) => a -> Bool -> m ()
- data ToolbarSetStyleMethodInfo
- toolbarSetStyle :: (HasCallStack, MonadIO m, IsToolbar a) => a -> ToolbarStyle -> m ()
- data ToolbarUnsetIconSizeMethodInfo
- toolbarUnsetIconSize :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m ()
- data ToolbarUnsetStyleMethodInfo
- toolbarUnsetStyle :: (HasCallStack, MonadIO m, IsToolbar a) => a -> m ()
- data ToolbarIconSizePropertyInfo
- constructToolbarIconSize :: IsToolbar o => IconSize -> IO (GValueConstruct o)
- getToolbarIconSize :: (MonadIO m, IsToolbar o) => o -> m IconSize
- setToolbarIconSize :: (MonadIO m, IsToolbar o) => o -> IconSize -> m ()
- toolbarIconSize :: AttrLabelProxy "iconSize"
- data ToolbarIconSizeSetPropertyInfo
- constructToolbarIconSizeSet :: IsToolbar o => Bool -> IO (GValueConstruct o)
- getToolbarIconSizeSet :: (MonadIO m, IsToolbar o) => o -> m Bool
- setToolbarIconSizeSet :: (MonadIO m, IsToolbar o) => o -> Bool -> m ()
- toolbarIconSizeSet :: AttrLabelProxy "iconSizeSet"
- data ToolbarShowArrowPropertyInfo
- constructToolbarShowArrow :: IsToolbar o => Bool -> IO (GValueConstruct o)
- getToolbarShowArrow :: (MonadIO m, IsToolbar o) => o -> m Bool
- setToolbarShowArrow :: (MonadIO m, IsToolbar o) => o -> Bool -> m ()
- toolbarShowArrow :: AttrLabelProxy "showArrow"
- data ToolbarToolbarStylePropertyInfo
- constructToolbarToolbarStyle :: IsToolbar o => ToolbarStyle -> IO (GValueConstruct o)
- getToolbarToolbarStyle :: (MonadIO m, IsToolbar o) => o -> m ToolbarStyle
- setToolbarToolbarStyle :: (MonadIO m, IsToolbar o) => o -> ToolbarStyle -> m ()
- toolbarToolbarStyle :: AttrLabelProxy "toolbarStyle"
- type C_ToolbarFocusHomeOrEndCallback = Ptr () -> CInt -> Ptr () -> IO CInt
- type ToolbarFocusHomeOrEndCallback = Bool -> IO Bool
- data ToolbarFocusHomeOrEndSignalInfo
- afterToolbarFocusHomeOrEnd :: (GObject a, MonadIO m) => a -> ToolbarFocusHomeOrEndCallback -> m SignalHandlerId
- genClosure_ToolbarFocusHomeOrEnd :: ToolbarFocusHomeOrEndCallback -> IO Closure
- mk_ToolbarFocusHomeOrEndCallback :: C_ToolbarFocusHomeOrEndCallback -> IO (FunPtr C_ToolbarFocusHomeOrEndCallback)
- noToolbarFocusHomeOrEndCallback :: Maybe ToolbarFocusHomeOrEndCallback
- onToolbarFocusHomeOrEnd :: (GObject a, MonadIO m) => a -> ToolbarFocusHomeOrEndCallback -> m SignalHandlerId
- wrap_ToolbarFocusHomeOrEndCallback :: ToolbarFocusHomeOrEndCallback -> Ptr () -> CInt -> Ptr () -> IO CInt
- type C_ToolbarOrientationChangedCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type ToolbarOrientationChangedCallback = Orientation -> IO ()
- data ToolbarOrientationChangedSignalInfo
- afterToolbarOrientationChanged :: (GObject a, MonadIO m) => a -> ToolbarOrientationChangedCallback -> m SignalHandlerId
- genClosure_ToolbarOrientationChanged :: ToolbarOrientationChangedCallback -> IO Closure
- mk_ToolbarOrientationChangedCallback :: C_ToolbarOrientationChangedCallback -> IO (FunPtr C_ToolbarOrientationChangedCallback)
- noToolbarOrientationChangedCallback :: Maybe ToolbarOrientationChangedCallback
- onToolbarOrientationChanged :: (GObject a, MonadIO m) => a -> ToolbarOrientationChangedCallback -> m SignalHandlerId
- wrap_ToolbarOrientationChangedCallback :: ToolbarOrientationChangedCallback -> Ptr () -> CUInt -> Ptr () -> IO ()
- type C_ToolbarPopupContextMenuCallback = Ptr () -> Int32 -> Int32 -> Int32 -> Ptr () -> IO CInt
- type ToolbarPopupContextMenuCallback = Int32 -> Int32 -> Int32 -> IO Bool
- data ToolbarPopupContextMenuSignalInfo
- afterToolbarPopupContextMenu :: (GObject a, MonadIO m) => a -> ToolbarPopupContextMenuCallback -> m SignalHandlerId
- genClosure_ToolbarPopupContextMenu :: ToolbarPopupContextMenuCallback -> IO Closure
- mk_ToolbarPopupContextMenuCallback :: C_ToolbarPopupContextMenuCallback -> IO (FunPtr C_ToolbarPopupContextMenuCallback)
- noToolbarPopupContextMenuCallback :: Maybe ToolbarPopupContextMenuCallback
- onToolbarPopupContextMenu :: (GObject a, MonadIO m) => a -> ToolbarPopupContextMenuCallback -> m SignalHandlerId
- wrap_ToolbarPopupContextMenuCallback :: ToolbarPopupContextMenuCallback -> Ptr () -> Int32 -> Int32 -> Int32 -> Ptr () -> IO CInt
- type C_ToolbarStyleChangedCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type ToolbarStyleChangedCallback = ToolbarStyle -> IO ()
- data ToolbarStyleChangedSignalInfo
- afterToolbarStyleChanged :: (GObject a, MonadIO m) => a -> ToolbarStyleChangedCallback -> m SignalHandlerId
- genClosure_ToolbarStyleChanged :: ToolbarStyleChangedCallback -> IO Closure
- mk_ToolbarStyleChangedCallback :: C_ToolbarStyleChangedCallback -> IO (FunPtr C_ToolbarStyleChangedCallback)
- noToolbarStyleChangedCallback :: Maybe ToolbarStyleChangedCallback
- onToolbarStyleChanged :: (GObject a, MonadIO m) => a -> ToolbarStyleChangedCallback -> m SignalHandlerId
- wrap_ToolbarStyleChangedCallback :: ToolbarStyleChangedCallback -> Ptr () -> CUInt -> Ptr () -> IO ()
Exported types
GObject Toolbar Source # | |
IsImplementorIface Toolbar Source # | |
IsObject Toolbar Source # | |
IsWidget Toolbar Source # | |
IsContainer Toolbar Source # | |
IsToolShell Toolbar Source # | |
IsOrientable Toolbar Source # | |
IsBuildable Toolbar Source # | |
IsToolbar Toolbar Source # | |
((~) * info (ResolveToolbarMethod t Toolbar), MethodInfo * info Toolbar p) => IsLabel t (Toolbar -> p) Source # | |
((~) * info (ResolveToolbarMethod t Toolbar), MethodInfo * info Toolbar p) => IsLabelProxy t (Toolbar -> p) Source # | |
HasAttributeList * Toolbar Source # | |
type AttributeList Toolbar Source # | |
type SignalList Toolbar Source # | |
Methods
getDropIndex
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> m Int32 | Returns: The position corresponding to the point ( |
Returns the position corresponding to the indicated point on
toolbar
. This is useful when dragging items to the toolbar:
this function returns the position a new item should be
inserted.
x
and y
are in toolbar
coordinates.
Since: 2.4
getIconSize
data ToolbarGetIconSizeMethodInfo Source #
((~) * signature (m IconSize), MonadIO m, IsToolbar a) => MethodInfo * ToolbarGetIconSizeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m IconSize | Returns: the current icon size for the icons on the toolbar. |
Retrieves the icon size for the toolbar. See toolbarSetIconSize
.
getItemIndex
data ToolbarGetItemIndexMethodInfo Source #
((~) * signature (b -> m Int32), MonadIO m, IsToolbar a, IsToolItem b) => MethodInfo * ToolbarGetItemIndexMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a, IsToolItem b) | |
=> a |
|
-> b |
|
-> m Int32 | Returns: the position of item on the toolbar. |
Returns the position of item
on the toolbar, starting from 0.
It is an error if item
is not a child of the toolbar.
Since: 2.4
getNItems
data ToolbarGetNItemsMethodInfo Source #
((~) * signature (m Int32), MonadIO m, IsToolbar a) => MethodInfo * ToolbarGetNItemsMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m Int32 | Returns: the number of items on the toolbar |
Returns the number of items on the toolbar.
Since: 2.4
getNthItem
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> Int32 |
|
-> m (Maybe ToolItem) | Returns: The |
Returns the n
'th item on toolbar
, or Nothing
if the
toolbar does not contain an n
'th item.
Since: 2.4
getReliefStyle
data ToolbarGetReliefStyleMethodInfo Source #
((~) * signature (m ReliefStyle), MonadIO m, IsToolbar a) => MethodInfo * ToolbarGetReliefStyleMethodInfo a signature Source # | |
toolbarGetReliefStyle Source #
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m ReliefStyle | Returns: The relief style of buttons on |
Returns the relief style of buttons on toolbar
. See
buttonSetRelief
.
Since: 2.4
getShowArrow
data ToolbarGetShowArrowMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsToolbar a) => MethodInfo * ToolbarGetShowArrowMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the toolbar has an overflow menu.
See toolbarSetShowArrow
.
Since: 2.4
getStyle
data ToolbarGetStyleMethodInfo Source #
((~) * signature (m ToolbarStyle), MonadIO m, IsToolbar a) => MethodInfo * ToolbarGetStyleMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m ToolbarStyle | Returns: the current style of |
Retrieves whether the toolbar has text, icons, or both . See
toolbarSetStyle
.
insert
data ToolbarInsertMethodInfo Source #
((~) * signature (b -> Int32 -> m ()), MonadIO m, IsToolbar a, IsToolItem b) => MethodInfo * ToolbarInsertMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a, IsToolItem b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> m () |
Insert a ToolItem
into the toolbar at position pos
. If pos
is
0 the item is prepended to the start of the toolbar. If pos
is
negative, the item is appended to the end of the toolbar.
Since: 2.4
new
:: (HasCallStack, MonadIO m) | |
=> m Toolbar | Returns: the newly-created toolbar. |
Creates a new toolbar.
setDropHighlightItem
data ToolbarSetDropHighlightItemMethodInfo Source #
((~) * signature (Maybe b -> Int32 -> m ()), MonadIO m, IsToolbar a, IsToolItem b) => MethodInfo * ToolbarSetDropHighlightItemMethodInfo a signature Source # | |
toolbarSetDropHighlightItem Source #
:: (HasCallStack, MonadIO m, IsToolbar a, IsToolItem b) | |
=> a |
|
-> Maybe b | |
-> Int32 |
|
-> m () |
Highlights toolbar
to give an idea of what it would look like
if item
was added to toolbar
at the position indicated by index_
.
If item
is Nothing
, highlighting is turned off. In that case index_
is ignored.
The toolItem
passed to this function must not be part of any widget
hierarchy. When an item is set as drop highlight item it can not
added to any widget hierarchy or used as highlight item for another
toolbar.
Since: 2.4
setIconSize
data ToolbarSetIconSizeMethodInfo Source #
((~) * signature (IconSize -> m ()), MonadIO m, IsToolbar a) => MethodInfo * ToolbarSetIconSizeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> IconSize |
|
-> m () |
This function sets the size of stock icons in the toolbar. You can call it both before you add the icons and after they’ve been added. The size you set will override user preferences for the default icon size.
This should only be used for special-purpose toolbars, normal application toolbars should respect the user preferences for the size of icons.
setShowArrow
data ToolbarSetShowArrowMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsToolbar a) => MethodInfo * ToolbarSetShowArrowMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether to show an overflow menu when
toolbar
doesn’t have room for all items on it. If True
,
items that there are not room are available through an
overflow menu.
Since: 2.4
setStyle
data ToolbarSetStyleMethodInfo Source #
((~) * signature (ToolbarStyle -> m ()), MonadIO m, IsToolbar a) => MethodInfo * ToolbarSetStyleMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> ToolbarStyle |
|
-> m () |
Alters the view of toolbar
to display either icons only, text only, or both.
unsetIconSize
data ToolbarUnsetIconSizeMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsToolbar a) => MethodInfo * ToolbarUnsetIconSizeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m () |
Unsets toolbar icon size set with toolbarSetIconSize
, so that
user preferences will be used to determine the icon size.
unsetStyle
data ToolbarUnsetStyleMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsToolbar a) => MethodInfo * ToolbarUnsetStyleMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsToolbar a) | |
=> a |
|
-> m () |
Unsets a toolbar style set with toolbarSetStyle
, so that
user preferences will be used to determine the toolbar style.
Properties
iconSize
data ToolbarIconSizePropertyInfo Source #
constructToolbarIconSize :: IsToolbar o => IconSize -> IO (GValueConstruct o) Source #
toolbarIconSize :: AttrLabelProxy "iconSize" Source #
iconSizeSet
data ToolbarIconSizeSetPropertyInfo Source #
constructToolbarIconSizeSet :: IsToolbar o => Bool -> IO (GValueConstruct o) Source #
toolbarIconSizeSet :: AttrLabelProxy "iconSizeSet" Source #
showArrow
data ToolbarShowArrowPropertyInfo Source #
constructToolbarShowArrow :: IsToolbar o => Bool -> IO (GValueConstruct o) Source #
toolbarShowArrow :: AttrLabelProxy "showArrow" Source #
toolbarStyle
data ToolbarToolbarStylePropertyInfo Source #
constructToolbarToolbarStyle :: IsToolbar o => ToolbarStyle -> IO (GValueConstruct o) Source #
getToolbarToolbarStyle :: (MonadIO m, IsToolbar o) => o -> m ToolbarStyle Source #
setToolbarToolbarStyle :: (MonadIO m, IsToolbar o) => o -> ToolbarStyle -> m () Source #
toolbarToolbarStyle :: AttrLabelProxy "toolbarStyle" Source #
Signals
focusHomeOrEnd
afterToolbarFocusHomeOrEnd :: (GObject a, MonadIO m) => a -> ToolbarFocusHomeOrEndCallback -> m SignalHandlerId Source #
mk_ToolbarFocusHomeOrEndCallback :: C_ToolbarFocusHomeOrEndCallback -> IO (FunPtr C_ToolbarFocusHomeOrEndCallback) Source #
onToolbarFocusHomeOrEnd :: (GObject a, MonadIO m) => a -> ToolbarFocusHomeOrEndCallback -> m SignalHandlerId Source #
wrap_ToolbarFocusHomeOrEndCallback :: ToolbarFocusHomeOrEndCallback -> Ptr () -> CInt -> Ptr () -> IO CInt Source #
orientationChanged
type ToolbarOrientationChangedCallback = Orientation -> IO () Source #
afterToolbarOrientationChanged :: (GObject a, MonadIO m) => a -> ToolbarOrientationChangedCallback -> m SignalHandlerId Source #
mk_ToolbarOrientationChangedCallback :: C_ToolbarOrientationChangedCallback -> IO (FunPtr C_ToolbarOrientationChangedCallback) Source #
onToolbarOrientationChanged :: (GObject a, MonadIO m) => a -> ToolbarOrientationChangedCallback -> m SignalHandlerId Source #
wrap_ToolbarOrientationChangedCallback :: ToolbarOrientationChangedCallback -> Ptr () -> CUInt -> Ptr () -> IO () Source #
popupContextMenu
type C_ToolbarPopupContextMenuCallback = Ptr () -> Int32 -> Int32 -> Int32 -> Ptr () -> IO CInt Source #
afterToolbarPopupContextMenu :: (GObject a, MonadIO m) => a -> ToolbarPopupContextMenuCallback -> m SignalHandlerId Source #
mk_ToolbarPopupContextMenuCallback :: C_ToolbarPopupContextMenuCallback -> IO (FunPtr C_ToolbarPopupContextMenuCallback) Source #
onToolbarPopupContextMenu :: (GObject a, MonadIO m) => a -> ToolbarPopupContextMenuCallback -> m SignalHandlerId Source #
wrap_ToolbarPopupContextMenuCallback :: ToolbarPopupContextMenuCallback -> Ptr () -> Int32 -> Int32 -> Int32 -> Ptr () -> IO CInt Source #
styleChanged
type ToolbarStyleChangedCallback = ToolbarStyle -> IO () Source #
afterToolbarStyleChanged :: (GObject a, MonadIO m) => a -> ToolbarStyleChangedCallback -> m SignalHandlerId Source #
mk_ToolbarStyleChangedCallback :: C_ToolbarStyleChangedCallback -> IO (FunPtr C_ToolbarStyleChangedCallback) Source #
onToolbarStyleChanged :: (GObject a, MonadIO m) => a -> ToolbarStyleChangedCallback -> m SignalHandlerId Source #
wrap_ToolbarStyleChangedCallback :: ToolbarStyleChangedCallback -> Ptr () -> CUInt -> Ptr () -> IO () Source #