This is Info file jptui.info, produced by Makeinfo version 1.68 from the
input file jptui.txi.

INFO-DIR-SECTION Libraries
START-INFO-DIR-ENTRY
* JPTUI: (jptui).
        Jean-Pierre Delprat's Textmode User Interface library.
END-INFO-DIR-ENTRY


File: jptui.info,  Node: Keycode Definitions,  Next: Gauge Definitions,  Prev: File Definitions,  Up: Preprocessor Symbols

Keycode Definitions
===================


- Normal Keys ----------------------------------------------------------

+ ESC                   + SPACE                 + TAB
+ RETURN

+ F1                    + F2                    + F3
+ F4                    + F5                    + F6
+ F7                    + F8                    + F9
+ F10                   + F11                   + F12

+ UP                    + DOWN                  + LEFT
+ RIGHT                 + HOME                  + END
+ PGUP                  + PGDN

+ BACKSPACE             + INSERT                + DELETE

- SHIFT-Modified Keys --------------------------------------------------

+ SHIFT_TAB

+ SHIFT_F1              + SHIFT_F2              + SHIFT_F3
+ SHIFT_F4              + SHIFT_F5              + SHIFT_F6
+ SHIFT_F7              + SHIFT_F8              + SHIFT_F9
+ SHIFT_F10             + SHIFT_F11             + SHIFT_F12

+ SHIFT_UP              + SHIFT_DOWN            + SHIFT_LEFT
+ SHIFT_RIGHT           + SHIFT_HOME            + SHIFT_END
+ SHIFT_PGUP            + SHIFT_PGDN

+ SHIFT_INSERT          + SHIFT_DELETE

- CTRL-Modified Keys --------------------------------------------------

+ CTRL_A                + CTRL_B                + CTRL_C
+ CTRL_D                + CTRL_E                + CTRL_F
+ CTRL_G                + CTRL_H                + CTRL_I
+ CTRL_J                + CTRL_K                + CTRL_L
+ CTRL_M                + CTRL_N                + CTRL_O
+ CTRL_P                + CTRL_Q                + CTRL_R
+ CTRL_S                + CTRL_T                + CTRL_U
+ CTRL_V                + CTRL_W                + CTRL_Y
+ CTRL_Z

+ CTRL_F1               + CTRL_F2               + CTRL_F3
+ CTRL_F4               + CTRL_F5               + CTRL_F6
+ CTRL_F7               + CTRL_F8               + CTRL_F9
+ CTRL_F10              + CTRL_F11              + CTRL_F12

+ CTRL_UP               + CTRL_DOWN             + CTRL_LEFT
+ CTRL_RIGHT            + CTRL_HOME             + CTRL_END
+ CTRL_PGUP             + CTRL_PGDN

+ CTRL_BACKSPACE        + CTRL_INSERT           + CTRL_DELETE

- ALT Keys -------------------------------------------------------------

+ ALT_A                 + ALT_B                 + ALT_C
+ ALT_D                 + ALT_E                 + ALT_F
+ ALT_G                 + ALT_H                 + ALT_I
+ ALT_J                 + ALT_K                 + ALT_L
+ ALT_M                 + ALT_N                 + ALT_O
+ ALT_P                 + ALT_Q                 + ALT_R
+ ALT_S                 + ALT_T                 + ALT_U
+ ALT_V                 + ALT_W                 + ALT_Y
+ ALT_Z

+ ALT_1                 + ALT_2                 + ALT_3
+ ALT_4                 + ALT_5                 + ALT_6
+ ALT_7                 + ALT_8                 + ALT_9
+ ALT_0

+ ALT_F1                + ALT_F2                + ALT_F3
+ ALT_F4                + ALT_F5                + ALT_F6
+ ALT_F7                + ALT_F8                + ALT_F9
+ ALT_F10               + ALT_F11               + ALT_F12

+ ALT_BACKSPACE         + ALT_DELETE

- CTRL-SHIFT-Modified Keys ---------------------------------------------

+ CTRL_SHIFT_UP         + CTRL_SHIFT_DOWN       + CTRL_SHIFT_LEFT
+ CTRL_SHIFT_RIGHT      + CTRL_SHIFT_HOME       + CTRL_SHIFT_END
+ CTRL_SHIFT_PGUP       + CTRL_SHIFT_PGDN


File: jptui.info,  Node: Gauge Definitions,  Next: InputBox Definitions,  Prev: Keycode Definitions,  Up: Preprocessor Symbols

Gauge Definitions
=================


- Gauge Style ---------------------------------------------------------

The following two values are actually part of the 'TGaugeStyle'
enumeration.

+ GAUGE_PERCENTAGE_STYLE

  This specifies that the gauge will display it's value as a percentage
  of the total (ie, 10 percent instead of 1 out of 10).

+ GAUGE_OUT_OF_STYLE

  This specifies that the gauge will display it's value as a number of
  parts complete of of the total number of parts (ie, '1 out of 10'
  instead of 10 percent).


File: jptui.info,  Node: InputBox Definitions,  Next: Language Definitions,  Prev: Gauge Definitions,  Up: Preprocessor Symbols

InputBox Definitions
====================


- InputBox Type --------------------------------------------------------

+ IB_STRING

  The InputBox is used to enter a string.

+ IB_PASSWORD

  The InputBox is used to enter a password. The string which is entered
  by the user doesn't appear on screen.

+ MB_OKQUIT

  A message box with two options --- OK and QUIT.

+ MB_ABORTRETRYIGNORE

  The infamous ABORT/RETRY/IGNORE message. It does look a lot friendlier
  with JPTUI, however...

+ MB_YESNOCANCEL

  A message box with three options --- YES, NO, and CANCEL.

+ MB_YESNO

  A message box with two options --- YES and NO.

+ MB_RETRYCANCEL

  A message box with two options --- RETRY and CANCEL.

Set 2 - Icons
-------------

+ MB_NOICON

  Instructs the MessageBox function not to draw any icons.

+ MB_ICONSTOP

  Displays a 'STOP' icon --- to warn the user to stop and pay attention
  to the message.

+ MB_ICONQUESTION

  Displays a 'QUESTION' icon.

+ MB_ICONEXCLAMATION

  Displays a 'EXCLAMATION' (!) icon.

+ MB_ICONINFORMATION

  Displays a 'INFORMATION' icon.

Set 3 - Default Buttons
-----------------------

+ MB_DEFBUTTON1

  Instructs the MessageBox function to treat the first button as the
  default response (selected when the user hits the Return key).

