Maintainer	hapytexeu+gh@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	Safe
Language	Haskell2010

Data.Char.Emoji.SkinColor

Contents

Skin color modifier
Create emoji with a SkinColorModifier
Pattern synonyms for the SkinColorModifier elements

Description

For several emoji, one can specify the color of the skin of the person(s) of the emoji. This module defines the skin color modifiers together with its values on the Fitzpatrick scale.

Synopsis

data SkinColorModifier
- = Light
- | MediumLight
- | Medium
- | MediumDark
- | Dark
type OptionalSkinColorModifier = Maybe SkinColorModifier
fromFitzpatrick :: Integral i => i -> Maybe SkinColorModifier
isSkinColorModifier :: Char -> Bool
class UnicodeText a => WithSkinColorModifierUnicodeText a where
- withSkinModifier :: a -> SkinColorModifier -> Text
- withOptionalSkinModifier :: a -> OptionalSkinColorModifier -> Text
- withoutOptionalSkinModifier :: Text -> Maybe (a, OptionalSkinColorModifier)
withSkinModifier' :: Text -> SkinColorModifier -> Text
withOptionalSkinModifier' :: Text -> OptionalSkinColorModifier -> Text
withoutOptionalSkinModifier' :: Text -> (Text, OptionalSkinColorModifier)
pattern FitzpatrickI :: SkinColorModifier
pattern FitzpatrickII :: SkinColorModifier
pattern FitzpatrickIII :: SkinColorModifier
pattern FitzpatrickIV :: SkinColorModifier
pattern FitzpatrickV :: SkinColorModifier
pattern FitzpatrickVI :: SkinColorModifier

Skin color modifier

data SkinColorModifier Source #

Some emoji deal with people. One can change the color of the skin with the SkinColorModifier. For the skin color, the /Fitzpatrick scale/ is used. A numerical classification system for skin types.

Constructors

Light	An emoji modifier that applies Fitzpatrick skin type one or two to the Emoji.
MediumLight	An emoji modifier that applies Fitzpatrick skin type three to the Emoji.
Medium	An emoji modifier that applies Fitzpatrick skin type four to the Emoji.
MediumDark	An emoji modifier that applies Fitzpatrick skin type five to the Emoji.
Dark	An emoji modifier that applies Fitzpatrick skin type six to the Emoji.

Instances

Instances details

