GI.Dazzle.Objects.PropertiesGroup

No description available in the introspection data.

Exported types

newtype PropertiesGroup

Memory-managed wrapper type.

Constructors

PropertiesGroup (ManagedPtr PropertiesGroup)

Instances

Eq PropertiesGroup

Defined in GI.Dazzle.Objects.PropertiesGroup

Methods

(==) :: PropertiesGroup -> PropertiesGroup -> Bool

(/=) :: PropertiesGroup -> PropertiesGroup -> Bool

GObject PropertiesGroup

Defined in GI.Dazzle.Objects.PropertiesGroup

ManagedPtrNewtype PropertiesGroup

Defined in GI.Dazzle.Objects.PropertiesGroup

Methods

toManagedPtr :: PropertiesGroup -> ManagedPtr PropertiesGroup

TypedObject PropertiesGroup

Defined in GI.Dazzle.Objects.PropertiesGroup

Methods

glibType :: IO GType

HasParentTypes PropertiesGroup

Defined in GI.Dazzle.Objects.PropertiesGroup

IsGValue (Maybe PropertiesGroup)

Convert PropertiesGroup to and from GValue. See toGValue and fromGValue.

Defined in GI.Dazzle.Objects.PropertiesGroup

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe PropertiesGroup -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe PropertiesGroup)

type ParentTypes PropertiesGroup

Defined in GI.Dazzle.Objects.PropertiesGroup

type ParentTypes PropertiesGroup = '[Object, ActionGroup]

class (GObject o, IsDescendantOf PropertiesGroup o) => IsPropertiesGroup o

Type class for types which can be safely cast to PropertiesGroup, for instance with toPropertiesGroup.

Instances

(GObject o, IsDescendantOf PropertiesGroup o) => IsPropertiesGroup o

Defined in GI.Dazzle.Objects.PropertiesGroup

toPropertiesGroup :: (MonadIO m, IsPropertiesGroup o) => o -> m PropertiesGroup

Cast to PropertiesGroup, 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

actionAdded, actionEnabledChanged, actionRemoved, actionStateChanged, activateAction, addAllProperties, addProperty, addPropertyFull, bindProperty, bindPropertyFull, changeActionState, forceFloating, freezeNotify, getv, hasAction, isFloating, listActions, notify, notifyByPspec, queryAction, ref, refSink, remove, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActionEnabled, getActionParameterType, getActionState, getActionStateHint, getActionStateType, getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

addAllProperties

propertiesGroupAddAllProperties

Arguments

:: (HasCallStack, MonadIO m, IsPropertiesGroup a)

=> a

self: A PropertiesGroup

-> m ()

This function will try to add all properties found on the target instance to the group. Only properties that are supported by the PropertiesGroup will be added.

The action name of all added properties will be identical to their property name.

Since: 3.26

addProperty

propertiesGroupAddProperty

Arguments

:: (HasCallStack, MonadIO m, IsPropertiesGroup a)

=> a

self: a PropertiesGroup

-> Text

name: the name of the action

-> Text

propertyName: the name of the property

-> m ()

Adds a new stateful action named name which maps to the underlying property propertyName of PropertiesGroup:object.

Since: 3.26

addPropertyFull

propertiesGroupAddPropertyFull

Arguments

:: (HasCallStack, MonadIO m, IsPropertiesGroup a)

=> a

self: a PropertiesGroup

-> Text

name: the name of the action

-> Text

propertyName: the name of the property

-> [PropertiesFlags]

flags: optional flags for the action

-> m ()

Adds a new stateful action named name which maps to the underlying property propertyName of PropertiesGroup:object.

Seting flags allows you to tweak some settings about the action.

Since: 3.26

new

propertiesGroupNew

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

object: The object containing the properties

-> m PropertiesGroup

Returns: A PropertiesGroup

This creates a new PropertiesGroup to create stateful actions around properties in object.

Call propertiesGroupAddProperty to add a property to action name mapping for this group. Until you've called this, no actions are mapped.

Note that PropertiesGroup only holds a weak reference to object and therefore you must keep object alive elsewhere.

Since: 3.26

newForType

propertiesGroupNewForType

Arguments

:: (HasCallStack, MonadIO m)

=> GType

objectType: A ObjectClass based type

-> m PropertiesGroup

Returns: A PropertiesGroup.

This creates a new PropertiesGroup for which the initial object is Nothing.

Set objectType to a type of a class which is a Object-based type.

remove

propertiesGroupRemove

Arguments

:: (HasCallStack, MonadIO m, IsPropertiesGroup a)

=> a

self: a PropertiesGroup

-> Text

name: the name of the action

-> m ()

Removes an action from self that was previously added with propertiesGroupAddProperty. name should match the name parameter to that function.

Since: 3.26

Properties

object

No description available in the introspection data.

clearPropertiesGroupObject :: (MonadIO m, IsPropertiesGroup o) => o -> m ()

Set the value of the “object” property to Nothing. When overloading is enabled, this is equivalent to

clear #object

constructPropertiesGroupObject :: (IsPropertiesGroup o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “object” property. This is rarely needed directly, but it is used by new.

getPropertiesGroupObject :: (MonadIO m, IsPropertiesGroup o) => o -> m (Maybe Object)

Get the value of the “object” property. When overloading is enabled, this is equivalent to

get propertiesGroup #object

setPropertiesGroupObject :: (MonadIO m, IsPropertiesGroup o, IsObject a) => o -> a -> m ()

Set the value of the “object” property. When overloading is enabled, this is equivalent to

set propertiesGroup [ #object := value ]

objectType

No description available in the introspection data.

constructPropertiesGroupObjectType :: (IsPropertiesGroup o, MonadIO m) => GType -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “object-type” property. This is rarely needed directly, but it is used by new.

getPropertiesGroupObjectType :: (MonadIO m, IsPropertiesGroup o) => o -> m GType

Get the value of the “object-type” property. When overloading is enabled, this is equivalent to

get propertiesGroup #objectType