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.ListBoxRow

Contents

Exported types
Methods
Properties
- activatable
- selectable
Signals
- activate

Description

No description available in the introspection data.

Synopsis

newtype ListBoxRow = ListBoxRow (ManagedPtr ListBoxRow)
class (GObject o, IsDescendantOf ListBoxRow o) => IsListBoxRow o
toListBoxRow :: (MonadIO m, IsListBoxRow o) => o -> m ListBoxRow
noListBoxRow :: Maybe ListBoxRow
listBoxRowChanged :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> m ()
listBoxRowGetActivatable :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> m Bool
listBoxRowGetHeader :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> m (Maybe Widget)
listBoxRowGetIndex :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> m Int32
listBoxRowGetSelectable :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> m Bool
listBoxRowIsSelected :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> m Bool
listBoxRowNew :: (HasCallStack, MonadIO m) => m ListBoxRow
listBoxRowSetActivatable :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> Bool -> m ()
listBoxRowSetHeader :: (HasCallStack, MonadIO m, IsListBoxRow a, IsWidget b) => a -> Maybe b -> m ()
listBoxRowSetSelectable :: (HasCallStack, MonadIO m, IsListBoxRow a) => a -> Bool -> m ()
constructListBoxRowActivatable :: IsListBoxRow o => Bool -> IO (GValueConstruct o)
getListBoxRowActivatable :: (MonadIO m, IsListBoxRow o) => o -> m Bool
setListBoxRowActivatable :: (MonadIO m, IsListBoxRow o) => o -> Bool -> m ()
constructListBoxRowSelectable :: IsListBoxRow o => Bool -> IO (GValueConstruct o)
getListBoxRowSelectable :: (MonadIO m, IsListBoxRow o) => o -> m Bool
setListBoxRowSelectable :: (MonadIO m, IsListBoxRow o) => o -> Bool -> m ()
type C_ListBoxRowActivateCallback = Ptr () -> Ptr () -> IO ()
type ListBoxRowActivateCallback = IO ()
afterListBoxRowActivate :: (IsListBoxRow a, MonadIO m) => a -> ListBoxRowActivateCallback -> m SignalHandlerId
genClosure_ListBoxRowActivate :: MonadIO m => ListBoxRowActivateCallback -> m (GClosure C_ListBoxRowActivateCallback)
mk_ListBoxRowActivateCallback :: C_ListBoxRowActivateCallback -> IO (FunPtr C_ListBoxRowActivateCallback)
noListBoxRowActivateCallback :: Maybe ListBoxRowActivateCallback
onListBoxRowActivate :: (IsListBoxRow a, MonadIO m) => a -> ListBoxRowActivateCallback -> m SignalHandlerId
wrap_ListBoxRowActivateCallback :: ListBoxRowActivateCallback -> C_ListBoxRowActivateCallback

Exported types

newtype ListBoxRow Source #

Memory-managed wrapper type.

Constructors

ListBoxRow (ManagedPtr ListBoxRow)

Instances

Instances details

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

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

(GObject o, IsDescendantOf ListBoxRow o) => IsListBoxRow o Source #
Instance details Defined 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.

noListBoxRow :: Maybe ListBoxRow Source #

A convenience alias for Nothing :: Maybe ListBoxRow.

Methods

changed

listBoxRowChanged Source #

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

listBoxRowGetActivatable Source #

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

getHeader

listBoxRowGetHeader Source #

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

listBoxRowGetIndex Source #

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

listBoxRowGetSelectable Source #

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

listBoxRowIsSelected Source #

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

listBoxRowNew Source #

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

listBoxRowSetActivatable Source #

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

setHeader

listBoxRowSetHeader Source #

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

listBoxRowSetSelectable Source #

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

constructListBoxRowActivatable :: IsListBoxRow o => Bool -> IO (GValueConstruct o) Source #

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

constructListBoxRowSelectable :: IsListBoxRow o => Bool -> IO (GValueConstruct o) Source #

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.

type ListBoxRowActivateCallback = IO () Source #

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

afterListBoxRowActivate :: (IsListBoxRow a, MonadIO m) => a -> ListBoxRowActivateCallback -> m SignalHandlerId Source #

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

genClosure_ListBoxRowActivate :: MonadIO m => ListBoxRowActivateCallback -> m (GClosure C_ListBoxRowActivateCallback) Source #

Wrap the callback into a GClosure.

mk_ListBoxRowActivateCallback :: C_ListBoxRowActivateCallback -> IO (FunPtr C_ListBoxRowActivateCallback) Source #

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

noListBoxRowActivateCallback :: Maybe ListBoxRowActivateCallback Source #

A convenience synonym for Nothing :: Maybe ListBoxRowActivateCallback.

onListBoxRowActivate :: (IsListBoxRow a, MonadIO m) => a -> ListBoxRowActivateCallback -> m SignalHandlerId Source #

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_ListBoxRowActivateCallback :: ListBoxRowActivateCallback -> C_ListBoxRowActivateCallback Source #

Wrap a ListBoxRowActivateCallback into a C_ListBoxRowActivateCallback.