Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gio.Objects.Emblem

Contents

Exported types
Methods
Properties
- icon
- origin

Description

GEmblem 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.

Synopsis

newtype Emblem = Emblem (ManagedPtr Emblem)
class (GObject o, IsDescendantOf Emblem o) => IsEmblem o
toEmblem :: (MonadIO m, IsEmblem o) => o -> m Emblem
type family ResolveEmblemMethod (t :: Symbol) o where ...
data EmblemGetIconMethodInfo
emblemGetIcon :: (HasCallStack, MonadIO m, IsEmblem a) => a -> m Icon
data EmblemGetOriginMethodInfo
emblemGetOrigin :: (HasCallStack, MonadIO m, IsEmblem a) => a -> m EmblemOrigin
emblemNew :: (HasCallStack, MonadIO m, IsIcon a) => a -> m Emblem
emblemNewWithOrigin :: (HasCallStack, MonadIO m, IsIcon a) => a -> EmblemOrigin -> m Emblem
data EmblemIconPropertyInfo
constructEmblemIcon :: (IsEmblem o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
emblemIcon :: AttrLabelProxy "icon"
getEmblemIcon :: (MonadIO m, IsEmblem o) => o -> m (Maybe Object)
data EmblemOriginPropertyInfo
constructEmblemOrigin :: (IsEmblem o, MonadIO m) => EmblemOrigin -> m (GValueConstruct o)
emblemOrigin :: AttrLabelProxy "origin"
getEmblemOrigin :: (MonadIO m, IsEmblem o) => o -> m EmblemOrigin

Exported types

newtype Emblem Source #

Memory-managed wrapper type.

Constructors

Emblem (ManagedPtr Emblem)

Instances

Instances details

Eq Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods (==) :: Emblem -> Emblem -> Bool # (/=) :: Emblem -> Emblem -> Bool #
GObject Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem
ManagedPtrNewtype Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods toManagedPtr :: Emblem -> ManagedPtr Emblem #
TypedObject Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods glibType :: IO GType #
HasParentTypes Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem
HasAttributeList Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem
(info ~ ResolveEmblemMethod t Emblem, OverloadedMethod info Emblem p, HasField t Emblem p) => HasField (t :: Symbol) Emblem (p :: Type) Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods getField :: Emblem -> p #
(info ~ ResolveEmblemMethod t Emblem, OverloadedMethodInfo info Emblem) => IsLabel t (MethodProxy info Emblem) Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods fromLabel :: MethodProxy info Emblem #
(info ~ ResolveEmblemMethod t Emblem, OverloadedMethod info Emblem p) => IsLabel t (Emblem -> p) Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods fromLabel :: Emblem -> p #
IsGValue (Maybe Emblem) Source #	Convert `Emblem` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gio.Objects.Emblem Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe Emblem -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe Emblem) #
type AttributeList Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem type AttributeList Emblem
type ParentTypes Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem type ParentTypes Emblem = '[Object, Icon]
type SignalList Emblem Source #
Instance details Defined in GI.Gio.Objects.Emblem type SignalList Emblem

class (GObject o, IsDescendantOf Emblem o) => IsEmblem o Source #

Type class for types which can be safely cast to Emblem, for instance with toEmblem.

Instances

Instances details

(GObject o, IsDescendantOf Emblem o) => IsEmblem o Source #
Instance details Defined in GI.Gio.Objects.Emblem

toEmblem :: (MonadIO m, IsEmblem o) => o -> m Emblem Source #

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

Methods

Click to display all available methods, including inherited ones

Expand

type family ResolveEmblemMethod (t :: Symbol) o where ... Source #

Equations

ResolveEmblemMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveEmblemMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveEmblemMethod "equal" o = IconEqualMethodInfo
ResolveEmblemMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveEmblemMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveEmblemMethod "getv" o = ObjectGetvMethodInfo
ResolveEmblemMethod "hash" o = IconHashMethodInfo
ResolveEmblemMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveEmblemMethod "notify" o = ObjectNotifyMethodInfo
ResolveEmblemMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveEmblemMethod "ref" o = ObjectRefMethodInfo
ResolveEmblemMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveEmblemMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveEmblemMethod "serialize" o = IconSerializeMethodInfo
ResolveEmblemMethod "stealData" o = ObjectStealDataMethodInfo
ResolveEmblemMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveEmblemMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveEmblemMethod "toString" o = IconToStringMethodInfo
ResolveEmblemMethod "unref" o = ObjectUnrefMethodInfo
ResolveEmblemMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveEmblemMethod "getData" o = ObjectGetDataMethodInfo
ResolveEmblemMethod "getIcon" o = EmblemGetIconMethodInfo
ResolveEmblemMethod "getOrigin" o = EmblemGetOriginMethodInfo
ResolveEmblemMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveEmblemMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveEmblemMethod "setData" o = ObjectSetDataMethodInfo
ResolveEmblemMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveEmblemMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveEmblemMethod l o = MethodResolutionFailed l o :: Type

getIcon

data EmblemGetIconMethodInfo Source #

Instances

Instances details

(signature ~ m Icon, MonadIO m, IsEmblem a) => OverloadedMethod EmblemGetIconMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo EmblemGetIconMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

emblemGetIcon Source #

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

Instances

Instances details

(signature ~ m EmblemOrigin, MonadIO m, IsEmblem a) => OverloadedMethod EmblemGetOriginMethodInfo a signature Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo EmblemGetOriginMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gio.Objects.Emblem Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

emblemGetOrigin Source #

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

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

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

The actual icon of the emblem.

Since: 2.18

data EmblemIconPropertyInfo Source #

Instances

Instances details

AttrInfo EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

Associated Types

type AttrAllowedOps EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrAllowedOps EmblemIconPropertyInfo = '['AttrConstruct, 'AttrGet, 'AttrClear]
type AttrBaseTypeConstraint EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrBaseTypeConstraint EmblemIconPropertyInfo = IsEmblem
type AttrGetType EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrGetType EmblemIconPropertyInfo = Maybe Object
type AttrSetTypeConstraint EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrSetTypeConstraint EmblemIconPropertyInfo = IsObject
type AttrTransferTypeConstraint EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrTransferTypeConstraint EmblemIconPropertyInfo = IsObject
type AttrTransferType EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrTransferType EmblemIconPropertyInfo = Object
type AttrLabel EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrLabel EmblemIconPropertyInfo = "icon"
type AttrOrigin EmblemIconPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrOrigin EmblemIconPropertyInfo = Emblem

