sack-gui v0.9.123

sack-gui

Node addon for a lightweight platform independant gui. Otherwise is includes all of sack.vfs

Vulkan API to be added eventually...

Requirements

CMake-js is required to build the GUI; to pull the full external sources.

• see requirements in sack.vfs

npm

cmake-js 
// don't use these anymore... but rather internal macros
// because I default all methods as readonly
// all objects exported by require are constants.
    // nan (Native Abstractions for Node.js)

Centos/linux

• yum install gcc-c++ libuuid-devel unixodbc-devel
  • (uuid/uuid.h sql.h)
• apt-get install uuid-dev unixodbc-dev
  • (uuid/uuid.h sql.h)
• pacman -S unixodbc util-linux
  • (sql.h uuid/uuid.h(probably already available, fs2util) )
• (?)emerge unixodbc

ODBC can be optioned out leaving only SQLite interface; or both may be optioend out; uuid is only required because of ODBC or Sqlite support inclusion. Which can then be 0 dependancies.

Mac

• (ODBC might be optioned out; just uses sqlite typically)
• brew (brew install unixODBC), if ODBC is desired.

ODBC can be optioned out leaving only SQLite interface; or both may be optioend out; uuid is only required because of ODBC or Sqlite support inclusion.
A third party UUID library is used (? or were there BSD builtins that got used, probably this).

Windows

none

Usage

var sack = require( 'sack-gui' );
var frame = sack.PSI.Frame( "control", 512, 512 );
frame.

Tests

In GIT respository there's a tests folder. Tests/sack_* are all gui type tests, and examples of simple gui applications.

Objects

This is the object returned from require( 'sack.vfs' );

vfs = {
    /*... for core system interfaces see [sack.vfs](https://npmjs.org/packages/sack.vfs) */

   PSI : Panther's Slick Interface.  It's a simple gui.  It provides elementary dialog controls.
   Image : interface for handling images.
   Render : interface for showing images.
   InterShell : a higher level control managment engine for full screen applications.
}

GUI Interface objects

Building GUI extensions use 'npm run build-gui' or 'npm run build-gui-debug' Which will download SACK from Github and build against the full library instead of a partial amalgamation.

var sack = require( 'sack.vfs' );

Image Methods

var imageFromFile = sack.Image( "image file.jpg" ); // handles bmp, gif, png, jpeg formats.
var imageFromBuffer = sack.Image( UInt8Array or TypedArray or ArrayBuffer ); // attempts to decompress image data contained in passed buffer.
var imageRaw = sack.Image( 100, 100 ); // creates a new image of specified width, height
var imageSubImage = sack.Image( 100, 100, otherImage, 10, 10 ); // creates new image of width, height starting at x, y in otherImage.

Image constructor can be passed either a string which is treated as a filename and the specified image is loaded. It can be passed a binary buffer which is treated as the contents of a file and is attempted to be decoded. Specifying a width and height alone will create a new blank image. A sub image can be created in another existing image by specifying the image and x, y position to start at. This last operation can be done by using the Image method on an existing image also.

Color methods

var colorFromInteger = sack.Image.Color( 0xFF995522 ); //creates a color from specifed integer 0xAARRGGBB
var colorFromObject = sack.Image.Color( { a: 255, r:128, g: 64, b: 100 } ); // creates color from specified parts.  Clamped to 0-255.
var colorFromObjectFloat = sack.Image.Color( { a: 0.9, r:0.5, g: 0.25, b: 0.37 } ); // creates color from specified parts.  Clamped to 0-255.  The value 1, unfortunatly is treated as integer 1 for the above 0-255 value.
var colorFromString = sack.Image.Color( "Some string" ); // Unimplemented.
var colorFromDialog = sack.Image.Color.dialog( callback );  // callback is passed a color object representing the picked color

There are some constant colors already builtin in Image.colors.color name

Font methods

var font = sack.Image.Font.dialog( callback );  // callback is passed a font object represenging the font selected 
font.save( "Picked font" );
var font = sack.Image.Font( <font name>, width, height, render flags (0-3 for mono, 4bit, 8bit render) ); 

var font = sack.Image.Font.load( "Picked Font" );

When creating a font by name, it can either be the name of a font, or a filename that contains a font.

Render Methods

Render constructor takes several optional parameters.

( title [, x, y [, w, h , parent Renderer]] )

TItle is a text string set as the window's caption/title string. X and Y control where the window is opened (-1, -1 uses a system default). W and H control the width and height of the window (-1, -1 uses a system default). parent renderer is a renderer that this one is opened over. This should guarantee stacking order, and is semi-modal, that events will not be sent to the parent renderer while the child is open.

Frame Methods

These are higher level interface that creates a frame with a caption using Renderer and Image methods underneath. First, create a frame...

var frame = sack.Frame( "Title", x, y, width, height );

Frame constructor requires a title. If x, y are not specified, (0, 0) is used, and (1024,768) is used for width and height.

sack.control.types

Frame and Control Color names

Border flags

Border Anchor Flags

If the required border to draw is larger than the image, the image is stretched to cover the area.

Specific control type extensions

Builtin controls have various methods that are associated with them. Such as a button's click event, which no other control has.

Button Controls (Image, Normal, Custom )

Check/Radio Button Controls

Scroll Bar Controls

Edit Field

List Box

Sheet Control (tabbed pages)

Progress Control

Clock Control

Control Registration

New controls can be created by specfiying a string name for the control type, and setting up event callback functions.

var newControl = sack.Registration( { name : "custom Control", draw(Image) { /* handle draw */ }, mouse( event ) { /* handle mouse event } } );

There are a couple dozen events actually available, but only a handful have been implemented. These are all specified in the option object passed to the control Registration constructor.

Intershell Interface

Mostly unimplemented, more of a place holder than functional.

Changelog

• 0.9.123
  • Sync VFS.
  • Fixed some GUI issues.
  • Improved documentation
• 0.9.122 - Release work in progress update; fixed link to other project.
• 0.9.121 -
• 0.9.120 - Add listbox methods. Make control color accessors a templated object instead of adding an object with method extensions.
• 0.9.119 - Fix missing websocket client event accessors. Add custom border support.
• 0.9.118 - Update documentation and keywords. Fix building.
• 0.9.117 - Fork from sack.vfs 0.9.117. Initial publication to NPM.