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 |
No description available in the introspection data.
Synopsis
- newtype TreeListRow = TreeListRow (ManagedPtr TreeListRow)
- class (GObject o, IsDescendantOf TreeListRow o) => IsTreeListRow o
- toTreeListRow :: (MonadIO m, IsTreeListRow o) => o -> m TreeListRow
- noTreeListRow :: Maybe TreeListRow
- treeListRowGetChildRow :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> Word32 -> m (Maybe TreeListRow)
- treeListRowGetChildren :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m (Maybe ListModel)
- treeListRowGetDepth :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m Word32
- treeListRowGetExpanded :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m Bool
- treeListRowGetItem :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m (Maybe Object)
- treeListRowGetParent :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m (Maybe TreeListRow)
- treeListRowGetPosition :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m Word32
- treeListRowIsExpandable :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> m Bool
- treeListRowSetExpanded :: (HasCallStack, MonadIO m, IsTreeListRow a) => a -> Bool -> m ()
- getTreeListRowChildren :: (MonadIO m, IsTreeListRow o) => o -> m (Maybe ListModel)
- getTreeListRowDepth :: (MonadIO m, IsTreeListRow o) => o -> m Word32
- getTreeListRowExpandable :: (MonadIO m, IsTreeListRow o) => o -> m Bool
- constructTreeListRowExpanded :: IsTreeListRow o => Bool -> IO (GValueConstruct o)
- getTreeListRowExpanded :: (MonadIO m, IsTreeListRow o) => o -> m Bool
- setTreeListRowExpanded :: (MonadIO m, IsTreeListRow o) => o -> Bool -> m ()
- getTreeListRowItem :: (MonadIO m, IsTreeListRow o) => o -> m (Maybe Object)
Exported types
newtype TreeListRow Source #
Memory-managed wrapper type.
Instances
Eq TreeListRow Source # | |
Defined in GI.Gtk.Objects.TreeListRow (==) :: TreeListRow -> TreeListRow -> Bool # (/=) :: TreeListRow -> TreeListRow -> Bool # | |
IsGValue TreeListRow Source # | Convert |
Defined in GI.Gtk.Objects.TreeListRow toGValue :: TreeListRow -> IO GValue # fromGValue :: GValue -> IO TreeListRow # | |
GObject TreeListRow Source # | |
Defined in GI.Gtk.Objects.TreeListRow gobjectType :: IO GType # | |
HasParentTypes TreeListRow Source # | |
Defined in GI.Gtk.Objects.TreeListRow | |
type ParentTypes TreeListRow Source # | |
Defined in GI.Gtk.Objects.TreeListRow |
class (GObject o, IsDescendantOf TreeListRow o) => IsTreeListRow o Source #
Type class for types which can be safely cast to TreeListRow
, for instance with toTreeListRow
.
Instances
(GObject o, IsDescendantOf TreeListRow o) => IsTreeListRow o Source # | |
Defined in GI.Gtk.Objects.TreeListRow |
toTreeListRow :: (MonadIO m, IsTreeListRow o) => o -> m TreeListRow Source #
Cast to TreeListRow
, for types for which this is known to be safe. For general casts, use castTo
.
noTreeListRow :: Maybe TreeListRow Source #
A convenience alias for Nothing
:: Maybe
TreeListRow
.
Methods
Overloaded methods
getChildRow
treeListRowGetChildRow Source #
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> Word32 |
|
-> m (Maybe TreeListRow) | Returns: the child in |
If self
is not expanded or position
is greater than the number of
children, Nothing
is returned.
getChildren
treeListRowGetChildren Source #
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m (Maybe ListModel) | Returns: The model containing the children |
If the row is expanded, gets the model holding the children of self
.
This model is the model created by the GtkTreeListModelCreateModelFunc
and contains the original items, no matter what value
TreeListModel
:passthrough
is set to.
getDepth
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m Word32 | Returns: The depth of this row |
Gets the depth of this row. Rows that correspond to items in the root model have a depth of zero, rows corresponding to items of models of direct children of the root model have a depth of 1 and so on.
The depth of a row never changes until the row is destroyed.
getExpanded
treeListRowGetExpanded Source #
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m Bool | Returns: |
Gets if a row is currently expanded.
getItem
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m (Maybe Object) | Returns: The item of this row
or |
Gets the item corresponding to this row,
The value returned by this function never changes until the row is destroyed.
getParent
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m (Maybe TreeListRow) | Returns: The parent of |
Gets the row representing the parent for self
. That is the row that would
need to be collapsed to make this row disappear.
If self
is a row corresponding to the root model, Nothing
is returned.
The value returned by this function never changes until the row is destroyed.
getPosition
treeListRowGetPosition Source #
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m Word32 | Returns: The position in the model |
Returns the position in the TreeListModel
that self
occupies
at the moment.
isExpandable
treeListRowIsExpandable Source #
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> m Bool | Returns: |
Checks if a row can be expanded. This does not mean that the
row is actually expanded, this can be checked with
treeListRowGetExpanded
If a row is expandable never changes until the row is destroyed.
setExpanded
treeListRowSetExpanded Source #
:: (HasCallStack, MonadIO m, IsTreeListRow a) | |
=> a |
|
-> Bool |
|
-> m () |
Expands or collapses a row.
If a row is expanded, the model of calling the
GtkTreeListModelCreateModelFunc
for the row's item will
be inserted after this row. If a row is collapsed, those
items will be removed from the model.
If the row is not expandable, this function does nothing.
Properties
children
The model holding the row's children.
getTreeListRowChildren :: (MonadIO m, IsTreeListRow o) => o -> m (Maybe ListModel) Source #
Get the value of the “children
” property.
When overloading is enabled, this is equivalent to
get
treeListRow #children
depth
The depth in the tree of this row
getTreeListRowDepth :: (MonadIO m, IsTreeListRow o) => o -> m Word32 Source #
Get the value of the “depth
” property.
When overloading is enabled, this is equivalent to
get
treeListRow #depth
expandable
If this row can ever be expanded
getTreeListRowExpandable :: (MonadIO m, IsTreeListRow o) => o -> m Bool Source #
Get the value of the “expandable
” property.
When overloading is enabled, this is equivalent to
get
treeListRow #expandable
expanded
If this row is currently expanded
constructTreeListRowExpanded :: IsTreeListRow o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “expanded
” property. This is rarely needed directly, but it is used by new
.
getTreeListRowExpanded :: (MonadIO m, IsTreeListRow o) => o -> m Bool Source #
Get the value of the “expanded
” property.
When overloading is enabled, this is equivalent to
get
treeListRow #expanded
setTreeListRowExpanded :: (MonadIO m, IsTreeListRow o) => o -> Bool -> m () Source #
Set the value of the “expanded
” property.
When overloading is enabled, this is equivalent to
set
treeListRow [ #expanded:=
value ]
item
The item held in this row
getTreeListRowItem :: (MonadIO m, IsTreeListRow o) => o -> m (Maybe Object) Source #
Get the value of the “item
” property.
When overloading is enabled, this is equivalent to
get
treeListRow #item