summaryrefslogtreecommitdiff
path: root/doc/examples.dox
diff options
context:
space:
mode:
authorJoão Paulo Fernandes Ventura <ventura@profusion.mobi>2012-03-19 12:58:12 +0000
committerJonas M. Gastal <jgastal@profusion.mobi>2012-03-19 12:58:12 +0000
commit4c3d68a07d4bb27775a6387a629cf96adada5317 (patch)
tree1517e53b73758691a884c24279afb886353397b1 /doc/examples.dox
parent1c17076655d04160c3cd572c42232ee9329320ba (diff)
downloadelementary-4c3d68a07d4bb27775a6387a629cf96adada5317.tar.gz
New simpler button example.
Patch by: João Paulo Fernandes Ventura<ventura@profusion.mobi> SVN revision: 69508
Diffstat (limited to 'doc/examples.dox')
-rw-r--r--doc/examples.dox57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/examples.dox b/doc/examples.dox
index 0af84f52e..7b4e625b7 100644
--- a/doc/examples.dox
+++ b/doc/examples.dox
@@ -810,6 +810,63 @@
*/
/**
+ * @page button_example_00 Button - Hello, Button!
+ *
+ * @dontinclude button_example_00.c
+ *
+ * Keeping the tradition, this is a simple "Hello, World" button example. We
+ * will show how to create a button and associate and action to be performed
+ * when you click on it.
+ *
+ * In the end, we'll be presented with something that looks like this:
+ *
+ * @image html screenshots/button_00.png
+ * @image latex screenshots/button_00.eps width=\textwidth
+ *
+ * The full code of the example is @ref button_example_00.c "here" and we
+ * will follow here with a rundown of it.
+ *
+ *
+ * There is only one button on the interface which performs a basic action:
+ * close the application. This behavior is described by on_click() function,
+ * that interrupt the program invoking elm_exit().
+ * @skip static void
+ * @until }
+ *
+ *
+ * On the main() function, we set the basic characteristics of the user
+ * interface. First we use the Elementary library to create a window and
+ * set its policies (such as close when the user click on the window close
+ * icon).
+ *
+ * @skip elm_win_add
+ * @until elm_policy_set
+ *
+ * In order to turn it visible on the WM (Window Manager), we also have to
+ * associate it to a canvas through Evas library, and set its dimensions.
+ *
+ * @skip evas_object_resize
+ * @until evas_object_show(win)
+ *
+ * Then we create a background associated to the window, define its dimensions,
+ * and turn it visible on the canvas.
+ * @skip elm_bg_add
+ * @until evas_object_show(bg)
+ *
+ *
+ * Finally we use Elementary to create a button and Evas to set its
+ * proprieties. Here we have not only to give the button dimensions, but also
+ * its coordinates and the action to be performed on the click event.
+ * @skip elm_button_add
+ * @until evas_object_show(btn)
+ *
+ *
+ * And we are done.
+ *
+ * @example button_example_00.c
+ */
+
+/**
* @page button_example_01 Button - Complete example
*
* @dontinclude button_example_01.c