MUX-Window Reference

Version 0.0 October 23, 1995
By Bill Kendrick, (c) NBS 1995

Additional Types that the MUX-Window Library Adds

• Window: specifies a window in which activities are to be done
• Col: (color) defines a color in which to draw (eg BLACK, CLEAR, WHITE, etc.)
• LineMode: defines a mode in which to draw lines (eg NORMAL, DASHED, etc.)
• String: a character string (array)
• Stat: status value (eg SUCCESS)
• Font: specifies a font with which to draw text

MUX-Window Library Value Defines

• Col's (Colors):
  • BLACK: black (foreground) color
  • WHITE: white (background) color
  • CLEAR: no color
• LineMode's:
  • NORMAL: solid line
  • DASHED: dashed line
• Return Values:
  • Stat's:
    • SUCCESS: command successful
    • FAILURE: command not successful, check "ErrStr" for the error which occurred
  • Other:
    • NULL: Unassigned value (or error)
• Comparison Values:
  • TRUE: True
  • FALSE: False

MUX-Window Library Globals

• ErrStr: String storing the last error for the client. (eg "Already connected!")

MUX-Window Library Functions

• Stat Connect(Char Array Name, AppType)
  This connects to the Window Server and registers the program with it.
  • "Name" is the program's name,
  • "AppType" is the type of application it is (eg "Demo").
  • It returns SUCCESS or FAILURE.
• Stat Disconnect()
  This disconnects from the Window Server.
  • It returns SUCCESS or FAILURE.
• Byte GetDepth()
  This returns the depth of the Server's screen
  • It returns depth (in bits) or NULL if not connected.
• Byte GetWidth()
  This returns the width of the Server's screen
  • It returns width (in pixels) or NULL if not connected.
• Byte GetHeight()
  This returns the height of the Server's screen
  • It returns height (in pixels) or NULL if not connected.
• Stat GetModel(String Model,Ver,Date,Manuf)
  This stores the model name, version number, version date and manufacturer (author) of the current Server.
  • "Model,Ver,Date,Manuf" are return buffers. It stores "NONE" in all strings if an error occurred.
  • It returns SUCCESS or FAILURE.
• Int FontHeight(Font F)
  Returns the height, in pixels, of a loaded font.
  • It returns a height or NULL
• Int CharWidth(Font F, Char C)
  Returns the width, in pixels, of a specific character of a loaded font.
  • "F" is the font.
  • "C" is the character.
  • It returns a width or NULL
• Stat DrawString(Window W, Int X,Y, String S, Col FC,BC, Font F)
  This draws the characters stored in S at position X,Y in window W using the font specified by the font ID F. If the background is CLEAR, then only the pixels of the characters will be drawn (no solid rectangle will be behind them). If the foreground is CLEAR, then the image behind the text will "show through" the background (if there is any).
  • "W" is the window in which to draw,
  • "X,Y" is the position (in pixels) for the top left corner of the drawn string,
  • "S" is the text to be drawn,
  • "FC,BC" are the foreground (text) and background (clearing solid) colors,
  • "F" is the font to draw with.
  • It returns SUCCESS or FAILURE.
• Stat RaiseWin(Window WID)
  This raises a window to the "top".
  • "WID" is the window to raise
  • It returns SUCCESS or FAILURE
• Window OpenWin(Int X,Y,W,H,B, String Name)
  This creates a window on the Window Server's screen.
  • "X,Y,W,H" are the (suggested) X/Y position of the top left corner of the window and the width and height of the window,
  • "B" is the thickness of the window's border,
  • "Title" is the title for the window.
  • It returns a Window value or NULL if there is an error.
• Stat CloseWin(Window WID)
  This closes a window.
  • "WID" is the window to close.
  • It returns SUCCESS or FAILURE.
• Stat DrawLine(Window W, Int X1,Y1,X2,Y2, Col C, LineMode M)
  This draws a line in the specified window.
  • "W" is the window to draw in,
  • "X1,Y1,X2,Y2" are the start and end points of the line,
  • "C" is the color to draw the line in,
  • "M" is the style in which to draw the line (eg "DASHED").
  • It returns SUCCESS or FAILURE.
• Stat DrawRect(Window W, Int X,Y,Wi,H, Col OC, LineMode OM, Col FC)
  This draws a rectangle/square in the specified window.
  • "W" is the window to draw in,
  • "X,Y,Wi,H" are the position of the top left corner of the rectangle and the size (width and height) of the rectangle,
  • "OC" is the outline color.
  • "OM" is the style in which to draw the outline (eg "DASHED").
  • "FC" is the fill color (CLEAR for an outline only)
  • It returns SUCCESS or FAILURE.
• Font LoadFont(String F)
  This loads the font specified in F into the server, if it is not loaded already, and if it can be loaded.
  • "F" is the filename of the font to load.
  • It returns a font ID or NULL.