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

GI.Gtk.Objects.MenuToolButton

Contents

Exported types
Methods
Properties
- menu
Signals
- showMenu

Description

A MenuToolButton is a ToolItem that contains a button and a small additional button with an arrow. When clicked, the arrow button pops up a dropdown menu.

Use menuToolButtonNew to create a new MenuToolButton.

GtkMenuToolButton as GtkBuildable

The GtkMenuToolButton implementation of the GtkBuildable interface supports adding a menu by specifying “menu” as the “type” attribute of a <child> element.

An example for a UI definition fragment with menus: > >class="GtkMenuToolButton" > type="menu" > class="GtkMenu"/ > /child >/object

Synopsis

newtype MenuToolButton = MenuToolButton (ManagedPtr MenuToolButton)
class (GObject o, IsDescendantOf MenuToolButton o) => IsMenuToolButton o
toMenuToolButton :: (MonadIO m, IsMenuToolButton o) => o -> m MenuToolButton
noMenuToolButton :: Maybe MenuToolButton
menuToolButtonGetMenu :: (HasCallStack, MonadIO m, IsMenuToolButton a) => a -> m Widget
menuToolButtonNew :: (HasCallStack, MonadIO m, IsWidget a) => Maybe a -> Maybe Text -> m MenuToolButton
menuToolButtonNewFromStock :: (HasCallStack, MonadIO m) => Text -> m MenuToolButton
menuToolButtonSetArrowTooltipMarkup :: (HasCallStack, MonadIO m, IsMenuToolButton a) => a -> Text -> m ()
menuToolButtonSetArrowTooltipText :: (HasCallStack, MonadIO m, IsMenuToolButton a) => a -> Text -> m ()
menuToolButtonSetMenu :: (HasCallStack, MonadIO m, IsMenuToolButton a, IsWidget b) => a -> b -> m ()
clearMenuToolButtonMenu :: (MonadIO m, IsMenuToolButton o) => o -> m ()
constructMenuToolButtonMenu :: (IsMenuToolButton o, IsMenu a) => a -> IO (GValueConstruct o)
getMenuToolButtonMenu :: (MonadIO m, IsMenuToolButton o) => o -> m (Maybe Menu)
setMenuToolButtonMenu :: (MonadIO m, IsMenuToolButton o, IsMenu a) => o -> a -> m ()
type C_MenuToolButtonShowMenuCallback = Ptr () -> Ptr () -> IO ()
type MenuToolButtonShowMenuCallback = IO ()
afterMenuToolButtonShowMenu :: (IsMenuToolButton a, MonadIO m) => a -> MenuToolButtonShowMenuCallback -> m SignalHandlerId
genClosure_MenuToolButtonShowMenu :: MonadIO m => MenuToolButtonShowMenuCallback -> m (GClosure C_MenuToolButtonShowMenuCallback)
mk_MenuToolButtonShowMenuCallback :: C_MenuToolButtonShowMenuCallback -> IO (FunPtr C_MenuToolButtonShowMenuCallback)
noMenuToolButtonShowMenuCallback :: Maybe MenuToolButtonShowMenuCallback
onMenuToolButtonShowMenu :: (IsMenuToolButton a, MonadIO m) => a -> MenuToolButtonShowMenuCallback -> m SignalHandlerId
wrap_MenuToolButtonShowMenuCallback :: MenuToolButtonShowMenuCallback -> C_MenuToolButtonShowMenuCallback

Exported types

newtype MenuToolButton Source #

Memory-managed wrapper type.

Constructors

MenuToolButton (ManagedPtr MenuToolButton)

Instances

Instances details

Eq MenuToolButton Source #
Instance details Defined in GI.Gtk.Objects.MenuToolButton Methods (==) :: MenuToolButton -> MenuToolButton -> Bool # (/=) :: MenuToolButton -> MenuToolButton -> Bool #
IsGValue MenuToolButton Source #	Convert `MenuToolButton` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.MenuToolButton Methods toGValue :: MenuToolButton -> IO GValue # fromGValue :: GValue -> IO MenuToolButton #
GObject MenuToolButton Source #
Instance details Defined in GI.Gtk.Objects.MenuToolButton Methods gobjectType :: IO GType #
HasParentTypes MenuToolButton Source #
Instance details Defined in GI.Gtk.Objects.MenuToolButton
type ParentTypes MenuToolButton Source #
Instance details Defined in GI.Gtk.Objects.MenuToolButton type ParentTypes MenuToolButton = '[ToolButton, ToolItem, Bin, Container, Widget, Object, ImplementorIface, Actionable, Activatable, Buildable]

class (GObject o, IsDescendantOf MenuToolButton o) => IsMenuToolButton o Source #

Type class for types which can be safely cast to MenuToolButton, for instance with toMenuToolButton.

