CODEWITHSUNDEEP
rubyuser-interfaceshoes
user54682
user54682

Reputation:

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/).

Upvotes: 4

Views: 1637

Answers (5)

rogerdpack
rogerdpack

Reputation: 66751

It appears that there is no real documentation, as such--you just have to glean it from examples [?] An attempt at rdoc failed pretty well [just ran rdoc from within the github repo] http://roger.doachristianturndaily.info/ruby/shoes/doc/ you can look into the C code to try to discover them :)

Upvotes: 0

Kevin
Kevin

Reputation:

Animation objects inherit from TimerBase (as do Every objects and Timer objects), and as such have the methods draw, remove, start, stop, and toggle. I don't know too much more... this is from my notes I took while digging through the shoes source. But those would be a good place to start.

Upvotes: 0

pauliephonic
pauliephonic

Reputation: 2127

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!).

Upvotes: 3

mlibby
mlibby

Reputation: 6734

Shoes Help seems to have all kinds of reference documentation.

Upvotes: 1

mookid8000
mookid8000

Reputation: 18628

I have never seen such thing for Shoes. It seems Why prefers to document his stuff with cartoons and collages.

Have you read Nobody Knows Shoes?

Upvotes: 0

Related Questions