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 |
A CellView
displays a single row of a TreeModel
using a CellArea
and CellAreaContext
. A CellAreaContext
can be provided to the
CellView
at construction time in order to keep the cellview in context
of a group of cell views, this ensures that the renderers displayed will
be properly aligned with eachother (like the aligned cells in the menus
of ComboBox
).
CellView
is Orientable
in order to decide in which orientation
the underlying CellAreaContext
should be allocated. Taking the ComboBox
menu as an example, cellviews should be oriented horizontally if the menus are
listed top-to-bottom and thus all share the same width but may have separate
individual heights (left-to-right menus should be allocated vertically since
they all share the same height but may have variable widths).
CSS nodes
GtkCellView has a single CSS node with name cellview.
Synopsis
- newtype CellView = CellView (ManagedPtr CellView)
- class (GObject o, IsDescendantOf CellView o) => IsCellView o
- toCellView :: (MonadIO m, IsCellView o) => o -> m CellView
- noCellView :: Maybe CellView
- cellViewGetDisplayedRow :: (HasCallStack, MonadIO m, IsCellView a) => a -> m (Maybe TreePath)
- cellViewGetDrawSensitive :: (HasCallStack, MonadIO m, IsCellView a) => a -> m Bool
- cellViewGetFitModel :: (HasCallStack, MonadIO m, IsCellView a) => a -> m Bool
- cellViewGetModel :: (HasCallStack, MonadIO m, IsCellView a) => a -> m (Maybe TreeModel)
- cellViewNew :: (HasCallStack, MonadIO m) => m CellView
- cellViewNewWithContext :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b) => a -> b -> m CellView
- cellViewNewWithMarkup :: (HasCallStack, MonadIO m) => Text -> m CellView
- cellViewNewWithText :: (HasCallStack, MonadIO m) => Text -> m CellView
- cellViewNewWithTexture :: (HasCallStack, MonadIO m, IsTexture a) => a -> m CellView
- cellViewSetDisplayedRow :: (HasCallStack, MonadIO m, IsCellView a) => a -> Maybe TreePath -> m ()
- cellViewSetDrawSensitive :: (HasCallStack, MonadIO m, IsCellView a) => a -> Bool -> m ()
- cellViewSetFitModel :: (HasCallStack, MonadIO m, IsCellView a) => a -> Bool -> m ()
- cellViewSetModel :: (HasCallStack, MonadIO m, IsCellView a, IsTreeModel b) => a -> Maybe b -> m ()
- constructCellViewCellArea :: (IsCellView o, IsCellArea a) => a -> IO (GValueConstruct o)
- getCellViewCellArea :: (MonadIO m, IsCellView o) => o -> m (Maybe CellArea)
- constructCellViewCellAreaContext :: (IsCellView o, IsCellAreaContext a) => a -> IO (GValueConstruct o)
- getCellViewCellAreaContext :: (MonadIO m, IsCellView o) => o -> m (Maybe CellAreaContext)
- constructCellViewDrawSensitive :: IsCellView o => Bool -> IO (GValueConstruct o)
- getCellViewDrawSensitive :: (MonadIO m, IsCellView o) => o -> m Bool
- setCellViewDrawSensitive :: (MonadIO m, IsCellView o) => o -> Bool -> m ()
- constructCellViewFitModel :: IsCellView o => Bool -> IO (GValueConstruct o)
- getCellViewFitModel :: (MonadIO m, IsCellView o) => o -> m Bool
- setCellViewFitModel :: (MonadIO m, IsCellView o) => o -> Bool -> m ()
- clearCellViewModel :: (MonadIO m, IsCellView o) => o -> m ()
- constructCellViewModel :: (IsCellView o, IsTreeModel a) => a -> IO (GValueConstruct o)
- getCellViewModel :: (MonadIO m, IsCellView o) => o -> m (Maybe TreeModel)
- setCellViewModel :: (MonadIO m, IsCellView o, IsTreeModel a) => o -> a -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq CellView Source # | |
IsGValue CellView Source # | Convert |
GObject CellView Source # | |
Defined in GI.Gtk.Objects.CellView gobjectType :: IO GType # | |
HasParentTypes CellView Source # | |
Defined in GI.Gtk.Objects.CellView | |
type ParentTypes CellView Source # | |
Defined in GI.Gtk.Objects.CellView |
class (GObject o, IsDescendantOf CellView o) => IsCellView o Source #
Type class for types which can be safely cast to CellView
, for instance with toCellView
.
Instances
(GObject o, IsDescendantOf CellView o) => IsCellView o Source # | |
Defined in GI.Gtk.Objects.CellView |
toCellView :: (MonadIO m, IsCellView o) => o -> m CellView Source #
Methods
Overloaded methods
getDisplayedRow
cellViewGetDisplayedRow Source #
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> m (Maybe TreePath) | Returns: the currently displayed row or |
getDrawSensitive
cellViewGetDrawSensitive Source #
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether cellView
is configured to draw all of its
cells in a sensitive state.
getFitModel
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> m Bool | Returns: whether |
Gets whether cellView
is configured to request space
to fit the entire TreeModel
.
getModel
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> m (Maybe TreeModel) |
Returns the model for cellView
. If no model is used Nothing
is
returned.
new
:: (HasCallStack, MonadIO m) | |
=> m CellView | Returns: A newly created |
Creates a new CellView
widget.
newWithContext
cellViewNewWithContext Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b) | |
=> a |
|
-> b |
|
-> m CellView | Returns: A newly created |
Creates a new CellView
widget with a specific CellArea
to layout cells and a specific CellAreaContext
.
Specifying the same context for a handfull of cells lets the underlying area synchronize the geometry for those cells, in this way alignments with cellviews for other rows are possible.
newWithMarkup
cellViewNewWithMarkup Source #
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m CellView | Returns: A newly created |
Creates a new CellView
widget, adds a CellRendererText
to it, and makes it show markup
. The text can be
marked up with the [Pango text markup language][PangoMarkupFormat].
newWithText
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m CellView | Returns: A newly created |
Creates a new CellView
widget, adds a CellRendererText
to it, and makes it show text
.
newWithTexture
cellViewNewWithTexture Source #
:: (HasCallStack, MonadIO m, IsTexture a) | |
=> a |
|
-> m CellView | Returns: A newly created |
Creates a new CellView
widget, adds a CellRendererPixbuf
to it, and makes it show texture
.
setDisplayedRow
cellViewSetDisplayedRow Source #
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> Maybe TreePath | |
-> m () |
setDrawSensitive
cellViewSetDrawSensitive Source #
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether cellView
should draw all of its
cells in a sensitive state, this is used by ComboBox
menus
to ensure that rows with insensitive cells that contain
children appear sensitive in the parent menu item.
setFitModel
:: (HasCallStack, MonadIO m, IsCellView a) | |
=> a |
|
-> Bool |
|
-> m () |
setModel
:: (HasCallStack, MonadIO m, IsCellView a, IsTreeModel b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the model for cellView
. If cellView
already has a model
set, it will remove it before setting the new model. If model
is
Nothing
, then it will unset the old model.
Properties
cellArea
The CellArea
rendering cells
If no area is specified when creating the cell view with cellViewNewWithContext
a horizontally oriented CellAreaBox
will be used.
since 3.0
constructCellViewCellArea :: (IsCellView o, IsCellArea a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “cell-area
” property. This is rarely needed directly, but it is used by new
.
getCellViewCellArea :: (MonadIO m, IsCellView o) => o -> m (Maybe CellArea) Source #
Get the value of the “cell-area
” property.
When overloading is enabled, this is equivalent to
get
cellView #cellArea
cellAreaContext
The CellAreaContext
used to compute the geometry of the cell view.
A group of cell views can be assigned the same context in order to ensure the sizes and cell alignments match across all the views with the same context.
ComboBox
menus uses this to assign the same context to all cell views
in the menu items for a single menu (each submenu creates its own
context since the size of each submenu does not depend on parent
or sibling menus).
since 3.0
constructCellViewCellAreaContext :: (IsCellView o, IsCellAreaContext a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “cell-area-context
” property. This is rarely needed directly, but it is used by new
.
getCellViewCellAreaContext :: (MonadIO m, IsCellView o) => o -> m (Maybe CellAreaContext) Source #
Get the value of the “cell-area-context
” property.
When overloading is enabled, this is equivalent to
get
cellView #cellAreaContext
drawSensitive
Whether all cells should be draw as sensitive for this view regardless of the actual cell properties (used to make menus with submenus appear sensitive when the items in submenus might be insensitive).
since 3.0
constructCellViewDrawSensitive :: IsCellView o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “draw-sensitive
” property. This is rarely needed directly, but it is used by new
.
getCellViewDrawSensitive :: (MonadIO m, IsCellView o) => o -> m Bool Source #
Get the value of the “draw-sensitive
” property.
When overloading is enabled, this is equivalent to
get
cellView #drawSensitive
setCellViewDrawSensitive :: (MonadIO m, IsCellView o) => o -> Bool -> m () Source #
Set the value of the “draw-sensitive
” property.
When overloading is enabled, this is equivalent to
set
cellView [ #drawSensitive:=
value ]
fitModel
Whether the view should request enough space to always fit the size of every row in the model (used by the combo box to ensure the combo box size doesnt change when different items are selected).
since 3.0
constructCellViewFitModel :: IsCellView o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “fit-model
” property. This is rarely needed directly, but it is used by new
.
getCellViewFitModel :: (MonadIO m, IsCellView o) => o -> m Bool Source #
Get the value of the “fit-model
” property.
When overloading is enabled, this is equivalent to
get
cellView #fitModel
setCellViewFitModel :: (MonadIO m, IsCellView o) => o -> Bool -> m () Source #
Set the value of the “fit-model
” property.
When overloading is enabled, this is equivalent to
set
cellView [ #fitModel:=
value ]
model
The model for cell view
since 2.10
clearCellViewModel :: (MonadIO m, IsCellView o) => o -> m () Source #
Set the value of the “model
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#model
constructCellViewModel :: (IsCellView o, IsTreeModel a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “model
” property. This is rarely needed directly, but it is used by new
.
getCellViewModel :: (MonadIO m, IsCellView o) => o -> m (Maybe TreeModel) Source #
Get the value of the “model
” property.
When overloading is enabled, this is equivalent to
get
cellView #model
setCellViewModel :: (MonadIO m, IsCellView o, IsTreeModel a) => o -> a -> m () Source #
Set the value of the “model
” property.
When overloading is enabled, this is equivalent to
set
cellView [ #model:=
value ]