{- |
Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License    : LGPL-2.1
Maintainer : Iñaki García Etxebarria (inaki@blueleaf.cc)

'GI.Atk.Interfaces.Value.Value' should be implemented for components which either display
a value from a bounded range, or which allow the user to specify a
value from a bounded range, or both. For instance, most sliders and
range controls, as well as dials, should have 'GI.Atk.Objects.Object.Object'
representations which implement 'GI.Atk.Interfaces.Value.Value' on the component\'s
behalf. @/AtKValues/@ may be read-only, in which case attempts to
alter the value return would fail.

\<refsect1 id=\"current-value-text\">
\<title>On the subject of current value text\<\/title>
\<para>
In addition to providing the current value, implementors can
optionally provide an end-user-consumable textual description
associated with this value. This description should be included
when the numeric value fails to convey the full, on-screen
representation seen by users.
\<\/para>

\<example>
\<title>Password strength\<\/title>
A password strength meter whose value changes as the user types
their new password. Red is used for values less than 4.0, yellow
for values between 4.0 and 7.0, and green for values greater than
7.0. In this instance, value text should be provided by the
implementor. Appropriate value text would be \"weak\", \"acceptable,\"
and \"strong\" respectively.
\<\/example>

A level bar whose value changes to reflect the battery charge. The
color remains the same regardless of the charge and there is no
on-screen text reflecting the fullness of the battery. In this
case, because the position within the bar is the only indication
the user has of the current charge, value text should not be
provided by the implementor.

\<refsect2 id=\"implementor-notes\">
\<title>Implementor Notes\<\/title>
\<para>
Implementors should bear in mind that assistive technologies will
likely prefer the value text provided over the numeric value when
presenting a widget\'s value. As a result, strings not intended for
end users should not be exposed in the value text, and strings
which are exposed should be localized. In the case of widgets which
display value text on screen, for instance through a separate label
in close proximity to the value-displaying widget, it is still
expected that implementors will expose the value text using the
above API.
\<\/para>

\<para>
'GI.Atk.Interfaces.Value.Value' should NOT be implemented for widgets whose displayed
value is not reflective of a meaningful amount. For instance, a
progress pulse indicator whose value alternates between 0.0 and 1.0
to indicate that some process is still taking place should not
implement 'GI.Atk.Interfaces.Value.Value' because the current value does not reflect
progress towards completion.
\<\/para>
\<\/refsect2>
\<\/refsect1>

\<refsect1 id=\"ranges\">
\<title>On the subject of ranges\<\/title>
\<para>
In addition to providing the minimum and maximum values,
implementors can optionally provide details about subranges
associated with the widget. These details should be provided by the
implementor when both of the following are communicated visually to
the end user:
\<\/para>
\<itemizedlist>
  \<listitem>The existence of distinct ranges such as \"weak\",
  \"acceptable\", and \"strong\" indicated by color, bar tick marks,
  and\/or on-screen text.\<\/listitem>
  \<listitem>Where the current value stands within a given subrange,
  for instance illustrating progression from very \"weak\" towards
  nearly \"acceptable\" through changes in shade and\/or position on
  the bar within the \"weak\" subrange.\<\/listitem>
\<\/itemizedlist>
\<para>
If both of the above do not apply to the widget, it should be
sufficient to expose the numeric value, along with the value text
if appropriate, to make the widget accessible.
\<\/para>

\<refsect2 id=\"ranges-implementor-notes\">
\<title>Implementor Notes\<\/title>
\<para>
If providing subrange details is deemed necessary, all possible
values of the widget are expected to fall within one of the
subranges defined by the implementor.
\<\/para>
\<\/refsect2>
\<\/refsect1>

\<refsect1 id=\"localization\">
\<title>On the subject of localization of end-user-consumable text
values\<\/title>
\<para>
Because value text and subrange descriptors are human-consumable,
implementors are expected to provide localized strings which can be
directly presented to end users via their assistive technology. In
order to simplify this for implementors, implementors can use
'GI.Atk.Functions.valueTypeGetLocalizedName' with the following
already-localized constants for commonly-needed values can be used:
\<\/para>

\<itemizedlist>
  \<listitem>ATK_VALUE_VERY_WEAK\<\/listitem>
  \<listitem>ATK_VALUE_WEAK\<\/listitem>
  \<listitem>ATK_VALUE_ACCEPTABLE\<\/listitem>
  \<listitem>ATK_VALUE_STRONG\<\/listitem>
  \<listitem>ATK_VALUE_VERY_STRONG\<\/listitem>
  \<listitem>ATK_VALUE_VERY_LOW\<\/listitem>
  \<listitem>ATK_VALUE_LOW\<\/listitem>
  \<listitem>ATK_VALUE_MEDIUM\<\/listitem>
  \<listitem>ATK_VALUE_HIGH\<\/listitem>
  \<listitem>ATK_VALUE_VERY_HIGH\<\/listitem>
  \<listitem>ATK_VALUE_VERY_BAD\<\/listitem>
  \<listitem>ATK_VALUE_BAD\<\/listitem>
  \<listitem>ATK_VALUE_GOOD\<\/listitem>
  \<listitem>ATK_VALUE_VERY_GOOD\<\/listitem>
  \<listitem>ATK_VALUE_BEST\<\/listitem>
  \<listitem>ATK_VALUE_SUBSUBOPTIMAL\<\/listitem>
  \<listitem>ATK_VALUE_SUBOPTIMAL\<\/listitem>
  \<listitem>ATK_VALUE_OPTIMAL\<\/listitem>
\<\/itemizedlist>
\<para>
Proposals for additional constants, along with their use cases,
should be submitted to the GNOME Accessibility Team.
\<\/para>
\<\/refsect1>

\<refsect1 id=\"changes\">
\<title>On the subject of changes\<\/title>
\<para>
Note that if there is a textual description associated with the new
numeric value, that description should be included regardless of
whether or not it has also changed.
\<\/para>
\<\/refsect1>
-}

