ActiveState Powered by ActiveState

ActiveState Community


Problem to find API documentation :-(

Posted by dafi on 2007-09-25 22:42
OS: All / Any

Hi ActiveState guys,

I'm trying hard to create useful Komodo extensions for me and I hope for other people but I continue to stop my work because I miss the correct API.

If I go to
http://aspn.activestate.com/ASPN/docs/Komodo/4.2/komodo-doc-top.html I don't find anything useful.
Zero results for koDocumentService,
Zero results for koIOs (find a not authorized Sourceforge link)

May you help me to understand where to search API?
I don't want to bore you with hundred stupid questions :-(

Actually I have problems with remote files, I see you can rename and/or delete remote files directly from Remote File Picker Dialog but how can I use these APIs from my code?

best regards,

dafi

--
Davide Ficano
Try MoreKomodo

The API documentation is currently in the macros section
ericp | Wed, 2007-09-26 09:38

You'll find more at
http://aspn.activestate.com/ASPN/docs/Komodo/4.2/komodo-doc-macroapi.htm...

There are currently two top-level namespaces - "komodo" and "ko". The old
"komodo" namespace is deprecated in favor of the "ko" namespace, and you'll
find good code-completion on the "ko" namespace when editing JS code.

The current API is under-documented, and we're working on it. But since
most of the codebase is in JavaScript and Python, you can often find the
functions you need by browsing it. The IDL files in support/sdk/idl (SharedSupport/... on the Mac) that start with "koI" can provide a good
overview. For example, once you learn that 'ko.views.manager.currentView'
gives you a koIView object, you can find its capabilities in koIViews.idl.

Also have a look at the extensions section of this forum, where you find
other macros and extensions people have posted.

Some additional notes
ToddW | Wed, 2007-09-26 09:57

In JS code, you can obtain the list of completions for an xpcom interface by typing the full component name. In the following example you should see completions on every dot:

Components.interfaces.koIRemoteConnectionService.

This gives you quick way to browse over the Komodo xpcom interfaces on the fly.

For remote file functionality, you should examine the following IDL files (interfaces):

  • koIRemoteConnectionService - obtaining a remote connection
  • koIFTP - connection objects (contains the rename functionality)

You may also want to examine the remote drive tree extension, found here:
http://community.activestate.com/forum-topic/remote-drive-tree-extensi

Cheers,
Todd

Thanks a lot but for me
dafi | Wed, 2007-09-26 21:52

Thanks a lot but for me completion doesn't work with ko namespace or XPCOM iterfaces.

PS
Your work at ActiveState is great

Enable the catalog
jeffg | Wed, 2007-09-26 22:16

To get completion for the ko namespace for Macros and JavaScript files, you need to do the following:

- go to Preferences / Code Intelligence and enable the 'Komodo' api catalog.
- Macros need to be edited in an editor tab ( eg right-click / Edit Macro ). If you edit the Macro in the 'Properties' dialog instead you won't get any completion.

XPCom interface completion should 'just work' in JavaScript, for example:

os = Components.classes['@activestate.com/koOs;1'].
        getService(Components.interfaces.koIOs);

os.

os = Components.classes['@activestate.com/koOs;1'].
        getService(Components.interfaces.koIOs);

os.

You should get completion on 'os'.

--
JeffG

Oh my god now
dafi | Wed, 2007-09-26 22:23

Oh my god now works!!!!

Thanks a lot

I'm near to release a new MoreKomodo version with little features added.
With these useful informationI hope to speedup the work

thanks for you patience with me ;-)

--
davide

-->