documentation... more! build! look vaguely ok

SVN revision: 40734
This commit is contained in:
Carsten Haitzler 2009-05-19 09:29:20 +00:00
parent b68636289b
commit 9d7db82782
20 changed files with 648 additions and 45376 deletions

View File

@ -1,7 +1,7 @@
PROJECT_NAME = Evas
PROJECT_NAME = Elementary
PROJECT_NUMBER =
OUTPUT_DIRECTORY = .
INPUT = evas.dox ../src/lib
INPUT = elementary.dox ../src/lib
IMAGE_PATH = img
OUTPUT_LANGUAGE = English
GENERATE_HTML = YES
@ -18,7 +18,7 @@ HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = YES
DISABLE_INDEX = NO
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
@ -63,7 +63,7 @@ WARN_IF_UNDOCUMENTED = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
FILE_PATTERNS =
RECURSIVE = YES
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =

View File

@ -1,14 +1,21 @@
/**
@file elementary.dox
@brief Elementary Widget Library
*/
/**
@mainpage Elementary
@image latex evas_big.eps width=5cm
@image html evas.png
@image html elementary.png
@version @PACKAGE_VERSION@
@author Carsten Haitzler <raster\@rasterman.com>
@author FIXME: get from Elementary.h
@author Gustavo Sverzut Barbieri <barbieri@profusion.mobi>
@author Cedric Bail <cedric.bail@free.fr>
@author Vincent Torri <vtorri@univ-evry.fr>
@author Daniel Kolesa <quaker6667@hotmail.com>
@author Jaime Thomas <avi.thomas@gmail.com>
@author Swisscom - http://www.swisscom.ch/
@date 2008-2009
@section intro What is Elementary?
BLAH BLAH Blah blah ...
@ -16,5 +23,4 @@ BLAH BLAH Blah blah ...
@verbatim
Pants
@endverbatim
*/

View File

@ -23,11 +23,10 @@
<table border="0" cellpadding="0" cellspacing="4px">
<tr>
<td class='nav'><a class='nav' href="index.html">Main&nbsp;Page</a></td>
<td class='nav'><a class='nav' href="modules.html">Modules</a></td>
<td class='nav'><a class='nav' href="annotated.html">Data Structures</a></td>
<td class="nav"><a class="nav" href="Evas_8h.html">API Reference</a></td>
<td class="nav"><a class="nav" href="modules.html">Modules</a></td>
<td class="nav"><a class="nav" href="Elementary_8h.html">API Reference</a></td>
<td class="nav"><a class="nav" href="globals.html">Globals</a></td>
<td class="nav"><a class="nav" href="pages.html">Related Pages</a></td>
<td class="nav"><a class="nav" href="files.html">Files</a></td>
</tr>
</table>
<hr />

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.1 KiB

View File

