| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.BoolFilter
Description
GtkBoolFilter evaluates a boolean GtkExpression
to determine whether to include items.
Synopsis
- newtype BoolFilter = BoolFilter (ManagedPtr BoolFilter)
- class (GObject o, IsDescendantOf BoolFilter o) => IsBoolFilter o
- toBoolFilter :: (MonadIO m, IsBoolFilter o) => o -> m BoolFilter
- boolFilterGetExpression :: (HasCallStack, MonadIO m, IsBoolFilter a) => a -> m (Maybe Expression)
- boolFilterGetInvert :: (HasCallStack, MonadIO m, IsBoolFilter a) => a -> m Bool
- boolFilterNew :: (HasCallStack, MonadIO m, IsExpression a) => Maybe a -> m BoolFilter
- boolFilterSetExpression :: (HasCallStack, MonadIO m, IsBoolFilter a, IsExpression b) => a -> Maybe b -> m ()
- boolFilterSetInvert :: (HasCallStack, MonadIO m, IsBoolFilter a) => a -> Bool -> m ()
- clearBoolFilterExpression :: (MonadIO m, IsBoolFilter o) => o -> m ()
- constructBoolFilterExpression :: (IsBoolFilter o, MonadIO m, IsExpression a) => a -> m (GValueConstruct o)
- getBoolFilterExpression :: (MonadIO m, IsBoolFilter o) => o -> m (Maybe Expression)
- setBoolFilterExpression :: (MonadIO m, IsBoolFilter o, IsExpression a) => o -> a -> m ()
- constructBoolFilterInvert :: (IsBoolFilter o, MonadIO m) => Bool -> m (GValueConstruct o)
- getBoolFilterInvert :: (MonadIO m, IsBoolFilter o) => o -> m Bool
- setBoolFilterInvert :: (MonadIO m, IsBoolFilter o) => o -> Bool -> m ()
Exported types
newtype BoolFilter Source #
Memory-managed wrapper type.
Constructors
| BoolFilter (ManagedPtr BoolFilter) |
Instances
| Eq BoolFilter Source # | |
Defined in GI.Gtk.Objects.BoolFilter | |
| GObject BoolFilter Source # | |
Defined in GI.Gtk.Objects.BoolFilter | |
| ManagedPtrNewtype BoolFilter Source # | |
Defined in GI.Gtk.Objects.BoolFilter Methods toManagedPtr :: BoolFilter -> ManagedPtr BoolFilter | |
| TypedObject BoolFilter Source # | |
Defined in GI.Gtk.Objects.BoolFilter | |
| HasParentTypes BoolFilter Source # | |
Defined in GI.Gtk.Objects.BoolFilter | |
| IsGValue (Maybe BoolFilter) Source # | Convert |
Defined in GI.Gtk.Objects.BoolFilter Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe BoolFilter -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe BoolFilter) | |
| type ParentTypes BoolFilter Source # | |
Defined in GI.Gtk.Objects.BoolFilter | |
class (GObject o, IsDescendantOf BoolFilter o) => IsBoolFilter o Source #
Type class for types which can be safely cast to BoolFilter, for instance with toBoolFilter.
Instances
| (GObject o, IsDescendantOf BoolFilter o) => IsBoolFilter o Source # | |
Defined in GI.Gtk.Objects.BoolFilter | |
toBoolFilter :: (MonadIO m, IsBoolFilter o) => o -> m BoolFilter Source #
Cast to BoolFilter, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, changed, forceFloating, freezeNotify, getv, isFloating, match, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getExpression, getInvert, getProperty, getQdata, getStrictness.
Setters
setData, setDataFull, setExpression, setInvert, setProperty.
getExpression
boolFilterGetExpression Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBoolFilter a) | |
| => a |
|
| -> m (Maybe Expression) | Returns: a |
Gets the expression that the filter uses to evaluate if an item should be filtered.
getInvert
Arguments
| :: (HasCallStack, MonadIO m, IsBoolFilter a) | |
| => a |
|
| -> m Bool | Returns: |
Returns whether the filter inverts the expression.
new
Arguments
| :: (HasCallStack, MonadIO m, IsExpression a) | |
| => Maybe a |
|
| -> m BoolFilter | Returns: a new |
Creates a new bool filter.
setExpression
boolFilterSetExpression Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBoolFilter a, IsExpression b) | |
| => a |
|
| -> Maybe b |
|
| -> m () |
Sets the expression that the filter uses to check if items should be filtered.
The expression must have a value type of G_TYPE_BOOLEAN.
setInvert
Arguments
| :: (HasCallStack, MonadIO m, IsBoolFilter a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the filter should invert the expression.
Properties
expression
The boolean expression to evaluate on item.
clearBoolFilterExpression :: (MonadIO m, IsBoolFilter o) => o -> m () Source #
Set the value of the “expression” property to Nothing.
When overloading is enabled, this is equivalent to
clear #expression
constructBoolFilterExpression :: (IsBoolFilter o, MonadIO m, IsExpression a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “expression” property. This is rarely needed directly, but it is used by new.
getBoolFilterExpression :: (MonadIO m, IsBoolFilter o) => o -> m (Maybe Expression) Source #
Get the value of the “expression” property.
When overloading is enabled, this is equivalent to
get boolFilter #expression
setBoolFilterExpression :: (MonadIO m, IsBoolFilter o, IsExpression a) => o -> a -> m () Source #
Set the value of the “expression” property.
When overloading is enabled, this is equivalent to
setboolFilter [ #expression:=value ]
invert
If the expression result should be inverted.
constructBoolFilterInvert :: (IsBoolFilter o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “invert” property. This is rarely needed directly, but it is used by new.
getBoolFilterInvert :: (MonadIO m, IsBoolFilter o) => o -> m Bool Source #
Get the value of the “invert” property.
When overloading is enabled, this is equivalent to
get boolFilter #invert
setBoolFilterInvert :: (MonadIO m, IsBoolFilter o) => o -> Bool -> m () Source #
Set the value of the “invert” property.
When overloading is enabled, this is equivalent to
setboolFilter [ #invert:=value ]