+ MB_DEFBUTTON2

  Instructs the MessageBox function to treat the second button as the
  default response (selected when the user hits the Return key).

+ MB_DEFBUTTON3

  Instructs the MessageBox function to treat the third button as the
  default response (selected when the user hits the Return key).

- MessageBox Return Values ---------------------------------------------

One of these values will be returned by the MessageBox function
depending on which response the user selected.

+ OK_BUTTON
+ CANCEL_BUTTON
+ QUIT_BUTTON
+ ABORT_BUTTON
+ RETRY_BUTTON
+ IGNORE_BUTTON
+ YES_BUTTON
+ NO_BUTTON


File: jptui.info,  Node: Language Definitions,  Next: List Definitions,  Prev: InputBox Definitions,  Up: Preprocessor Symbols

Language Definitions
====================


- Language -------------------------------------------------------------

The following are defined as part of the enumeration 'TLanguage'.

+ NONE

  No language has been chosen yet.

+ ENGLISH
+ FRENCH
+ GERMAN
+ ITALIAN
+ SPANISH
+ DUTCH
+ GREEK (partial support : only upper case characters and no shortcuts)


File: jptui.info,  Node: List Definitions,  Next: MessageBox Definitions,  Prev: Language Definitions,  Up: Preprocessor Symbols

List Definitions
================


- Scrolling Speed ------------------------------------------------------

+ LIST_SCROLL_SPEED

*Note EDITZONE_SCROLL_SPEED: EditZone Definitions.

+ LIST_FIRST_SCROLL_SPEED

*Note EDITZONE_FIRST_SCROLL_SPEED: EditZone Definitions.


File: jptui.info,  Node: MessageBox Definitions,  Next: Mouse Definitions,  Prev: List Definitions,  Up: Preprocessor Symbols

MessageBox Definitions
======================


- MessageBox Type ------------------------------------------------------

The following three sets of definitions are ORed together to select your
MessageBox type.

Set 1 - Buttons
---------------

+ MB_OK

  A simple message, which the user can only read, and press OK.

+ MB_OKCANCEL

  A message box with two options --- OK and CANCEL.

+ MB_OKQUIT

  A message box with two options --- OK and QUIT.

+ MB_ABORTRETRYIGNORE

  The infamous ABORT/RETRY/IGNORE message. It does look a lot friendlier
  with JPTUI, however...

+ MB_YESNOCANCEL

  A message box with three options --- YES, NO, and CANCEL.

+ MB_YESNO

  A message box with two options --- YES and NO.

+ MB_RETRYCANCEL

  A message box with two options --- RETRY and CANCEL.

Set 2 - Icons
-------------

+ MB_NOICON

  Instructs the MessageBox function not to draw any icons.

+ MB_ICONSTOP

  Displays a 'STOP' icon --- to warn the user to stop and pay attention
  to the message.

+ MB_ICONQUESTION

  Displays a 'QUESTION' icon.

+ MB_ICONEXCLAMATION

  Displays a 'EXCLAMATION' (!) icon.

+ MB_ICONINFORMATION

  Displays a 'INFORMATION' icon.

Set 3 - Default Buttons
-----------------------

+ MB_DEFBUTTON1

  Instructs the MessageBox function to treat the first button as the
  default response (selected when the user hits the Return key).

+ MB_DEFBUTTON2

  Instructs the MessageBox function to treat the second button as the
  default response (selected when the user hits the Return key).

+ MB_DEFBUTTON3

  Instructs the MessageBox function to treat the third button as the
  default response (selected when the user hits the Return key).

- MessageBox Return Values ---------------------------------------------

One of these values will be returned by the MessageBox function
depending on which response the user selected.

+ OK_BUTTON
+ CANCEL_BUTTON
+ QUIT_BUTTON
+ ABORT_BUTTON
+ RETRY_BUTTON
+ IGNORE_BUTTON
+ YES_BUTTON
+ NO_BUTTON


File: jptui.info,  Node: Mouse Definitions,  Next: Object Type Definitions,  Prev: MessageBox Definitions,  Up: Preprocessor Symbols

Mouse Definitions
=================


- Button States --------------------------------------------------------

+ NO_BUTTON_PRESSED
+ LEFT_BUTTON_PRESSED
+ RIGHT_BUTTON_PRESSED

- Button Identifiers ---------------------------------------------------

+ LEFT_BUTTON
+ RIGHT_BUTTON

- Double-Click Timing --------------------------------------------------

+ MAX_DOUBLE_CLICK_DURATION

  This is the longest delay allowed between both mouse clicks in a
  'double-click' event. If the delay is longer, it will not be
  considered a 'double-click', but rather, as two separate clicks. This
  value is in Milliseconds.

- Mouse Pointer --------------------------------------------------------

The following are defined as part of the enumeration 'TMousePointer'.

+ MP_ARROW

  The normal 'arrow' mouse pointer.

+ MP_HOURGLASS

  The hourglass pointer, used to indicate that the application is
  working on something.

- Mouse Pointer Aspect -------------------------------------------------

The following are defined as part of the enumeration
'TMousePointerAspect'.

+ MPA_GRAPHICAL

  The mouse pointer is a graphical arrow displayed by JPTUI

+ MPA_TEXTUAL

  The mouse pointer is a textual block displayed by JPTUI

+ MPA_MOUSE_DRIVER

  The mouse pointer is displayed by the mouse driver. It can be a
  textual block if the program is ran in full screen mode (or nothing
  with non-standard text modes), or the pointer of Microsoft Windows if
  the program is ran in a Dos BOX.


File: jptui.info,  Node: Object Type Definitions,  Next: PushButton Type Definitions,  Prev: Mouse Definitions,  Up: Preprocessor Symbols

Object Type Definitions
=======================

 These are all quite self-explanatory, since they all refer the the
respective classes, so I've just listed them here without any explanation
for use as a reference table. There is one exception, though, OBJ_NONE,
which is explained immediately below.


+ OBJ_NONE

  This is used to mark unset variables, or to return an 'invalid' code.

+ OBJ_CHECK_BOX
+ OBJ_COMBO_LIST
+ OBJ_EDIT_ZONE
+ OBJ_FRAME_GROUP
+ OBJ_LABEL
+ OBJ_GAUGE
+ OBJ_LIST_BOX
+ OBJ_MENU
+ OBJ_MENU_BAR
+ OBJ_PUSH_BUTTON
+ OBJ_SCROLL_BAR
+ OBJ_TAB
+ OBJ_TAB_GROUP
+ OBJ_TEXT_ZONE
+ OBJ_WINDOW