#define ENABLE_OVERLOADING (MIN_VERSION_haskell_gi_overloading(1,0,0) \
       && !defined(__HADDOCK_VERSION__))

module GI.Atk.Interfaces.Value
    (

-- * Exported types
    Value(..)                               ,
    noValue                                 ,
    IsValue                                 ,
    toValue                                 ,


 -- * Methods
-- ** getCurrentValue #method:getCurrentValue#

#if ENABLE_OVERLOADING
    ValueGetCurrentValueMethodInfo          ,
#endif
    valueGetCurrentValue                    ,


-- ** getIncrement #method:getIncrement#

#if ENABLE_OVERLOADING
    ValueGetIncrementMethodInfo             ,
#endif
    valueGetIncrement                       ,


-- ** getMaximumValue #method:getMaximumValue#

#if ENABLE_OVERLOADING
    ValueGetMaximumValueMethodInfo          ,
#endif
    valueGetMaximumValue                    ,


-- ** getMinimumIncrement #method:getMinimumIncrement#

#if ENABLE_OVERLOADING
    ValueGetMinimumIncrementMethodInfo      ,
#endif
    valueGetMinimumIncrement                ,


-- ** getMinimumValue #method:getMinimumValue#

#if ENABLE_OVERLOADING
    ValueGetMinimumValueMethodInfo          ,
#endif
    valueGetMinimumValue                    ,


-- ** getRange #method:getRange#

#if ENABLE_OVERLOADING
    ValueGetRangeMethodInfo                 ,
#endif
    valueGetRange                           ,


-- ** getSubRanges #method:getSubRanges#

#if ENABLE_OVERLOADING
    ValueGetSubRangesMethodInfo             ,
#endif
    valueGetSubRanges                       ,


-- ** getValueAndText #method:getValueAndText#

#if ENABLE_OVERLOADING
    ValueGetValueAndTextMethodInfo          ,
#endif
    valueGetValueAndText                    ,


-- ** setCurrentValue #method:setCurrentValue#

#if ENABLE_OVERLOADING
    ValueSetCurrentValueMethodInfo          ,
#endif
    valueSetCurrentValue                    ,


-- ** setValue #method:setValue#

#if ENABLE_OVERLOADING
    ValueSetValueMethodInfo                 ,
#endif
    valueSetValue                           ,




 -- * Signals
-- ** valueChanged #signal:valueChanged#

    C_ValueValueChangedCallback             ,
    ValueValueChangedCallback               ,
#if ENABLE_OVERLOADING
    ValueValueChangedSignalInfo             ,
#endif
    afterValueValueChanged                  ,
    genClosure_ValueValueChanged            ,
    mk_ValueValueChangedCallback            ,
    noValueValueChangedCallback             ,
    onValueValueChanged                     ,
    wrap_ValueValueChangedCallback          ,




    ) where

