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

Constructors

EmblemedIcon (ManagedPtr EmblemedIcon)

Instances

GObject EmblemedIcon

Methods

gobjectType :: EmblemedIcon -> IO GType

IsObject EmblemedIcon

IsIcon EmblemedIcon

IsEmblemedIcon EmblemedIcon

class GObject o => IsEmblemedIcon o

Instances

(GObject a, UnknownAncestorError Constraint EmblemedIcon a) => IsEmblemedIcon a

IsEmblemedIcon EmblemedIcon

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

noEmblemedIcon :: Maybe EmblemedIcon

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

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

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