File: jptui.info,  Node: PushButton Type Definitions,  Next: Screen Definitions,  Prev: Object Type Definitions,  Up: Preprocessor Symbols

PushButton Type Definitions
===========================


+ PB_NORMAL

  For standard PushButtons.

+ PB_DEFAULT

  Set this only for the button that you want to be hit by default (when
  the Return key is hit).

+ PB_CANCEL

  Set this only for the button that you want to be hit to abort (when
  the ESCape key is hit).

+ PRESSURE_TIME_LENGTH

  This value determines how many milliseconds an object will be
  displayed as depressed for when it's m_press() method is called.


File: jptui.info,  Node: Screen Definitions,  Next: ScrollBar Definitions,  Prev: PushButton Type Definitions,  Up: Preprocessor Symbols

Screen Definitions
==================


- Background -----------------------------------------------------------

+ SCREEN_BACKGROUND

  The screen's background character, including attributes.

- Text Modes -----------------------------------------------------------

The following are defined as part of the enumeration 'TTextMode'.

+ TEXTMODE_USER

  Any text mode you want to use, provided that you give me a function to
  set it.

+ TEXTMODE_80x25_8

  80 columns, 25 rows, 8x16 font.

+ TEXTMODE_80x25_9

  80 columns, 25 rows, 9x16 font (default).

+ TEXTMODE_80x28_8

  80 columns, 28 rows, 8x14 font.

+ TEXTMODE_80x28_9

  80 columns, 28 rows, 9x14 font.

+ TEXTMODE_80x50_8

  80 columns, 50 rows, 8x8 font.

+ TEXTMODE_80x50_9

  80 columns, 50 rows, 9x8 font.

- Fonts ----------------------------------------------------------------

The following are defined as part of the enumeration 'TFont'.

+ FONT_STANDARD

  Standard font.

+ FONT_JPTUI

  Special font designed for JPTUI.


File: jptui.info,  Node: ScrollBar Definitions,  Next: Shadow Definitions,  Prev: Screen Definitions,  Up: Preprocessor Symbols

ScrollBar Definitions
=====================


- Scrolling Speed ------------------------------------------------------

+ SCROLLBAR_SCROLL_SPEED

*Note EDITZONE_SCROLL_SPEED: EditZone Definitions.

+ SCROLLBAR_FIRST_SCROLL_SPEED

*Note EDITZONE_FIRST_SCROLL_SPEED: EditZone Definitions.

- Scrollbar Orientation ------------------------------------------------

The following two values are actually defined as parts of the
enumeration 'TSbOrientation'.  They are used to specify whether the
scrollbar is to be vertically or horizontally orientated.

+ SB_VERTICAL

  Vertically orientated

+ SB_HORIZONTAL

  Horizontally orientated

- Scrollbar Choice -----------------------------------------------------

The following values are actually defined as parts of the enumeration
'TScrollbarChoice'.  They are used to specify what kind of scrollbars
are used by an object.

+ SBC_NONE

  The object has no scrollbar.

+ SBC_HORIZONTAL

  The object has an horizontal scrollbar.

+ SBC_VERTICAL

  The object has a vertical scrollbar.

+ SBC_BOTH

  The object has both an horizontal scrollbar and a vertical one.


File: jptui.info,  Node: Shadow Definitions,  Next: Shortcut Definitions,  Prev: ScrollBar Definitions,  Up: Preprocessor Symbols

Shadow Definitions
==================


- Shadow Choice --------------------------------------------------------

The following values are actually defined as parts of the enumeration
'TShadowChoice'.  They are used to specify what kind of shadows are used
by an object.

+ SHC_NONE

  The object has no shadow.

+ SHC_HORIZONTAL

  The object has an horizontal shadow.

+ SHC_VERTICAL

  The object has a vertical scrollbar.

+ SHC_BOTH

  The object has both an horizontal shadow and a vertical one.


File: jptui.info,  Node: Shortcut Definitions,  Next: Sound Definitions,  Prev: Shadow Definitions,  Up: Preprocessor Symbols

Shortcut Definitions
====================


+ SC_NONE

+ SC_CTRL_A             + SC_CTRL_B             + SC_CTRL_C
+ SC_CTRL_D             + SC_CTRL_E             + SC_CTRL_F
+ SC_CTRL_G             + SC_CTRL_H             + SC_CTRL_I
+ SC_CTRL_J             + SC_CTRL_K             + SC_CTRL_L
+ SC_CTRL_M             + SC_CTRL_N             + SC_CTRL_O
+ SC_CTRL_P             + SC_CTRL_Q             + SC_CTRL_R
+ SC_CTRL_S             + SC_CTRL_T             + SC_CTRL_U
+ SC_CTRL_V             + SC_CTRL_W             + SC_CTRL_Y
+ SC_CTRL_Z

+ SC_ALT_A              + SC_ALT_B              + SC_ALT_C
+ SC_ALT_D              + SC_ALT_E              + SC_ALT_F
+ SC_ALT_G              + SC_ALT_H              + SC_ALT_I
+ SC_ALT_J              + SC_ALT_K              + SC_ALT_L
+ SC_ALT_M              + SC_ALT_N              + SC_ALT_O
+ SC_ALT_P              + SC_ALT_Q              + SC_ALT_R
+ SC_ALT_S              + SC_ALT_T              + SC_ALT_U
+ SC_ALT_V              + SC_ALT_W              + SC_ALT_Y
+ SC_ALT_Z

+ SC_ALT_1              + SC_ALT_2              + SC_ALT_3
+ SC_ALT_4              + SC_ALT_5              + SC_ALT_6
+ SC_ALT_7              + SC_ALT_8              + SC_ALT_9
+ SC_ALT_0

+ SC_F1                 + SC_F2                 + SC_F3
+ SC_F4                 + SC_F5                 + SC_F6
+ SC_F7                 + SC_F8                 + SC_F9
+ SC_F10                + SC_F11                + F12

+ SC_CTRL_F1            + SC_CTRL_F2            + SC_CTRL_F3
+ SC_CTRL_F4            + SC_CTRL_F5            + SC_CTRL_F6
+ SC_CTRL_F7            + SC_CTRL_F8            + SC_CTRL_F9
+ SC_CTRL_F10           + SC_CTRL_F11           + SC_CTRL_F12

