HGamer3D-CEGUI-Binding-0.1.9: HGamer3D/Bindings/CEGUI/ClassScrollbar.hs

-- GENERATED by C->Haskell Compiler, version 0.16.3 Crystal Seed, 24 Jan 2009 (Haskell)
-- Edit the ORIGNAL .chs file instead!


{-# LINE 1 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}{-# LANGUAGE ForeignFunctionInterface #-}
{-# LANGUAGE TypeSynonymInstances #-}

-- This source file is part of HGamer3D
-- (A project to enable 3D game development in Haskell)
-- For the latest info, see http://www.althainz.de/HGamer3D.html
-- 

-- (c) 2011, 2012 Peter Althainz
-- 
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
-- 
--     http://www.apache.org/licenses/LICENSE-2.0
-- 
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
-- 


-- ClassScrollbar.chs

-- 

module HGamer3D.Bindings.CEGUI.ClassScrollbar where

import Foreign
import Foreign.Ptr
import Foreign.C

import HGamer3D.Data.HG3DClass
import HGamer3D.Data.Vector
import HGamer3D.Data.Colour
import HGamer3D.Data.Angle

import HGamer3D.Bindings.CEGUI.Utils
{-# LINE 40 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}
import HGamer3D.Bindings.CEGUI.ClassPtr
{-# LINE 41 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}
import HGamer3D.Bindings.CEGUI.StructHG3DClass
{-# LINE 42 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return the size of the document or data.  - Details: The document size should be thought of as the total size of the data
--that is being scrolled through (the number of lines in a text file for
--example).
--
getDocumentSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (Float)
 -- ^ 
getDocumentSize a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getDocumentSize'_ a1' a2' >>= \res ->
  peekFloatConv  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 48 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return the page size for this scroll bar.  - Details: The page size is typically the amount of data that can be displayed at
--one time.  This value is also used when calculating the amount the
--position will change when you click either side of the scroll bar
--thumb, the amount the position changes will is (pageSize - overlapSize).
--
getPageSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (Float)
 -- ^ 
getPageSize a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getPageSize'_ a1' a2' >>= \res ->
  peekFloatConv  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 53 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return the step size for this scroll bar.  - Details: The step size is typically a single unit of data that can be displayed,
--this is the amount the position will change when you click either of
--the arrow buttons on the scroll bar.  (this could be 1 for a single
--line of text, for example).
--
getStepSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (Float)
 -- ^ 
getStepSize a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getStepSize'_ a1' a2' >>= \res ->
  peekFloatConv  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 58 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return the overlap size for this scroll bar.  - Details: The overlap size is the amount of data from the end of a 'page' that
--will remain visible when the position is moved by a page.  This is
--usually used so that the user keeps some context of where they were
--within the document's data when jumping a page at a time.
--
getOverlapSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (Float)
 -- ^ 
getOverlapSize a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getOverlapSize'_ a1' a2' >>= \res ->
  peekFloatConv  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 63 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return the current position of scroll bar within the document.  - Details: The range of the scroll bar is from 0 to the size of the document minus
--the size of a page (0 <= position <= (documentSize - pageSize)).
--
getScrollPosition :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (Float)
 -- ^ 
getScrollPosition a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getScrollPosition'_ a1' a2' >>= \res ->
  peekFloatConv  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 68 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return a pointer to the 'increase' PushButtoncomponent widget for this Scrollbar
getIncreaseButton :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (HG3DClass)
 -- ^ return value - Pointer to a     
getIncreaseButton a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getIncreaseButton'_ a1' a2' >>= \res ->
  peek  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 73 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return a pointer to the 'decrease' PushButtonScrollbar
getDecreaseButton :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (HG3DClass)
 -- ^ return value - Pointer to a     
getDecreaseButton a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getDecreaseButton'_ a1' a2' >>= \res ->
  peek  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 78 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Return a pointer to the ThumbScrollbar
getThumb :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (HG3DClass)
 -- ^ return value - Pointer to a     
getThumb a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  getThumb'_ a1' a2' >>= \res ->
  peek  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 83 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Initialises the Scrollbar - Details: This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window
initialiseComponents :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO ()
 -- ^ return value - Nothing     
initialiseComponents a1 =
  withHG3DClass a1 $ \a1' -> 
  initialiseComponents'_ a1' >>= \res ->
  return ()
{-# LINE 87 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Set the size of the document or data.  - Details: The document size should be thought of as the total size of the data
--that is being scrolled through (the number of lines in a text file for
--example).
--
setDocumentSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  Float  -- ^ document_size
  ->  IO ()
 -- ^ 
setDocumentSize a1 a2 =
  withHG3DClass a1 $ \a1' -> 
  let {a2' = realToFrac a2} in 
  setDocumentSize'_ a1' a2' >>= \res ->
  return ()
{-# LINE 92 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Set the page size for this scroll bar.  - Details: The page size is typically the amount of data that can be displayed at
--one time.  This value is also used when calculating the amount the
--position will change when you click either side of the scroll bar
--thumb, the amount the position changes will is (pageSize - overlapSize).
--
setPageSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  Float  -- ^ page_size
  ->  IO ()
 -- ^ 
setPageSize a1 a2 =
  withHG3DClass a1 $ \a1' -> 
  let {a2' = realToFrac a2} in 
  setPageSize'_ a1' a2' >>= \res ->
  return ()
{-# LINE 97 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Set the step size for this scroll bar.  - Details: The step size is typically a single unit of data that can be displayed,
--this is the amount the position will change when you click either of the
--arrow buttons on the scroll bar.  (this could be 1 for a single line of
--text, for example).
--
setStepSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  Float  -- ^ step_size
  ->  IO ()
 -- ^ 
setStepSize a1 a2 =
  withHG3DClass a1 $ \a1' -> 
  let {a2' = realToFrac a2} in 
  setStepSize'_ a1' a2' >>= \res ->
  return ()
{-# LINE 102 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Set the overlap size for this scroll bar.  - Details: The overlap size is the amount of data from the end of a 'page' that
--will remain visible when the position is moved by a page.  This is
--usually used so that the user keeps some context of where they were
--within the document's data when jumping a page at a time.
--
setOverlapSize :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  Float  -- ^ overlap_size
  ->  IO ()
 -- ^ 
setOverlapSize a1 a2 =
  withHG3DClass a1 $ \a1' -> 
  let {a2' = realToFrac a2} in 
  setOverlapSize'_ a1' a2' >>= \res ->
  return ()
{-# LINE 107 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Set the current position of scroll bar within the document.  - Details: The range of the scroll bar is from 0 to the size of the document minus
--the size of a page (0 <= position <= (documentSize - pageSize)), any
--attempt to set the position outside this range will be adjusted so that
--it falls within the legal range.
--
setScrollPosition :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  Float  -- ^ position
  ->  IO ()
 -- ^ 
setScrollPosition a1 a2 =
  withHG3DClass a1 $ \a1' -> 
  let {a2' = realToFrac a2} in 
  setScrollPosition'_ a1' a2' >>= \res ->
  return ()
{-# LINE 112 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Enable or disable the 'end lock' mode for the scrollbar.  - Details: When enabled and the current position of the scrollbar is at the end of
--it's travel, the end lock mode of the scrollbar will automatically
--update the position when the document and/or page size change in order
--that the scroll position will remain at the end of it's travel.  This
--can be used to implement auto-scrolling in certain other widget types.
--
setEndLockEnabled :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  Bool  -- ^ enabled
  ->  IO ()
 -- ^ 
setEndLockEnabled a1 a2 =
  withHG3DClass a1 $ \a1' -> 
  let {a2' = fromBool a2} in 
  setEndLockEnabled'_ a1' a2' >>= \res ->
  return ()
{-# LINE 117 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Returns whether the 'end lock'mode for the scrollbar is enabled.  - Details: When enabled, and the current position of the scrollbar is at the end of
--it's travel, the end lock mode of the scrollbar will automatically
--update the scrollbar position when the document and/or page size change
--in order that the scroll position will remain at the end of it's travel.
--This can be used to implement auto-scrolling in certain other widget
--types.
--
isEndLockEnabled :: HG3DClass  -- ^ classpointer - pointer of Class instance from which this methods is called.
  ->  IO (Bool)
 -- ^ 
isEndLockEnabled a1 =
  withHG3DClass a1 $ \a1' -> 
  alloca $ \a2' -> 
  isEndLockEnabled'_ a1' a2' >>= \res ->
  peekBoolUtil  a2'>>= \a2'' -> 
  return (a2'')
{-# LINE 122 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Constructor for Scrollbar
new :: String  -- ^ type
  ->  String  -- ^ name
  ->  IO (HG3DClass)
 -- ^ 
new a1 a2 =
  withCString a1 $ \a1' -> 
  withCString a2 $ \a2' -> 
  alloca $ \a3' -> 
  new'_ a1' a2' a3' >>= \res ->
  peek  a3'>>= \a3'' -> 
  return (a3'')
{-# LINE 128 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}

-- | Destructor for Scrollbar
delete :: HG3DClass  -- ^ classpointer - pointer of Class instance which is going to be deleted.
  ->  IO ()
 -- ^ 
delete a1 =
  withHG3DClass a1 $ \a1' -> 
  delete'_ a1' >>= \res ->
  return ()
{-# LINE 132 ".\\HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs" #-}


foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getDocumentSize"
  getDocumentSize'_ :: ((HG3DClassPtr) -> ((Ptr CFloat) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getPageSize"
  getPageSize'_ :: ((HG3DClassPtr) -> ((Ptr CFloat) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getStepSize"
  getStepSize'_ :: ((HG3DClassPtr) -> ((Ptr CFloat) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getOverlapSize"
  getOverlapSize'_ :: ((HG3DClassPtr) -> ((Ptr CFloat) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getScrollPosition"
  getScrollPosition'_ :: ((HG3DClassPtr) -> ((Ptr CFloat) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getIncreaseButton"
  getIncreaseButton'_ :: ((HG3DClassPtr) -> ((HG3DClassPtr) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getDecreaseButton"
  getDecreaseButton'_ :: ((HG3DClassPtr) -> ((HG3DClassPtr) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_getThumb"
  getThumb'_ :: ((HG3DClassPtr) -> ((HG3DClassPtr) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_initialiseComponents"
  initialiseComponents'_ :: ((HG3DClassPtr) -> (IO ()))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_setDocumentSize"
  setDocumentSize'_ :: ((HG3DClassPtr) -> (CFloat -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_setPageSize"
  setPageSize'_ :: ((HG3DClassPtr) -> (CFloat -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_setStepSize"
  setStepSize'_ :: ((HG3DClassPtr) -> (CFloat -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_setOverlapSize"
  setOverlapSize'_ :: ((HG3DClassPtr) -> (CFloat -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_setScrollPosition"
  setScrollPosition'_ :: ((HG3DClassPtr) -> (CFloat -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_setEndLockEnabled"
  setEndLockEnabled'_ :: ((HG3DClassPtr) -> (CInt -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_isEndLockEnabled"
  isEndLockEnabled'_ :: ((HG3DClassPtr) -> ((Ptr CInt) -> (IO ())))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_construct"
  new'_ :: ((Ptr CChar) -> ((Ptr CChar) -> ((HG3DClassPtr) -> (IO ()))))

foreign import ccall safe "HGamer3D\\Bindings\\CEGUI\\ClassScrollbar.chs.h cegui_scrlbr_destruct"
  delete'_ :: ((HG3DClassPtr) -> (IO ()))