Maintainer	gtk2hs-devel@lists.sourceforge.net
Stability	alpha
Portability	portable (depends on GHC)
Safe Haskell	None
Language	Haskell98

System.GIO.Icons.Emblem

Contents

Details
Types
Enums
Methods

Description

Synopsis

newtype Emblem = Emblem (ForeignPtr Emblem)
class GObjectClass o => EmblemClass o
data EmblemOrigin
emblemNew :: IconClass icon => icon -> IO Emblem
emblemNewWithOrigin :: IconClass icon => icon -> EmblemOrigin -> IO Emblem
emblemGetIcon :: EmblemClass emblem => emblem -> IO Icon
emblemGetOrigin :: EmblemClass emblem => emblem -> IO EmblemOrigin

Details

Emblem is an implementation of Icon that supports having an emblem, which is an icon with additional properties. It can than be added to a EmblemedIcon.

Currently, only metainformation about the emblem's origin is supported. More may be added in the future.

Types

newtype Emblem Source #

Constructors

Emblem (ForeignPtr Emblem)

Instances

Instances details

Eq Emblem Source #
Instance details Defined in System.GIO.Types Methods (==) :: Emblem -> Emblem -> Bool # (/=) :: Emblem -> Emblem -> Bool #
Ord Emblem Source #
Instance details Defined in System.GIO.Types Methods compare :: Emblem -> Emblem -> Ordering # (<) :: Emblem -> Emblem -> Bool # (<=) :: Emblem -> Emblem -> Bool # (>) :: Emblem -> Emblem -> Bool # (>=) :: Emblem -> Emblem -> Bool # max :: Emblem -> Emblem -> Emblem # min :: Emblem -> Emblem -> Emblem #
GObjectClass Emblem Source #
Instance details Defined in System.GIO.Types Methods toGObject :: Emblem -> GObject # unsafeCastGObject :: GObject -> Emblem #
EmblemClass Emblem Source #
Instance details Defined in System.GIO.Types

class GObjectClass o => EmblemClass o Source #

Instances

Instances details

EmblemClass Emblem Source #
Instance details Defined in System.GIO.Types

Enums

data EmblemOrigin Source #

EmblemOrigin is used to add information about the origin of the emblem to Emblem.

Constructors

EmblemOriginUnknown
EmblemOriginDevice
EmblemOriginLivemetadata
EmblemOriginTag

Instances

Instances details

Bounded EmblemOrigin Source #
Instance details Defined in System.GIO.Enums Methods minBound :: EmblemOrigin # maxBound :: EmblemOrigin #
Enum EmblemOrigin Source #
Instance details Defined in System.GIO.Enums Methods succ :: EmblemOrigin -> EmblemOrigin # pred :: EmblemOrigin -> EmblemOrigin # toEnum :: Int -> EmblemOrigin # fromEnum :: EmblemOrigin -> Int # enumFrom :: EmblemOrigin -> [EmblemOrigin] # enumFromThen :: EmblemOrigin -> EmblemOrigin -> [EmblemOrigin] # enumFromTo :: EmblemOrigin -> EmblemOrigin -> [EmblemOrigin] # enumFromThenTo :: EmblemOrigin -> EmblemOrigin -> EmblemOrigin -> [EmblemOrigin] #
Eq EmblemOrigin Source #
Instance details Defined in System.GIO.Enums Methods (==) :: EmblemOrigin -> EmblemOrigin -> Bool # (/=) :: EmblemOrigin -> EmblemOrigin -> Bool #
Ord EmblemOrigin Source #
Instance details Defined in System.GIO.Enums Methods compare :: EmblemOrigin -> EmblemOrigin -> Ordering # (<) :: EmblemOrigin -> EmblemOrigin -> Bool # (<=) :: EmblemOrigin -> EmblemOrigin -> Bool # (>) :: EmblemOrigin -> EmblemOrigin -> Bool # (>=) :: EmblemOrigin -> EmblemOrigin -> Bool # max :: EmblemOrigin -> EmblemOrigin -> EmblemOrigin # min :: EmblemOrigin -> EmblemOrigin -> EmblemOrigin #
Show EmblemOrigin Source #
Instance details Defined in System.GIO.Enums Methods showsPrec :: Int -> EmblemOrigin -> ShowS # show :: EmblemOrigin -> String # showList :: [EmblemOrigin] -> ShowS #

Methods

emblemNew :: IconClass icon => icon -> IO Emblem Source #

Creates a new emblem for icon.

emblemNewWithOrigin Source #

Arguments

:: IconClass icon
=> icon	`icon` a `Icon` containing the icon.
-> EmblemOrigin	`origin` a `EmblemOrigin` enum defining the emblem's origin
-> IO Emblem

Creates a new emblem for icon.

emblemGetIcon Source #

Arguments

:: EmblemClass emblem
=> emblem	`emblem` a `Emblem` from which the icon should be extracted.
-> IO Icon	returns a `Icon`. The returned object belongs to the emblem and should not be modified or freed.

Gives back the icon from emblem.

emblemGetOrigin :: EmblemClass emblem => emblem -> IO EmblemOrigin Source #

Gets the origin of the emblem.