GUI: PLT Graphics Toolkit

1`` | Overview
- | Windowing
- | Drawing
- | Editor
2`` | Reference
- | Windowing Classes
- | Windowing Functions
- | Drawing Classes
- | Drawing Functions
- | Editor Classes
- | Editor Functions
- | WXME Decoding
3`` | Configuration
4`` | Dynamic Loading
| Index

On this page:

jump-to
ok?
pretty-finish
pretty-start
put
put-fixed
tell

Version: 4.0.2
contents index
← prev up next →

editor-stream-out% : class?
superclass: object%

An editor-stream-out% object is used to write editor information to a file or other output stream (such as the clipboard).

(make-object editor-stream-out% base)
→ (is-a?/c editor-stream-out%)
base : (is-a?/c editor-stream-out-base%)

An out-stream base – possibly an editor-stream-out-bytes-base% object – must be supplied in base.

(send an-editor-stream-out jump-to pos) → void?
pos : nonnegative-exact-integer?

Jumps to a given position in the stream.

(send an-editor-stream-out ok?) → boolean?

Returns #t if the stream is ready for writing, #f otherwise. Writing to a bad stream has no effect.

(send an-editor-stream-out pretty-finish) → void?

Ensures that the stream ends with a newline. This method is called by write-editor-global-footer.

(send an-editor-stream-out pretty-start) → void?

Writes a “comment” into the stream that identifies the file format. This method is called by write-editor-global-header.

(send an-editor-stream-out put n v)
→ (is-a?/c editor-stream-out%)
n : nonnegative-exact-integer?
v : bytes?
(send an-editor-stream-out put v)
→ (is-a?/c editor-stream-out%)
v : bytes?
(send an-editor-stream-out put v)
→ (is-a?/c editor-stream-out%)
v : (and/c exact? integer?)
(send an-editor-stream-out put v)
→ (is-a?/c editor-stream-out%)
v : real?

Writes v, or n bytes of v.

When n is supplied, use get-unterminated-bytes to read the bytes later.

If n is not supplied and v is a byte string, then for historical reasons, the actual number of bytes written includes a #\nul terminator, so use get-bytes instead of get-unterminated-bytes to read the bytes later.

(send an-editor-stream-out put-fixed v)
→ (is-a?/c editor-stream-out%)
v : (and/c exact? integer?)

Puts a fixed-sized integer into the stream. This method is needed because numbers are usually written in a way that takes varying numbers of bytes. In some cases it is useful to temporary write a 0 to a stream, write more data, and then go back and change the 0 to another number; such a process requires a fixed-size number.

Numbers written to a stream with put-fixed must be read with get-fixed.

(send an-editor-stream-out tell) → nonnegative-exact-integer?

Returns the current stream position.

contents index
← prev up next →