Warning, /frameworks/kross/README.md is written in an unsupported language. File is not indexed.

0001 # Kross
0002 
0003 Embedding of scripting into applications
0004 
0005 ## Introduction
0006 
0007 Kross is a scripting bridge to embed scripting functionality
0008 into an application. It supports QtScript as a scripting interpreter backend.
0009 
0010 
0011 ## Components
0012 
0013 The core of Kross provides the framework to deal transparently
0014 with interpreter-backends and offers abstract functionality
0015 to deal with scripts.
0016 
0017 The Kross::Manager class is a singleton that provides the
0018 main entry point to deal with the Kross Scripting Framework.
0019 
0020 The Kross::Interpreter class is the base for interpreter
0021 implementations. Each scripting backend needs to inherit
0022 its own interpreter and implement it.
0023 The Kross::InterpreterInfo class provides abstract information
0024 about a Interpreter before the interpreter-backend itself is
0025 loaded.
0026 
0027 The Kross::Action class is an abstract container to deal with
0028 scripts like a single standalone script file. Each action holds
0029 a reference to by the matching Kross::Interpreter created
0030 Kross::Script instance.
0031 
0032 The Kross::ActionCollectionProxyModel class implements a
0033 QSortFilterProxyModel for a Kross::ActionCollectionModel instance
0034 which implements QAbstractItemModel to provide a model for views
0035 on a Kross::ActionCollection instance.
0036 
0037 The Kross::ActionCollection class manages collections of
0038 Kross::Action instances.
0039 
0040 
0041 ### Modules
0042 
0043 Kross is able to optional dynamic load modules which provide then
0044 additional functionality for scripts.
0045 
0046 - Kross::FormModule provides access to UI functionality like dialogs or
0047   widgets.
0048 - Kross::TranslationModule provides access to the KDE internationalization and
0049   translation facilities.
0050 
0051 
0052 ### Console Application
0053 
0054 The Kross console application provides an executable application
0055 to run by Kross supported scripts from within the command line:
0056 
0057     kross myscript.js
0058 
0059 
0060 ## Backends
0061 
0062 Currently, the only backend is a JavaScript backend powered by the QtScript
0063 library (which is part of Qt).
0064 
0065