Package gstream-devel

Development files for gstream

http://allegro.molhanec.net/gstream.html

The gstream-devel package contains libraries and header files for
developing applications that use gstream.

Library Functions (Section 3)
gstream-cd_console
Draws a normal console cursor: the insert cursor is like an _, and the overwrite cursor covers the letter. The preferred dimensions (you have to set them...
gstream-cd_winconsole
Draws a mixture of a win cursor and console cursor: the insert cursor looks like a win cursor (a vertical line: | ), whereas the overwrite cursor is like the...
gstream-color
Sets the font to the specified colour.
gstream-get_bitmap
Returns the currently used bitmap.
gstream-get_color
Returns the currently used colour.
gstream-get_cursor_drawer
Returns the currently used cursor drawer.
gstream-get_cursor_h
Returns the input cursor height in the current insert mode, i.e. if the gstream is in insert mode when this function is called, it will return the cursor's...
gstream-get_cursor_w
Returns the input cursor width in the current insert-mode, i.e. if the gstream is in insert mode when this function is called, it will return the cursor's...
gstream-get_dirty_rectangle_marker
Returns the currently used dirty rectangle marker.
gstream-get_font
Returns the currently used font.
gstream-get_input_approver
Returns the currently used input approver.
gstream-get_input_error_handler
Returns the input error handler.
gstream-get_insert_mode
True if pressing a key makes the inputter insert the character. False if the inputter overwrites the next character with the new character.
gstream-get_line_spacing
Returns the current line spacing.
gstream-get_margin
Returns the margin setting.
gstream-get_tab_size
Returns the tabulator size.
gstream-get_x
Returns the cursor's x position.
gstream-get_y
Returns the cursor's y position.
gstream-goto_row
Moves the cursor to line number ROW. If, for instance, the currently used font has a height of 12, then goto_row(4) is exactly the same as goto_y(4*12). Unless...
gstream-goto_x
Moves the cursor to the given x-coordinate.
gstream-goto_xy
Moves the cursor to the specified x- and y-coordinates.
gstream-goto_y
Moves the cursor to the given y-coordinate.
gstream-GSTREAM_DATE_STR
This will contain the year of the current version of the library. For example, for version 1.0 of the library, this string will be "1999". (For version 19.43 it...
gstream-GSTREAM_SUB_VERSION
This macro has the minor version number of the library. For example, for version 19.34 of the library, this macro will be 34.
gstream-GSTREAM_VERSION
This macro has the major version number of the library. For example, for version 19.34 of the library, this macro will be 19.
gstream-GSTREAM_VERSION_STR
This will contain the current version string of the library. For example, for version 19.34 of the library, this string will be "19.34".
gstream-ia_allow_decimal
Allows only digits and decimal delimiters (0123456789.) - for inputting floats and the like.
gstream-ia_allow_everything
Always returns true - allows everything.
gstream-ia_allow_hexadigits
Allows only hexadecimal digits (0123456789abcdefABCDEF) - for inputting hexadecimal numbers.
gstream-ia_allow_integer
Allows only digits (0123456789) - for inputting numbers.
gstream-ia_allow_word_chars
Allows characters that can make up a word. Any number and any alphabetic character is allowed. Actually it works by blocking some known non-alphabetic...
gstream-ia_block_spaces
Allows everything but whitespace.
gstream-ieh_led_flasher
Very fancy handler: it flashes the keyboard LED indicators. How nice. :-) You may want to copy it and adjust it to fit your particular situation.
gstream-ieh_never_complain
Nice error handler that covers many situations: it doesn't do anything at all. ;-)
gstream-insert
Use insert mode when inputting.
gstream-line_spacing
line_spacing
gstream-margin
Sets the place where newlines will return to, to M.
gstream-max_input_length
Sets the maximum number of characters accepted by the inputter upon the next input.
gstream-move_row
Moves cursor relative to the current position by ROW.
gstream-move_x
Moves cursor relative to the current position by X.
gstream-move_xy
Moves cursor relative to the current position by (X,Y).
gstream-move_y
Moves cursor relative to the current position by Y.
gstream-no_wrap
The stream will not wrap. Same effect as set_wrap(false).
gstream-operator
These two functions don't actually belong to the gstreams, they are here simply because they sometimes make the life a bit easier (without costing anything in...
gstream-overwrite
Use overwrite mode when inputting.
gstream-remove_all_tabs
Removes all tabulator stops. It is useful for cleaning up.
gstream-remove_tab
This will remove the tabulator stop (if it exists) at position X.
gstream-reset
This sets the stream to the default state. All smart tab stops are deleted, the font is set to font 'font', the bitmap is set to screen, etc...
gstream-restore
When you have activated a tabulator stop (by using the '\t' character), it might change the colour or the font depending on what or what not you have told it to...
gstream-restore_input_approver
Restores the previously saved backup. You can call this function as many times as you want, i.e. the backup will remain the same until you save another...
gstream-row
row
gstream-save_input_approver
A typical use of the input approver system is to temporarily set a home-made approver, launch an input and then get the original settings back. Consequently...
gstream-set_bitmap
Sets the bitmap that the stream will draw characters on. This may also be done while constructing the stream (see the introduction).
gstream-set_color
Sets the colour to draw the font with. For a detailed discussion of this see the documentation for Allegro (under textout) - the gstream will pass this colour...
gstream-set_cursor_blink
Sets the number of cursor blinks per minute - the cursor will be turned on around CB times a minute, passing 60 would make the cursor turn on approximately once...
gstream-set_cursor_dimensions
This will set the cursor dimensions to IW x IH when in insert mode and OW x OH when in overwrite mode. Although the standard cursors respond to this, it is...
gstream-set_cursor_drawer
This will set the function for drawing the cursor, which is useful if you want to customize it with your own favourite cursor (perhaps a BITMAP). Before you can...
gstream-set_dirty_rectangle_marker
Sets a function which the gstream will use to mark the areas that it draws inside as "dirty"; this can, for instance, be very useful in conjuction with a dirty...
gstream-set_font
Sets the font that the stream will draw the characters with. The default is the font 'font'.
gstream-set_input_approver
The function handed over will be called with every new character inputted and determines whether the character will be accepted by the inputter. If it returns...
gstream-set_input_error_handler
Sets an error handler that will be called of the inputter encounter any unusual, erratic behaviour, e.g. the user trying to move the cursor off the string or...
gstream-set_input_string
This function provides a way to specify an editable default string when inputting.
gstream-set_insert_mode
If invoked with true, the edit mode is set to insert (entering a character in the middle of a string will insert it, and not overwrite the next character). If...
gstream-set_line_spacing
Sets the line spacing in pixels. The supplied value is added to the height of the font so if your font is 12 pixels high, and you call this function with 4...
gstream-set_margin
Sets the margin at the left side of the bitmap. Every time you launch a newline, the cursor will return to this x-position. Default is 0.
gstream-set_max_input_length
This sets the maximum number of characters that the inputter will accept from the user at the next, and only the next, input, i.e. if you call this function...
gstream-set_tab
This is the basic function - it creates a tab stop at the specified x-coordinate with the specified colour and the specified font. But the function is...
gstream-set_tab_size
Sets the standard-tabulator size. The default size is 8.
gstream-set_wrap
If set to true, the outputter will launch a newline if the text is too wide to fit the line. The text will be wrapped at the spaces between the words. If a...
gstream-tab_size
Sets the standard tabulator size to TS.
gstream-wrap
The stream will wrap at the right boundary. Same effect as set_wrap(true).
gstream-x
Moves to the x-coordinate PX.
gstream-y
Moves to the y-coordinate PY.