Permalink
Browse files

Updated Loudmouth and Clutter docs.

  • Loading branch information...
1 parent 3bed24d commit a8e645a4a9d15ba72d89b30bfb70b0b23eb7cf3e @josip josip committed Apr 30, 2010
Showing with 2,160 additions and 333 deletions.
  1. +0 −3 .gitmodules
  2. +1 −0 addons/Clutter/io/ClutterColor.io
  3. +4 −2 addons/Clutter/io/ClutterEvent.io
  4. +2 −0 addons/Clutter/io/ClutterShader.io
  5. +1 −1 addons/Clutter/io/ClutterStage.io
  6. +6 −0 addons/Clutter/io/ClutterUnits.io
  7. +2 −0 addons/Clutter/io/IoClutterVertex.io
  8. +45 −12 addons/Clutter/source/IoClutter.c
  9. +79 −3 addons/Clutter/source/IoClutterActor.c
  10. +15 −10 addons/Clutter/source/IoClutterActorBox.c
  11. +24 −1 addons/Clutter/source/IoClutterColor.c
  12. +21 −1 addons/Clutter/source/IoClutterEvent.c
  13. +4 −0 addons/Clutter/source/IoClutterInputDevice.c
  14. +11 −0 addons/Clutter/source/IoClutterShader.c
  15. +8 −1 addons/Clutter/source/IoClutterStage.c
  16. +19 −0 addons/Clutter/source/IoClutterUnits.c
  17. +11 −0 addons/Clutter/source/IoClutterVertex.c
  18. +0 −1 addons/Generys
  19. +9 −9 addons/Loudmouth/io/JID.io
  20. +15 −15 addons/Loudmouth/io/LoudmouthMessage.io
  21. +1 −1 docs/docs.css
  22. +12 −5 docs/js/browser.js
  23. +0 −1 docs/reference/Apple/AppleExtras/index.html
  24. +0 −1 docs/reference/Apple/index.html
  25. +0 −1 docs/reference/Audio/LibSndFile/index.html
  26. +0 −1 docs/reference/Audio/Ogg/index.html
  27. +0 −1 docs/reference/Audio/PortAudio/index.html
  28. +0 −1 docs/reference/Audio/SampleRateConverter/index.html
  29. +0 −1 docs/reference/Audio/SoundTouch/index.html
  30. +0 −1 docs/reference/Audio/TagLib/index.html
  31. +0 −1 docs/reference/Audio/index.html
  32. +8 −3 docs/reference/{binding/CFFI/CFFI → Bridges/CFFI/CFFIPointer}/index.html
  33. +5 −4 docs/reference/{binding → Bridges}/CFFI/index.html
  34. +1 −1 docs/reference/Bridges/ObjcBridge/index.html
  35. +1 −1 docs/reference/Bridges/Python/index.html
  36. +1 −1 docs/reference/Bridges/index.html
  37. +0 −1 docs/reference/Compilers/Loki/index.html
  38. +0 −1 docs/reference/Compilers/index.html
  39. +0 −1 docs/reference/Compression/LZO/index.html
  40. +0 −1 docs/reference/Compression/Zlib/index.html
  41. +0 −1 docs/reference/Compression/index.html
  42. +0 −1 docs/reference/Concurrency/Thread/index.html
  43. +0 −1 docs/reference/Concurrency/index.html
  44. +2 −2 docs/reference/Core/Core/Call/index.html
  45. +1 −1 docs/reference/Core/Core/Coroutine/index.html
  46. +20 −2 docs/reference/Core/Core/Directory/index.html
  47. +3 −3 docs/reference/Core/Core/Exception/index.html
  48. +33 −33 docs/reference/Core/Core/List/index.html
  49. +35 −0 docs/reference/Core/Core/Number/index.html
  50. +1 −1 docs/reference/Core/Core/Object/index.html
  51. +14 −0 docs/reference/Core/Core/Sequence/index.html
  52. +0 −1 docs/reference/Core/Core/index.html
  53. +0 −1 docs/reference/Core/Flux/index.html
  54. +0 −1 docs/reference/Core/NotificationCenter/index.html
  55. +0 −1 docs/reference/Core/Range/index.html
  56. +0 −1 docs/reference/Core/index.html
  57. +0 −1 docs/reference/Databases/DBI/index.html
  58. +0 −1 docs/reference/Databases/Memcached/index.html
  59. +0 −1 docs/reference/Databases/MySQL/index.html
  60. +0 −1 docs/reference/Databases/Obsidian/index.html
  61. +0 −1 docs/reference/Databases/Postgres/index.html
  62. +0 −1 docs/reference/Databases/QDBM/index.html
  63. +0 −1 docs/reference/Databases/SQLite/index.html
  64. +0 −1 docs/reference/Databases/SQLite3/index.html
  65. +0 −1 docs/reference/Databases/SkipDB/index.html
  66. +0 −1 docs/reference/Databases/SqlDatabase/index.html
  67. +0 −1 docs/reference/Databases/TagDB/index.html
  68. +0 −1 docs/reference/Databases/TokyoCabinet/index.html
  69. +0 −1 docs/reference/Databases/index.html
  70. +0 −1 docs/reference/Digests/MD5/index.html
  71. +0 −1 docs/reference/Digests/SHA1/index.html
  72. +0 −1 docs/reference/Digests/UUID/index.html
  73. +0 −1 docs/reference/Digests/index.html
  74. +0 −1 docs/reference/Encryption/Blowfish/index.html
  75. +0 −1 docs/reference/Encryption/index.html
  76. +0 −1 docs/reference/Filesystem/AsyncRequest/index.html
  77. +0 −1 docs/reference/Filesystem/index.html
  78. +0 −1 docs/reference/Graphics/Box/index.html
  79. +0 −1 docs/reference/Graphics/Cairo/index.html
  80. +0 −1 docs/reference/Graphics/Font/index.html
  81. +0 −1 docs/reference/Graphics/GLFW/index.html
  82. +0 −1 docs/reference/Graphics/Image/index.html
  83. +0 −1 docs/reference/Graphics/OpenGL/index.html
  84. +0 −1 docs/reference/Graphics/index.html
  85. +0 −1 docs/reference/Math/BigNum/index.html
  86. +0 −1 docs/reference/Math/ContinuedFraction/index.html
  87. +0 −1 docs/reference/Math/Random/index.html
  88. +0 −1 docs/reference/Math/Rational/index.html
  89. +0 −1 docs/reference/Math/index.html
  90. +0 −1 docs/reference/Networking/Beanstalk/index.html
  91. +0 −1 docs/reference/Networking/CGI/index.html
  92. +0 −1 docs/reference/Networking/DistributedObjects/index.html
  93. +0 −1 docs/reference/Networking/GoogleSearch/index.html
  94. +2 −2 docs/reference/Networking/HttpClient/HCRequest/index.html
  95. +0 −1 docs/reference/Networking/HttpClient/index.html
  96. +6 −6 docs/reference/Networking/Loudmouth/JID/index.html
  97. +0 −56 docs/reference/Networking/Loudmouth/Loudmouth/index.html
  98. +60 −4 docs/reference/Networking/Loudmouth/LoudmouthMessage/index.html
  99. +6 −1 docs/reference/Networking/Loudmouth/XmppChatMessage/index.html
  100. +0 −1 docs/reference/Networking/Loudmouth/index.html
  101. +0 −1 docs/reference/Networking/NetworkAdapter/index.html
  102. +0 −1 docs/reference/Networking/SecureSocket/index.html
  103. +0 −1 docs/reference/Networking/Socket/index.html
  104. +0 −1 docs/reference/Networking/Twitter/index.html
  105. +0 −1 docs/reference/Networking/Volcano/index.html
  106. +0 −1 docs/reference/Networking/index.html
  107. +0 −1 docs/reference/Parsers/Fnmatch/index.html
  108. +0 −1 docs/reference/Parsers/Libxml2/index.html
  109. +0 −1 docs/reference/Parsers/Regex/index.html
  110. +0 −1 docs/reference/Parsers/SGML/index.html
  111. +0 −1 docs/reference/Parsers/Yajl/index.html
  112. +0 −1 docs/reference/Parsers/index.html
  113. +0 −1 docs/reference/Physics/ODE/index.html
  114. +0 −1 docs/reference/Physics/index.html
  115. +0 −1 docs/reference/Server/Curses/index.html
  116. +0 −1 docs/reference/Server/EditLine/index.html
  117. +0 −1 docs/reference/Server/NullAddon/index.html
  118. +0 −1 docs/reference/Server/ReadLine/index.html
  119. +0 −1 docs/reference/Server/Syslog/index.html
  120. +0 −1 docs/reference/Server/SystemCall/index.html
  121. +0 −1 docs/reference/Server/User/index.html
  122. +0 −1 docs/reference/Server/index.html
  123. +243 −10 docs/reference/UserInterface/Clutter/Clutter/index.html
  124. +513 −0 docs/reference/UserInterface/Clutter/ClutterActor/index.html
  125. +71 −0 docs/reference/UserInterface/Clutter/ClutterActorBox/index.html
  126. +152 −0 docs/reference/UserInterface/Clutter/ClutterColor/index.html
  127. +176 −0 docs/reference/UserInterface/Clutter/ClutterEvent/index.html
  128. +57 −0 docs/reference/UserInterface/Clutter/ClutterInputDevice/index.html
  129. +120 −0 docs/reference/UserInterface/Clutter/ClutterShader/index.html
  130. +78 −0 docs/reference/UserInterface/Clutter/ClutterStage/index.html
  131. +136 −0 docs/reference/UserInterface/Clutter/ClutterUnits/index.html
  132. +113 −0 docs/reference/UserInterface/Clutter/ClutterVertex/index.html
  133. +10 −2 docs/reference/UserInterface/Clutter/index.html
  134. +1 −2 docs/reference/UserInterface/index.html
  135. +0 −1 docs/reference/Video/AVCodec/index.html
  136. +0 −1 docs/reference/Video/Theora/index.html
  137. +0 −1 docs/reference/Video/Vorbis/index.html
  138. +0 −1 docs/reference/Video/index.html
  139. +0 −45 docs/reference/binding/index.html
  140. +1 −1 docs/reference/docs.json
  141. +0 −1 docs/reference/index.html