@ -1,149 +0,0 @@
%!PS-Adobe-2.0 EPSF-2.0
%%Title: evas.eps
%%Creator: fig2dev Version 3.2 Patchlevel 3c
%%CreationDate: Wed Oct 23 16:18:00 2002
%%For: raster@dugong.fluffyspider.com.au (The Rasterman)
%%BoundingBox: 0 0 404 396
%%Magnification: 1.0000
%%EndComments
/$F2psDict 200 dict def
$F2psDict begin
$F2psDict /mtrx matrix put
/col-1 {0 setgray} bind def
/col0 {0.000 0.000 0.000 srgb} bind def
/col1 {0.000 0.000 1.000 srgb} bind def
/col2 {0.000 1.000 0.000 srgb} bind def
/col3 {0.000 1.000 1.000 srgb} bind def
/col4 {1.000 0.000 0.000 srgb} bind def
/col5 {1.000 0.000 1.000 srgb} bind def
/col6 {1.000 1.000 0.000 srgb} bind def
/col7 {1.000 1.000 1.000 srgb} bind def
/col8 {0.000 0.000 0.560 srgb} bind def
/col9 {0.000 0.000 0.690 srgb} bind def
/col10 {0.000 0.000 0.820 srgb} bind def
/col11 {0.530 0.810 1.000 srgb} bind def
/col12 {0.000 0.560 0.000 srgb} bind def
/col13 {0.000 0.690 0.000 srgb} bind def
/col14 {0.000 0.820 0.000 srgb} bind def
/col15 {0.000 0.560 0.560 srgb} bind def
/col16 {0.000 0.690 0.690 srgb} bind def
/col17 {0.000 0.820 0.820 srgb} bind def
/col18 {0.560 0.000 0.000 srgb} bind def
/col19 {0.690 0.000 0.000 srgb} bind def
/col20 {0.820 0.000 0.000 srgb} bind def
/col21 {0.560 0.000 0.560 srgb} bind def
/col22 {0.690 0.000 0.690 srgb} bind def
/col23 {0.820 0.000 0.820 srgb} bind def
/col24 {0.500 0.190 0.000 srgb} bind def
/col25 {0.630 0.250 0.000 srgb} bind def
/col26 {0.750 0.380 0.000 srgb} bind def
/col27 {1.000 0.500 0.500 srgb} bind def
/col28 {1.000 0.630 0.630 srgb} bind def
/col29 {1.000 0.750 0.750 srgb} bind def
/col30 {1.000 0.880 0.880 srgb} bind def
/col31 {1.000 0.840 0.000 srgb} bind def
end
save
newpath 0 396 moveto 0 0 lineto 404 0 lineto 404 396 lineto closepath clip newpath
-8.0 450.0 translate
1 -1 scale
/cp {closepath} bind def
/ef {eofill} bind def
/gr {grestore} bind def
/gs {gsave} bind def
/sa {save} bind def
/rs {restore} bind def
/l {lineto} bind def
/m {moveto} bind def
/rm {rmoveto} bind def
/n {newpath} bind def
/s {stroke} bind def
/sh {show} bind def
/slc {setlinecap} bind def
/slj {setlinejoin} bind def
/slw {setlinewidth} bind def
/srgb {setrgbcolor} bind def
/rot {rotate} bind def
/sc {scale} bind def
/sd {setdash} bind def
/ff {findfont} bind def
/sf {setfont} bind def
/scf {scalefont} bind def
/sw {stringwidth} bind def
/tr {translate} bind def
/tnt {dup dup currentrgbcolor
4 -2 roll dup 1 exch sub 3 -1 roll mul add
4 -2 roll dup 1 exch sub 3 -1 roll mul add
4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb}
bind def
/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul
4 -2 roll mul srgb} bind def
/DrawEllipse {
/endangle exch def
/startangle exch def
/yrad exch def
/xrad exch def
/y exch def
/x exch def
/savematrix mtrx currentmatrix def
x y tr xrad yrad sc 0 0 1 startangle endangle arc
closepath
savematrix setmatrix
} def
/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def
/$F2psEnd {$F2psEnteredState restore end} def
$F2psBegin
%%Page: 1 1
10 setmiterlimit
0.06000 0.06000 sc
%
% Fig objects follow
%
% Ellipse
n 3450 4200 3300 3300 0 360 DrawEllipse gs 0.00 setgray ef gr
% Ellipse
n 3825 4200 3000 3000 0 360 DrawEllipse gs col7 1.00 shd ef gr
% Ellipse
n 1725 4200 600 600 0 360 DrawEllipse gs 0.00 setgray ef gr
% Ellipse
n 6238 4200 600 600 0 360 DrawEllipse gs 0.00 setgray ef gr
% Rotated Ellipse
gs
3225 4200 tr
-90.000 rot
n 0 0 600 600 0 360 DrawEllipse 90.000 rot
gs 0.00 setgray ef gr gr
% Rotated Ellipse
gs
4725 4200 tr
-270.001 rot
n 0 0 600 600 0 360 DrawEllipse 270.001 rot
gs 0.00 setgray ef gr gr
% Rotated Ellipse
gs
3225 4132 tr
-90.000 rot
n 0 0 545 545 0 360 DrawEllipse 90.000 rot
gs col7 1.00 shd ef gr gr
% Rotated Ellipse
gs
4725 4268 tr
-270.001 rot
n 0 0 545 545 0 360 DrawEllipse 270.001 rot
gs col7 1.00 shd ef gr gr
% Arc
n 6306.0 4200.0 545.0 180.0 0.0 arc
6306.0 4200.0 l 5761.0 4200.0 l gs col7 1.00 shd ef gr
% Arc
n 6170.0 4200.0 545.0 180.0 0.0 arcn
6170.0 4200.0 l 5625.0 4200.0 l gs col7 1.00 shd ef gr
$F2psEnd
rs

View File