+ SC_SHIFT_F1           + SC_SHIFT_F2           + SC_SHIFT_F3
+ SC_SHIFT_F4           + SC_SHIFT_F5           + SC_SHIFT_F6
+ SC_SHIFT_F7           + SC_SHIFT_F8           + SC_SHIFT_F9
+ SC_SHIFT_F10          + SC_SHIFT_F11          + SC_SHIFT_F12

+ SC_ALT_F1             + SC_ALT_F2             + SC_ALT_F3
+ SC_ALT_F4             + SC_ALT_F5             + SC_ALT_F6
+ SC_ALT_F7             + SC_ALT_F8             + SC_ALT_F9
+ SC_ALT_F10            + SC_ALT_F11            + SC_ALT_F12

+ SC_HOME               + SC_END                + SC_PGUP
+ SC_PGDN

+ SC_CTRL_UP            + SC_CTRL_DOWN          + SC_CTRL_LEFT
+ SC_CTRL_RIGHT         + SC_CTRL_HOME          + SC_CTRL_END
+ SC_CTRL_PGUP          + SC_CTRL_PGDN

+ SC_ALT_HOME           + SC_ALT_END

+ SC_INSERT             + SC_DELETE

+ SC_CTRL_BACKSPACE     + SC_CTRL_INSERT        + SC_CTRL_DELETE

+ SC_SHIFT_INSERT       + SC_SHIFT_DELETE

+ SC_ALT_BACKSPACE      + SC_ALT_DELETE


File: jptui.info,  Node: Sound Definitions,  Next: Special Character Definitions,  Prev: Shortcut Definitions,  Up: Preprocessor Symbols

Sound Definitions
=================

 The following are defined as part of the enumeration 'TSound'.


+ NO_SOUND

  No sound.

+ ERROR_SOUND

  A general error sound.

+ BIP1
+ SOUND_UP1
+ ALARM1

  Other sounds.

If you want more sounds, define them with the sound() and delay()
functions then send me their definition. I will add them to JPTUI.


File: jptui.info,  Node: Special Character Definitions,  Next: TextZone Definitions,  Prev: Sound Definitions,  Up: Preprocessor Symbols

Special Character Definitions
=============================

 Below are the identifiers for the special graphical characters used by
JPTUI. They are all quite self-explanatory, so I haven't included any
additional explanation here.


Note : These characters can only be used if the current font is
JPTUI_FONT (*note Screen Definitions::.).

- Border Characters ----------------------------------------------------

+ CHAR_UP_LEFT_CORNER
+ TEXT_UP_LEFT_CORNER
+ CHAR_UP_HLINE
+ TEXT_UP_HLINE
+ CHAR_UP_RIGHT_CORNER
+ TEXT_UP_RIGHT_CORNER
+ CHAR_LEFT_VLINE
+ TEXT_LEFT_VLINE
+ CHAR_RIGHT_VLINE
+ TEXT_RIGHT_VLINE
+ CHAR_BOTTOM_LEFT_CORNER
+ TEXT_BOTTOM_LEFT_CORNER
+ CHAR_BOTTOM_HLINE
+ TEXT_BOTTOM_HLINE
+ CHAR_BOTTOM_RIGHT_CORNER
+ TEXT_BOTTOM_RIGHT_CORNER
+ CHAR_UP_BOTTOM_HLINES
+ TEXT_UP_BOTTOM_HLINES

- Ticks ----------------------------------------------------------------

+ CHAR_TICK
+ TEXT_TICK

- Arrow Characters -----------------------------------------------------

+ TEXT_ARROW_UP
+ TEXT_ARROW_DOWN
+ TEXT_ARROW_LEFT
+ TEXT_ARROW_RIGHT

- Button Characters ----------------------------------------------------

+ TEXT_CLOSE_BUTTON
+ TEXT_CHECKED_RADIO_BUTTON
+ TEXT_UNCHECKED_RADIO_BUTTON
+ TEXT_CHECKED_CHECK_BOX
+ TEXT_UNCHECKED_CHECK_BOX


File: jptui.info,  Node: TextZone Definitions,  Next: TList Attribute Definitions,  Prev: Special Character Definitions,  Up: Preprocessor Symbols

TextZone Definitions
====================


- Scrolling Speed ------------------------------------------------------

+ TEXTZONE_SCROLL_SPEED

*Note EDITZONE_SCROLL_SPEED: EditZone Definitions.

+ TEXTZONE_FIRST_SCROLL_SPEED

*Note EDITZONE_FIRST_SCROLL_SPEED: EditZone Definitions.


File: jptui.info,  Node: TList Attribute Definitions,  Next: Window Definitions,  Prev: TextZone Definitions,  Up: Preprocessor Symbols

TList Attribute Definitions
===========================


+ LI_NOATTR

  Specifies no attributes.

+ LI_DISABLED

  Specifies that the item is disabled.

+ LI_CHECKED

  Specifies that the item is checked.

+ LI_TOGGLE

  Specifies that the item can be checked, and should toggle (ie, that it
  should alternate between checked and unchecked each time it is
  selected).


File: jptui.info,  Node: Window Definitions,  Next: String Datatypes,  Prev: TList Attribute Definitions,  Up: Preprocessor Symbols

Window Definitions
==================


- Caption Text Justification (Alignment) -------------------------------

+ CENTERED

  The caption text will be centered in its display area when this is
  set.

+ JUSTIFIED_LEFT

  The caption text will be positionned at the left of its display area
  when this is set.

+ JUSTIFIED_RIGHT

  The caption text will be positionned at the right of its display area
  when this is set.

+ CENTERED_LEFT

  When this is set, the caption text will be centered in its display
  area if there is enough place to display it entirely, otherwise it
  will be positionned at the left of its display area.

+ CENTERED_RIGHT

  When this is set, the caption text will be centered in its display
  area if there is enough place to display it entirely, otherwise it
  will be positionned at the right of its display area.

- Arrow Types ----------------------------------------------------------

+ ARROW_UP

  The up-arrow.

+ ARROW_DOWN

  The down-arrow.

+ ARROW_LEFT

  The left-arrow.

+ ARROW_RIGHT

  The right-arrow.

- Window Styles (affects colors, etc...) -------------------------------

+ DIALOG1

  The standard dialog style.

+ DIALOG2

  Another dialog style --- for a bit more emphasis.

+ DIALOG3

  Another dialog style --- for even more emphasis.

+ ALERT

  For alerting the user about problems.

+ HELP

  The suggested style for help-windows, about boxes, etc.


