- Inherits from:
- DTextDrawable
- Declared in:
- DTextScreen.h
Object
|
+---DTextDrawable
|
+---DTextScreen
Class Description
The DTextScreen class implements a class to use the text screen. On unix it
is a wrapper for the ncurses library. For obvious reasons there can be only
one text screen object in any application.
- Last modified:
- 31-Oct-2007 (DTextScreen.h)
Instance Variables
- private BOOL _isOpen
- is the text screen open ?
- private id <DScreenHandler> _handler
- the screen event handler
- private DKey *_key
- the key
- private unsigned long _mouseMask
- the previous mouse mask
- Constructors
- - (DTextScreen *) init
- Initialise to an unopened text screen object
- Returns:
- the object
- - (DTextScreen *) init :(DColor *) fgc :(DColor *) bgc
- Initialise an opened text screen object with a fore- and background color
- Parameters:
- fgc - the foreground color
bgc - the background color
- Returns:
- the object
- Copy related methods
- - shallowCopy
- Do a shallow copy of the text screen object (not implemented)
- Returns:
- the object
- Deconstructor
- - free
- Free the text screen
- Returns:
- the object
- Screen status methods
- - (BOOL) hasColors
- Check if the terminal support colors
- Returns:
- support the terminal colors ?
- - (BOOL) isOpen
- Check if the text screen object is open
- Returns:
- is it ?
- Event handler methods
- - (id <DScreenHandler>) screenHandler
- Return the current screen event handler
- Returns:
- the (reference to the) screen handler
- - (id <DScreenHandler>) screenHandler :(id <DScreenHandler>) handler
- Set the screen event handler
- Parameters:
- handler - the (reference to the) screen handler
- Returns:
- the previous screen handler
- Screen control methods
- - (DTextScreen *) close
- Close the text screen
- Returns:
- the object
- - (BOOL) open :(DColor *) fgc :(DColor *) bgc
- Open the text screen (only one instance is opened)
- Parameters:
- fgc - the foreground color
bgc - the background color
- Returns:
- success
- Screen output methods
- - (DTextScreen *) beep
- Beep the terminal
- Returns:
- the object
- - (int) cursor :(int) state
- Set the visibility of the cursor
- Parameters:
- state - the cursor state (DDW_CURSOR..)
- Returns:
- the previous state of the cursor
- Drawing control methods
- - (BOOL) startDrawing
- Start drawing on the screen
- Returns:
- success
- - (DTextScreen *) stopDrawing
- Stop drawing on the screen
- Returns:
- the screen object
- Event processing
- - (DTextScreen *) clearEvents
- Clear any pending events
- Returns:
- the object
- - (unsigned) processEvents
- Process any pending events
- Returns:
- the number of processed events
- - (unsigned) waitEvents
- Wait (and process) events
- Returns:
- the number of processed events
generated 05-Nov-2007 by ObjcDoc 3.0.0