import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P

import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL

import {-# SOURCE #-} qualified GI.Atk.Structs.Range as Atk.Range
import qualified GI.GObject.Objects.Object as GObject.Object

-- interface Value 
-- | Memory-managed wrapper type.
newtype Value = Value (ManagedPtr Value)
-- | A convenience alias for `Nothing` :: `Maybe` `Value`.
noValue :: Maybe Value
noValue = Nothing

-- signal Value::value-changed
{- |
The \'value-changed\' signal is emitted when the current value
that represent the object changes. /@value@/ is the numerical
representation of this new value.  /@text@/ is the human
readable text alternative of /@value@/, and can be NULL if it is
not available. Note that if there is a textual description
associated with the new numeric value, that description
should be included regardless of whether or not it has also
changed.

Example: a password meter whose value changes as the user
types their new password. Appropiate value text would be
\"weak\", \"acceptable\" and \"strong\".

/Since: 2.12/
-}
type ValueValueChangedCallback =
    Double
    {- ^ /@value@/: the new value in a numerical form. -}
    -> T.Text
    {- ^ /@text@/: human readable text alternative (also called
description) of this object. NULL if not available. -}
    -> IO ()

-- | A convenience synonym for @`Nothing` :: `Maybe` `ValueValueChangedCallback`@.
noValueValueChangedCallback :: Maybe ValueValueChangedCallback
noValueValueChangedCallback = Nothing

-- | Type for the callback on the (unwrapped) C side.
type C_ValueValueChangedCallback =
    Ptr () ->                               -- object
    CDouble ->
    CString ->
    Ptr () ->                               -- user_data
    IO ()

-- | Generate a function pointer callable from C code, from a `C_ValueValueChangedCallback`.
foreign import ccall "wrapper"
    mk_ValueValueChangedCallback :: C_ValueValueChangedCallback -> IO (FunPtr C_ValueValueChangedCallback)

-- | Wrap the callback into a `GClosure`.
genClosure_ValueValueChanged :: MonadIO m => ValueValueChangedCallback -> m (GClosure C_ValueValueChangedCallback)
genClosure_ValueValueChanged cb = liftIO $ do
    let cb' = wrap_ValueValueChangedCallback cb
    mk_ValueValueChangedCallback cb' >>= B.GClosure.newGClosure


-- | Wrap a `ValueValueChangedCallback` into a `C_ValueValueChangedCallback`.
wrap_ValueValueChangedCallback ::
    ValueValueChangedCallback ->
    C_ValueValueChangedCallback
wrap_ValueValueChangedCallback _cb _ value text _ = do
    let value' = realToFrac value
    text' <- cstringToText text
    _cb  value' text'


{- |
Connect a signal handler for the “@value-changed@” signal, to be run before the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to

@
'Data.GI.Base.Signals.on' value #valueChanged callback
@
-}
onValueValueChanged :: (IsValue a, MonadIO m) => a -> ValueValueChangedCallback -> m SignalHandlerId
onValueValueChanged obj cb = liftIO $ do
    let cb' = wrap_ValueValueChangedCallback cb
    cb'' <- mk_ValueValueChangedCallback cb'
    connectSignalFunPtr obj "value-changed" cb'' SignalConnectBefore

{- |
Connect a signal handler for the “@value-changed@” signal, to be run after the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to

@
'Data.GI.Base.Signals.after' value #valueChanged callback
@
-}
afterValueValueChanged :: (IsValue a, MonadIO m) => a -> ValueValueChangedCallback -> m SignalHandlerId
afterValueValueChanged obj cb = liftIO $ do
    let cb' = wrap_ValueValueChangedCallback cb
    cb'' <- mk_ValueValueChangedCallback cb'
    connectSignalFunPtr obj "value-changed" cb'' SignalConnectAfter


#if ENABLE_OVERLOADING
data ValueValueChangedSignalInfo
instance SignalInfo ValueValueChangedSignalInfo where
    type HaskellCallbackType ValueValueChangedSignalInfo = ValueValueChangedCallback
    connectSignal _ obj cb connectMode = do
        let cb' = wrap_ValueValueChangedCallback cb
        cb'' <- mk_ValueValueChangedCallback cb'
        connectSignalFunPtr obj "value-changed" cb'' connectMode

type instance O.SignalList Value = ValueSignalList
type ValueSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo), '("valueChanged", ValueValueChangedSignalInfo)] :: [(Symbol, *)])