File: jptui.info,  Node: String Datatypes,  Next: Keyboard Structures,  Prev: Window Definitions,  Up: Datatypes

String Datatypes
================

 Strings used by JPTUI can have different formats.


+ the 'text' string format

  This string format is used by the 'TWindow::m_put_text' function, and
  by any object which uses this function. In particular, the text of
  TLabel objects is displayed using this function.

  This kind of string is of form :
  "1st line\n2nd line\n...\nlast line"

  Each line is of form "Normal text[special sequence]Normal text ....".
  Each sub-string between '[' and ']' is not displayed (you can use "[["
  to  display a '[' character), but has a special meaning.

  The following special sequences can be used :
  > [cx] to change the color of the text (x is the color : 0,1...9,
    A...F),
  > [axy] to change the attribute (text and background colors) of the
    text (x for background, y for text : 0,1...9,A...F).

  In some cases (in TTextZone objects for instance), these special
  sequences are considered as normal text.

+ the 'caption' string format

  This string format is used by the 'TWindow::m_put_caption', and by any
  object which uses this function. In particul, the caption of most
  objects is displayed using this function.

  This kind of string is a standard string in which the hot key is
  preceded by a '~' (you can use "~~" to display a '~' character).


File: jptui.info,  Node: Keyboard Structures,  Next: TList Structures,  Prev: String Datatypes,  Up: Structures

Keyboard Structures
===================


+ TKey

  > int character

    The key code (*note Keycode Definitions::.).

  > u_char hot_character

    The character part of a hotkey code.  For example, for the sequence
    ALT-A, this would be A.  Similarly, for the a simple press of the A
    key, this value would still be a simple A.  Effectively, it is the
    keypress with the qualifier-keys (ALT, CTRL, etc) filtered-off.


File: jptui.info,  Node: TList Structures,  Next: TMenu Structures,  Prev: Keyboard Structures,  Up: Structures

TList Structures
================


+ TListItem

  > char* label

    The item's label.

  > int attribute

    The item's attributes (*note TList Attribute Definitions::.).


File: jptui.info,  Node: TMenu Structures,  Next: Application Macros,  Prev: TList Structures,  Up: Structures

TMenu Structures
================


+ TMenuItem

  > char* label

    The item's label.

  > int attribute

    The item's attributes (*note TList Attribute Definitions::.).

  > int short_cut

    The keycode which should be used as a shortcut (*note Shortcut Definitions::.).

  > char* help_message

    The help message to display on the status bar when the user
    highlights the menu option.  Note that this only applies to windows
    which were created with a status bar (*note TWindow Instanciation::.).


File: jptui.info,  Node: Application Macros,  Next: Character set Macros,  Prev: TMenu Structures,  Up: Functions and Macros

Application Macros
==================


- Application Memory Management ----------------------------------------

+ JPOutOfMemoryExit ()

  This is called to exit the application when memory runs out.

- Scheduling -----------------------------------------------------------

+ JPInit ()

  Initialises everything needed for JPTUI (mouse, display...).

+ JPRun ()

  Starts event processing.  Call this when your application is ready to
  start taking user input.

+ JPRunDialog ()

  Start's event processing for a dialog box.

+ JPProcessEvents ()

  This functions processes events once and returns to the calling
  function. You can use it in long callbacks for instance, so that
  events are regularly processed. If you have long callbacks and want
  events to be processed during their execution, another solution is to
  use the 'no event' callback (cf 'JPSetNoEventCallback' below).

+ JPStop ()

  Stops event processing.  Call this to disable JPTUI when you want to
  quit your application or stop even processing for a dialog box.

- Display Refreshing ---------------------------------------------------

+ JPRefresh ()

  Refreshes the part of the screen that has changed since the last
  refresh. The refresh is synchronized with the video beam retrace.

+ JPRefreshAll ()

  Refreshes the whole screen. The refresh is synchronized with the video
  beam retrace.

- Windows --------------------------------------------------------------

+ boolean JPRedrawWindows ()

  Redraws the contents of windows.

+ boolean JPMakeNextWindowActive ()

  Makes the next window (relative to the currently-selected window)
  active. Returns a boolean value which indicates success or failure.

+ PWindow GetActiveWindow ()

  Returns a pointer to the active window or NULL if there is no such
  window.

- Clipboard ------------------------------------------------------------

