gi-gio-2.0.25: Gio bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.EmblemedIcon

Contents

Description

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

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

Synopsis

Exported types

newtype EmblemedIcon Source #

Memory-managed wrapper type.

Constructors

EmblemedIcon (ManagedPtr EmblemedIcon) 
Instances
Eq EmblemedIcon Source # 
Instance details

Defined in GI.Gio.Objects.EmblemedIcon

Methods

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

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

GObject EmblemedIcon Source # 
Instance details

Defined in GI.Gio.Objects.EmblemedIcon

Methods

gobjectType :: IO GType

IsGValue EmblemedIcon Source #

Convert EmblemedIcon to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Gio.Objects.EmblemedIcon

Methods

toGValue :: EmblemedIcon -> IO GValue

fromGValue :: GValue -> IO EmblemedIcon

HasParentTypes EmblemedIcon Source # 
Instance details

Defined in GI.Gio.Objects.EmblemedIcon

type ParentTypes EmblemedIcon Source # 
Instance details

Defined in GI.Gio.Objects.EmblemedIcon

type ParentTypes EmblemedIcon = Object ': (Icon ': ([] :: [Type]))

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

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

Instances
(GObject o, IsDescendantOf EmblemedIcon o) => IsEmblemedIcon o Source # 
Instance details

Defined in GI.Gio.Objects.EmblemedIcon

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

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

noEmblemedIcon :: Maybe EmblemedIcon Source #

A convenience alias for Nothing :: Maybe EmblemedIcon.

Methods

Overloaded methods

addEmblem

emblemedIconAddEmblem Source #

Arguments

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

emblemed: a tEmblemedIcon

-> b

emblem: a tEmblem

-> m () 

Adds emblem to the tList of GEmblems.

Since: 2.18

clearEmblems

emblemedIconClearEmblems Source #

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a) 
=> a

emblemed: a tEmblemedIcon

-> m () 

Removes all the emblems from icon.

Since: 2.28

getEmblems

emblemedIconGetEmblems Source #

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a) 
=> a

emblemed: a tEmblemedIcon

-> m [Emblem]

Returns: a tList of GEmblems that is owned by emblemed

Gets the list of emblems for the icon.

Since: 2.18

getIcon

emblemedIconGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsEmblemedIcon a) 
=> a

emblemed: a tEmblemedIcon

-> m Icon

Returns: a tIcon that is owned by emblemed

Gets the main icon for emblemed.

Since: 2.18

new

emblemedIconNew Source #

Arguments

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

icon: a tIcon

-> Maybe b

emblem: a tEmblem, or Nothing

-> m EmblemedIcon

Returns: a new tIcon

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, IsIcon a) => a -> IO (GValueConstruct o) Source #

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) Source #

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

get emblemedIcon #gicon