townforge/tb
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
5 Commits 1 Branch 0 Tags 13 MiB
C++ 93.1%
CMake 3.9%
Java 1.5%
Makefile 0.9%
Shell 0.4%
36fb07f2e4
Go to file
Tim Johansson 36fb07f2e4 Honor the window setting for disabling the close button.
2012-02-20 18:34:10 +01:00
Demo fixed bug with the glut timer hack. 2011-12-14 20:45:18 +01:00
tbanimation First commit to public rep 2011-12-14 08:42:33 +01:00
tdfont First commit to public rep 2011-12-14 08:42:33 +01:00
tdimage First commit to public rep 2011-12-14 08:42:33 +01:00
tinkerbell Honor the window setting for disabling the close button. 2012-02-20 18:34:10 +01:00
.gitignore First commit to public rep 2011-12-14 08:42:33 +01:00
freeglut.dll First commit to public rep 2011-12-14 08:42:33 +01:00
Makefile First commit to public rep 2011-12-14 08:42:33 +01:00
readme.txt First commit to public rep 2011-12-14 08:42:33 +01:00

readme.txt 

// ================================================================================
// == This file is a part of Tinkerbell UI Toolkit. (C) 2011-2012, Emil Segerås  ==
// ==             See tinkerbell.h for more information and license.             ==
// ================================================================================

Tinkerbell UI Toolkit - ALPHA
-----------------------------

NOTE: This is a alpha version. Some APIs is still experimental and is very
      likely to change.

I created Tinkerbell UI toolkit because i wanted a small UI toolkit for use in
games, that has minimal dependencies and is very easy to work with.

It has no dependency on stl, RTTI or exceptions. Compiling without theese features
makes footprint very small. Utility classes (such as string, lists, hashtable,
etc.) are quite minimal for the basic needs of tinkerbell itself.

Image loading and font system can be used if wanted, or you can make it use
whatever systems you have for this already.

What features does it have
--------------------------

  Tinkerbell core:
  -Widgets (all the common standard widgets)
  -Text editing widget (With clipboard, undo/redo, styling functionality)
  -Extendable skin system. (Dynamic, Automatic runtime atlas creation)
  -Automatic widget layout (No need to specify widget dimensions by pixels)
  -Text based UI resource format (No need to write C++ to create UI)
  -Keyboard friendly (tab focus etc.)
  -Message handling, with delayed/timed messages.
  -All containers are scrollable and pannable (automatically from mouse/finger
   interaction, and following focus).
  -Very failproof event handling (F.ex deleting a widget that is on the
   stack in a event handler is not dangerous).
  -Language string handling

  Optional components:
  -TdFont (Optional)
  -TdImage (Optional)
  -TdAnimation (Optional)

What features does it NOT have
-------------------------------

  -BIDI, Unicode support (The latter might be added later)
  -No painting API except the skin & string rendering.
   The idea is that you plug tinkerbell into a OpenGL/Direct2D/3D environment anyway.
  -Not thread safe.

Extending tinkerbell - What to think about (if a pull request should be accepted)
---------------------------------------------------------------------------------

  -Do not make it dependant on exceptions, RTTI or stl (or boost or similar)

  -On out of memory, it should not crash or leak, so check pointers and do some recovery.

  -Follow the used code style (4 spaces wide tabs, indentation style, at least minimal
   documentation etc.)

Author
------

Emil Segerås (emilsegers@gmail.com)
http://fiffigt.com/