-- -----------------------------------------------------------------------
--
-- $Source: /repository/uni/htk/toolkit/Separator.hs,v $
--
-- HTk - a GUI toolkit for Haskell  -  (c) Universitaet Bremen
--
-- $Revision: 1.2 $ from $Date: 2002/01/07 21:14:22 $  
-- Last modification by $Author: ludi $
--
-- -----------------------------------------------------------------------

---
-- Separators for widgets. It is just
-- a frame with a given relief and borderwidth etc. 
module Separator (
        Separator,
        newSeparator,
        newHSeparator,
        newVSeparator
        
        ) where

import Core
import HTk
                
-- --------------------------------------------------------------------------
-- Separator
-- --------------------------------------------------------------------------   

---
-- The <code>Separator</code> datatype.
data Separator = Separator Frame deriving Eq


---
-- Constructs a new separator widget and returns it as a value.
-- @param par     - the parent widget, which has to be a container widget
--                  (an instance of <code>class Container</code>).
-- @param cnf     - the list of configuration options for this separator.
-- @return result - a separator widget.
newSeparator :: (Container par) => par -> [Config Separator] -> IO Separator
newSeparator par conf =
 do
  w <- newFrame par []
  configure (Separator w) conf


---
-- Constructs a new horizontal separator widget and returns it as a value. (no packing needed)
-- @param par     - the parent widget, which has to be a container widget
--                  (an instance of <code>class Container</code>).
-- @return result - a separator widget.
newHSeparator :: (Container par) => par -> IO Separator
newHSeparator par = 
 do 
  w <- newFrame par [relief Sunken, height 2, borderwidth 1]
  pack w [Expand Off, Fill X]
  configure (Separator w) []
  
---
-- Constructs a new vertical separator widget and returns it as a value. (no packing needed)
-- @param par     - the parent widget, which has to be a container widget
--                  (an instance of <code>class Container</code>).
-- @return result - a separator widget.
newVSeparator :: (Container par) => par -> IO Separator
newVSeparator par = 
 do 
  w <- newFrame par [relief Sunken, width 2, borderwidth 1]
  pack w [Expand Off, Fill Y]
  configure (Separator w) []
                
-- --------------------------------------------------------------------------
-- Instances
-- --------------------------------------------------------------------------   
---
-- Internal.
instance GUIObject Separator where 
---
-- Internal.
        toGUIObject (Separator w) = toGUIObject w
---
-- Internal.
        cname w = "Separator"
	
---
-- A separator can be destroyed.
instance Destroyable Separator where
---
-- Destroys a separator widget.
        destroy = destroy . toGUIObject

---
-- A separator widget has a configureable border.
instance HasBorder Separator

---
-- You can specify the size of a separator widget.
instance HasSize Separator

---
-- A spearator widget has an orientation (Horizontal or Vertical)
instance HasOrientation Separator where
        orient Horizontal s = do {
                configure s [height 2];
                return s
                }
        orient Vertical s = do {
                configure s [width 2];
                return s
                }