summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJonas M. Gastal <jgastal@profusion.mobi>2011-07-27 20:36:47 +0000
committerJonas M. Gastal <jgastal@profusion.mobi>2011-07-27 20:36:47 +0000
commit9d25e48ba04422d21d57ca3d994ee8d2f6c2e03c (patch)
tree2590770ed8da5c29cddd85840404169e5f298688 /doc
parent5c3d599c88be85a888020a748db89176a5001e6b (diff)
Elementary: photocam documentation.
SVN revision: 61821
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/examples.dox50
-rw-r--r--doc/index.doxy3
-rw-r--r--doc/widgets/Makefile.am4
-rw-r--r--doc/widgets/widget_preview_photocam.c10
5 files changed, 68 insertions, 2 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c689cbbe1..5ad98d8f0 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -61,7 +61,8 @@ WGT_PREVIEW = \
61 progressbar:preview-00.png:widget_preview_progressbar:150:50 \ 61 progressbar:preview-00.png:widget_preview_progressbar:150:50 \
62 box:preview-00.png:widget_preview_box:200:160 \ 62 box:preview-00.png:widget_preview_box:200:160 \
63 notify:preview-00.png:widget_preview_notify:60:30 \ 63 notify:preview-00.png:widget_preview_notify:60:30 \
64 slideshow:preview-00.png:widget_preview_slideshow:50:50 64 slideshow:preview-00.png:widget_preview_slideshow:50:50 \
65 photocam:preview-00.png:widget_preview_photocam:243:162
65 66
66widget-build: 67widget-build:
67 @$(MAKE) -C widgets 68 @$(MAKE) -C widgets
diff --git a/doc/examples.dox b/doc/examples.dox
index 05ea48a2f..cb9d3705c 100644
--- a/doc/examples.dox
+++ b/doc/examples.dox
@@ -4714,6 +4714,56 @@
4714 */ 4714 */
4715 4715
4716/** 4716/**
4717 * @page tutorial_photocam Photocam example
4718 * @dontinclude photocam_example_01.c
4719 *
4720 * In this example we will have a photocam and a couple of buttons and slider to
4721 * control the photocam. To avoid cluttering we'll only show the parts of the
4722 * example that relate to the photocam, the full source code can be seen @ref
4723 * photocam_example_01.c "here".
4724 *
4725 * Creating a photocam is as easy as creating any other widget:
4726 * @skipline elm_photocam_add
4727 *
4728 * A photocam is only useful if we have a image on it, so lets set a file for it
4729 * to work with:
4730 * @until file_set
4731 *
4732 * We now set the photocam to not bounce horizontally:
4733 * @until bounce_set
4734 *
4735 * And we want to know when the photocam has finished loading the image so:
4736 * @until smart_callback
4737 *
4738 * The reason to know when the image is loaded is so that we can bring the
4739 * center of the image into view:
4740 * @skip static
4741 * @until }
4742 *
4743 * As mentioned we have 2 buttons in this example, the "Fit" one will cause
4744 * the photocam to go in to a zoom mode that makes the image fit inside the
4745 * photocam. Tough this has no effect on the image we also print what region was
4746 * being viewed before setting the zoom mode:
4747 * @until }
4748 * @note When in fit mode our slider(explained below) won't work.
4749 *
4750 * The second button("Unfit") will bring the photocam back into manual zoom
4751 * mode:
4752 * @until }
4753 *
4754 * Our slider controls the level of zoom of the photocam:
4755 * @until }
4756 * @note It is important to note that this only works when in manual zoom mode.
4757 *
4758 * Our example will initially look like this:
4759 *
4760 * @image html screenshots/photocam_example_01.png
4761 * @image latex screenshots/photocam_example_01.eps width=\textwidth
4762 *
4763 * @example photocam_example_01.c
4764 */
4765
4766/**
4717 * @page bg_example_01_c bg_example_01.c 4767 * @page bg_example_01_c bg_example_01.c
4718 * @include bg_example_01.c 4768 * @include bg_example_01.c
4719 * @example bg_example_01.c 4769 * @example bg_example_01.c
diff --git a/doc/index.doxy b/doc/index.doxy
index 6653292dd..62af37c78 100644
--- a/doc/index.doxy
+++ b/doc/index.doxy
@@ -155,6 +155,9 @@
155 * @image latex img/panes.eps 155 * @image latex img/panes.eps
156 * @li @ref Photo 156 * @li @ref Photo
157 * @li @ref Photocam 157 * @li @ref Photocam
158 *
159 * @image html img/widget/photocam/preview-00.png
160 * @image latex img/widget/photocam/preview-00.eps
158 * @li @ref Progressbar 161 * @li @ref Progressbar
159 * 162 *
160 * @image html img/widget/progressbar/preview-00.png 163 * @image html img/widget/progressbar/preview-00.png
diff --git a/doc/widgets/Makefile.am b/doc/widgets/Makefile.am
index 1b167c692..b71d07394 100644
--- a/doc/widgets/Makefile.am
+++ b/doc/widgets/Makefile.am
@@ -77,7 +77,8 @@ widget_preview_gengrid \
77widget_preview_progressbar \ 77widget_preview_progressbar \
78widget_preview_box \ 78widget_preview_box \
79widget_preview_notify \ 79widget_preview_notify \
80widget_preview_slideshow 80widget_preview_slideshow \
81widget_preview_photocam
81 82
82LDADD = $(top_builddir)/src/lib/libelementary.la @ELEMENTARY_EWEATHER_LIBS@ @ELEMENTARY_EDBUS_LIBS@ @ELEMENTARY_EFREET_LIBS@ @ELEMENTARY_EMAP_LIBS@ @ELEMENTARY_LIBS@ @EIO_LIBS@ @my_libs@ 83LDADD = $(top_builddir)/src/lib/libelementary.la @ELEMENTARY_EWEATHER_LIBS@ @ELEMENTARY_EDBUS_LIBS@ @ELEMENTARY_EFREET_LIBS@ @ELEMENTARY_EMAP_LIBS@ @ELEMENTARY_LIBS@ @EIO_LIBS@ @my_libs@
83 84
@@ -136,5 +137,6 @@ EXTRA_DIST = \
136 widget_preview_box.c \ 137 widget_preview_box.c \
137 widget_preview_notify.c \ 138 widget_preview_notify.c \
138 widget_preview_slideshow.c \ 139 widget_preview_slideshow.c \
140 widget_preview_photocam.c \
139 widget_preview_tmpl_foot.c \ 141 widget_preview_tmpl_foot.c \
140 widget_preview_tmpl_head.c 142 widget_preview_tmpl_head.c
diff --git a/doc/widgets/widget_preview_photocam.c b/doc/widgets/widget_preview_photocam.c
new file mode 100644
index 000000000..29104cf3e
--- /dev/null
+++ b/doc/widgets/widget_preview_photocam.c
@@ -0,0 +1,10 @@
1#include "widget_preview_tmpl_head.c"
2
3Evas_Object *o = elm_photocam_add(win);
4elm_photocam_file_set(o, PACKAGE_DATA_DIR"/images/insanely_huge_test_image.jpg");
5elm_photocam_zoom_mode_set(o, ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT);
6evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
7elm_win_resize_object_add(win, o);
8evas_object_show(o);
9
10#include "widget_preview_tmpl_foot.c"