summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/Doxyfile.in6
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/examples.dox108
3 files changed, 2 insertions, 115 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 341e03198..7cb9ed41b 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -41,7 +41,6 @@ VERBATIM_HEADERS = NO
41SHOW_INCLUDE_FILES = NO 41SHOW_INCLUDE_FILES = NO
42JAVADOC_AUTOBRIEF = YES 42JAVADOC_AUTOBRIEF = YES
43MULTILINE_CPP_IS_BRIEF = NO 43MULTILINE_CPP_IS_BRIEF = NO
44DETAILS_AT_TOP = NO
45INHERIT_DOCS = YES 44INHERIT_DOCS = YES
46INLINE_INFO = YES 45INLINE_INFO = YES
47SORT_MEMBER_DOCS = YES 46SORT_MEMBER_DOCS = YES
@@ -132,9 +131,8 @@ GRAPHICAL_HIERARCHY = NO
132DOT_IMAGE_FORMAT = png 131DOT_IMAGE_FORMAT = png
133DOT_PATH = 132DOT_PATH =
134DOTFILE_DIRS = 133DOTFILE_DIRS =
135MAX_DOT_GRAPH_WIDTH = 512 134DOT_GRAPH_MAX_NODES = 50
136MAX_DOT_GRAPH_HEIGHT = 512
137GENERATE_LEGEND = YES 135GENERATE_LEGEND = YES
138DOT_CLEANUP = YES 136DOT_CLEANUP = YES
139SEARCHENGINE = NO 137SEARCHENGINE = NO
140LAYOUTFILE = DoxygenLayout.xml 138LAYOUT_FILE = DoxygenLayout.xml
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 53b696b7d..1fa880100 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -58,9 +58,6 @@ WGT_PREVIEW = \
58 flipselector:preview-00.png:widget_preview_flipselector:100:60 \ 58 flipselector:preview-00.png:widget_preview_flipselector:100:60 \
59 hoversel:preview-00.png:widget_preview_hoversel:90:170 \ 59 hoversel:preview-00.png:widget_preview_hoversel:90:170 \
60 hover:preview-00.png:widget_preview_hover:90:170 \ 60 hover:preview-00.png:widget_preview_hover:90:170 \
61 anchorview:preview-00.png:widget_preview_anchorview:100:30 \
62 anchorblock:preview-00.png:widget_preview_anchorblock:100:30 \
63 pager:preview-00.png:widget_preview_pager:100:100 \
64 separator:preview-00.png:widget_preview_separator:10:80 \ 61 separator:preview-00.png:widget_preview_separator:10:80 \
65 radio:preview-00.png:widget_preview_radio:60:20 \ 62 radio:preview-00.png:widget_preview_radio:60:20 \
66 panel:preview-00.png:widget_preview_panel:150:50 \ 63 panel:preview-00.png:widget_preview_panel:150:50 \
diff --git a/doc/examples.dox b/doc/examples.dox
index 04ac72965..0a6524b1c 100644
--- a/doc/examples.dox
+++ b/doc/examples.dox
@@ -5334,114 +5334,6 @@
5334 */ 5334 */
5335 5335
5336/** 5336/**
5337 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
5338 * This example will show both Anchorblock and @ref Anchorview,
5339 * since both are very similar and it's easier to show them once and side
5340 * by side, so the difference is more clear.
5341 *
5342 * We'll show the relevant snippets of the code here, but the full example
5343 * can be found here... sorry, @ref anchorblock_example_01.c "here".
5344 *
5345 * As for the actual example, it's just a simple window with an anchorblock
5346 * and an anchorview, both containing the same text. After including
5347 * Elementary.h and declaring some functions we'll need, we jump to our
5348 * elm_main (see ELM_MAIN) and create our window.
5349 * @dontinclude anchorblock_example_01.c
5350 * @skip int
5351 * @until const char
5352 * @until ;
5353 *
5354 * With the needed variables declared, we'll create the window and a box to
5355 * hold our widgets, but we don't need to go through that here.
5356 *
5357 * In order to make clear where the anchorblock ends and the anchorview
5358 * begins, they'll be each inside a @ref Frame. After creating the frame,
5359 * the anchorblock follows.
5360 * @skip elm_frame_add
5361 * @until elm_frame_content_set
5362 *
5363 * Nothing out of the ordinary there. What's worth mentioning is the call
5364 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
5365 * when an anchor is clicked, the hover for the popup will cover the entire
5366 * window. This affects the area that will be obscured by the hover and
5367 * where clicking will dismiss it, as well as the calculations it does to
5368 * inform the best locations where to insert the popups content.
5369 * Other than that, the code is pretty standard. We also need to set our
5370 * callback for when an anchor is clicked, since it's our task to populate
5371 * the popup. There's no default for it.
5372 *
5373 * The anchorview is no different, we only change a few things so it looks
5374 * different.
5375 * @until elm_frame_content_set
5376 *
5377 * Then we run, so stuff works and close our main function in the usual way.
5378 * @until ELM_MAIN
5379 *
5380 * Now, a little note. Normally you would use either one of anchorblock or
5381 * anchorview, set your one callback to clicks and do your stuff in there.
5382 * In this example, however, there are a few tricks to make it easier to
5383 * show both widgets in one go (and to save me some typing). So we have
5384 * two callbacks, one per widget, that will call a common function to do
5385 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
5386 * anchorview too, since both are equal, and passing a callback to use
5387 * for our buttons to end the hover, because each widget has a different
5388 * function for it.
5389 * @until _anchorview_clicked_cb
5390 * @until }
5391 *
5392 * The meat of our popup is in the following function. We check what kind
5393 * of menu we need to show, based on the name set to the anchor in the
5394 * markup text. If there's no type (something went wrong, no valid contact
5395 * in the address list) we are just putting a button that does nothing, but
5396 * it's perfectly reasonable to just end the hover and call it quits.
5397 *
5398 * Our popup will consist of one main button in the middle of our hover,
5399 * and possibly a secondary button and a list of other options. We'll create
5400 * first our main button and check what kind of popup we need afterwards.
5401 * @skip static void
5402 * @skip static void
5403 * @until eina_stringshare_add
5404 * @until }
5405 *
5406 * Each button has two callbacks, one is our hack to close the hover
5407 * properly based on which widget it belongs to, the other a simple
5408 * printf that will show the action with the anchors own data. This is
5409 * not how you would usually do it. Instead, the common case is to have
5410 * one callback for the button that will know which function to call to end
5411 * things, but since we are doing it this way it's worth noting that
5412 * smart callbacks will be called in reverse in respect to the order they
5413 * were added, and since our @c btn_end_cb will close the hover, and thus
5414 * delete our buttons, the other callback wouldn't be called if we had
5415 * added it before.
5416 *
5417 * After our telephone popup, there are a few others that are practically
5418 * the same, so they won't be shown here.
5419 *
5420 * Once we are done with that, it's time to place our actions into our
5421 * hover. Main button goes in the middle without much questioning, and then
5422 * we see if we have a secondary button and a box of extra options.
5423 * Because I said so, secondary button goes on either side and box of
5424 * options either on top or below the main one, but to choose which
5425 * exactly, we use the hints our callback info has, which saves us from
5426 * having to do the math and see which side has more space available, with
5427 * a little special case where we delete our extra stuff if there's nowhere
5428 * to place it.
5429 * @skip url:
5430 * @skip }
5431 * @skip evas_object_smart
5432 * @until evas_object_del(box)
5433 * @until }
5434 * @until }
5435 *
5436 * The example will look like this:
5437 *
5438 * @image html screenshots/anchorblock_01.png
5439 * @image latex screenshots/anchorblock_01.eps width=\textwidth
5440 *
5441 * @example anchorblock_example_01.c
5442 */
5443
5444/**
5445 * @page tutorial_check Check example 5337 * @page tutorial_check Check example
5446 * @dontinclude check_example_01.c 5338 * @dontinclude check_example_01.c
5447 * 5339 *