GI.Gtk.Objects.ToggleToolButton

A ToggleToolButton is a ToolItem that contains a toggle button.

Use toggleToolButtonNew to create a new GtkToggleToolButton.

CSS nodes

GtkToggleToolButton has a single CSS node with name togglebutton.

Exported types

newtype ToggleToolButton

Constructors

ToggleToolButton (ManagedPtr ToggleToolButton)

Instances

GObject ToggleToolButton

Methods

gobjectType :: ToggleToolButton -> IO GType

IsImplementorIface ToggleToolButton

IsObject ToggleToolButton

IsWidget ToggleToolButton

IsToolItem ToggleToolButton

IsToolButton ToggleToolButton

IsToggleToolButton ToggleToolButton

IsContainer ToggleToolButton

IsBin ToggleToolButton

IsBuildable ToggleToolButton

IsActivatable ToggleToolButton

IsActionable ToggleToolButton

class GObject o => IsToggleToolButton o

Instances

(GObject a, UnknownAncestorError Constraint ToggleToolButton a) => IsToggleToolButton a

IsToggleToolButton ToggleToolButton

IsToggleToolButton RadioToolButton

toToggleToolButton :: (MonadIO m, IsToggleToolButton o) => o -> m ToggleToolButton

noToggleToolButton :: Maybe ToggleToolButton

Methods

getActive

toggleToolButtonGetActive

Arguments

:: (HasCallStack, MonadIO m, IsToggleToolButton a)

=> a

button: a ToggleToolButton

-> m Bool

Returns: True if the toggle tool button is pressed in, False if not

Queries a ToggleToolButton and returns its current state. Returns True if the toggle button is pressed in and False if it is raised.

Since: 2.4

new

toggleToolButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ToggleToolButton

Returns: a newly created ToggleToolButton

Returns a new ToggleToolButton

Since: 2.4

newFromStock

toggleToolButtonNewFromStock

Arguments

:: (HasCallStack, MonadIO m)

=> Text

stockId: the name of the stock item

-> m ToggleToolButton

Returns: A new ToggleToolButton

Deprecated: (Since version 3.10)Use toggleToolButtonNew instead.

Creates a new ToggleToolButton containing the image and text from a stock item. Some stock ids have preprocessor macros like STOCK_OK and STOCK_APPLY.

It is an error if stockId is not a name of a stock item.

Since: 2.4

setActive

toggleToolButtonSetActive

Arguments

:: (HasCallStack, MonadIO m, IsToggleToolButton a)

=> a

button: a ToggleToolButton

-> Bool

isActive: whether button should be active

-> m ()

Sets the status of the toggle tool button. Set to True if you want the GtkToggleButton to be “pressed in”, and False to raise it. This action causes the toggled signal to be emitted.

Since: 2.4

Properties

active

constructToggleToolButtonActive :: IsToggleToolButton o => Bool -> IO (GValueConstruct o)

getToggleToolButtonActive :: (MonadIO m, IsToggleToolButton o) => o -> m Bool

setToggleToolButtonActive :: (MonadIO m, IsToggleToolButton o) => o -> Bool -> m ()

Signals

toggled

type C_ToggleToolButtonToggledCallback = Ptr () -> Ptr () -> IO ()

type ToggleToolButtonToggledCallback = IO ()

afterToggleToolButtonToggled :: (IsToggleToolButton a, MonadIO m) => a -> ToggleToolButtonToggledCallback -> m SignalHandlerId

genClosure_ToggleToolButtonToggled :: ToggleToolButtonToggledCallback -> IO Closure

mk_ToggleToolButtonToggledCallback :: C_ToggleToolButtonToggledCallback -> IO (FunPtr C_ToggleToolButtonToggledCallback)

noToggleToolButtonToggledCallback :: Maybe ToggleToolButtonToggledCallback

onToggleToolButtonToggled :: (IsToggleToolButton a, MonadIO m) => a -> ToggleToolButtonToggledCallback -> m SignalHandlerId

wrap_ToggleToolButtonToggledCallback :: ToggleToolButtonToggledCallback -> Ptr () -> Ptr () -> IO ()