Instances

Instances details

(GObject o, IsDescendantOf MenuToolButton o) => IsMenuToolButton o Source #
Instance details Defined in GI.Gtk.Objects.MenuToolButton

toMenuToolButton :: (MonadIO m, IsMenuToolButton o) => o -> m MenuToolButton Source #

Cast to MenuToolButton, for types for which this is known to be safe. For general casts, use castTo.

noMenuToolButton :: Maybe MenuToolButton Source #

A convenience alias for Nothing :: Maybe MenuToolButton.

Methods

Overloaded methods

getMenu

menuToolButtonGetMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsMenuToolButton a)
=> a	`button`: a `MenuToolButton`
-> m Widget	Returns: the `Menu` associated with `MenuToolButton`

Gets the Menu associated with MenuToolButton.

Since: 2.6

new

menuToolButtonNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)
=> Maybe a	`iconWidget`: a widget that will be used as icon widget, or `Nothing`
-> Maybe Text	`label`: a string that will be used as label, or `Nothing`
-> m MenuToolButton	Returns: the new `MenuToolButton`

Creates a new MenuToolButton using iconWidget as icon and label as label.

Since: 2.6

newFromStock

menuToolButtonNewFromStock Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`stockId`: the name of a stock item
-> m MenuToolButton	Returns: the new `MenuToolButton`

Deprecated: (Since version 3.10)Use menuToolButtonNew instead.

Creates a new MenuToolButton. The new MenuToolButton will contain an icon and label from the stock item indicated by stockId.

Since: 2.6

setArrowTooltipMarkup

menuToolButtonSetArrowTooltipMarkup Source #

Arguments

:: (HasCallStack, MonadIO m, IsMenuToolButton a)
=> a	`button`: a `MenuToolButton`
-> Text	`markup`: markup text to be used as tooltip text for button’s arrow button
-> m ()

Sets the tooltip markup text to be used as tooltip for the arrow button which pops up the menu. See toolItemSetTooltipText for setting a tooltip on the whole MenuToolButton.

Since: 2.12

setArrowTooltipText

menuToolButtonSetArrowTooltipText Source #

Arguments

:: (HasCallStack, MonadIO m, IsMenuToolButton a)
=> a	`button`: a `MenuToolButton`
-> Text	`text`: text to be used as tooltip text for button’s arrow button
-> m ()

Sets the tooltip text to be used as tooltip for the arrow button which pops up the menu. See toolItemSetTooltipText for setting a tooltip on the whole MenuToolButton.

Since: 2.12

setMenu

menuToolButtonSetMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsMenuToolButton a, IsWidget b)
=> a	`button`: a `MenuToolButton`
-> b	`menu`: the `Menu` associated with `MenuToolButton`
-> m ()

Sets the Menu that is popped up when the user clicks on the arrow. If menu is NULL, the arrow button becomes insensitive.

Since: 2.6

Properties

Signals

showMenu

type C_MenuToolButtonShowMenuCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type MenuToolButtonShowMenuCallback = IO () Source #

The showMenu signal is emitted before the menu is shown.

It can be used to populate the menu on demand, using menuToolButtonSetMenu.

Note that even if you populate the menu dynamically in this way, you must set an empty menu on the MenuToolButton beforehand, since the arrow is made insensitive if the menu is not set.

afterMenuToolButtonShowMenu :: (IsMenuToolButton a, MonadIO m) => a -> MenuToolButtonShowMenuCallback -> m SignalHandlerId Source #

Connect a signal handler for the showMenu signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after menuToolButton #showMenu callback

genClosure_MenuToolButtonShowMenu :: MonadIO m => MenuToolButtonShowMenuCallback -> m (GClosure C_MenuToolButtonShowMenuCallback) Source #

Wrap the callback into a GClosure.

mk_MenuToolButtonShowMenuCallback :: C_MenuToolButtonShowMenuCallback -> IO (FunPtr C_MenuToolButtonShowMenuCallback) Source #

Generate a function pointer callable from C code, from a C_MenuToolButtonShowMenuCallback.

noMenuToolButtonShowMenuCallback :: Maybe MenuToolButtonShowMenuCallback Source #

A convenience synonym for Nothing :: Maybe MenuToolButtonShowMenuCallback.

onMenuToolButtonShowMenu :: (IsMenuToolButton a, MonadIO m) => a -> MenuToolButtonShowMenuCallback -> m SignalHandlerId Source #

Connect a signal handler for the showMenu signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on menuToolButton #showMenu callback

wrap_MenuToolButtonShowMenuCallback :: MenuToolButtonShowMenuCallback -> C_MenuToolButtonShowMenuCallback Source #

Wrap a MenuToolButtonShowMenuCallback into a C_MenuToolButtonShowMenuCallback.