Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.ListBoxRow

Contents

Exported types
Methods
Properties
- activatable
- selectable
Signals
- activate

Description

Synopsis

Exported types

newtype ListBoxRow Source #

Constructors

ListBoxRow (ManagedPtr ListBoxRow)

Instances

GObject ListBoxRow Source #
Methods gobjectType :: ListBoxRow -> IO GType #
IsImplementorIface ListBoxRow Source #

IsObject ListBoxRow Source #

IsWidget ListBoxRow Source #

IsListBoxRow ListBoxRow Source #

IsContainer ListBoxRow Source #

IsBin ListBoxRow Source #

IsBuildable ListBoxRow Source #

((~) * info (ResolveListBoxRowMethod t ListBoxRow), MethodInfo * info ListBoxRow p) => IsLabel t (ListBoxRow -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> ListBoxRow -> p #
((~) * info (ResolveListBoxRowMethod t ListBoxRow), MethodInfo * info ListBoxRow p) => IsLabelProxy t (ListBoxRow -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> ListBoxRow -> p #
HasAttributeList * ListBoxRow Source #

type AttributeList ListBoxRow Source #
type AttributeList ListBoxRow
type SignalList ListBoxRow Source #
type SignalList ListBoxRow

class GObject o => IsListBoxRow o Source #

Instances

(GObject a, UnknownAncestorError Constraint ListBoxRow a) => IsListBoxRow a Source #

IsListBoxRow ListBoxRow Source #

toListBoxRow :: IsListBoxRow o => o -> IO ListBoxRow Source #

noListBoxRow :: Maybe ListBoxRow Source #

Methods

changed

data ListBoxRowChangedMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowChangedMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowChangedMethodInfo a -> signature -> s #

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

data ListBoxRowGetActivatableMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowGetActivatableMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowGetActivatableMethodInfo a -> signature -> s #

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

data ListBoxRowGetHeaderMethodInfo Source #

Instances

((~) * signature (m (Maybe Widget)), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowGetHeaderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowGetHeaderMethodInfo a -> signature -> s #

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

data ListBoxRowGetIndexMethodInfo Source #

Instances

((~) * signature (m Int32), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowGetIndexMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowGetIndexMethodInfo a -> signature -> s #

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

data ListBoxRowGetSelectableMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowGetSelectableMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowGetSelectableMethodInfo a -> signature -> s #

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

data ListBoxRowIsSelectedMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowIsSelectedMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowIsSelectedMethodInfo a -> signature -> s #

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

data ListBoxRowSetActivatableMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowSetActivatableMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowSetActivatableMethodInfo a -> signature -> s #

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

data ListBoxRowSetHeaderMethodInfo Source #

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsListBoxRow a, IsWidget b) => MethodInfo * ListBoxRowSetHeaderMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowSetHeaderMethodInfo a -> signature -> s #

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

data ListBoxRowSetSelectableMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsListBoxRow a) => MethodInfo * ListBoxRowSetSelectableMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy ListBoxRowSetSelectableMethodInfo a -> signature -> s #

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

data ListBoxRowActivatablePropertyInfo Source #

Instances

AttrInfo ListBoxRowActivatablePropertyInfo Source #
Associated Types type AttrAllowedOps ListBoxRowActivatablePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint ListBoxRowActivatablePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo :: * -> Constraint # type AttrGetType ListBoxRowActivatablePropertyInfo :: * # type AttrLabel ListBoxRowActivatablePropertyInfo :: Symbol # type AttrOrigin ListBoxRowActivatablePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo o => Proxy * ListBoxRowActivatablePropertyInfo -> o -> IO (AttrGetType ListBoxRowActivatablePropertyInfo) # attrSet :: (AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo o, AttrSetTypeConstraint ListBoxRowActivatablePropertyInfo b) => Proxy * ListBoxRowActivatablePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo o => Proxy * ListBoxRowActivatablePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo o, AttrSetTypeConstraint ListBoxRowActivatablePropertyInfo b) => Proxy * ListBoxRowActivatablePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin ListBoxRowActivatablePropertyInfo Source #
type AttrOrigin ListBoxRowActivatablePropertyInfo = ListBoxRow
type AttrLabel ListBoxRowActivatablePropertyInfo Source #
type AttrLabel ListBoxRowActivatablePropertyInfo = "activatable"
type AttrGetType ListBoxRowActivatablePropertyInfo Source #
type AttrGetType ListBoxRowActivatablePropertyInfo = Bool
type AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo Source #
type AttrBaseTypeConstraint ListBoxRowActivatablePropertyInfo = IsListBoxRow
type AttrSetTypeConstraint ListBoxRowActivatablePropertyInfo Source #
type AttrSetTypeConstraint ListBoxRowActivatablePropertyInfo = * ~ Bool
type AttrAllowedOps ListBoxRowActivatablePropertyInfo Source #
type AttrAllowedOps ListBoxRowActivatablePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

listBoxRowActivatable :: AttrLabelProxy "activatable" Source #

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

selectable

data ListBoxRowSelectablePropertyInfo Source #

Instances

AttrInfo ListBoxRowSelectablePropertyInfo Source #
Associated Types type AttrAllowedOps ListBoxRowSelectablePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint ListBoxRowSelectablePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo :: * -> Constraint # type AttrGetType ListBoxRowSelectablePropertyInfo :: * # type AttrLabel ListBoxRowSelectablePropertyInfo :: Symbol # type AttrOrigin ListBoxRowSelectablePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo o => Proxy * ListBoxRowSelectablePropertyInfo -> o -> IO (AttrGetType ListBoxRowSelectablePropertyInfo) # attrSet :: (AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo o, AttrSetTypeConstraint ListBoxRowSelectablePropertyInfo b) => Proxy * ListBoxRowSelectablePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo o => Proxy * ListBoxRowSelectablePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo o, AttrSetTypeConstraint ListBoxRowSelectablePropertyInfo b) => Proxy * ListBoxRowSelectablePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin ListBoxRowSelectablePropertyInfo Source #
type AttrOrigin ListBoxRowSelectablePropertyInfo = ListBoxRow
type AttrLabel ListBoxRowSelectablePropertyInfo Source #
type AttrLabel ListBoxRowSelectablePropertyInfo = "selectable"
type AttrGetType ListBoxRowSelectablePropertyInfo Source #
type AttrGetType ListBoxRowSelectablePropertyInfo = Bool
type AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo Source #
type AttrBaseTypeConstraint ListBoxRowSelectablePropertyInfo = IsListBoxRow
type AttrSetTypeConstraint ListBoxRowSelectablePropertyInfo Source #
type AttrSetTypeConstraint ListBoxRowSelectablePropertyInfo = * ~ Bool
type AttrAllowedOps ListBoxRowSelectablePropertyInfo Source #
type AttrAllowedOps ListBoxRowSelectablePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

listBoxRowSelectable :: AttrLabelProxy "selectable" Source #

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

Signals

activate

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

type ListBoxRowActivateCallback = IO () Source #

data ListBoxRowActivateSignalInfo Source #

Instances

SignalInfo ListBoxRowActivateSignalInfo Source #
Associated Types type HaskellCallbackType ListBoxRowActivateSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o ListBoxRowActivateSignalInfo -> o -> HaskellCallbackType ListBoxRowActivateSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType ListBoxRowActivateSignalInfo Source #
type HaskellCallbackType ListBoxRowActivateSignalInfo = ListBoxRowActivateCallback

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

genClosure_ListBoxRowActivate :: ListBoxRowActivateCallback -> IO Closure Source #

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

noListBoxRowActivateCallback :: Maybe ListBoxRowActivateCallback Source #

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

wrap_ListBoxRowActivateCallback :: ListBoxRowActivateCallback -> Ptr () -> Ptr () -> IO () Source #