@ -1,25 +0,0 @@
#FIG 3.2
Landscape
Center
Inches
Letter
500.00
Single
-2
1200 2
6 150 900 6825 7500
1 4 0 0 0 0 48 0 20 0.000 1 0.0000 1725 4200 600 600 1125 4200 2325 4200
1 4 0 0 0 0 50 0 20 0.000 1 0.0000 3450 4200 3300 3300 150 4200 6750 4200
1 4 0 0 0 7 49 0 20 0.000 1 0.0000 3825 4200 3000 3000 825 4200 6825 4200
-6
6 5625 3600 6900 4800
6 5625 3600 6900 4800
5 2 0 0 0 7 30 0 20 0.000 0 0 0 0 6306.000 4200.000 5761 4200 6306 3655 6851 4200
5 2 0 0 0 7 30 0 20 0.000 0 1 0 0 6170.000 4200.000 5625 4200 6170 4745 6715 4200
-6
1 4 0 0 0 0 40 0 20 0.000 1 0.0000 6238 4200 600 600 5638 4200 6838 4200
-6
1 4 0 0 0 0 40 0 20 0.000 1 1.5708 3225 4200 600 600 3225 4800 3225 3600
1 4 0 0 0 7 39 0 20 0.000 1 1.5708 3225 4132 545 545 3225 4677 3225 3587
1 4 0 0 0 0 40 0 20 0.000 1 4.7124 4725 4200 600 600 4725 3600 4725 4800
1 4 0 0 0 7 39 0 20 0.000 1 4.7124 4725 4268 545 545 4725 3723 4725 4813

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

File diff suppressed because it is too large Load Diff

Binary file not shown.

Before

Width:  |  Height:  |  Size: 915 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 753 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

View File

@ -25,13 +25,15 @@ AC_ARG_ENABLE([doc],
efl_enable_doc="no"
fi
],
[efl_enable_doc="yes"]
)
[efl_enable_doc="yes"])
AC_MSG_CHECKING([whether to build documentation])
AC_MSG_RESULT([${efl_enable_doc}])
if test "x${efl_enable_doc}" = "xyes" ; then
dnl
dnl Specify the full file name, with path
dnl Specify the file name, without path
dnl
efl_doxygen="doxygen"
@ -51,10 +53,10 @@ dnl
if test "x${efl_have_doxygen}" = "xno" ; then
echo "WARNING:"
echo "The doxygen program you specified:"
echo "$efl_doxygen"
echo "${efl_doxygen}"
echo "was not found. Please check the path and make sure "
echo "the program exists and is executable."
AC_MSG_WARN([Warning: no doxygen detected. Documentation will not be built])
AC_MSG_WARN([no doxygen detected. Documentation will not be built])
fi
],
[AC_CHECK_PROG([efl_have_doxygen],
@ -63,17 +65,16 @@ dnl
[no])
if test "x${efl_have_doxygen}" = "xno" ; then
echo "WARNING:"
echo "The doxygen program was not found in your execute"
echo "The doxygen program was not found in your execute path."
echo "You may have doxygen installed somewhere not covered by your path."
echo ""
echo "If this is the case make sure you have the packages installed, AND"
echo "that the doxygen program is in your execute path (see your"
echo "shell manual page on setting the \$PATH environment variable), OR"
echo "alternatively, specify the program to use with --with-doxygen."
AC_MSG_WARN([Warning: no doxygen detected. Documentation will not be built])
AC_MSG_WARN([no doxygen detected. Documentation will not be built])
fi
]
)
])
fi
dnl
@ -88,9 +89,9 @@ fi
AM_CONDITIONAL(EFL_BUILD_DOC, test "x${efl_enable_doc}" = "xyes")
if test "x${efl_enable_doc}" = "xyes" ; then
ifelse([$1], , :, [$1])
m4_default([$1], [:])
else
ifelse([$2], , :, [$2])
m4_default([$2], [:])
fi
])

View File

@ -38,6 +38,13 @@
*
*/
/**
* @file Elementary.h
* @brief Elementary's API
*
* Elementary API.
*/
@ELM_UNIX_DEF@ ELM_UNIX
@ELM_WIN32_DEF@ ELM_WIN32
@ELM_WINCE_DEF@ ELM_WINCE

View File