View
@@ -1,3 +0,0 @@
-[submodule "addons/Generys"]
- path = addons/Generys
- url = git://github.com/josip/generys.git
@@ -2,5 +2,6 @@ ClutterColor do(
)
+//doc Sequence asClutterColor Calls [[ClutterColor with]] with self as an argument.
Sequence asClutterColor := method(
ClutterColor with(self))
@@ -3,14 +3,16 @@ ClutterEvent do(
self x = 0
self y = 0)
- 0_coords_ := getSlot("coords")
+ __coords := getSlot("coords")
coords = lazySlot(
- realCoords := self 0_coords_
+ realCoords := self __coords
self setX(realCoord x) setY(realCoords y)
realCoords)
+ //doc ClutterEvent x
x ::= method(
self coords x)
+ //doc ClutterEvent y
y ::= method(
self coords y)
)
@@ -1,7 +1,9 @@
ClutterShader do(
+ //doc ClutterShader enable
enable := method(
self setIsEnabled(true))
+ //doc ClutterShader disable
disable := method(
self setIsEnabled(false))
)
@@ -1,5 +1,5 @@
ClutterStage do(
- forwad := method(
+ forward := method(
self actor hasSlot(call message name) ifTrue(
self actor doMessage(call message)))
@@ -1,14 +1,20 @@
ClutterUnits do(
)
+//doc Sequence asClutterUnit Calls [[ClutterUnit withString]].
Sequence asClutterUnit := method(
ClutterUnit withString(self))
Number do(
+ //doc Number px Calls [[ClutterUnits withPx]].
px := method(ClutterUnits withPx(self))
+ //doc Number mm Calls [[ClutterUnits withMm]].
mm := method(ClutterUnits withMm(self))
+ //doc Number pt Calls [[ClutterUnits withPt]].
pt := method(ClutterUnits withPt(self))
+ //doc Number em Calls [[ClutterUnits withEm]].
em := method(ClutterUnits withEm(self))
+ //doc Number emForFont(fontname) Calls [[ClutterUnits emForFont]].
emForFont := method(font,
ClutterUnits withEmForFont(font, self))
)
@@ -1,10 +1,12 @@
ClutterVertex do(
+ //doc ClutterVertex asList Returns [[List]] with x, y, and z values.
asList := method(
list(self x, self y, self z))
asString := method(
self asList asString exSlice(4))
)
+//doc List asClutterVertex Converts [[List]] to [[ClutterVertex]].
List asClutterVertex := method(
ClutterVertex performWithArgList("with", self))
@@ -1,22 +1,23 @@
#include "IoClutter.h"
//metadoc Clutter category UserInterface
/*metadoc Clutter description
-Clutter is a GObject based library for creating fast, visually rich, graphical user interfaces.
-
+<p>
+<a href="http://clutter-project.org">Clutter</a> is a GObject based library for creating fast, visually rich, graphical user interfaces.
+</p><p>
Clutter works by manipulating a scene-graph of 2D surfaces, or 'actors', inside a 3D space.
-
+</p><p>
ClutterActor is the base class for such surfaces. All ClutterActors can be positioned, scaled and rotated in 3D space. In addition, other properties can be set, such as 2D clipping, children and opacity. Tranforms applied to a parent actor also apply to any children. Actors are also able to receive events.
-
+</p><p>
Subclasses of ClutterActor include ClutterStage, ClutterTexture, ClutterLabel, ClutterRectangle, ClutterEntry and ClutterGroup. ClutterActors are added to a parent, transformed and then made visible.
-
+</p><p>
ClutterStage is the top level ClutterActor - it's the representation of a window, or framebuffer. It is created automatically when Clutter is initialised. ClutterStage is a ClutterGroup, a class implementing the ClutterCointainer interface.
-
+</p><p>
ClutterTimelines provide the basis for Clutter's animation utilities. Multiple timelines can be synchronised using ClutterScore, and ClutterBehaviour and ClutterEffect allow for the creation of animation effects such as transitions.
-
+</p><p>
Clutter further contains a number of utilities, including; ClutterScript - for loading 'UI definition' files formatted in JSON, ClutterShader - a class for applying GPU shaders to actors, ClutterModel - a utility class for MVC list type implementations, and fixed point math utilities.
-
-For detailed docs, see <a href=http://clutter-project.org/docs/clutter/stable/>clutter-project</a>
-
+</p><p>
+For detailed docs, see <a href="http://clutter-project.org/docs/clutter/stable/">clutter-project</a>.
+</p>
*/
/*** Initalisation functions ***/
@@ -181,89 +182,115 @@ IO_METHOD(IoClutter, init) {
IoObject_setSlot_to_(grav, IOSYMBOL("NORTH_WEST"), IONUMBER(CLUTTER_GRAVITY_NORTH_WEST));
IoObject_setSlot_to_(grav, IOSYMBOL("CENTER"), IONUMBER(CLUTTER_GRAVITY_CENTER));
+ //doc Clutter MASK Contains all CLUTTER_*_MASK constants.
IoObject_setSlot_to_(self, IOSYMBOL("MASK"), cmod);
+ //doc Clutter SCROLL Contains all CLUTTER_SCROLL_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("SCROLL"), sdir);
+ //doc Clutter STAGE_STATE Contains all CLUTTER_STAGE_STATE_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("STAGE_STATE"), stag);
+ //doc Clutter EVENT Contains all Clutter event type constants.
IoObject_setSlot_to_(self, IOSYMBOL("EVENT"), evnt);
+ //doc Clutter EVENT_FLAG Contains all CLUTTER_EVENT_FLAG_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("EVENT_FLAG"), eflg);
+ //doc Clutter DEVICE_TYPE Contains all CLUTTER_TYPE_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("DEVICE_TYPE"), devt);
+ //doc Clutter SHADER_ERROR Contains all CLUTTER_SHADER_ERROR_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("SHADER_ERROR"),shde);
+ //doc Clutter UNIT Contains all CLUTTER_UNIT_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("UNIT"), unit);
+ //doc Clutter AXIS Contains all CLUTTER_AXIS_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("AXIS"), axis);
+ //doc Clutter GRAVITY Contains all CLUTTER_GRAVITY_* constants.
IoObject_setSlot_to_(self, IOSYMBOL("GRAVITY"), grav);
+ //doc Clutter version
IoObject_setSlot_to_(self, IOSYMBOL("version"), IOSYMBOL(CLUTTER_VERSION_S));
+ //doc Clutter flavour
IoObject_setSlot_to_(self, IOSYMBOL("flavour"), IOSYMBOL(CLUTTER_FLAVOUR));
+ //doc Clutter cogl
IoObject_setSlot_to_(self, IOSYMBOL("cogl"), IOSYMBOL(CLUTTER_COGL));
return IOBOOL(self, clutter_init(NULL, NULL));
}
+//doc Clutter initThreads
IO_METHOD(IoClutter, initThreads) {
g_thread_init(NULL);
clutter_threads_init();
return self;
}
+//doc Clutter threadEnter
IO_METHOD(IoClutter, threadEnter) {
clutter_threads_enter();
return self;
}
+//doc Clutter threadLeave
IO_METHOD(IoClutter, threadLeave) {
clutter_threads_leave();
return self;
}
// TODO: clutter_threads_add_idle(), _add_idle_full(), _add_timeout, _add_timeout_full
+//doc Clutter main Calls clutter_main() which starts GMainLoop.
IO_METHOD(IoClutter, main) {
clutter_main();
return IONIL(self);
}
+//doc Clutter quitMain
IO_METHOD(IoClutter, quitMain) {
clutter_main_quit();
return IONIL(self);
}
+//doc Clutter mainLevel
IO_METHOD(IoClutter, mainLevel) {
return IONUMBER(clutter_main_level());
}
+//doc Clutter isFpsShown
IO_METHOD(IoClutter, isFpsShown) {
return IOBOOL(self, clutter_get_show_fps());
}
+//doc Clutter getDefaultFrameRate
IO_METHOD(IoClutter, getDefaultFrameRate) {
return IONUMBER(clutter_get_default_frame_rate());
}
+//doc Clutter setDefaultFrameRate(frameRate)
IO_METHOD(IoClutter, setDefaultFrameRate) {
clutter_set_default_frame_rate((guint)(IoMessage_locals_floatArgAt_(m, locals, 0)));
return self;
}
+//doc Clutter enableMotionEvents
IO_METHOD(IoClutter, enableMotionEvents) {
clutter_set_motion_events_enabled(1);
return self;
}
+//doc Clutter disableMotionEvents
IO_METHOD(IoClutter, disableMotionEvents) {
clutter_set_motion_events_enabled(0);
return self;
}
+//doc Clutter motionEventsEnabled Returns true if motion events are enabled.
IO_METHOD(IoClutter, motionEventsEnabled) {
return IOBOOL(self, clutter_get_motion_events_enabled());
}
+//doc Clutter clearGlyphCache
IO_METHOD(IoClutter, clearGlyphCache) {
clutter_clear_glyph_cache();
return self;
}
-//doc Clutter fontHinting Returns <code>true</code> if <code>CLUTTER_FONT_HINTING</code>
+//doc Clutter fontHinting Returns <code>true</code> if <code>CLUTTER_FONT_HINTING</code> is set.
IO_METHOD(IoClutter, getFontHinting) {
return IOBOOL(self, clutter_get_font_flags());
}
@@ -276,16 +303,19 @@ IO_METHOD(IoClutter, setFontHinting) {
return self;
}
+//doc Clutter getActorByGid(gid)
IO_METHOD(IoClutter, getActorByGid) {
guint32 gid = (guint32)(IoMessage_locals_doubleArgAt_(m, locals, 0));
ClutterActor *actor = clutter_get_actor_by_gid(gid);
return (actor == NULL)? IONIL(self) : IoClutterActor_newWithActor(IOSTATE, actor);
}
+//doc Clutter getKeyboardGrab
IO_METHOD(IoClutter, getKeyboardGrab) {
return IoClutterActor_newWithActor(IOSTATE, clutter_get_keyboard_grab());
}
+//doc Clutter getPointerGrab
IO_METHOD(IoClutter, getPointerGrab) {
return IoClutterActor_newWithActor(IOSTATE, clutter_get_pointer_grab());
}
@@ -310,12 +340,13 @@ IO_METHOD(IoClutter, grabPointer) {
return self;
}
-//IoObject *IoClutter_ungrabKeyboard(IoClutter *self, IoObject *l, IoMessage *m) {
+//doc Clutter ungrabKeyboard
IO_METHOD(IoClutter, ungrabKeyboard) {
clutter_ungrab_keyboard();
return self;
}
+//doc Clutter ungrabPointer
IO_METHOD(IoClutter, ungrabPointer) {
IoObject *device_n = IoMessage_locals_valueArgAt_(m, locals, 0);
@@ -327,10 +358,12 @@ IO_METHOD(IoClutter, ungrabPointer) {
return self;
}
+//doc Clutter keySymbolToUnicode(symbol)
IO_METHOD(IoClutter, keySymbolToUnicode) {
return IONUMBER(clutter_keysym_to_unicode(IoMessage_locals_doubleArgAt_(m, locals, 0)));
}
+//doc Clutter currentEventTime
IO_METHOD(IoClutter, currentEventTime) {
return IoDate_newWithTime_(IOSTATE, clutter_get_current_event_time());
}
Oops, something went wrong.

0 comments on commit a8e645a

Please sign in to comment.