Search code examples
rubyuser-interfaceshoes

Where can I find documentation on functions available in the Ruby Shoe GUI Toolkit?


Is there any documentation that describes all the available functions and objects in shoe?

update: 2008.01.21
I am looking for a list of all the methods that can be called against an animate object.

For example I only figured out how to pause an animation using the toggle() method by reading source code from the shoebox (http://the-shoebox.org/).


Solution

  • If you run

    shoes -m 
    

    in a console (command prompt) window, shoes will run in Help/Manual mode.

    In this mode it displays the shoes manual, complete with runnable examples (the manual is a shoes application) This mode has a built-in search feature which jumps straight to the relevant section of the docs and is very handy for reference.

    Most of this info is reformatted as html in the help.shoooes.net site mentioned above.

    As most open source projects go it's well documented. And _why seems to have actually shown restraint in the documentation (he obviously worked out his cartoony madness in the nobody knows shoes manual!).