ncurses-0.2.1: Modernised bindings to GNU ncurses

Portability | portable (requires FFI)
Maintainer | jmillikin@gmail.com
Safe Haskell | None

UI.NCurses.Panel

Description

Synopsis

- data Panel
- newPanel :: Window -> Curses Panel
- deletePanel :: Panel -> Curses ()
- refreshPanels :: Curses ()
- panelAbove :: Panel -> Curses (Maybe Panel)
- panelBelow :: Panel -> Curses (Maybe Panel)
- panelTop :: Curses (Maybe Panel)
- panelBottom :: Curses (Maybe Panel)
- showPanel :: Panel -> Curses ()
- hidePanel :: Panel -> Curses ()
- panelHidden :: Panel -> Curses Bool
- movePanel :: Panel -> Integer -> Integer -> Curses ()
- raisePanel :: Panel -> Curses ()
- lowerPanel :: Panel -> Curses ()
- getPanelWindow :: Panel -> Curses Window
- replacePanelWindow :: Panel -> Window -> Curses ()

# Documentation

data Panel Source

newPanel :: Window -> Curses Panel Source

Creates a new `Panel`, on top of the panel stack.

deletePanel :: Panel -> Curses ()Source

Permanently removes the given panel from the panel stack.

refreshPanels :: Curses ()Source

Updates windows to account for the current panel stack order. The user must call `render` before changes are drawn to the screen.

panelAbove :: Panel -> Curses (Maybe Panel)Source

`panelAbove p` retrieve the panel above p.

panelBelow :: Panel -> Curses (Maybe Panel)Source

`panelAbove p` retrieve the panel below p.

panelTop :: Curses (Maybe Panel)Source

Retrieve the top–most panel in the stack.

panelBottom :: Curses (Maybe Panel)Source

Retrieve the bottom–most panel in the stack.

showPanel :: Panel -> Curses ()Source

Makes a hidden panel visible, and places it on the top of the stack.

hidePanel :: Panel -> Curses ()Source

Temporarily removes the given panel from the panel stack. Use `showPanel` to restore it.

panelHidden :: Panel -> Curses Bool Source

Checks if the given panel is currently visible.

movePanel Source

Arguments

:: Panel |
-> Integer | New upper–left row
-> Integer | New upper–left column
-> Curses () |

Move the panel so its upper–left corner is at the new coordinates.

raisePanel :: Panel -> Curses ()Source

Raise a bottom to the top of the stack.

lowerPanel :: Panel -> Curses ()Source

Lower a panel to the bottom of the stack.

getPanelWindow :: Panel -> Curses Window Source

Retrieves which window a panel is drawn to.

replacePanelWindow :: Panel -> Window -> Curses ()Source

Replaces which window a panel is drawn to.