Methods

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

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

attrClear :: AttrBaseTypeConstraint EmblemIconPropertyInfo o => o -> IO () #

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

attrTransfer :: (AttrBaseTypeConstraint EmblemIconPropertyInfo o, AttrTransferTypeConstraint EmblemIconPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType EmblemIconPropertyInfo) #

dbgAttrInfo :: Maybe ResolvedSymbolInfo #

type AttrAllowedOps EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrAllowedOps EmblemIconPropertyInfo = '['AttrConstruct, 'AttrGet, 'AttrClear]

type AttrBaseTypeConstraint EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrBaseTypeConstraint EmblemIconPropertyInfo = IsEmblem

type AttrGetType EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrGetType EmblemIconPropertyInfo = Maybe Object

type AttrLabel EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrLabel EmblemIconPropertyInfo = "icon"

type AttrOrigin EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrOrigin EmblemIconPropertyInfo = Emblem

type AttrSetTypeConstraint EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrSetTypeConstraint EmblemIconPropertyInfo = IsObject

type AttrTransferType EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrTransferType EmblemIconPropertyInfo = Object

type AttrTransferTypeConstraint EmblemIconPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

type AttrTransferTypeConstraint EmblemIconPropertyInfo = IsObject

constructEmblemIcon :: (IsEmblem o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #

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

emblemIcon :: AttrLabelProxy "icon" Source #

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

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

get emblem #icon

origin

The origin the emblem is derived from.

Since: 2.18

data EmblemOriginPropertyInfo Source #

Instances

Instances details

AttrInfo EmblemOriginPropertyInfo Source #

Instance details

Defined in GI.Gio.Objects.Emblem

Associated Types

type AttrAllowedOps EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrAllowedOps EmblemOriginPropertyInfo = '['AttrConstruct, 'AttrGet]
type AttrBaseTypeConstraint EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrBaseTypeConstraint EmblemOriginPropertyInfo = IsEmblem
type AttrGetType EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrGetType EmblemOriginPropertyInfo = EmblemOrigin
type AttrSetTypeConstraint EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrSetTypeConstraint EmblemOriginPropertyInfo = Type ~ EmblemOrigin
type AttrTransferTypeConstraint EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrTransferTypeConstraint EmblemOriginPropertyInfo = Type ~ EmblemOrigin
type AttrTransferType EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrTransferType EmblemOriginPropertyInfo = EmblemOrigin
type AttrLabel EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrLabel EmblemOriginPropertyInfo = "origin"
type AttrOrigin EmblemOriginPropertyInfo
Instance details Defined in GI.Gio.Objects.Emblem type AttrOrigin EmblemOriginPropertyInfo = Emblem