Drezil/pioneers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixed haddock for UI

Browse Source
This commit is contained in:
Nicole Dresselhaus 2014-05-18 00:14:19 +02:00
parent 35364b50aa
commit ef549eac4d
No known key found for this signature in database
GPG Key ID: BC16D887851A1A80
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/UI/UIBase.hs
View File

@ -122,19 +122,19 @@ data EventHandler m =
-- A widget becomes mouse-active if no other button is currently pressed and the mouse -- A widget becomes mouse-active if no other button is currently pressed and the mouse
-- coordinates are within the widget's extent ('isInside') until no button is pressed any -- coordinates are within the widget's extent ('isInside') until no button is pressed any
-- more. -- more.
_onMousePress :: MouseButton -- ^the pressed button _onMousePress :: MouseButton -- the pressed button
-> Pixel -- ^screen position -> Pixel -- screen position
-> GUIWidget m -- ^widget the event is invoked on -> GUIWidget m -- widget the event is invoked on
-> m (GUIWidget m) -- ^widget after the event and the possibly altered mouse handler -> m (GUIWidget m) -- widget after the event and the possibly altered mouse handler
, ,
-- |The function 'onMouseReleased' is called when a button is released -- |The function 'onMouseReleased' is called when a button is released
-- while the widget is mouse-active. -- while the widget is mouse-active.
-- --
-- Thus, the mouse is either within the widget or outside while still dragging. -- Thus, the mouse is either within the widget or outside while still dragging.
_onMouseRelease :: MouseButton -- ^the released button _onMouseRelease :: MouseButton -- the released button
-> Pixel -- ^screen position -> Pixel -- screen position
-> GUIWidget m -- ^widget the event is invoked on -> GUIWidget m -- widget the event is invoked on
-> m (GUIWidget m) -- ^widget after the event and the altered handler -> m (GUIWidget m) -- widget after the event and the altered handler
} }
| |
-- |Handler to control the functionality of a 'GUIWidget' on mouse movement. -- |Handler to control the functionality of a 'GUIWidget' on mouse movement.
@ -144,22 +144,22 @@ data EventHandler m =
-- widget's extent ('isInside') while no button is pressed or when the mouse is inside the -- widget's extent ('isInside') while no button is pressed or when the mouse is inside the
-- widget's extent while another button loses its mouse-active state. Triggered after -- widget's extent while another button loses its mouse-active state. Triggered after
-- '_onMouseEnter'. -- '_onMouseEnter'.
_onMouseMove :: Pixel -- ^screen position _onMouseMove :: Pixel -- screen position
-> GUIWidget m -- ^widget the event is invoked on -> GUIWidget m -- widget the event is invoked on
-> m (GUIWidget m) -- ^widget after the event and the altered handler -> m (GUIWidget m) -- widget after the event and the altered handler
, ,
-- |The function 'onMouseMove' is invoked when the mouse enters the -- |The function 'onMouseMove' is invoked when the mouse enters the
-- widget's extent ('isInside') or when the mouse is inside the -- widget's extent ('isInside') or when the mouse is inside the
-- widget's extent while another button loses its mouse-active state.. -- widget's extent while another button loses its mouse-active state..
_onMouseEnter :: Pixel -- ^screen position _onMouseEnter :: Pixel -- screen position
-> GUIWidget m -- ^widget the event is invoked on -> GUIWidget m -- widget the event is invoked on
-> m (GUIWidget m) -- ^widget after the event and the altered handler -> m (GUIWidget m) -- widget after the event and the altered handler
, ,
-- |The function 'onMouseLeave' is invoked when the mouse leaves the -- |The function 'onMouseLeave' is invoked when the mouse leaves the
-- widget's extent ('isInside') while no other widget is mouse-active. -- widget's extent ('isInside') while no other widget is mouse-active.
_onMouseLeave :: Pixel -- ^screen position _onMouseLeave :: Pixel -- screen position
-> GUIWidget m -- ^widget the event is invoked on -> GUIWidget m -- widget the event is invoked on
-> m (GUIWidget m) -- ^widget after the event and the altered handler -> m (GUIWidget m) -- widget after the event and the altered handler
} }
deriving () deriving ()
@ -196,7 +196,7 @@ data GUIBaseProperties m = BaseProperties
-- The default implementations tests if the point is within the rectangle specified by the -- The default implementations tests if the point is within the rectangle specified by the
-- 'getBoundary' function. -- 'getBoundary' function.
_isInside :: GUIWidget m _isInside :: GUIWidget m
-> Pixel -- ^local coordinates -> Pixel -- local coordinates
-> m Bool -> m Bool
, ,
-- |The @_getPriority@ function returns the priority score of a @GUIWidget@. -- |The @_getPriority@ function returns the priority score of a @GUIWidget@.