GUITool - Easy to Use GUI Toolkit & Framework for MATLAB
========================================================

GUITool is a cross compatible Graphical User Interface (GUI) Toolkit, UI design, and layout framework for MATLAB. It has been specifically designed to be very easy to use and allow rapid prototyping of custom MATLAB UI interfaces. At the same time it has been developed to be faster and have better performance for complex and larger scale GUIs than the Mathworks GUI Layout Toolbox.

GUITool is for example used for designing and building the simulation interfaces for the FEATool Multiphysics (https://www.featool.com) and CFDTool (https://www.cfdtool.com) simulation toolboxes.

Performance Evaluation
----------------------

The GUITool framework has been compared to the Mathworks GUI Layout Toolbox (GLT) by running the included test suite, as for example

runTestSuite( 'nruns', 100, 'pause', 0, 'closef', 1, 'uilib', 'uitk' )

substituting the _uilib_ parameter with `uitk`, `uiextras`, and `uix` correspondingly. The resulting timings can be seen in the table below. First, we can see that GUITool is 1.8-2.5 times faster than the GUI Layout Toolbox (GLT), moreover, comparing the runs for MATLAB 2011a with 2019a it also clear that the MATLAB GUI functionality is currently 2-3 times slower with is also consistent with a previous MATLAB GUI benchmark comparison ( https://www.featool.com/news/2019/08/20/benchmarking-and-performance-comparison-of-matlab-versions ). To really get good GUI performance we can therefore only recommend using the GUITool framework with older MATLAB versions.

Installation
------------

Copy and add the GUI toolkit source files (.m and .p files from the _src_ directory) to your own project directory, or add a path to to the directory with the `addpath` command.

Examples
--------

Look at the examples in the source files _uitkHBox_, _uitkVBox_, _uitkGrid_, _uitkBoxPanel_, and _uitkTabPanel_ as well as the examples in the _src/tests_ directory.

Testing
-------

Run the `runTestSuite` function from the root directory.

Documentation
-------------

Open the included *index.html* file in a web browser to access the function documentation.