The outage for Sunday 24th November has been cancelled.
Bioplib
Protein Structure C Library
 All Data Structures Files Functions Variables Typedefs Macros Pages
Macros | Functions
WindIO.h File Reference

Header for window/normal interface routines. More...

#include "SysDefs.h"
#include "deprecated.h"

Go to the source code of this file.

Macros

#define _WINDIO_H_DEPRECATED
 

Functions

void blScreen (char *string)
 
void blPrompt (char *string)
 
void blRePrompt (void)
 
void blGetKybdString (char *string, int maxlen)
 
void blPagingOn (void)
 
void blPagingOff (void)
 
void blWindowMode (BOOL mode)
 
void blWindowInteractive (BOOL mode)
 
int blYorN (char deflt)
 

Detailed Description

Header for window/normal interface routines.

Version
V1.6
Date
14.08.14
Copyright
(c) UCL / Dr. Andrew C. R. Martin 1993-2014
Author
Dr. Andrew C. R. Martin
Institute of Structural & Molecular Biology, University College London, Gower Street, London. WC1E 6BT.
andre.nosp@m.w@bi.nosp@m.oinf..nosp@m.org..nosp@m.uk andre.nosp@m.w.ma.nosp@m.rtin@.nosp@m.ucl..nosp@m.ac.uk

This code is NOT IN THE PUBLIC DOMAIN, but it may be copied according to the conditions laid out in the accompanying file COPYING.DOC.

The code may be modified as required, but any modifications must be documented so that the person responsible can be identified.

The code may not be sold commercially or included as part of a commercial product except as described in the file COPYING.DOC.

Description:

Usage:

Revision History:

Definition in file WindIO.h.

Macro Definition Documentation

#define _WINDIO_H_DEPRECATED

Definition at line 74 of file WindIO.h.

Function Documentation

void blGetKybdString ( char *  string,
int  maxlen 
)

Reads a string from the keyboard

  • 02.10.92 Original
  • 05.10.92 Added AMIGA_WINDOWS support
  • 15.03.94 Added check on sWindowMode
  • 01.02.01 Added maxlen parameter and changed gets() to fgets()
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 263 of file WindIO.c.

void blPagingOff ( void  )

Switches off screen paging.

  • 07.10.92 Original
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 311 of file WindIO.c.

void blPagingOn ( void  )

Switches on screen paging.

  • 07.10.92 Original
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 295 of file WindIO.c.

void blPrompt ( char *  string)
Parameters
[in]*stringPrompt string

Sets a prompt for input. If windowing is on, this simply sets the prompt variable (the actual prompt is issued by the GetKybdString() function). If no windowing is used, the actual string is printed. If the prompt ends with a . it is simply printed; if not, a > is appended.

  • 25.09.92 Original
  • 02.10.92 Added CURSES support
  • 05.10.92 Added AMIGA_WINDOWS support
  • 11.03.94 Modified to save prompt string even if not windowing
  • 15.03.94 Now sets up string and just calls RePrompt()
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 217 of file WindIO.c.

void blRePrompt ( void  )

Reissue the current prompt. Only has any effect when windowing is not in use. Normally only used by ReadBufferedFile() and ProbeBufferedFile() to re-issue prompts while eating blank lines.

  • 10.03.94 Original By: ACRM
  • 15.03.94 Changed to work whenever we're not windowing and are interactive
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 241 of file WindIO.c.

void blScreen ( char *  string)
Parameters
[in]*stringString to write on window

Writes information to the screen. Handles any windows as appropriate.

  • 25.09.92 Original
  • 02.10.92 Added CURSES support
  • 05.10.92 Added AMIGA_WINDOWS support
  • 07.10.92 Added paging support
  • 11.03.94 Added check on sWindowMode
  • 14.03.94 Changed this to check on sInteractive Changed check on WINDOWING to sWindowMode
  • 01.02.01 Added maxlen parameter
  • 15.02.01 oops! removed maxlen parameter, value of 80 should have gone into GetKybdString()
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 155 of file WindIO.c.

void blWindowInteractive ( BOOL  mode)
Parameters
[in]modeTRUE: Is interactive (default) FALSE: Not interactive

Switch interactive mode on or off. If switched off, calls WindowMode(FALSE) to switch off windowing

  • 15.03.94 Original By: ACRM
  • 17.03.94 Set sInteractive not sWindowMode!
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 354 of file WindIO.c.

void blWindowMode ( BOOL  mode)
Parameters
[in]modeTRUE: Use windowing FALSE: Output normally (default)

Switch window mode on or off.

  • 11.03.94 Original By: ACRM
  • 15.03.94 Added check on WINDOWING
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 330 of file WindIO.c.

int blYorN ( char  deflt)
Parameters
[in]*defltDefault response ('y' or 'n') if return is pressed without a letter or an invalid letter is given
Returns
0 if the user responds with N or n 1 if the user responds with Y or y 2 if the user responds with A or a 3 if the user responds with Q or q

Get a yes or no response from the keyboard

A default ('y' or 'n') is supplied in the function call and hitting <return> or supplying any invalid character will result in the default being used.

The routine will work correctly with any response which starts with the right letter (e.g. Yes, Yeah, yellow(!), no, Never, etc.)

  • 18.06.93 Original By: ACRM
  • 01.02.01 Added maxlen parameter to GetKybdString()
  • 07.07.14 Use bl prefix for functions By: CTP

Definition at line 388 of file WindIO.c.

Generated on Tue Oct 24 2017 10:57:49 for Bioplib by   doxygen 1.8.8