+ JPGetClipboard ()

  Returns the clipboard contents (a string ('char*') which uses the
  'text' string format (*note String Datatypes::.).

+ JPSetClipboard (
    char *text)

  Changes the clipboard contents to 'text'. 'text' has a special
  string format (*note String Datatypes::.).

- Enabling and Disabling Callbacks -------------------------------------

+ JPEnableCallbacks ()

  Enables all callback processing.

+ JPDisableCallbacks ()

  Disables all callback processing.

+ JPCallbacksEnabled ()

  Returns a boolean value which indicates if callbacks are currently
  enabled.

- Setting Callbacks ----------------------------------------------------

+ JPSetNoEventCallback (
    void (*no_event_action)(char *),
    char *no_event_argument);

  Sets the callback to invoke when no event occur.  the
  'no_event_argument' can be used to provide an argument to your
  callback.

+ JPSetClipboardChangedCallback (
    void (*clipboard_changed_action)(char *),
    char *clipboard_changed_argument);

  Sets the function to call when the clipboard contents change.  Again,
  as with all callback setting functions, a 'char*' argument can be
  supplied --- with 'clipboard_changed_argument'.


File: jptui.info,  Node: Character set Macros,  Next: MIN and MAX Macros,  Prev: Application Macros,  Up: Functions and Macros

Character set Macros
====================


+ void DefineChars (
    int nb_chars,
    char first_char,
    char *char_definition)

  Defines character settings, as if by
  'GetSetCharDefinition (*note Character set Functions::.)(TRUE,nb_chars,first_char,char_definition)'.

+ void GetCharDefinition (
    int nb_chars,
    char first_char,
    char *char_definition)

  Retrieves current character settings, as if by
  'GetSetCharDefinition (*note Character set Functions::.)(FALSE,nb_chars,first_char,char_definition)'.


File: jptui.info,  Node: MIN and MAX Macros,  Next: Caption Functions,  Prev: Character set Macros,  Up: Functions and Macros

MIN and MAX Macros
==================


+ MIN(a,b)

  Works out which of 'a' and 'b' is greater in value, and returns it.

+ MAX(a,b)

  Works out which of 'a' and 'b' is lesser in value, and returns it.


File: jptui.info,  Node: Caption Functions,  Next: Character set Functions,  Prev: MIN and MAX Macros,  Up: Functions and Macros

Caption Functions
=================


+ char HotKey (char *caption)

  Returns the Hotkey character specified in the string 'caption'.

+ int DisplayLength (char *caption)

  Returns the length of the string 'caption', after allowing for special
  non-printing characters, such as the hotkey code.


File: jptui.info,  Node: Character set Functions,  Next: Conversion Functions,  Prev: Caption Functions,  Up: Functions and Macros

Character set Functions
=======================


+ void GetSetCharDefinition (
    boolean set,
    int nb_chars,
    char first_char,
    char *char_definition)

  When 'set' is TRUE, this function changes 'nb_char' characters in the
  character set, starting at 'first', to the new values in the array
  'char_definition'.  When 'set' is FALSE, the current character values
  will be copied into your supplied 'char_definition' buffer instead.

*Note Character set Macros::.


File: jptui.info,  Node: Conversion Functions,  Next: Cursor Functions,  Prev: Character set Functions,  Up: Functions and Macros

Conversion Functions
====================


+ char EndOfString (
    char *string)

  Returns the last char of 'string' (or 0 if string is "").

+ int HexaToInt (
    char hexa_digit)

  Converts the hexadecimal (base-16) character 'hexa_digit' to an
  integer.

+ boolean StringToLong (
    char *string,long &value)

  Converts 'string' to a long integer, and stores it in the buffer
  'value'.  Returns a boolean which indicates if the conversion
  succeeded.

+ boolean StringToDouble (
    char *string,double &value)

  Converts 'string' to a double, and stores it in the buffer 'value'.
  Returns a boolean which indicates if the conversion succeeded.

+ void LongToString (
    long value,char *string)

  Converts the long 'value' to a string, and places it into the buffer
  'string'.

+ void DoubleToString (
    double value,char *string)

  Converts the double 'value' to a string, and places it into the buffer
  'string'.


File: jptui.info,  Node: Cursor Functions,  Next: Data file Functions,  Prev: Conversion Functions,  Up: Functions and Macros

Cursor Functions
================


- Style ----------------------------------------------------------------

+ void SetTextCursorStyle (
    int cursor_style)

  Changes the cursor style to 'cursor_style' (*note Cursor Definitions::.).

+ int GetTextCursorStyle ()

  Returns the current cursor style (*note Cursor Definitions::.).

- Visibility -----------------------------------------------------------

+ void HideTextCursor ()

  Makes the cursor invisible.

+ void ShowTextCursor ()

  Makes the cursor visible.

+ boolean TextCursorIsVisible ()

  Returns a boolean value, which indicates whether the cursor is
  currently visible.

- Position -------------------------------------------------------------

+ void SetTextCursorAt (
    int x,int y)

  Moves the cursor to position ('x','y').

+ void SetTextCursorAt (
    int x,int y,int cursor_style)

  Moves the cursor to position ('x','y'), changing the cursor style at
  the same time (*note Cursor Definitions::.).

+ int GetXTextCursor ()

  Returns the current 'x' position of the cursor.

+ int GetYTextCursor ()

  Returns the current 'y' position of the cursor.


File: jptui.info,  Node: Data file Functions,  Next: Debug Macros,  Prev: Cursor Functions,  Up: Functions and Macros

Data file Functions
===================


- Introduction ---------------------------------------------------------

Data files of applications written with JPTUI can be located :
> in the .exe file directory,
> in an EXEDAT archive file (JPTUI.DAT) in the .exe file directory,
> in an EXEDAT archive linked to the .exe file.

Note : EXEDAT (*note Credits::.) is a program which can be used to easily create an
       archive, insert numerous files, compress them (or not) and link
       the archive to your .exe file.

JPTUI.DAT provided with JPTUI contains several files which are necessary
to the library (fonts, mouse pointers, vocabulary files (*note Vocabulary Functions::.)...).

JPTUI supports the following compression methods of EXEDAT :
> 0 (compr_none)  : no compression,
> 1 (compr_lzss)  : lzss compression, for fast decoding,
> 2 (compr_lzari) : arithmetic compression, like most archivers.

- Functions ------------------------------------------------------------

+ void LoadDataFile (
    char *file_name,char *(&buffer),long &length)

  Allocates a buffer and loads the data file 'file_name' into this
  buffer. This buffer has to be freed by delete [].

  If the file 'file_name' can be found in the .exe file directory,
  this file is loaded even if it is also located in JPTUI.DAT or an
  exedat archive linked to the .exe file. If this file cannot be found
  in the .exe file directory but is archived in JPTUI.DAT, the file in
  JPTUI.DAT is loaded even an exedat archive containing the same file is
  linked to the .exe file.

  Returns :
  > a pointer to the buffer (in 'buffer') or NULL if an error
    occurs (no data file or incorrect data file),
  > the length of the buffer (in 'length').

  File_name must be at most 12 characters length

+ void GetInvalidDataFileMessage()

  Returns the message 'Data file is invalid or missing' in the current
  language,  even if vocabulary data files haven't been loaded into
  memory (*note Vocabulary Functions::.).


File: jptui.info,  Node: Debug Macros,  Next: Dialog Functions,  Prev: Data file Functions,  Up: Debug

Debug Macros
============

 The following macros behave differently whether you use the 'debug' version
of JPTUI or the 'release' one.


+ NO_DEBUG (instruction)

  > 'debug' version   : doesn't do anything
  > 'release' version : execute 'instruction'

+ DEBUG (instruction)

  > 'debug' version   : execute 'instruction'
  > 'release' version : doesn't do anything

+ DEBUG_STOP ()

  > 'debug' version   : aborts the program
  > 'release' version : doesn't do anything

+ DEBUG_TEST (test)

  > 'debug' version   : if 'test' evaluates to 0, aborts the program
  > 'release' version : doesn't do anything.

+ DEBUG_SHOW_MEMORY ()

  > 'debug' version   : after calling this macro, available memory is
                        regularly displayed using 'DEBUG_DISPLAY_MEMORY'
  > 'release' version : doesn't do anything

+ DEBUG_HIDE_MEMORY ()

  > 'debug' version   : stops displaying available memory (after
                         calling 'DEBUG_SHOW_MEMORY'),
  > 'release' version : doesn't do anything.

+ DEBUG_DISPLAY_MEMORY ()

  > 'debug' version   : displays the available memory (physical and
                        and virtual if any) at the top of the screen,
  > 'release' version : doesn't do anything.


File: jptui.info,  Node: Dialog Functions,  Next: Error Functions,  Prev: Debug Macros,  Up: Functions and Macros

Dialog Functions
================


+ void InputBox (
    char *title,
    char *message,
    int window_style,
    char *default_string,
    int max_length,
    char *return_string,
    int type=IB_STRING);

  Opens a window of the type specified by the 'type' argument (cf
   (*note InputBox Definitions::.)) which the user can enter a string into.
  The window uses the style 'window_style', the title 'title, and
  displays the prompt 'message'. Initially, the string will be set to
  whatever you specify with 'default_string', and the user can either
  use your suggested default, or change the string to any text up to
  'max_length' characters in length.  The chosen string ("" if the user
  presses the cancel button) will be stored in the buffer
  'return_string'.

+ int MessageBox (
    char *title,
    char *message,
    int window_style,
    int type=MB_OK,
    TSound sound_type=NO_SOUND)

  Displays a message box, of the type specified by the 'type' argument
  (*note MessageBox Definitions::.).  The window will have the title
  'title', and the message 'message', and use the window style
  'window_style'. The sound 'sound_type' (*note Sound Definitions::.) is
  played when the message box opens.

+ char * FileSelectionBox (
    char *title,
    char *mask,
    char *ok_button_caption="",
    char *cancel_button_caption="")

  Opens a window in which the user can choose a file. The window title
  is 'title' and the default file mask is 'mask'.  The captions of the
  ok and cancel buttons can also be specified in 'ok_button_caption'
  and  'cancel_button_caption', otherwise default strings are used.
  The string returned by this fonction is the full name of the chosen
  file ("" if the user have pressed the cancel button).


File: jptui.info,  Node: Error Functions,  Next: File Functions,  Prev: Dialog Functions,  Up: Functions and Macros

Error Functions
===============


+ void AbortProgram ()

  Aborts the program without displaying any message.

+ void FatalError (
    char *message)

  Aborts the application, printing 'message'.

+ void TextError (
   char *message)

  Closes the application if necessary (*note CloseScreen: Screen Functions.)
  and displays the error 'message' (in text mode).


File: jptui.info,  Node: File Functions,  Next: Keyboard Functions,  Prev: Error Functions,  Up: Functions and Macros

File Functions
==============


+ boolean FileExists (
    char *file_name)

  Returns a boolean value which indicates whether 'file_name' exists.

+ char * GetCurrentDir ()

  Returns the current directory (including the drive specifier), or ""
  if an error occurs.

+ boolean FullPath (
    char *full_path,char *path)

  Converts a path to its full name (making it absolute if it is
  relative, adding drive specifier if needed, collapsing '..'
  components, converting all slashes to '\', converting '\\' to '\'...).
  Stores the result in the buffer pointed to by 'full_path'.

  In case of failure, this function returns the root of the current
  drive in 'full_path' and returns FALSE, otherwise it returns the full
  name and TRUE.

  > 'full_path' must be MAX_PATH bytes length (including /0)
    (cf (*note File Definitions::.)).
  > If 'path' ends with a slash, 'full_path' too.
  > If a drive is specified in 'path', this drive must exist.

+ void FullPathOfFileInExeDir (
    char *full_path,char *file_name)

  Returns the full path of a file located in the directory of your .exe
  file.

  > 'full_path' must be MAX_PATH bytes length (including /0)
    (cf (*note File Definitions::.)).
  > 'file_name' must be a file name without directory information (only
    'FILE.EXT'), otherwise this file name is returned unchanged.

+ boolean DriveExists (int drive)

  Returns a boolean value which indicated whether 'drive' (0="A:",
  1="B:"...) exists.


File: jptui.info,  Node: Keyboard Functions,  Next: Mouse Functions,  Prev: File Functions,  Up: Functions and Macros

Keyboard Functions
==================


+ void ResetKeyboard ()

  Clears the keyboard buffer.

+ boolean KeyPressed ()

  Indicates whether a key has been pressed. Contrary to kbhit(), doesn't
  pause the program when the user hits CTRL-S.

+ void GetKey (
    TKey &key)

  Reads the keyboard buffer, and stores the last key pressed into 'key'.

+ boolean IsPrintableKey (
    TKey key)

  Returns a boolean which indicates whether 'key' is a printable key
  (ascii character).

+ boolean IsExtendedKey (
    TKey key)

  Returns a boolean which indicates whether 'key' is an extended key.

+ boolean IsAltKey (
    TKey key)

  Returns a boolean which indicates whether 'key' is an ALT-? key.

+ TKey GetNullKey ()

  Returns the 'Null Key'. The 'Null Key' is a reserved value which
  doesn't corresponds to any existing key.

+ boolean IsNullKey (TKey key)

  Returns a boolean which indicates whether 'key' is the Null key.

+ void WaitKeyRelease ()

  This function will wait until no key is pressed.

+ TKey WaitLeftClickOrKeyPressed ()

  This function will wait until a key has been pressed, or the left
  mouse button has been pressed, and then return the keycode for it.
  If the left button has been pressed, the returned value is the 'Null
  Key' (cf 'IsNullKey').


File: jptui.info,  Node: Mouse Functions,  Next: Screen Functions,  Prev: Keyboard Functions,  Up: Functions and Macros

Mouse Functions
===============


+ boolean InitMouse ()

  Attempts to initialize the mouse handler, and returns a boolean value
  indicating success or failure.

+ void CloseMouse ()

  Disables the mouse handling code that was previously enabled by
 'InitMouse'.

+ void ShowMouse ()

  Makes the mouse pointer visible.

+ void HideMouse ()

  Makes the mouse pointer invisible.

+ void GetMouseState (
    int &x,int &y,
    int &button_state)

  Reads the current mouse position and button states, and stores them
  in the supplied buffers 'x', 'y', and 'button_state'
  (*note Mouse Definitions::.).

+ void SetMousePointer (
    TMousePointer pointer)

  Changes the mouse pointer type to 'pointer' (*note Mouse Definitions::.).

+ TMousePointer getMousePointer ()

  Returns the current mouse pointer (*note Mouse Definitions::.).

+ TMousePointerAspect SetMousePointerAspect ()

  Sets the aspect of the mouse pointer (*note Mouse Definitions::.).

+ void WaitMouseLeftButtonRelease ()

  Waits for the left button of the mouse to be released


File: jptui.info,  Node: Screen Functions,  Next: Shadow Functions,  Prev: Mouse Functions,  Up: Functions and Macros

Screen Functions
================


+ void SetTextMode (
    TTextMode text_mode)

  Sets the text mode of the screen to 'text_mode' ( (*note Screen Definitions::.)).
  Only use this function for text modes JPTUI is able to set (not
  TEXTMODE_USER). For any other text mode, call 'SetUserTextMode'.

+ void SetUserTextMode (
    void (*set_mode_function)())

  Sets the text mode of the screen to any text mode. 'set_mode_function'
  is a pointer to a function that sets this mode.

+ TTextMode GetTextMode ()

  Returns the current text mode (*note Screen Definitions::.).

+ int GetScreenHeight ()

  Returns the current height of the screen in characters.

+ int GetScreenWidth ()

  Returns the current width of the screen in characters.

+ void SetFont (
    TFont font)

  Sets the font used by JPTUI to 'font' (*note Screen Definitions::.).

+ TFont GetFont ()

  Returns the font used by JPTUI (*note Screen Definitions::.).

+ int GetFontHeight ()

  Returns the height of the current font in pixels.

+ int GetFontWidth ()

  Returns the width of the current font in pixels.

+ void InitScreen ()

  Initializes the screen for JPTUI.  This includes setting up the mouse
  and it's pointer, the text cursor, and video mode.

+ void CloseScreen ()

  This function closes the JPTUI screen, restoring all original video
  settings. It should be only used after you are finished with JPTUI
  functions, or when you temporary disable the JPTUI screen (see
  'HideScreen' below).

+ boolean ScreenInitialized ()

  Returns a boolean value, which indicates whether the JPTUI screen has
  been initialized (by a call to 'InitScreen()').

+ void HideScreen ()

  Temporarily disables the JPTUI screen.  This is useful if you want to
  run a DOS program or shell, and also if you want to take over the
  display, for example to display graphics.

+ void UnhideScreen ()

  Redisplays the JPTUI screen after a call to 'HideScreen()'.  This
  function will take care of all necessary setup, including
  re-establishment of the correct video mode.

+ void ClearScreen (
    char attribute, char character)

  Clears the entire video screen, using 'character' and 'attribute' for
  the fill character.

+ void ClearPartOfScreen (
    int x1,int y1,int x2,int y2,
    char attribute,char character)

  Clears a rectangular area of the screen, from ('x1','y1') to
  ('x2','y2') using 'character' and 'attribute'.

+ void PartOfBufferToScreen (
    int x,int y,
    word *buffer,
    int x1_part,int y1_part,
    int part_width,int part_height,
    int buffer_width)

  Copies a rectangular area of size 'part_width' by 'part_height',
  starting at ('x1_part','y1_part') in 'buffer' to the screen at
  ('x','y').  You must supply the width of the buffer in the argument
  'buffer_width'.


File: jptui.info,  Node: Shadow Functions,  Next: Sound Functions,  Prev: Screen Functions,  Up: Functions and Macros

Shadow Functions
================


+ void HorizontalShadow (
    int x1,int x2,int y)

  Draws a horizontal shadow from ('x1','y') to ('x2','y').

+ void VerticalShadow (
    int x,int y1,int y2)

  Draws a vertical shadow from ('x','y1') to ('x','y2').


File: jptui.info,  Node: Sound Functions,  Next: Text Functions,  Prev: Shadow Functions,  Up: Functions and Macros

Sound Functions
===============


+ void PlaySound (
    TSound sound_type)

  Plays a sound, which is selected with the argument 'sound_type'
  (*note Sound Definitions::.).


File: jptui.info,  Node: Text Functions,  Next: Video beam Functions,  Prev: Sound Functions,  Up: Functions and Macros

Text Functions
==============


+ int GetTextHeight (char *text)

  Returns the number of lines required to display 'text'.

+ int GetTextWidth (char *text)

  Returns the number of columns required to display 'text'.


File: jptui.info,  Node: Video beam Functions,  Next: Vocabulary Functions,  Prev: Text Functions,  Up: Functions and Macros

Video beam Functions
====================


+ void WaitRetrace ()

  Waits until the video beam enters retrace mode.  Sometimes, when
  redrawing the display, the video beam will be redrawing the same part
  on the monitor, and the changes will produce noticeable glitches in
  the image.  Using video beam syncronisation however, you can be sure
  that the video beam is in retrace mode (ie, is preparing to redraw the
  display again), and isn't drawing the display while you change it.


File: jptui.info,  Node: Vocabulary Functions,  Next: Windows Functions,  Prev: Video beam Functions,  Up: Functions and Macros

Vocabulary Functions
====================


- Introduction ---------------------------------------------------------

In order to support several languages, JPTUI needs vocabulary files.
Theses files are data files (*note Data file Functions::.) whose name
are :
> JPVOCAB.xxx for the interface vocabulary,
> VOCAB.xxx for the application vocabulary.

xxx can currently be one of the following extensions :
> ENG (English vocabulary)
> FRE (French vocabulary)
> GER (German vocabulary)
> ITA (Italian vocabulary)
> SPA (Spanish vocabulary)
> DUT (Dutch vocabulary)

VOCAB.xxx files provided with JPTUI (in the JPTUI.DAT EXEDAT archive)
are empty. If you want your application to support several languages,
you have to change them.

For example, VOCAB.xxx could be :

1000,"String number 1000"
1001,"String number 1001"

Strings numbers 0 to 999 are reserved for JPTUI vocabulary.
Strings numbers above 999 can be used by the application.

- Functions ------------------------------------------------------------

+ TLanguage GetLanguage ()

  Returns the current language (*note Language Definitions::.).

+ boolean LoadVocabulary (
    TLanguage language)

  Loads vocabulary files which are specific to language 'language'
  (*note Language Definitions::.) :
  > JPVOCAB.xxx
  > VOCAB.xxx

  Returns FALSE if the chosen vocabulary can't be loaded.

+ void FreeVocabulary ()

  Removes vocabulary from memory.

+ char * GetString (
    int string_number)

  Returns the string whose number is 'string_number' in the current
  language.


File: jptui.info,  Node: Windows Functions,  Next: TApplication,  Prev: Vocabulary Functions,  Up: Functions and Macros

Windows Functions
=================


+ boolean RunningUnderWindows ()

  Indicates whether the program is running under Windows.

+ void SetDosBoxMode ()

  Configures JPTUI to be ran in a DOS box under Windows.

+ void SetFullScreenMode ()

  Configures JPTUI to be ran in full screen mode (under Windows or not).
  If the application is running in a window, it is forced to full
  screen.