Arbitrary SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods arbitrary :: Gen SkinColorModifier # shrink :: SkinColorModifier -> [SkinColorModifier] #
Data SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SkinColorModifier -> c SkinColorModifier # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SkinColorModifier # toConstr :: SkinColorModifier -> Constr # dataTypeOf :: SkinColorModifier -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SkinColorModifier) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SkinColorModifier) # gmapT :: (forall b. Data b => b -> b) -> SkinColorModifier -> SkinColorModifier # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SkinColorModifier -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SkinColorModifier -> r # gmapQ :: (forall d. Data d => d -> u) -> SkinColorModifier -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SkinColorModifier -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SkinColorModifier -> m SkinColorModifier # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SkinColorModifier -> m SkinColorModifier # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SkinColorModifier -> m SkinColorModifier #
Bounded SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods minBound :: SkinColorModifier # maxBound :: SkinColorModifier #
Enum SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods succ :: SkinColorModifier -> SkinColorModifier # pred :: SkinColorModifier -> SkinColorModifier # toEnum :: Int -> SkinColorModifier # fromEnum :: SkinColorModifier -> Int # enumFrom :: SkinColorModifier -> [SkinColorModifier] # enumFromThen :: SkinColorModifier -> SkinColorModifier -> [SkinColorModifier] # enumFromTo :: SkinColorModifier -> SkinColorModifier -> [SkinColorModifier] # enumFromThenTo :: SkinColorModifier -> SkinColorModifier -> SkinColorModifier -> [SkinColorModifier] #
Generic SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Associated Types type Rep SkinColorModifier :: Type -> Type # Methods from :: SkinColorModifier -> Rep SkinColorModifier x # to :: Rep SkinColorModifier x -> SkinColorModifier #
Read SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods readsPrec :: Int -> ReadS SkinColorModifier # readList :: ReadS [SkinColorModifier] # readPrec :: ReadPrec SkinColorModifier # readListPrec :: ReadPrec [SkinColorModifier] #
Show SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods showsPrec :: Int -> SkinColorModifier -> ShowS # show :: SkinColorModifier -> String # showList :: [SkinColorModifier] -> ShowS #
NFData SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods rnf :: SkinColorModifier -> () #
Eq SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods (==) :: SkinColorModifier -> SkinColorModifier -> Bool # (/=) :: SkinColorModifier -> SkinColorModifier -> Bool #
Ord SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods compare :: SkinColorModifier -> SkinColorModifier -> Ordering # (<) :: SkinColorModifier -> SkinColorModifier -> Bool # (<=) :: SkinColorModifier -> SkinColorModifier -> Bool # (>) :: SkinColorModifier -> SkinColorModifier -> Bool # (>=) :: SkinColorModifier -> SkinColorModifier -> Bool # max :: SkinColorModifier -> SkinColorModifier -> SkinColorModifier # min :: SkinColorModifier -> SkinColorModifier -> SkinColorModifier #
Hashable SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods hashWithSalt :: Int -> SkinColorModifier -> Int # hash :: SkinColorModifier -> Int #
UnicodeCharacter SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods toUnicodeChar :: SkinColorModifier -> Char Source # fromUnicodeChar :: Char -> Maybe SkinColorModifier Source # fromUnicodeChar' :: Char -> SkinColorModifier Source # isInCharRange :: Char -> Bool Source #
UnicodeText SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor Methods toUnicodeText :: SkinColorModifier -> Text Source # fromUnicodeText :: Text -> Maybe SkinColorModifier Source # fromUnicodeText' :: Text -> SkinColorModifier Source # isInTextRange :: Text -> Bool Source #
type Rep SkinColorModifier Source #
Instance details Defined in Data.Char.Emoji.SkinColor type Rep SkinColorModifier = D1 ('MetaData "SkinColorModifier" "Data.Char.Emoji.SkinColor" "unicode-tricks-0.14.1.0-EInLeozqGjBL3vIQTNPsAm" 'False) ((C1 ('MetaCons "Light" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MediumLight" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Medium" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MediumDark" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Dark" 'PrefixI 'False) (U1 :: Type -> Type))))

type OptionalSkinColorModifier = Maybe SkinColorModifier Source #

For emoji often the skin color is optional: in case there is no skin color specified, the emoji have often a yellow skin color.

fromFitzpatrick Source #

Arguments

:: Integral i
=> i	The given Fitzpatrick skin type.
-> Maybe SkinColorModifier	The corresponding `SkinColorModifier` wrapped in a `Just`; `Nothing` if no such modifier exists.

Convert the given Fitzpatrick skin type to the corresponding SkinColorModifier wrapped in a Just, if no such SkinColorModifier exists, Nothing is returned.

isSkinColorModifier Source #

Arguments

:: Char	The given `Char`acter to check.
-> Bool	`True` if the given `Char`acter is a skin color modifier, `False` otherwise.

Check if the given Character is a skin color modifier.

Create emoji with a `SkinColorModifier`

class UnicodeText a => WithSkinColorModifierUnicodeText a where Source #

A typeclass where one can specify that the object can be rendered with a given skin color modifier.

Minimal complete definition

Nothing

Methods

withSkinModifier Source #

Arguments

:: a	The given item to render to a unicode `Text` object.
-> SkinColorModifier	The given skin color modifier to apply.
-> Text	The corresponding `Text` where we applied the given `SkinColorModifier`.

Apply the given SkinColorModifier to the item and obtain a Text object where the item has been modified with the SkinColorModifier.

withOptionalSkinModifier Source #

Arguments

:: a	The given item to render to a unicode `Text` object.
-> OptionalSkinColorModifier	The given optional skin color modifier.
-> Text	The corresponding `Text` where we applied the given `SkinColorModifier`.

Apply the given SkinColorModifier to the item given it is not Nothing such that the object is rendered with the given skin color modifier.

withoutOptionalSkinModifier Source #

Arguments

:: Text	The given `Text` object that should be decoded.
-> Maybe (a, OptionalSkinColorModifier)	An optional 2-tuple with the item that has been read, and an optional `SkinColorModifier`.

Convert the given Text to an item with an OptionalSkinColorModifier that might have been applied.

Instances

Instances details

WithSkinColorModifierUnicodeText MultiCharHandGesture Source #
Instance details Defined in Data.Char.Emoji.Hand Methods withSkinModifier :: MultiCharHandGesture -> SkinColorModifier -> Text Source # withOptionalSkinModifier :: MultiCharHandGesture -> OptionalSkinColorModifier -> Text Source # withoutOptionalSkinModifier :: Text -> Maybe (MultiCharHandGesture, OptionalSkinColorModifier) Source #
WithSkinColorModifierUnicodeText SingleCharHandGesture Source #
Instance details Defined in Data.Char.Emoji.Hand Methods withSkinModifier :: SingleCharHandGesture -> SkinColorModifier -> Text Source # withOptionalSkinModifier :: SingleCharHandGesture -> OptionalSkinColorModifier -> Text Source # withoutOptionalSkinModifier :: Text -> Maybe (SingleCharHandGesture, OptionalSkinColorModifier) Source #

withSkinModifier' Source #

Arguments

:: Text	The given `Text` object where we want to specify the skin color.
-> SkinColorModifier	The given`SkinColorModifier` to apply.
-> Text	The given `Text` object combined with the given `SkinColorModifier`.

Append the given Text object with the Unicode character to modify its skin color.

withOptionalSkinModifier' Source #

Arguments

:: Text	The given `Text` object where we want to specify the skin color.
-> OptionalSkinColorModifier	The given`OptionalSkinColorModifier` to apply.
-> Text	The given `Text` object combined with the given `SkinColorModifier`.

Append the given Text object with the Unicode character to modify its skin color. If Nothing, then no modification is applied.

withoutOptionalSkinModifier' Source #

Arguments

:: Text	The given `Text` to decompose.
-> (Text, OptionalSkinColorModifier)	A 2-tuple where the first item is the remaining `Text` and where the second item is an optioanl `SkinColorModifier`.

Convert the given Text object to a wrapped Text object with an OptionalSkinColorModifier.

Pattern synonyms for the `SkinColorModifier` elements

pattern FitzpatrickI :: SkinColorModifier Source #

The SkinColorModifier that corresponds to type one of the /Fitzpatrick scale/.

pattern FitzpatrickII :: SkinColorModifier Source #

The SkinColorModifier that corresponds to type two of the /Fitzpatrick scale/.

pattern FitzpatrickIII :: SkinColorModifier Source #

The SkinColorModifier that corresponds to type three of the /Fitzpatrick scale/.

pattern FitzpatrickIV :: SkinColorModifier Source #

The SkinColorModifier that corresponds to type four of the /Fitzpatrick scale/.

pattern FitzpatrickV :: SkinColorModifier Source #

The SkinColorModifier that corresponds to type five of the /Fitzpatrick scale/.

pattern FitzpatrickVI :: SkinColorModifier Source #

The SkinColorModifier that corresponds to type six of the /Fitzpatrick scale/.

Skin color modifier

Instances

Create emoji with a SkinColorModifier

Instances

Pattern synonyms for the SkinColorModifier elements

Create emoji with a `SkinColorModifier`

Pattern synonyms for the `SkinColorModifier` elements