Difference between revisions of "Komodo Macro"
Templarian (talk | contribs) m |
Templarian (talk | contribs) m (continued documenting macro commands) |
||
| Line 7: | Line 7: | ||
== Macro Basics == | == Macro Basics == | ||
| − | To create a new macro | + | To create a new macro simply add your code below the starting script below |
[[Image:Komodo_Toolbox_Macro.png|frame|right|Add a new Macro to the Toolbox]] | [[Image:Komodo_Toolbox_Macro.png|frame|right|Add a new Macro to the Toolbox]] | ||
| Line 17: | Line 17: | ||
komodo.view.scintilla.focus(); // Sets focus | komodo.view.scintilla.focus(); // Sets focus | ||
} | } | ||
| + | [... Your Script Here ...] | ||
</source> | </source> | ||
| Line 59: | Line 60: | ||
=== Check If Connected === | === Check If Connected === | ||
| + | |||
| + | The first thing you need to determine is if the emulator or device is connected. | ||
==== Is Emulator Connected ==== | ==== Is Emulator Connected ==== | ||
| − | |||
| − | |||
<source lang="javascript"> | <source lang="javascript"> | ||
| Line 95: | Line 96: | ||
You may have never used the palm command line since you are use to the add-on, but the following are what the quick buttons rely on. | You may have never used the palm command line since you are use to the add-on, but the following are what the quick buttons rely on. | ||
| + | |||
| + | ==== Generate Application ==== | ||
| + | |||
| + | This function is documented only to show the complete list of commands. It is recommended that you use the new project option in the emulator as this will only create the src/ contents. | ||
| + | |||
| + | <source lang="javascript"> | ||
| + | ko.extensions.webos.palm.generateApplication({ | ||
| + | appInfo:{}, // The appinfo.json object | ||
| + | path:"", // Absolute file path. "C:\Folder" for instance | ||
| + | onSuccess:function() | ||
| + | { | ||
| + | // Created a application at path | ||
| + | }, | ||
| + | onFailure:function() | ||
| + | { | ||
| + | // Failed to create application template | ||
| + | } | ||
| + | }); | ||
| + | </source> | ||
==== Package Application ==== | ==== Package Application ==== | ||
| − | Package an application | + | Package an application simply creates the ipk and places it into either the bin/release or bin/debug based on the framework_config.json settings. |
<source lang="javascript"> | <source lang="javascript"> | ||
| Line 112: | Line 132: | ||
}); | }); | ||
</source> | </source> | ||
| + | |||
| + | ==== | ||
Revision as of 05:24, 15 March 2010
Macros show up in the toolbox panel on the right hand side of the Komodo window. They can be used to automate almost everything in Komodo, and with the Komodo add-on all the functionality are extended to the macros.
Since users are use to writing javascript from their Mojo applications all macros are written in JavaScript (Python is also allowed, but not documented).
If you do not see the panel: View > Tabs & Sidebars > Toolbox.
Macro Basics
To create a new macro simply add your code below the starting script below
<source lang="javascript"> komodo.assertMacroVersion(2); // Macro Version if(komodo.view && komodo.view.scintilla) {
komodo.view.scintilla.focus(); // Sets focus
} [... Your Script Here ...] </source>
Deploy Functions
The deploy functions which will automatically toggle and animate the add-on to prevent conflicts.
<source lang="javascript"> // Emulator Functions ko.extensions.webos.emulator.packageInstallLaunch(); ko.extensions.webos.emulator.packageInstallInspect(); ko.extensions.webos.emulator.remove(); ko.extensions.webos.emulator.launch(); ko.extensions.webos.emulator.close(); // Device Functions ko.extensions.webos.device.packageInstallLaunch(); ko.extensions.webos.device.remove(); ko.extensions.webos.device.launch(); ko.extensions.webos.device.close(); </source>
The above functions can optionally be passed an object with onSuccess and onFailure property functions.
<source lang="javascript"> {
onSuccess:function()
{
// This means the function worked
},
onFailure:function()
{
// This means the function failed the UI will show this also.
}
} </source>
For more customization you must use the base palm functions listed below.
Macro Functions
All functions are asynchronous with onSuccess and onFailure callbacks. These are written to make the more complicated tasks very simple to write into a macro.
Check If Connected
The first thing you need to determine is if the emulator or device is connected.
Is Emulator Connected
<source lang="javascript"> ko.extensions.webos.palm.isEmulatorConnected({
onSuccess:function()
{
// Emulator was found
},
onFailure:function()
{
// Emulator was not found
}
}); </source>
Is Device Connected
<source lang="javascript"> ko.extensions.webos.palm.isDeviceConnected({
onSuccess:function()
{
// Emulator was found
},
onFailure:function()
{
// Emulator was not found
}
}); </source>
Palm Commands
You may have never used the palm command line since you are use to the add-on, but the following are what the quick buttons rely on.
Generate Application
This function is documented only to show the complete list of commands. It is recommended that you use the new project option in the emulator as this will only create the src/ contents.
<source lang="javascript"> ko.extensions.webos.palm.generateApplication({
appInfo:{}, // The appinfo.json object
path:"", // Absolute file path. "C:\Folder" for instance
onSuccess:function()
{
// Created a application at path
},
onFailure:function()
{
// Failed to create application template
}
}); </source>
Package Application
Package an application simply creates the ipk and places it into either the bin/release or bin/debug based on the framework_config.json settings.
<source lang="javascript"> ko.extensions.webos.palm.packageApplication({
onSuccess:function()
{
// Created the ipk package file
},
onFailure:function()
{
// Failed to create package
}
}); </source>