User Tools
jwlua:frameworkdocs
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
jwlua:frameworkdocs [2013/08/06 23:48] jariw [Objects] |
jwlua:frameworkdocs [2013/09/03 14:21] jariw |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| This page discusses how you should read the [[http://www.finaletips.nu/frameworkref/|PDK Framework documentation]], so it makes sense in //JW Lua// scripts. | This page discusses how you should read the [[http://www.finaletips.nu/frameworkref/|PDK Framework documentation]], so it makes sense in //JW Lua// scripts. | ||
| + | |||
| + | For discussions on specific programming topics related to //JW Lua//, please refer to the [[jwlua:development|general development page]]. | ||
| ===== A Reference for C++ ===== | ===== A Reference for C++ ===== | ||
| Line 15: | Line 17: | ||
| All top level classes that are available to //JW Lua// scripts are listed at http://www.finaletips.nu/frameworkref/group__lua__classes.html | All top level classes that are available to //JW Lua// scripts are listed at http://www.finaletips.nu/frameworkref/group__lua__classes.html | ||
| - | If a method requires an object as a parameter, you need to create it. This might be specially important to note for the ''FCString'' class, which is the main class which the PDK Framework uses for string access (the ''FCString'' class objects is only compatible with Lua strings through some of its methods and properties). | + | If a method requires an object as a parameter, you need to create it. This might be specially important to note for the ''[[http://www.finaletips.nu/frameworkref/class_f_c_string.html|FCString]]'' class, which is the main class which the PDK Framework uses for string access (the ''FCString'' class objects is only compatible with Lua strings through some of its methods and properties). |
| ===== Inheritance ====== | ===== Inheritance ====== | ||
| Line 21: | Line 23: | ||
| {{ :wiki:jwlua:fcmeasures-parents.png|}}Please note that the PDK Framework is object-oriented, so if you don't find a task in the class you're searching, try to look in the parent classes. | {{ :wiki:jwlua:fcmeasures-parents.png|}}Please note that the PDK Framework is object-oriented, so if you don't find a task in the class you're searching, try to look in the parent classes. | ||
| - | For example: if you want to load all the measures of a document, it's easy to think that the ''LoadAll()'' method would be available in the ''FCMeasures'' class. However, it's not. Instead, it's implemented in the ''_FCCollectionData'' parent class and that method will affect many other child classes, such as ''FCPages'', ''FCStaffSystems'', etc. | + | For example: if you want to load all the measures of a document, it's easy to think that the ''LoadAll()'' method would be available in the ''[[http://www.finaletips.nu/frameworkref/class_f_c_measure.html|FCMeasures]]'' class. However, it's not. Instead, it's implemented in the ''[[http://www.finaletips.nu/frameworkref/class_____f_c_collection_data.html|__FCCollectionData]]'' parent class and that method will affect many other child classes, such as ''[[http://www.finaletips.nu/frameworkref/class_f_c_pages.html|FCPages]]'', ''[[http://www.finaletips.nu/frameworkref/class_f_c_staff_systems.html|FCStaffSystems]]'', etc. |
| + | By using the JW Lua's Class Browser feature, it's easy to see which properties and methods a class actually has access to. | ||
| ===== Constructors ===== | ===== Constructors ===== | ||
| Line 74: | Line 77: | ||
| Although the Lua language contains numerous advantages compared to programming directly in C++, there are some drawbacks as well: | Although the Lua language contains numerous advantages compared to programming directly in C++, there are some drawbacks as well: | ||
| * The currently used conversion layer between Lua and C++ doesn't support optional arguments in method calls (this might change in the future, though). So in Lua, you need to provide all the arguments to a PDK Framework method. | * The currently used conversion layer between Lua and C++ doesn't support optional arguments in method calls (this might change in the future, though). So in Lua, you need to provide all the arguments to a PDK Framework method. | ||
| - | * Overloaded methods aren't supported, due to Lua's loose types. Only one version of a PDK Framework method will be available to JW Lua. | + | * Overloaded methods aren't supported, due to Lua's loose type checking. Only one version of a PDK Framework method will be available to JW Lua. |
jwlua/frameworkdocs.txt ยท Last modified: 2013/09/03 14:22 by jariw
Page Tools