@ -1,6 +1,17 @@
#include <Elementary.h>
#include "elm_priv.h"
/**
* @defgroup Check Check
*
* The check widget allows for toggling a value between true or false (1or 0).
*
* Signals that you can add callbacks for are:
*
* changed - This is called whenever the user changes the state of one of the check object.
*
* Check objects are a lot like radio objects in layout and functionality except they do not work as a group, but independently and only toggle the value of a boolean from false to true (0 or 1). elm_check_state_set() sets the boolean state (1 for true, 0 for false), and elm_check_state_get() returns the current state. For convenience, like the radio objects, you can set a pointer to a boolean directly with elm_check_state_pointer_set() for it to modify.
*/
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
@ -124,6 +135,14 @@ _signal_check_toggle(void *data, Evas_Object *obj, const char *emission, const c
evas_object_smart_callback_call(data, "changed", NULL);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Check
*/
EAPI Evas_Object *
elm_check_add(Evas_Object *parent)
{
@ -153,6 +172,14 @@ elm_check_add(Evas_Object *parent)
return obj;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Check
*/
EAPI void
elm_check_label_set(Evas_Object *obj, const char *label)
{
@ -176,6 +203,14 @@ elm_check_label_set(Evas_Object *obj, const char *label)
_sizing_eval(obj);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Check
*/
EAPI void
elm_check_icon_set(Evas_Object *obj, Evas_Object *icon)
{
@ -194,6 +229,14 @@ elm_check_icon_set(Evas_Object *obj, Evas_Object *icon)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Check
*/
EAPI void
elm_check_state_set(Evas_Object *obj, Evas_Bool state)
{
@ -209,6 +252,14 @@ elm_check_state_set(Evas_Object *obj, Evas_Bool state)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Check
*/
EAPI Evas_Bool
elm_check_state_get(const Evas_Object *obj)
{
@ -216,6 +267,14 @@ elm_check_state_get(const Evas_Object *obj)
return wd->state;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Check
*/
EAPI void
elm_check_state_pointer_set(Evas_Object *obj, Evas_Bool *statep)
{

View File

@ -1,6 +1,70 @@
#include <Elementary.h>
#include "elm_priv.h"
/**
* @defgroup Genlist Genlist
*
* The aim was to have more expansive list that the simple list in Elementary that could have more flexible items and allow many more entries while still being fast and low on memory usage. At the same time it was also made to be able to do tree structures.
*
* Signals that you can add callbacks for are:
*
* clicked - This is called when a user has double-clicked an item. The event_info parameter is the genlist item that as double-clicked.
*
* selected - This is called when a user has made an item selected. The event_info parameter is the genlist item that was selected.
*
* unselected - This is called when a user has made an item unselected. The event_info parameter is the genlist item that was unselected.
*
* expanded - This is called when elm_genlist_item_expanded_set() is called and the item is now meant to be expanded. The event_info parameter is the genlist item that was indicated to expand. It is the job of this callback to then fill in the child items.
*
* contracted - This is called when elm_genlist_item_expanded_set() is called and the item is now meant to be contracted. The event_info parameter is the genlist item that was indicated to contract. It is the job of this callback to then delete the child items
*
* expand,request - This is called when a user has indicated they want to expand a tree branch item. The callback should decide if the item can expand (has any children) and then call elm_genlist_item_expanded_set() appropriately to set the state. The event_info parameter is the genlist item that was indicated to expand.
*
* contract,request - This is called when a user has indicated they want to contract a tree branch item. The callback should decide if the item can contract (has any children) and then call elm_genlist_item_expanded_set() appropriately to set the state. The event_info parameter is the genlist item that was indicated to contract.
*
* Genlist has a fairly large API, mostly because it's relatively complex, trying to be both expansive, powerful and efficient. First we will begin an overview o the theory behind genlist.
*
* Evas tracks every object you create. Every time it processes an event (mouse move, down, up etc.) it needs to walk through objects and find out what event that affects. Even worse every time it renders display updates, in order to just calculate what to re-draw, it needs to walk through many many many objects. Thus, the more objects you keep active, the more overhead Evas has in just doing its work. It is advisable to keep your active objects to the minimum working set you need. Also remember that object creation and deletion carries an overhead, so there is a middle-ground, which is not easily determined. But don't keep massive lists of objects you can't see or use. Genlist does this with list objects. It creates and destroys them dynamically as you scroll around. It groups them into blocks so it can determine the visibility etc. of a whole block at once as opposed to having to walk the whole list. This 2-level list allows for very large numbers of items to be in the list (tests have used up to 1,000,000 items). Also genlist employs a queue for adding items. As items may be different sizes, every item added needs to be calculated as to its size and thus this presents a lot of overhead on populating the list, this genlist employs a queue. Any item added is queued and spooled off over time, actually appearing some time later, so if your list has many members you may find it takes a while for them to all appear, with your process consuming a lot of CPU while it is busy spooling.
*
* Genlist also implements a tree structure, but it does so with callbacks to the application, with the application filling in tree structures when requested (allowing for efficient building of a very deep tree that could even be used for file-management). See the above smart signal callbacks for details.
*
* An item in the genlist world can have 0 or more text labels (they can be regular text or textblock that's up to the style to determine), 0 or more icons (which are simply objects swallowed into the genlist item) and 0 or more boolean states that can be used for check, radio or other indicators by the edje theme style. An item may be one of several styles (Elementary provides 2 by default - default and double_label, but this can be extended by system or application custom themes/overlays/extensions).
*
* In order to implement the ability to add and delete items on the fly, Genlist implements a class/callback system where the application provides a structure with information about that type of item (genlist may contain multiple different items with different classes, states and styles). Genlist will call the functions in this struct (methods) when an item is realized (that is created dynamically while scrolling). All objects will simply be deleted when no longer needed with evas_object_del(). The Elm_Genlist_Item_Class structure contains the following members:
*
* item_style - This is a constant string and simply defines the name of the item style. It must be specified and the default should be default.
*
* func.label_get - This function is called when an actual item object is created. The data parameter is the data parameter passed to elm_genlist_item_append() and related item creation functions. The obj parameter is the genlist object and the part parameter is the string name of the text part in the edje design that is listed as one of the possible labels that can be set. This function must return a strudup()'ed string as the caller will free() it when done.
*
* func.icon_get - This function is called when an actual item object is created. The data parameter is the data parameter passed to elm_genlist_item_append() and related item creation functions. The obj parameter is the genlist object and the part parameter is the string name of the icon part in the edje design that is listed as one of the possible icons that can be set. This must return NULL for no object or a valid object. The object will be deleted by genlist on shutdown or when he item its unrealized.
*
* func.state_get - This function is called when an actual item object is created. The data parameter is the data parameter passed to elm_genlist_item_append() and related item creation functions. The obj parameter is the genlist object and the part parameter is the string name of the state part in the edje design that is listed as one of the possible states that can be set. Return 0 for false or 1 for true. Genlist will emit a signal with elm,state,XXX,active elm when true (the default is false), where XXX is the name of the part.
*
* func.del - This is called when elm_genlist_item_del() is called on an item, elm_genlist_clear() is called on the genlist, or elm_genlist_item_subitems_clear() is called to clear sub-items. This is intended for use when actual genlist items are deleted, so any backing data attached to the item (e.g. its data parameter on creation) can be deleted.
*
* Items can be added by several calls. All of them return a Elm_Genlist_Item handle that is an internal member inside the genlist. They all take a data parameter that is meant to be used for a handle to the applications internal data (eg the struct with the original item data). The parent parameter is the parent genlist item this belongs to if it is a tree, and NULL if there is no parent. The flags can be a bitmask of ELM_GENLIST_ITEM_NONE and ELM_GENLIST_ITEM_SUBITEMS. If ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as a item that is able to expand and have child items. The func parameter is a convenience callback that is called when the item is selected and the data parameter will be the func_data parameter, obj be the genlist object and vent_info will be the genlist item.
*
* elm_genlist_item_append() appends an item to the end of the list, or if there is a parent, to the end of all the child items of the parent. elm_genlist_item_prepend() is the same but prepends to the beginning of the list or children list. elm_genlist_item_insert_before() inserts at item before another item and elm_genlist_item_insert_after() inserts after the indicated item.
*
* The application can clear the list with elm_genlist_clear() which deletes all the items in the list and elm_genlist_item_del() will delete a specific item. elm_genlist_item_subitems_clear() will clear all items that are children of the indicated parent item.
*
* If the application wants multiple items to be able to be selected, elm_genlist_multi_select_set() can enable this. If the list is single-selection only (the default), then elm_genlist_selected_item_get() will return the selected item, if any, or NULL I none is selected. If the list is multi-select then elm_genlist_selected_items_get() will return a list (that is only valid as long as no items are modified (added, deleted, selected or unselected).
*
* To help inspect list items you can jump to the item at the top of the list with elm_genlist_first_item_get() which will return the item pointer, and similarly elm_genlist_last_item_get() gets the item at the end of the list. elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next and previous items respectively relative to the indicated item. Using these calls you can walk the entire item list/tree. Note that as a tree he items are flattened in the list, so elm_genlist_item_parent_get() will let you know which item is the parent (and thus know how to skip them if wanted).
*
* There are also convenience functions. elm_genlist_item_genlist_get() will return the genlist object the item belongs to. elm_genlist_item_show() will make the scroller scroll to show that specific item so its visible. elm_genlist_item_data_get() returns the data pointer set by the item creation functions.
*
* If an item changes (state of boolean changes, label or icons change), then use elm_genlist_item_update() to have genlist update the item with the new state. Genlist will re-realize the item thus call the functions in the _Elm_Genlist_Item_Class for that item.
*
* To pro grammatically (un)select an item use elm_genlist_item_selected_set(). To get its selected state use elm_genlist_item_selected_get(). Similarly to expand/contract and item and get its expanded state, use elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And again to make an item disabled (unable to be selected and appear differently) use elm_genlist_item_disabled_set() to set this and elm_genlist_item_disabled_get() to get the disabled state.
*
* In general to indicate how the genlist should expand items horizontally to fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This mode means that if items are too wide to fit, the scroller will scroll horizontally. Otherwise items are expanded to fill the width of the viewport of the scroller. If it is ELM_LIST_LIMIT, Items will be expanded to the viewport width and limited to that size. This can be combined with a different style that uses edjes' ellipsis feature (cutting text off like this: tex...).
*
* Items will only call their selection func and callback when first becoming selected. Any further clicks will do nothing, unless you enable always select with elm_genlist_always_select_mode_set(). This means even if selected, every click will make the selected callbacks be called. elm_genlist_no_select_mode_set() will turn off the ability to select items entirely and they will neither appear selected nor call selected callback functions.
*
* Remember that you can create new styles and add you own theme augmentation per application with elm_theme_extension_add(). If you absolutely must have a specific style that overrides any theme the user or system sets up you can use elm_theme_overlay_add() to add such a file.
*
*/
typedef struct _Widget_Data Widget_Data;
typedef struct _Item_Block Item_Block;
typedef struct _Pan Pan;
@ -786,6 +850,14 @@ _pan_calculate(Evas_Object *obj)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Evas_Object *
elm_genlist_add(Evas_Object *parent)
{
@ -1085,6 +1157,14 @@ _item_queue(Widget_Data *wd, Elm_Genlist_Item *it)
wd->queue = eina_list_append(wd->queue, it);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc,
const void *data, Elm_Genlist_Item *parent,
@ -1116,6 +1196,14 @@ elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc,
return it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc,
const void *data, Elm_Genlist_Item *parent,
@ -1137,6 +1225,14 @@ elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc,
return it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc,
const void *data, Elm_Genlist_Item *before,
@ -1159,6 +1255,14 @@ elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *i
return it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc,
const void *data, Elm_Genlist_Item *after,
@ -1181,6 +1285,14 @@ elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *it
return it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_clear(Evas_Object *obj)
{
@ -1230,6 +1342,14 @@ elm_genlist_clear(Evas_Object *obj)
_sizing_eval(obj);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_multi_select_set(Evas_Object *obj, Evas_Bool multi)
{
@ -1237,6 +1357,14 @@ elm_genlist_multi_select_set(Evas_Object *obj, Evas_Bool multi)
wd->multi = multi;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_selected_item_get(const Evas_Object *obj)
{
@ -1245,6 +1373,14 @@ elm_genlist_selected_item_get(const Evas_Object *obj)
return NULL;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI const Eina_List *
elm_genlist_selected_items_get(const Evas_Object *obj)
{
@ -1252,6 +1388,14 @@ elm_genlist_selected_items_get(const Evas_Object *obj)
return wd->selected;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_first_item_get(const Evas_Object *obj)
{
@ -1262,6 +1406,14 @@ elm_genlist_first_item_get(const Evas_Object *obj)
return it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_last_item_get(const Evas_Object *obj)
{
@ -1273,6 +1425,14 @@ elm_genlist_last_item_get(const Evas_Object *obj)
return it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_next_get(const Elm_Genlist_Item *it)
{
@ -1284,6 +1444,14 @@ elm_genlist_item_next_get(const Elm_Genlist_Item *it)
return (Elm_Genlist_Item *)it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_prev_get(const Elm_Genlist_Item *it)
{
@ -1295,6 +1463,14 @@ elm_genlist_item_prev_get(const Elm_Genlist_Item *it)
return (Elm_Genlist_Item *)it;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Evas_Object *
elm_genlist_item_genlist_get(const Elm_Genlist_Item *it)
{
@ -1302,6 +1478,14 @@ elm_genlist_item_genlist_get(const Elm_Genlist_Item *it)
return it->wd->obj;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Elm_Genlist_Item *
elm_genlist_item_parent_get(const Elm_Genlist_Item *it)
{
@ -1309,6 +1493,14 @@ elm_genlist_item_parent_get(const Elm_Genlist_Item *it)
return it->parent;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_subitems_clear(Elm_Genlist_Item *it)
{
@ -1322,6 +1514,14 @@ elm_genlist_item_subitems_clear(Elm_Genlist_Item *it)
elm_genlist_item_del(it2);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_selected_set(Elm_Genlist_Item *it, Evas_Bool selected)
{
@ -1346,6 +1546,14 @@ elm_genlist_item_selected_set(Elm_Genlist_Item *it, Evas_Bool selected)
_item_unselect(it);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Evas_Bool
elm_genlist_item_selected_get(const Elm_Genlist_Item *it)
{
@ -1353,6 +1561,14 @@ elm_genlist_item_selected_get(const Elm_Genlist_Item *it)
return it->selected;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_expanded_set(Elm_Genlist_Item *it, Evas_Bool expanded)
{
@ -1373,6 +1589,14 @@ elm_genlist_item_expanded_set(Elm_Genlist_Item *it, Evas_Bool expanded)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Evas_Bool
elm_genlist_item_expanded_get(const Elm_Genlist_Item *it)
{
@ -1380,6 +1604,14 @@ elm_genlist_item_expanded_get(const Elm_Genlist_Item *it)
return it->expanded;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_disabled_set(Elm_Genlist_Item *it, Evas_Bool disabled)
{
@ -1396,6 +1628,14 @@ elm_genlist_item_disabled_set(Elm_Genlist_Item *it, Evas_Bool disabled)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI Evas_Bool
elm_genlist_item_disabled_get(const Elm_Genlist_Item *it)
{
@ -1404,6 +1644,14 @@ elm_genlist_item_disabled_get(const Elm_Genlist_Item *it)
return it->disabled;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_show(Elm_Genlist_Item *it)
{
@ -1426,6 +1674,14 @@ elm_genlist_item_show(Elm_Genlist_Item *it)
it->block->w, it->h);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_del(Elm_Genlist_Item *it)
{
@ -1449,12 +1705,28 @@ elm_genlist_item_del(Elm_Genlist_Item *it)
_item_del(it);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI const void *
elm_genlist_item_data_get(const Elm_Genlist_Item *it)
{
return it->data;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_item_update(Elm_Genlist_Item *it)
{
@ -1499,6 +1771,14 @@ elm_genlist_item_update(Elm_Genlist_Item *it)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode)
{
@ -1511,6 +1791,14 @@ elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode)
elm_scroller_content_min_limit(wd->scr, 0, 0);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_always_select_mode_set(Evas_Object *obj, Evas_Bool always_select)
{
@ -1518,6 +1806,14 @@ elm_genlist_always_select_mode_set(Evas_Object *obj, Evas_Bool always_select)
wd->always_select = always_select;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Genlist
*/
EAPI void
elm_genlist_no_select_mode_set(Evas_Object *obj, Evas_Bool no_select)
{

View File

@ -669,6 +669,7 @@ elm_exit(void)
*
* @param obj The object
* @param scale Scale factor (from 0.0 up, with 1.0 == no scaling)
*
* @ingroup Scaling
*/
EAPI void
@ -682,6 +683,7 @@ elm_object_scale_set(Evas_Object *obj, double scale)
*
* @param obj The object
* @return The scaling factor set by elm_object_scale_set()
*
* @ingroup Scaling
*/
EAPI double

View File

@ -1,6 +1,14 @@
#include <Elementary.h>
#include "elm_priv.h"
/**
* @defgroup Pager Pager
*
* The pager is an object that allows flipping (with animation) between 1 or more pages of objects, much like a stack of windows within the window.
*
* Objects can be pushed or popped from he stack or deleted as normal. Pushes an pops will animate (and a pop will delete the object once the animation is finished). Any object in the pager can be promoted to the top (from its current stacking position) as well. Objects are pushed to the top with elm_pager_content_push() and when the top item is no longer wanted, simply pop it with elm_pager_content_pop() and it will also be deleted. Any object you wish to promote to the top that is already in the pager, simply use elm_pager_content_promote(). If an object is no longer needed and is not the top item, just delete it as normal. You can query which objects are the top and bottom with elm_pager_content_bottom_get() and elm_pager_content_top_get()
*/
typedef struct _Widget_Data Widget_Data;
typedef struct _Item Item;
@ -163,6 +171,14 @@ _signal_hide_finished(void *data, Evas_Object *obj, const char *emission, const
_sizing_eval(obj2);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Pager
*/
EAPI Evas_Object *
elm_pager_add(Evas_Object *parent)
{
@ -188,6 +204,14 @@ elm_pager_add(Evas_Object *parent)
return obj;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Pager
*/
EAPI void
elm_pager_content_push(Evas_Object *obj, Evas_Object *content)
{
@ -216,6 +240,14 @@ elm_pager_content_push(Evas_Object *obj, Evas_Object *content)
_sizing_eval(obj);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Pager
*/
EAPI void
elm_pager_content_pop(Evas_Object *obj)
{
@ -253,6 +285,14 @@ elm_pager_content_pop(Evas_Object *obj)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Pager
*/
EAPI void
elm_pager_content_promote(Evas_Object *obj, Evas_Object *content)
{
@ -271,6 +311,14 @@ elm_pager_content_promote(Evas_Object *obj, Evas_Object *content)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Pager
*/
EAPI Evas_Object *
elm_pager_content_bottom_get(Evas_Object *obj)
{
@ -281,6 +329,14 @@ elm_pager_content_bottom_get(Evas_Object *obj)
return it->content;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Pager
*/
EAPI Evas_Object *
elm_pager_content_top_get(Evas_Object *obj)
{

View File

@ -1,6 +1,18 @@
#include <Elementary.h>
#include "elm_priv.h"
/**
* @defgroup Radio Radio
*
* The radio button allows for 1 or more selectors to be created to select 1 of a set of options.
*
* Signals that you can add callbacks for are:
*
* changed - This is called whenever the user changes the state of one of the radio objects within the group of radio objects that work together.
*
* A radio object contains an indicator, an optional Label and an optional icon object. They work normally in groups of 2 or more. When you create a radio (if it is not the first member of the group), simply add it to the group by adding it to any other member of the group that already exists (or the first member) with elm_radio_group_add() with the second parameter being the existing group member. The radio object(s) will select from one of a set of integer values, so any value they are configuring needs to be mapped to a set of integers. To configure what value that radio object represents, use elm_radio_state_value_set() to set the integer it represents. To set the value the whole group is to indicate use elm_radio_value_set() on any group member, and to get the groups value use elm_radio_value_get(). For convenience the radio objects are also able to directly set an integer (int) to the value that is selected. To specify the pointer to this integer to modify, use elm_radio_value_pointer_set(). The radio objects will modify this directly. That implies the pointer must point to valid memory for as long as the radio objects exist.
*/
typedef struct _Widget_Data Widget_Data;
typedef struct _Group Group;
@ -141,6 +153,14 @@ _signal_radio_on(void *data, Evas_Object *obj, const char *emission, const char
evas_object_smart_callback_call(data, "changed", NULL);
}
/**
* Add a new radio to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Radio
*/
EAPI Evas_Object *
elm_radio_add(Evas_Object *parent)
{
@ -173,6 +193,14 @@ elm_radio_add(Evas_Object *parent)
return obj;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI void
elm_radio_label_set(Evas_Object *obj, const char *label)
{
@ -196,6 +224,14 @@ elm_radio_label_set(Evas_Object *obj, const char *label)
_sizing_eval(obj);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI void
elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon)
{
@ -214,6 +250,14 @@ elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon)
}
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI void
elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
{
@ -229,6 +273,14 @@ elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
else _state_set(obj, 0);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI void
elm_radio_state_value_set(Evas_Object *obj, int value)
{
@ -239,6 +291,14 @@ elm_radio_state_value_set(Evas_Object *obj, int value)
else _state_set(obj, 0);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI void
elm_radio_value_set(Evas_Object *obj, int value)
{
@ -251,6 +311,14 @@ elm_radio_value_set(Evas_Object *obj, int value)
_state_set_all(wd);
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI int
elm_radio_value_get(const Evas_Object *obj)
{
@ -258,6 +326,14 @@ elm_radio_value_get(const Evas_Object *obj)
return wd->group->value;
}
/**
* XXX
*
* @param xxx XXX
* @return XXX
*
* @ingroup Radio
*/
EAPI void
elm_radio_value_pointer_set(Evas_Object *obj, int *valuep)
{

View File

@ -1,6 +1,40 @@
#include <Elementary.h>
#include "elm_priv.h"
/**
* @defgroup Slider Slider
*
* The slider adds a dragable slider widget for selecting the value of
* something within a range.
*
* Signals that you can add callbacks for are:
*
* changed - Whenever the slider value is changed by the user.
*
* delay,changed - A short time after the value is changed by the user.
* This will be called only when the user stops dragging for a very short
* period or when they release their finger/mouse, so it avoids possibly
* expensive reactions to the value change.
*
* A slider can be horizontal or vertical. It can contain an Icon and has a
* primary label as well as a units label (that is formatted with floating
* point values and thus accepts a printf-style format string, like
* %1.2f units. There is also an indicator string that may be somewhere
* else (like on the slider itself) that also accepts a format string like
* units. Label, Icon Unit and Indicator strings/objects are optional.
*
* A slider may be inverted which means values invert, with high vales being
* on the left or top and low values on the right or bottom (as opposed to
* normally being low on the left or top and high on the bottom and right).
*
* The slider should have its minimum and maximum values set by the
* application with elm_slider_min_max_set() and value should also be set by
* the application before use with elm_slider_value_set(). The span of the
* slider is its length (horizontally or vertically). This will be scaled by
* the object or applications scaling factor. At any point code can query the
* slider for its value with elm_slider_value_get().
*/
typedef struct _Widget_Data Widget_Data;
struct _Widget_Data
@ -208,6 +242,14 @@ _drag_stop(void *data, Evas_Object *obj, const char *emission, const char *sourc
_indicator_set(data);
}
/**
* Add a new slider to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Slider
*/
EAPI Evas_Object *
elm_slider_add(Evas_Object *parent)
{