gi-gtk-3.0.32: Gtk bindings
Copyright Will Thompson Iñaki García Etxebarria and Jonas Platte LGPL-2.1 Iñaki García Etxebarria None Haskell2010

GI.Gtk.Objects.ListBoxRow

Description

No description available in the introspection data.

Synopsis

# Exported types

newtype ListBoxRow Source #

Memory-managed wrapper type.

Constructors

 ListBoxRow (ManagedPtr ListBoxRow)

#### Instances

Instances details
 Source # Instance detailsDefined in GI.Gtk.Objects.ListBoxRow Methods Source # Convert ListBoxRow to and from GValue with toGValue and fromGValue. Instance detailsDefined in GI.Gtk.Objects.ListBoxRow Methods Source # Instance detailsDefined in GI.Gtk.Objects.ListBoxRow Methods Source # Instance detailsDefined in GI.Gtk.Objects.ListBoxRow Source # Instance detailsDefined in GI.Gtk.Objects.ListBoxRow

class (GObject o, IsDescendantOf ListBoxRow o) => IsListBoxRow o Source #

Type class for types which can be safely cast to ListBoxRow, for instance with toListBoxRow.

#### Instances

Instances details
 Source # Instance detailsDefined in GI.Gtk.Objects.ListBoxRow

toListBoxRow :: (MonadIO m, IsListBoxRow o) => o -> m ListBoxRow Source #

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

A convenience alias for Nothing :: Maybe ListBoxRow.

# Methods

## changed

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> m ()

Marks row as changed, causing any state that depends on this to be updated. This affects sorting, filtering and headers.

Note that calls to this method must be in sync with the data used for the row functions. For instance, if the list is mirroring some external data set, and *two* rows changed in the external data set then when you call listBoxRowChanged on the first row the sort function must only read the new data for the first of the two changed rows, otherwise the resorting of the rows will be wrong.

This generally means that if you don’t fully control the data model you have to duplicate the data that affects the listbox row functions into the row widgets themselves. Another alternative is to call listBoxInvalidateSort on any model change, but that is more expensive.

Since: 3.10

## getActivatable

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> m Bool Returns: True if the row is activatable

Gets the value of the ListBoxRow:activatable property for this row.

Since: 3.14

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> m (Maybe Widget) Returns: the current header, or Nothing if none

Returns the current header of the row. This can be used in a ListBoxUpdateHeaderFunc to see if there is a header set already, and if so to update the state of it.

Since: 3.10

## getIndex

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> m Int32 Returns: the index of the row, or -1 if the row is not in a listbox

Gets the current index of the row in its ListBox container.

Since: 3.10

## getSelectable

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> m Bool Returns: True if the row is selectable

Gets the value of the ListBoxRow:selectable property for this row.

Since: 3.14

## isSelected

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> m Bool Returns: True if row is selected

Returns whether the child is currently selected in its ListBox container.

Since: 3.14

## new

Arguments

 :: (HasCallStack, MonadIO m) => m ListBoxRow Returns: a new ListBoxRow

Creates a new ListBoxRow, to be used as a child of a ListBox.

Since: 3.10

## setActivatable

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> Bool activatable: True to mark the row as activatable -> m ()

Set the ListBoxRow:activatable property for this row.

Since: 3.14

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a, IsWidget b) => a row: a ListBoxRow -> Maybe b header: the header, or Nothing -> m ()

Sets the current header of the row. This is only allowed to be called from a ListBoxUpdateHeaderFunc. It will replace any existing header in the row, and be shown in front of the row in the listbox.

Since: 3.10

## setSelectable

Arguments

 :: (HasCallStack, MonadIO m, IsListBoxRow a) => a row: a ListBoxRow -> Bool selectable: True to mark the row as selectable -> m ()

Set the ListBoxRow:selectable property for this row.

Since: 3.14

# Properties

## activatable

The property determines whether the rowActivated signal will be emitted for this row.

Since: 3.14

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

getListBoxRowActivatable :: (MonadIO m, IsListBoxRow o) => o -> m Bool Source #

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

get listBoxRow #activatable


setListBoxRowActivatable :: (MonadIO m, IsListBoxRow o) => o -> Bool -> m () Source #

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

set listBoxRow [ #activatable := value ]


## selectable

The property determines whether this row can be selected.

Since: 3.14

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

getListBoxRowSelectable :: (MonadIO m, IsListBoxRow o) => o -> m Bool Source #

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

get listBoxRow #selectable


setListBoxRowSelectable :: (MonadIO m, IsListBoxRow o) => o -> Bool -> m () Source #

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

set listBoxRow [ #selectable := value ]


# Signals

## activate

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

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

This is a keybinding signal, which will cause this row to be activated.

If you want to be notified when the user activates a row (by key or not), use the rowActivated signal on the row’s parent ListBox.

Since: 3.10

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

after listBoxRow #activate callback


Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxRowActivateCallback.

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

on listBoxRow #activate callback


Wrap a ListBoxRowActivateCallback into a C_ListBoxRowActivateCallback.