GI.Gio.Objects.Emblem

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.

Exported types

newtype Emblem

Constructors

Emblem (ManagedPtr Emblem)

Instances

GObject Emblem

Methods

gobjectType :: Emblem -> IO GType

IsObject Emblem

IsEmblem Emblem

IsIcon Emblem

((~) * info (ResolveEmblemMethod t Emblem), MethodInfo * info Emblem p) => IsLabel t (Emblem -> p)

Methods

fromLabel :: Proxy# Symbol t -> Emblem -> p

((~) * info (ResolveEmblemMethod t Emblem), MethodInfo * info Emblem p) => IsLabelProxy t (Emblem -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Emblem -> p

HasAttributeList * Emblem

type AttributeList Emblem

type AttributeList Emblem

type SignalList Emblem

type SignalList Emblem

class GObject o => IsEmblem o

Instances

(GObject a, UnknownAncestorError Constraint Emblem a) => IsEmblem a

IsEmblem Emblem

toEmblem :: IsEmblem o => o -> IO Emblem

noEmblem :: Maybe Emblem

Methods

getIcon

data EmblemGetIconMethodInfo

Instances

((~) * signature (m Icon), MonadIO m, IsEmblem a) => MethodInfo * EmblemGetIconMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EmblemGetIconMethodInfo a -> signature -> s

emblemGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsEmblem a)

=> a

emblem: a Emblem from which the icon should be extracted.

-> m Icon

Returns: a Icon. The returned object belongs to the emblem and should not be modified or freed.

Gives back the icon from emblem.

Since: 2.18

getOrigin

data EmblemGetOriginMethodInfo

Instances

((~) * signature (m EmblemOrigin), MonadIO m, IsEmblem a) => MethodInfo * EmblemGetOriginMethodInfo a signature

Methods

overloadedMethod :: MethodProxy EmblemGetOriginMethodInfo a -> signature -> s

emblemGetOrigin

Arguments

:: (HasCallStack, MonadIO m, IsEmblem a)

=> a

emblem: a Emblem

-> m EmblemOrigin

Returns: the origin of the emblem

Gets the origin of the emblem.

Since: 2.18

new

emblemNew

Arguments

:: (HasCallStack, MonadIO m, IsIcon a)

=> a

icon: a GIcon containing the icon.

-> m Emblem

Returns: a new Emblem.

Creates a new emblem for icon.

Since: 2.18

newWithOrigin

emblemNewWithOrigin

Arguments

:: (HasCallStack, MonadIO m, IsIcon a)

=> a

icon: a GIcon containing the icon.

-> EmblemOrigin

origin: a GEmblemOrigin enum defining the emblem's origin

-> m Emblem

Returns: a new Emblem.

Creates a new emblem for icon.

Since: 2.18

Properties

icon

data EmblemIconPropertyInfo

Instances

AttrInfo EmblemIconPropertyInfo

Associated Types

type AttrAllowedOps EmblemIconPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint EmblemIconPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint EmblemIconPropertyInfo :: * -> Constraint

type AttrGetType EmblemIconPropertyInfo :: *

type AttrLabel EmblemIconPropertyInfo :: Symbol

type AttrOrigin EmblemIconPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint EmblemIconPropertyInfo o => Proxy * EmblemIconPropertyInfo -> o -> IO (AttrGetType EmblemIconPropertyInfo)

attrSet :: (AttrBaseTypeConstraint EmblemIconPropertyInfo o, AttrSetTypeConstraint EmblemIconPropertyInfo b) => Proxy * EmblemIconPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint EmblemIconPropertyInfo o => Proxy * EmblemIconPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint EmblemIconPropertyInfo o, AttrSetTypeConstraint EmblemIconPropertyInfo b) => Proxy * EmblemIconPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin EmblemIconPropertyInfo

type AttrOrigin EmblemIconPropertyInfo = Emblem

type AttrLabel EmblemIconPropertyInfo

type AttrLabel EmblemIconPropertyInfo = "icon"

type AttrGetType EmblemIconPropertyInfo

type AttrGetType EmblemIconPropertyInfo = Maybe Object

type AttrBaseTypeConstraint EmblemIconPropertyInfo

type AttrBaseTypeConstraint EmblemIconPropertyInfo = IsEmblem

type AttrSetTypeConstraint EmblemIconPropertyInfo

type AttrSetTypeConstraint EmblemIconPropertyInfo = IsObject

type AttrAllowedOps EmblemIconPropertyInfo

type AttrAllowedOps EmblemIconPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructEmblemIcon :: (IsEmblem o, IsObject a) => a -> IO (GValueConstruct o)

emblemIcon :: AttrLabelProxy "icon"

getEmblemIcon :: (MonadIO m, IsEmblem o) => o -> m (Maybe Object)

origin

data EmblemOriginPropertyInfo

Instances

AttrInfo EmblemOriginPropertyInfo

Associated Types

type AttrAllowedOps EmblemOriginPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint EmblemOriginPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint EmblemOriginPropertyInfo :: * -> Constraint

type AttrGetType EmblemOriginPropertyInfo :: *

type AttrLabel EmblemOriginPropertyInfo :: Symbol

type AttrOrigin EmblemOriginPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint EmblemOriginPropertyInfo o => Proxy * EmblemOriginPropertyInfo -> o -> IO (AttrGetType EmblemOriginPropertyInfo)

attrSet :: (AttrBaseTypeConstraint EmblemOriginPropertyInfo o, AttrSetTypeConstraint EmblemOriginPropertyInfo b) => Proxy * EmblemOriginPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint EmblemOriginPropertyInfo o => Proxy * EmblemOriginPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint EmblemOriginPropertyInfo o, AttrSetTypeConstraint EmblemOriginPropertyInfo b) => Proxy * EmblemOriginPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin EmblemOriginPropertyInfo

type AttrOrigin EmblemOriginPropertyInfo = Emblem

type AttrLabel EmblemOriginPropertyInfo

type AttrLabel EmblemOriginPropertyInfo = "origin"

type AttrGetType EmblemOriginPropertyInfo

type AttrGetType EmblemOriginPropertyInfo = EmblemOrigin

type AttrBaseTypeConstraint EmblemOriginPropertyInfo

type AttrBaseTypeConstraint EmblemOriginPropertyInfo = IsEmblem

type AttrSetTypeConstraint EmblemOriginPropertyInfo

type AttrSetTypeConstraint EmblemOriginPropertyInfo = * ~ EmblemOrigin

type AttrAllowedOps EmblemOriginPropertyInfo

type AttrAllowedOps EmblemOriginPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructEmblemOrigin :: IsEmblem o => EmblemOrigin -> IO (GValueConstruct o)

emblemOrigin :: AttrLabelProxy "origin"

getEmblemOrigin :: (MonadIO m, IsEmblem o) => o -> m EmblemOrigin