{-# LINE 2 "./Graphics/UI/Gtk/Special/VRuler.chs" #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget VRuler
--
-- Author : Andy Stewart
--
-- Created: 28 Mar 2010
--
-- Copyright (C) 2010 Andy Stewart
--
-- This library is free software; you can redistribute it and/or
-- modify it under the terms of the GNU Lesser General Public
-- License as published by the Free Software Foundation; either
-- version 2.1 of the License, or (at your option) any later version.
--
-- This library is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-- Lesser General Public License for more details.
--
-- |
-- Maintainer : gtk2hs-users@lists.sourceforge.net
-- Stability : provisional
-- Portability : portable (depends on GHC)
--
-- A vertical ruler
--
module Graphics.UI.Gtk.Special.VRuler (

-- * Detail
--
-- | The 'VRuler' widget is a widget arranged vertically creating a ruler that
-- is utilized around other widgets such as a text widget. The ruler is used to
-- show the location of the mouse on the window and to show the size of the
-- window in specified units. The available units of measurement are 'Pixels',
-- 'Inches' and 'Centimeters'. 'Pixels' is the default. rulers.
--
-- * Rulers are removed in Gtk3 and thus this module is blank. There is no
-- replacement

-- * Class Hierarchy
--
-- |
-- @
-- | 'GObject'
-- | +----'Object'
-- | +----'Widget'
-- | +----'Ruler'
-- | +----VRuler
-- @

-- * Types
  VRuler,
  VRulerClass,
  castToVRuler,
  toVRuler,

-- * Constructors
  vRulerNew,

  ) where

import Control.Monad (liftM)

import System.Glib.FFI
import Graphics.UI.Gtk.Abstract.Object (makeNewObject)
import Graphics.UI.Gtk.Types
{-# LINE 68 "./Graphics/UI/Gtk/Special/VRuler.chs" #-}


{-# LINE 70 "./Graphics/UI/Gtk/Special/VRuler.chs" #-}

--------------------
-- Constructors

-- | Creates a new vertical ruler
--
vRulerNew :: IO VRuler
vRulerNew =
  makeNewObject mkVRuler $
  liftM (castPtr :: Ptr Widget -> Ptr VRuler) $
  gtk_vruler_new
{-# LINE 81 "./Graphics/UI/Gtk/Special/VRuler.chs" #-}

foreign import ccall safe "gtk_vruler_new"
  gtk_vruler_new :: (IO (Ptr Widget))