gi-gtk4-4.0.12: Gtk 4.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.NotebookPage

Contents

- Exported types
- Methods
  - getChild
- Properties
  - child
  - detachable
  - menu
  - menuLabel
  - position
  - reorderable
  - tab
  - tabExpand
  - tabFill
  - tabLabel

Description

An auxiliary object used by `GtkNotebook`.

Synopsis

- newtype NotebookPage = NotebookPage (ManagedPtr NotebookPage)
- class (GObject o, IsDescendantOf NotebookPage o) => IsNotebookPage o
- toNotebookPage :: (MonadIO m, IsNotebookPage o) => o -> m NotebookPage
- notebookPageGetChild :: (HasCallStack, MonadIO m, IsNotebookPage a) => a -> m Widget
- constructNotebookPageChild :: (IsNotebookPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getNotebookPageChild :: (MonadIO m, IsNotebookPage o) => o -> m Widget
- constructNotebookPageDetachable :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getNotebookPageDetachable :: (MonadIO m, IsNotebookPage o) => o -> m Bool
- setNotebookPageDetachable :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m ()
- constructNotebookPageMenu :: (IsNotebookPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getNotebookPageMenu :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Widget)
- clearNotebookPageMenuLabel :: (MonadIO m, IsNotebookPage o) => o -> m ()
- constructNotebookPageMenuLabel :: (IsNotebookPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getNotebookPageMenuLabel :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Text)
- setNotebookPageMenuLabel :: (MonadIO m, IsNotebookPage o) => o -> Text -> m ()
- constructNotebookPagePosition :: (IsNotebookPage o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getNotebookPagePosition :: (MonadIO m, IsNotebookPage o) => o -> m Int32
- setNotebookPagePosition :: (MonadIO m, IsNotebookPage o) => o -> Int32 -> m ()
- constructNotebookPageReorderable :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getNotebookPageReorderable :: (MonadIO m, IsNotebookPage o) => o -> m Bool
- setNotebookPageReorderable :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m ()
- constructNotebookPageTab :: (IsNotebookPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getNotebookPageTab :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Widget)
- constructNotebookPageTabExpand :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getNotebookPageTabExpand :: (MonadIO m, IsNotebookPage o) => o -> m Bool
- setNotebookPageTabExpand :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m ()
- constructNotebookPageTabFill :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getNotebookPageTabFill :: (MonadIO m, IsNotebookPage o) => o -> m Bool
- setNotebookPageTabFill :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m ()
- clearNotebookPageTabLabel :: (MonadIO m, IsNotebookPage o) => o -> m ()
- constructNotebookPageTabLabel :: (IsNotebookPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getNotebookPageTabLabel :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Text)
- setNotebookPageTabLabel :: (MonadIO m, IsNotebookPage o) => o -> Text -> m ()

# Exported types

newtype NotebookPage Source #

Memory-managed wrapper type.

Constructors

NotebookPage (ManagedPtr NotebookPage) |

#### Instances

Instances details

Eq NotebookPage Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage Methods (==) :: NotebookPage -> NotebookPage -> Bool Source # (/=) :: NotebookPage -> NotebookPage -> Bool Source #
GObject NotebookPage Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage
ManagedPtrNewtype NotebookPage Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage Methods toManagedPtr :: NotebookPage -> ManagedPtr NotebookPage Source #
TypedObject NotebookPage Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage Methods glibType :: IO GType Source #
HasParentTypes NotebookPage Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage
IsGValue (Maybe NotebookPage) Source # | Convert `NotebookPage` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.NotebookPage Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe NotebookPage -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe NotebookPage) Source #
type ParentTypes NotebookPage Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage type ParentTypes NotebookPage = '[Object]

class (GObject o, IsDescendantOf NotebookPage o) => IsNotebookPage o Source #

Type class for types which can be safely cast to `NotebookPage`, for instance with `toNotebookPage`.

#### Instances

Instances details

(GObject o, IsDescendantOf NotebookPage o) => IsNotebookPage o Source # |
Instance details Defined in GI.Gtk.Objects.NotebookPage

toNotebookPage :: (MonadIO m, IsNotebookPage o) => o -> m NotebookPage Source #

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

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

#### Getters

getChild, getData, getProperty, getQdata.

#### Setters

setData, setDataFull, setProperty.

## getChild

notebookPageGetChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsNotebookPage a) |
=> a | `page`: a `GtkNotebookPage`
-> m Widget | Returns: the child to which `page` belongs

Returns the notebook child to which `page` belongs.

# Properties

## child

The child for this page.

constructNotebookPageChild :: (IsNotebookPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`child`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageChild :: (MonadIO m, IsNotebookPage o) => o -> m Widget Source #

Get the value of the “`child`” property. When overloading is enabled, this is equivalent to

    get notebookPage #child

## detachable

Whether the tab is detachable.

constructNotebookPageDetachable :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`detachable`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageDetachable :: (MonadIO m, IsNotebookPage o) => o -> m Bool Source #

Get the value of the “`detachable`” property. When overloading is enabled, this is equivalent to

    get notebookPage #detachable

setNotebookPageDetachable :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m () Source #

Set the value of the “`detachable`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #detachable := value ]

## menu

The label widget displayed in the child's menu entry.

constructNotebookPageMenu :: (IsNotebookPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`menu`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageMenu :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Widget) Source #

Get the value of the “`menu`” property. When overloading is enabled, this is equivalent to

    get notebookPage #menu

## menuLabel

The text of the menu widget.

clearNotebookPageMenuLabel :: (MonadIO m, IsNotebookPage o) => o -> m () Source #

Set the value of the “`menu-label`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #menuLabel

constructNotebookPageMenuLabel :: (IsNotebookPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`menu-label`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageMenuLabel :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Text) Source #

Get the value of the “`menu-label`” property. When overloading is enabled, this is equivalent to

    get notebookPage #menuLabel

setNotebookPageMenuLabel :: (MonadIO m, IsNotebookPage o) => o -> Text -> m () Source #

Set the value of the “`menu-label`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #menuLabel := value ]

## position

The index of the child in the parent.

constructNotebookPagePosition :: (IsNotebookPage o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`position`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPagePosition :: (MonadIO m, IsNotebookPage o) => o -> m Int32 Source #

Get the value of the “`position`” property. When overloading is enabled, this is equivalent to

    get notebookPage #position

setNotebookPagePosition :: (MonadIO m, IsNotebookPage o) => o -> Int32 -> m () Source #

Set the value of the “`position`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #position := value ]

## reorderable

Whether the tab is reorderable by user action.

constructNotebookPageReorderable :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`reorderable`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageReorderable :: (MonadIO m, IsNotebookPage o) => o -> m Bool Source #

Get the value of the “`reorderable`” property. When overloading is enabled, this is equivalent to

    get notebookPage #reorderable

setNotebookPageReorderable :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m () Source #

Set the value of the “`reorderable`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #reorderable := value ]

## tab

The tab widget for this page.

constructNotebookPageTab :: (IsNotebookPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`tab`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageTab :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Widget) Source #

Get the value of the “`tab`” property. When overloading is enabled, this is equivalent to

    get notebookPage #tab

## tabExpand

Whether to expand the child's tab.

constructNotebookPageTabExpand :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`tab-expand`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageTabExpand :: (MonadIO m, IsNotebookPage o) => o -> m Bool Source #

Get the value of the “`tab-expand`” property. When overloading is enabled, this is equivalent to

    get notebookPage #tabExpand

setNotebookPageTabExpand :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m () Source #

Set the value of the “`tab-expand`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #tabExpand := value ]

## tabFill

Whether the child's tab should fill the allocated area.

constructNotebookPageTabFill :: (IsNotebookPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`tab-fill`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageTabFill :: (MonadIO m, IsNotebookPage o) => o -> m Bool Source #

Get the value of the “`tab-fill`” property. When overloading is enabled, this is equivalent to

    get notebookPage #tabFill

setNotebookPageTabFill :: (MonadIO m, IsNotebookPage o) => o -> Bool -> m () Source #

Set the value of the “`tab-fill`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #tabFill := value ]

## tabLabel

The text of the tab widget.

clearNotebookPageTabLabel :: (MonadIO m, IsNotebookPage o) => o -> m () Source #

Set the value of the “`tab-label`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #tabLabel

constructNotebookPageTabLabel :: (IsNotebookPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`tab-label`” property. This is rarely needed directly, but it is used by `new`.

getNotebookPageTabLabel :: (MonadIO m, IsNotebookPage o) => o -> m (Maybe Text) Source #

Get the value of the “`tab-label`” property. When overloading is enabled, this is equivalent to

    get notebookPage #tabLabel

setNotebookPageTabLabel :: (MonadIO m, IsNotebookPage o) => o -> Text -> m () Source #

Set the value of the “`tab-label`” property. When overloading is enabled, this is equivalent to

    set notebookPage [ #tabLabel := value ]