Protocol DDrawable

Conforms to:
DTextWritable
Adopted by:
DTextDrawable
Declared in:
DDrawable.h

Protocol Description

The DDrawable protocol specifies methods that should be implemented by classes that draw on an area.

Last modified:
01-Dec-2005 (DDrawable.h)

Method Index

- (BOOL) clear
Clear the drawable
Returns:
success
- (int) cursor :(int) state
Set the visibility of the cursor
Parameters:
state - the cursor state (DDW_CURSOR..)
Returns:
the previous state of the cursor
- (BOOL) drawHLine : (unsigned) endX
Draw a (horizontal) line on the drawable starting from the current position and with the previous line width and type settings
Parameters:
endX - the x position for the end of the line
Returns:
success
- (BOOL) drawHLine :(unsigned) startX : (unsigned) endX :(unsigned) startY
Draw a horizontal line with the previous line width and type settings
Parameters:
startX - the x position for the start of the line
endX - the x position for the end of the line
startY - the y position for the line
Returns:
success
- (BOOL) drawHLine :(unsigned) startX : (unsigned) endX :(unsigned) startY :(int) lineType
Draw a (horizontal) line on the drawable
Parameters:
startX - the x position for the start of the line
endX - the x position for the end of the line
startY - the y position for the line
lineType - the type of the line DDW_LINE_...
Returns:
success
- (BOOL) drawLine :(unsigned) endX :(unsigned) endY
Draw a line on the drawable starting from the current position and with the current line width and type settings
Parameters:
endX - the x-position for the end of the line
endY - the y-position for the end of the line
Returns:
success
- (BOOL) drawLine :(unsigned) startX :(unsigned) endX :(unsigned) startY :(unsigned) endY
Draw a line with the current line type and width settings
Parameters:
startX - the x position for the start of the line
endX - the x position for the end of the line
startY - the y position for the start of the line
endY - the y position for the end of the line
Returns:
success
- (BOOL) drawLine :(unsigned) startX :(unsigned) endX :(unsigned) startY :(unsigned) endY :(int) lineType
Draw a line on the screen
Parameters:
startX - the x position for the start of the line
endX - the x position for the end of the line
startY - the y position for the start of the line
endY - the y position for the end of the line
lineType - the type of the line (DDW_LINE_...)
lineWidth - the width of the line (>0)
Returns:
success
- (BOOL) drawVLine :(unsigned) endY
Draw a (vertical) line on the drawable starting from the current position and with the current line width and type settings
Parameters:
endY - the y position for the end of the line
Returns:
success
- (BOOL) drawVLine :(unsigned) startX :(unsigned) startY :(unsigned) endY
Draw a vertical line with the current line type and width settings
Parameters:
startX - the x position for the line
startY - the y position for the line
endY - the y position for the end of the line
Returns:
success
- (BOOL) drawVLine :(unsigned) startX :(unsigned) startY :(unsigned) endY :(int) lineType
Draw a vertical line on the screen
Parameters:
startX - the x position for the line
startY - the y position for the line
endY - the y position for the end of the line
lineType - the type of the line (DDW_LINE_...)
lineWidth - the width of the line (>0)
Returns:
success
- (int) error
Return the last error
Returns:
the last error (or 0)
- (int) pointer :(int) state
Set the visibility of the mouse pointer
Parameters:
state - the pointer state (DDW_POINTER..)
Returns:
the previous state of the pointer
- (BOOL) seek :(unsigned long) offset :(int) origin
Move the current position to a location
Parameters:
offset - the offset from the origin (in bytes)
origin - the origin for the offset (0=begin, 1=current, 2=end)
Returns:
success
- (BOOL) skip :(unsigned long) offset
Skip a number of positions
Parameters:
offset - the number of bytes to skip
Returns:
success
- (unsigned long) tell
Tell the current position in the writeable
Returns:
the current position
- (BOOL) writeChar :(char) ch
Write a character
Parameters:
ch - the character to be written
Returns:
success
- (BOOL) writeLine :(const char *) text
Write a line (appending a '\n')
Parameters:
text - the text to be written as line
Returns:
success
- (BOOL) writeText :(const char *) text
Write a text string
Parameters:
text - the text to be written
Returns:
success

generated 25-Jul-2006 by ObjcDoc 3.0.0