-- -----------------------------------------------------------------------
--
-- $Source: /repository/uni/htk/widgets/MenuButton.hs,v $
--
-- HTk - a GUI toolkit for Haskell  -  (c) Universitaet Bremen
--
-- $Revision: 1.4 $ from $Date: 2001/11/05 23:46:11 $
-- Last modification by $Author: ludi $
--
-- -----------------------------------------------------------------------

module MenuButton (

  ButtonWidget(..),

  MenuButton,
  newMenuButton

) where

import Core
import ButtonWidget
import BaseClasses(Widget)
import Configuration
import Image
import BitMap
import Concurrent
import Computation
import Destructible
import Synchronized
import Menu
import Packer
import Tooltip


-- -----------------------------------------------------------------------
-- type
-- -----------------------------------------------------------------------

---
-- The <code>MenuButton</code> datatype.
data MenuButton = MenuButton GUIOBJECT


-- -----------------------------------------------------------------------
-- creation
-- -----------------------------------------------------------------------

---
-- Constructs a new menubutton widget and returns a handler.
-- @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 menubutton.
-- @return result - A menubutton widget.
newMenuButton :: Container par => par -> [Config MenuButton] -> IO MenuButton
newMenuButton par cnf =
  do
    b <- createGUIObject (toGUIObject par) MENUBUTTON defMethods
    configure (MenuButton b) cnf


-- -----------------------------------------------------------------------
-- instances
-- -----------------------------------------------------------------------

---
-- Internal.
instance GUIObject MenuButton where 
---
-- Internal.
  toGUIObject (MenuButton w) = w
---
-- Internal.
  cname _ = "MenuButton"

---
-- A menubutton widget can be destroyed.
instance Destroyable MenuButton where
---
-- Destroys a menubutton widget.
  destroy   = destroy . toGUIObject

---
-- A menubutton widget has standard widget properties
-- (concerning focus, cursor).
instance Widget MenuButton
 
---
-- A menubutton widget can be flashed (redisplayed several times in
-- alternate colours) and invoked (the associated event).
instance ButtonWidget MenuButton

---
-- A menubutton widget can contain a bitmap.
instance HasBitMap MenuButton

---
-- A menubutton widget has a configureable border.
instance HasBorder MenuButton

---
-- A menu button has a normal foreground and background colour and an
-- active/disabled foreground and background colour.
instance HasColour MenuButton where 
---
-- Internal.
  legalColourID = buttonColours

---
-- A menubutton widget is a stateful widget, it can be enabled or
-- disabled.
instance HasEnable MenuButton

---
-- You can specify the font of a menubutton.
instance HasFont MenuButton

---
-- A menu button has a configureable text justification.
instance HasJustify MenuButton

---
-- A menubutton can contain an image.
instance HasPhoto MenuButton

---
-- You can specify the size of a menubutton.
instance HasSize MenuButton

---
-- A menubutton can contain text.
instance GUIValue v => HasText MenuButton v

---
-- You can set the index of a text character to underline.
instance HasUnderline MenuButton

---
-- You can synchronize on a menubutton object (in JAVA style).
instance Synchronized MenuButton where
---
-- Synchronizes on a menubutton object.
  synchronize = synchronize . toGUIObject

---
-- When a menubutton is clicked, a corresponding event is invoked.
instance HasCommand MenuButton

---
-- A menubutton is a menu container.
instance HasMenu MenuButton

---
-- A menubutton can have a tooltip (only displayed if you are using
-- tixwish).
instance HasTooltip MenuButton

---
-- A menubutton has a text anchor.
instance HasAnchor MenuButton