GI.Gio.Objects.EmblemedIcon

EmblemedIcon is an implementation of Icon that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via emblemedIconAddEmblem.

Note that EmblemedIcon allows no control over the position of the emblems. See also Emblem for more information.

Exported types

newtype EmblemedIcon

Memory-managed wrapper type.

Constructors

EmblemedIcon (ManagedPtr EmblemedIcon)

Instances

Eq EmblemedIcon

Defined in GI.Gio.Objects.EmblemedIcon

Methods

(==) :: EmblemedIcon -> EmblemedIcon -> Bool

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

IsGValue EmblemedIcon

Convert EmblemedIcon to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.EmblemedIcon

Methods

toGValue :: EmblemedIcon -> IO GValue

fromGValue :: GValue -> IO EmblemedIcon

ManagedPtrNewtype EmblemedIcon

Defined in GI.Gio.Objects.EmblemedIcon

Methods

toManagedPtr :: EmblemedIcon -> ManagedPtr EmblemedIcon

TypedObject EmblemedIcon

Defined in GI.Gio.Objects.EmblemedIcon

Methods

glibType :: IO GType

GObject EmblemedIcon

Defined in GI.Gio.Objects.EmblemedIcon

HasParentTypes EmblemedIcon

Defined in GI.Gio.Objects.EmblemedIcon

type ParentTypes EmblemedIcon

Defined in GI.Gio.Objects.EmblemedIcon

type ParentTypes EmblemedIcon = '[Object, Icon]

class (GObject o, IsDescendantOf EmblemedIcon o) => IsEmblemedIcon o

Type class for types which can be safely cast to EmblemedIcon, for instance with toEmblemedIcon.

Instances

(GObject o, IsDescendantOf EmblemedIcon o) => IsEmblemedIcon o

Defined in GI.Gio.Objects.EmblemedIcon

toEmblemedIcon :: (MonadIO m, IsEmblemedIcon o) => o -> m EmblemedIcon

Cast to EmblemedIcon, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

addEmblem

emblemedIconAddEmblem

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a, IsEmblem b)

=> a

emblemed: a EmblemedIcon

-> b

emblem: a Emblem

-> m ()

Adds emblem to the List of GEmblems.

Since: 2.18

clearEmblems

emblemedIconClearEmblems

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a)

=> a

emblemed: a EmblemedIcon

-> m ()

Removes all the emblems from icon.

Since: 2.28

getEmblems

emblemedIconGetEmblems

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a)

=> a

emblemed: a EmblemedIcon

-> m [Emblem]

Returns: a List of GEmblems that is owned by emblemed

Gets the list of emblems for the icon.

Since: 2.18

getIcon

emblemedIconGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a)

=> a

emblemed: a EmblemedIcon

-> m Icon

Returns: a Icon that is owned by emblemed

Gets the main icon for emblemed.

Since: 2.18

new

emblemedIconNew

Arguments

:: (HasCallStack, MonadIO m, IsIcon a, IsEmblem b)

=> a

icon: a Icon

-> Maybe b

emblem: a Emblem, or Nothing

-> m EmblemedIcon

Returns: a new Icon

Creates a new emblemed icon for icon with the emblem emblem.

Since: 2.18

Properties

gicon

No description available in the introspection data.

constructEmblemedIconGicon :: (IsEmblemedIcon o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)

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

getEmblemedIconGicon :: (MonadIO m, IsEmblemedIcon o) => o -> m (Maybe Icon)

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

get emblemedIcon #gicon