#endif

foreign import ccall "atk_value_get_type"
    c_atk_value_get_type :: IO GType

instance GObject Value where
    gobjectType = c_atk_value_get_type


-- | Type class for types which can be safely cast to `Value`, for instance with `toValue`.
class (GObject o, O.IsDescendantOf Value o) => IsValue o
instance (GObject o, O.IsDescendantOf Value o) => IsValue o

instance O.HasParentTypes Value
type instance O.ParentTypes Value = '[GObject.Object.Object]

-- | Cast to `Value`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toValue :: (MonadIO m, IsValue o) => o -> m Value
toValue = liftIO . unsafeCastTo Value

#if ENABLE_OVERLOADING
instance O.HasAttributeList Value
type instance O.AttributeList Value = ValueAttributeList
type ValueAttributeList = ('[ ] :: [(Symbol, *)])
#endif

#if ENABLE_OVERLOADING
#endif

#if ENABLE_OVERLOADING
type family ResolveValueMethod (t :: Symbol) (o :: *) :: * where
    ResolveValueMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
    ResolveValueMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
    ResolveValueMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
    ResolveValueMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
    ResolveValueMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
    ResolveValueMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
    ResolveValueMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
    ResolveValueMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
    ResolveValueMethod "ref" o = GObject.Object.ObjectRefMethodInfo
    ResolveValueMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
    ResolveValueMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
    ResolveValueMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
    ResolveValueMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
    ResolveValueMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
    ResolveValueMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
    ResolveValueMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
    ResolveValueMethod "getCurrentValue" o = ValueGetCurrentValueMethodInfo
    ResolveValueMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
    ResolveValueMethod "getIncrement" o = ValueGetIncrementMethodInfo
    ResolveValueMethod "getMaximumValue" o = ValueGetMaximumValueMethodInfo
    ResolveValueMethod "getMinimumIncrement" o = ValueGetMinimumIncrementMethodInfo
    ResolveValueMethod "getMinimumValue" o = ValueGetMinimumValueMethodInfo
    ResolveValueMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
    ResolveValueMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
    ResolveValueMethod "getRange" o = ValueGetRangeMethodInfo
    ResolveValueMethod "getSubRanges" o = ValueGetSubRangesMethodInfo
    ResolveValueMethod "getValueAndText" o = ValueGetValueAndTextMethodInfo
    ResolveValueMethod "setCurrentValue" o = ValueSetCurrentValueMethodInfo
    ResolveValueMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
    ResolveValueMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
    ResolveValueMethod "setValue" o = ValueSetValueMethodInfo
    ResolveValueMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveValueMethod t Value, O.MethodInfo info Value p) => OL.IsLabel t (Value -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#else
    fromLabel _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#endif

#endif

-- method Value::get_current_value
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TInterface (Name {namespace = "GObject", name = "Value"}), direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GValue representing the current accessible value", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = True, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_current_value" atk_value_get_current_value ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    Ptr GValue ->                           -- value : TInterface (Name {namespace = "GObject", name = "Value"})
    IO ()

{-# DEPRECATED valueGetCurrentValue ["Since 2.12. Use 'GI.Atk.Interfaces.Value.valueGetValueAndText'","instead."] #-}
{- |
Gets the value of this object.
-}
valueGetCurrentValue ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m (GValue)
valueGetCurrentValue obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    value <- callocBoxedBytes 24 :: IO (Ptr GValue)
    atk_value_get_current_value obj' value
    value' <- (wrapBoxed GValue) value
    touchManagedPtr obj
    return value'

#if ENABLE_OVERLOADING
data ValueGetCurrentValueMethodInfo
instance (signature ~ (m (GValue)), MonadIO m, IsValue a) => O.MethodInfo ValueGetCurrentValueMethodInfo a signature where
    overloadedMethod _ = valueGetCurrentValue

#endif

-- method Value::get_increment
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TDouble)
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_increment" atk_value_get_increment ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    IO CDouble

{- |
Gets the minimum increment by which the value of this object may be
changed.  If zero, the minimum increment is undefined, which may
mean that it is limited only by the floating point precision of the
platform.

/Since: 2.12/
-}
valueGetIncrement ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m Double
    {- ^ __Returns:__ the minimum increment by which the value of this
object may be changed. zero if undefined. -}
valueGetIncrement obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    result <- atk_value_get_increment obj'
    let result' = realToFrac result
    touchManagedPtr obj
    return result'

#if ENABLE_OVERLOADING
data ValueGetIncrementMethodInfo
instance (signature ~ (m Double), MonadIO m, IsValue a) => O.MethodInfo ValueGetIncrementMethodInfo a signature where
    overloadedMethod _ = valueGetIncrement

#endif

-- method Value::get_maximum_value
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TInterface (Name {namespace = "GObject", name = "Value"}), direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GValue representing the maximum accessible value", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = True, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_maximum_value" atk_value_get_maximum_value ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    Ptr GValue ->                           -- value : TInterface (Name {namespace = "GObject", name = "Value"})
    IO ()

{-# DEPRECATED valueGetMaximumValue ["Since 2.12. Use 'GI.Atk.Interfaces.Value.valueGetRange' instead."] #-}
{- |
Gets the maximum value of this object.
-}
valueGetMaximumValue ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m (GValue)
valueGetMaximumValue obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    value <- callocBoxedBytes 24 :: IO (Ptr GValue)
    atk_value_get_maximum_value obj' value
    value' <- (wrapBoxed GValue) value
    touchManagedPtr obj
    return value'

#if ENABLE_OVERLOADING
data ValueGetMaximumValueMethodInfo
instance (signature ~ (m (GValue)), MonadIO m, IsValue a) => O.MethodInfo ValueGetMaximumValueMethodInfo a signature where
    overloadedMethod _ = valueGetMaximumValue

#endif

-- method Value::get_minimum_increment
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TInterface (Name {namespace = "GObject", name = "Value"}), direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GValue representing the minimum increment by which the accessible value may be changed", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = True, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_minimum_increment" atk_value_get_minimum_increment ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    Ptr GValue ->                           -- value : TInterface (Name {namespace = "GObject", name = "Value"})
    IO ()

{-# DEPRECATED valueGetMinimumIncrement ["Since 2.12. Use 'GI.Atk.Interfaces.Value.valueGetIncrement' instead."] #-}
{- |
Gets the minimum increment by which the value of this object may be changed.  If zero,
the minimum increment is undefined, which may mean that it is limited only by the
floating point precision of the platform.

/Since: 1.12/
-}
valueGetMinimumIncrement ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m (GValue)
valueGetMinimumIncrement obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    value <- callocBoxedBytes 24 :: IO (Ptr GValue)
    atk_value_get_minimum_increment obj' value
    value' <- (wrapBoxed GValue) value
    touchManagedPtr obj
    return value'

#if ENABLE_OVERLOADING
data ValueGetMinimumIncrementMethodInfo
instance (signature ~ (m (GValue)), MonadIO m, IsValue a) => O.MethodInfo ValueGetMinimumIncrementMethodInfo a signature where
    overloadedMethod _ = valueGetMinimumIncrement

#endif

-- method Value::get_minimum_value
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TInterface (Name {namespace = "GObject", name = "Value"}), direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GValue representing the minimum accessible value", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = True, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_minimum_value" atk_value_get_minimum_value ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    Ptr GValue ->                           -- value : TInterface (Name {namespace = "GObject", name = "Value"})
    IO ()

{-# DEPRECATED valueGetMinimumValue ["Since 2.12. Use 'GI.Atk.Interfaces.Value.valueGetRange' instead."] #-}
{- |
Gets the minimum value of this object.
-}
valueGetMinimumValue ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m (GValue)
valueGetMinimumValue obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    value <- callocBoxedBytes 24 :: IO (Ptr GValue)
    atk_value_get_minimum_value obj' value
    value' <- (wrapBoxed GValue) value
    touchManagedPtr obj
    return value'

#if ENABLE_OVERLOADING
data ValueGetMinimumValueMethodInfo
instance (signature ~ (m (GValue)), MonadIO m, IsValue a) => O.MethodInfo ValueGetMinimumValueMethodInfo a signature where
    overloadedMethod _ = valueGetMinimumValue

#endif

-- method Value::get_range
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Atk", name = "Range"}))
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_range" atk_value_get_range ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    IO (Ptr Atk.Range.Range)

{- |
Gets the range of this object.

/Since: 2.12/
-}
valueGetRange ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m (Maybe Atk.Range.Range)
    {- ^ __Returns:__ a newly allocated 'GI.Atk.Structs.Range.Range'
that represents the minimum, maximum and descriptor (if available)
of /@obj@/. NULL if that range is not defined. -}
valueGetRange obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    result <- atk_value_get_range obj'
    maybeResult <- convertIfNonNull result $ \result' -> do
        result'' <- (wrapBoxed Atk.Range.Range) result'
        return result''
    touchManagedPtr obj
    return maybeResult

#if ENABLE_OVERLOADING
data ValueGetRangeMethodInfo
instance (signature ~ (m (Maybe Atk.Range.Range)), MonadIO m, IsValue a) => O.MethodInfo ValueGetRangeMethodInfo a signature where
    overloadedMethod _ = valueGetRange

#endif

-- method Value::get_sub_ranges
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TGSList (TInterface (Name {namespace = "Atk", name = "Range"})))
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_sub_ranges" atk_value_get_sub_ranges ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    IO (Ptr (GSList (Ptr Atk.Range.Range)))

{- |
Gets the list of subranges defined for this object. See 'GI.Atk.Interfaces.Value.Value'
introduction for examples of subranges and when to expose them.

/Since: 2.12/
-}
valueGetSubRanges ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m [Atk.Range.Range]
    {- ^ __Returns:__ an 'GI.GLib.Structs.SList.SList' of
'GI.Atk.Structs.Range.Range' which each of the subranges defined for this object. Free
the returns list with @/g_slist_free()/@. -}
valueGetSubRanges obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    result <- atk_value_get_sub_ranges obj'
    result' <- unpackGSList result
    result'' <- mapM (wrapBoxed Atk.Range.Range) result'
    g_slist_free result
    touchManagedPtr obj
    return result''

#if ENABLE_OVERLOADING
data ValueGetSubRangesMethodInfo
instance (signature ~ (m [Atk.Range.Range]), MonadIO m, IsValue a) => O.MethodInfo ValueGetSubRangesMethodInfo a signature where
    overloadedMethod _ = valueGetSubRanges

#endif

-- method Value::get_value_and_text
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TBasicType TDouble, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "address of #gdouble to put the current value of @obj", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything},Arg {argCName = "text", argType = TBasicType TUTF8, direction = DirectionOut, mayBeNull = False, argDoc = Documentation {rawDocText = Just "address of #gchar to put the human\nreadable text alternative for @value", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferEverything}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_get_value_and_text" atk_value_get_value_and_text ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    Ptr CDouble ->                          -- value : TBasicType TDouble
    Ptr CString ->                          -- text : TBasicType TUTF8
    IO ()

{- |
Gets the current value and the human readable text alternative of
/@obj@/. /@text@/ is a newly created string, that must be freed by the
caller. Can be NULL if no descriptor is available.

/Since: 2.12/
-}
valueGetValueAndText ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> m ((Double, T.Text))
valueGetValueAndText obj = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    value <- allocMem :: IO (Ptr CDouble)
    text <- allocMem :: IO (Ptr CString)
    atk_value_get_value_and_text obj' value text
    value' <- peek value
    let value'' = realToFrac value'
    text' <- peek text
    text'' <- cstringToText text'
    freeMem text'
    touchManagedPtr obj
    freeMem value
    freeMem text
    return (value'', text'')

#if ENABLE_OVERLOADING
data ValueGetValueAndTextMethodInfo
instance (signature ~ (m ((Double, T.Text))), MonadIO m, IsValue a) => O.MethodInfo ValueGetValueAndTextMethodInfo a signature where
    overloadedMethod _ = valueGetValueAndText

#endif

-- method Value::set_current_value
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "value", argType = TInterface (Name {namespace = "GObject", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GValue which is the desired new accessible value.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_set_current_value" atk_value_set_current_value ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    Ptr GValue ->                           -- value : TInterface (Name {namespace = "GObject", name = "Value"})
    IO CInt

{-# DEPRECATED valueSetCurrentValue ["Since 2.12. Use 'GI.Atk.Interfaces.Value.valueSetValue' instead."] #-}
{- |
Sets the value of this object.
-}
valueSetCurrentValue ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> GValue
    {- ^ /@value@/: a 'GI.GObject.Structs.Value.Value' which is the desired new accessible value. -}
    -> m Bool
    {- ^ __Returns:__ 'True' if new value is successfully set, 'False' otherwise. -}
valueSetCurrentValue obj value = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    value' <- unsafeManagedPtrGetPtr value
    result <- atk_value_set_current_value obj' value'
    let result' = (/= 0) result
    touchManagedPtr obj
    touchManagedPtr value
    return result'

#if ENABLE_OVERLOADING
data ValueSetCurrentValueMethodInfo
instance (signature ~ (GValue -> m Bool), MonadIO m, IsValue a) => O.MethodInfo ValueSetCurrentValueMethodInfo a signature where
    overloadedMethod _ = valueSetCurrentValue

#endif

-- method Value::set_value
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "obj", argType = TInterface (Name {namespace = "Atk", name = "Value"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a GObject instance that implements AtkValueIface", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "new_value", argType = TBasicType TDouble, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a double which is the desired new accessible value.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "atk_value_set_value" atk_value_set_value ::
    Ptr Value ->                            -- obj : TInterface (Name {namespace = "Atk", name = "Value"})
    CDouble ->                              -- new_value : TBasicType TDouble
    IO ()

{- |
Sets the value of this object.

This method is intended to provide a way to change the value of the
object. In any case, it is possible that the value can\'t be
modified (ie: a read-only component). If the value changes due this
call, it is possible that the text could change, and will trigger
an 'GI.Atk.Interfaces.Value.Value'::@/value-changed/@ signal emission.

Note for implementors: the deprecated 'GI.Atk.Interfaces.Value.valueSetCurrentValue'
method returned TRUE or FALSE depending if the value was assigned
or not. In the practice several implementors were not able to
decide it, and returned TRUE in any case. For that reason it is not
required anymore to return if the value was properly assigned or
not.

/Since: 2.12/
-}
valueSetValue ::
    (B.CallStack.HasCallStack, MonadIO m, IsValue a) =>
    a
    {- ^ /@obj@/: a GObject instance that implements AtkValueIface -}
    -> Double
    {- ^ /@newValue@/: a double which is the desired new accessible value. -}
    -> m ()
valueSetValue obj newValue = liftIO $ do
    obj' <- unsafeManagedPtrCastPtr obj
    let newValue' = realToFrac newValue
    atk_value_set_value obj' newValue'
    touchManagedPtr obj
    return ()

#if ENABLE_OVERLOADING
data ValueSetValueMethodInfo
instance (signature ~ (Double -> m ()), MonadIO m, IsValue a) => O.MethodInfo ValueSetValueMethodInfo a signature where
    overloadedMethod _ = valueSetValue

#endif