doc/index.doxy

   1 /**
   2  * @page infralist Infrastructure list
   3  *
   4  * Elementary is mostly composed of widgets, but it also contains some
   5  * infrastructure modules that facilitate the use of widgets. These are the
   6  * infrastructure modules:
   7  * @li @ref Caches
   8  * @li @ref Cursors
   9  * @li @ref Debug
  10  * @li @ref Config
  11  * @li @ref Engine
  12  * @li @ref Fonts
  13  * @li @ref Profile
  14  * @li @ref Fingers
  15  * @li @ref Focus
  16  * @li @ref General
  17  * @li @ref Elm_Gesture_Layer
  18  * @li @ref Password_last_show
  19  * @li @ref Start
  20  * @li @ref Scrolling
  21  * @li @ref Scrollhints
  22  * @li @ref Mirroring
  23  * @li @ref Scaling
  24  * @li @ref Styles
  25  * @li @ref Theme
  26  * @li @ref Transit
  27  * @li @ref WidgetNavigation
  28  * @li @ref elm_opengl_page
  29  *
  30  * The other two main groups in Elementary are:
  31  * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
  32  * @li @ref containerslist - These are the containers which hold the widgets.
  33  *
  34  * @internal
  35  * Also see other generic EFL programming guides:
  36  * @li @ref threading
  37  * @endinternal
  38  */
  39 /**
  40  * @page widgetslist Widget list
  41  *
  42  * Here is a list of the widgets and some images to give you an idea of what
  43  * they are:
  44  * @internal
  45  * @li @ref Actionslider
  46  *
  47  * @image html img/widget/actionslider/preview-00.png
  48  * @image latex img/widget/actionslider/preview-00.eps
  49  * @endinternal
  50  * @li @ref Bg
  51  *
  52  * @internal
  53  * @li @ref Bubble
  54  *
  55  * @image html img/widget/bubble/preview-00.png
  56  * @image latex img/widget/bubble/preview-00.eps
  57  * @endinternal
  58  * @li @ref Button
  59  *
  60  * @internal
  61  * @li @ref Calendar
  62  *
  63  * @image html img/widget/calendar/preview-00.png
  64  * @image latex img/widget/calendar/preview-00.eps
  65  * @endinternal
  66  * @li @ref Check
  67  *
  68  * @internal
  69  * @li @ref Clock
  70  *
  71  * @image html img/widget/clock/preview-00.png
  72  * @image latex img/widget/clock/preview-00.eps
  73  * @endinternal
  74  *
  75  * @li @ref Colorselector
  76  *
  77  * @li @ref Ctxpopup
  78  *
  79  * @li @ref Datetime
  80  *
  81  * @internal
  82  * @li @ref Dayselector
  83  *
  84  * @image html img/widget/dayselector/preview-00.png
  85  * @image latex img/widget/dayselector/preview-00.eps
  86  * @li @ref Diskselector
  87  *
  88  * @endinternal
  89  * @li @ref Entry
  90  *
  91  * @internal
  92  * @li @ref File_Selector_Button
  93  *
  94  * @image html img/widget/fileselector_button/preview-00.png
  95  * @image latex img/widget/fileselector_button/preview-00.eps
  96  * @li @ref File_Selector_Entry
  97  *
  98  * @image html img/widget/fileselector_entry/preview-00.png
  99  * @image latex img/widget/fileselector_entry/preview-00.eps
 100  * @li @ref Fileselector
 101  *
 102  * @image html img/widget/fileselector/preview-00.png
 103  * @image latex img/widget/fileselector/preview-00.eps
 104  * @endinternal
 105  * @li @ref Flip
 106  *
 107  * @internal
 108  * @li @ref Flipselector
 109  *
 110  * @image html img/widget/flipselector/preview-00.png
 111  * @image latex img/widget/flipselector/preview-00.eps
 112  * @li @ref Frame
 113  *
 114  * @image html img/widget/frame/preview-00.png
 115  * @image latex img/widget/frame/preview-00.eps
 116  *
 117  * @li @ref GLView
 118  * @li @ref Hover
 119  *
 120  * @image html img/widget/hover/preview-00.png
 121  * @image latex img/widget/hover/preview-00.eps
 122  * @li @ref Hoversel
 123  *
 124  * @image html img/widget/hoversel/preview-00.png
 125  * @image latex img/widget/hoversel/preview-00.eps
 126  * @endinternal
 127  * @li @ref Icon
 128  *
 129  * @li @ref Image
 130  *
 131  * @li @ref Index
 132  *
 133  * @li @ref Inwin
 134  *
 135  * @li @ref List
 136  *
 137  * @li @ref Label
 138  *
 139  * @li @ref Map
 140  *
 141  * @li @ref Mapbuf
 142  *
 143  * @internal
 144  * @li @ref Menu
 145  *
 146  * @image html img/widget/menu/preview-00.png
 147  * @image latex img/widget/menu/preview-00.eps
 148  * @endinternal
 149  * @li @ref Notify
 150  *
 151  * @li @ref Panel
 152  *
 153  * @internal
 154  * @li @ref Photo
 155  * @endinternal
 156  * @li @ref Photocam
 157  *
 158  * @li @ref Popup
 159  *
 160  * @li @ref Progressbar
 161  *
 162  * @li @ref Radio
 163  *
 164  * @internal
 165  * @li @ref Route
 166  * @endinternal
 167  * @li @ref SegmentControl
 168  *
 169  * @internal
 170  * @li @ref Separator
 171  *
 172  * @image html img/widget/separator/preview-00.png
 173  * @image latex img/widget/separator/preview-00.eps
 174  * @endinternal
 175  * @li @ref Slider
 176  *
 177  * @internal
 178  * @li @ref Slideshow
 179  *
 180  * @image html img/widget/slideshow/preview-00.png
 181  * @image latex img/widget/slideshow/preview-00.eps
 182  * @endinternal
 183  * @li @ref Spinner
 184  *
 185  * @internal
 186  * @li @ref Thumb
 187
 188  * @image html img/widget/thumb/preview-00.png
 189  * @image latex img/widget/thumb/preview-00.eps
 190  * @endinternal
 191  * @li @ref Toolbar
 192  *
 193  * @li @ref Tooltips
 194  * @internal
 195  * @li @ref Video
 196  * @li @ref Web
 197  *
 198  * @image html img/widget/web/preview-00.png
 199  * @image latex img/widget/web/preview-00.eps
 200  * @endinternal
 201  * @li @ref Win
 202  *
 203  * The other two main groups in Elementary are:
 204  * @li @ref infralist - These are modules that deal with Elementary as a whole.
 205  * @li @ref containerslist - These are the containers which will hold the widgets.
 206  */
 207 /**
 208  * @page containerslist Containers List
 209  *
 210  * Elementary is about displaying its widgets in a nice layout, for this purpose
 211  * it provides a number of containers. It's important to note that as containers
 212  * widgets don't have their own visual identity, so here we show one use for
 213  * them and a diagram showing their component parts:
 214  * @li @ref Gengrid
 215  *
 216  * @image html img/widget/gengrid/preview-00.png
 217  * @image latex img/widget/gengrid/preview-00.eps
 218  * @li @ref Genlist
 219  *
 220  * @image html img/widget/genlist/preview-00.png
 221  * @image latex img/widget/genlist/preview-00.eps
 222  * @image html img/genlist.png
 223  * @image latex img/genlist.eps
 224  * @li @ref Box
 225  *
 226  * @image html img/widget/box/preview-00.png
 227  * @image latex img/widget/box/preview-00.eps
 228  * @image html img/box.png
 229  * @image latex img/box.eps
 230  * @li @ref Conformant
 231  *
 232  * @image html img/widget/conformant/preview-00.png
 233  * @image latex img/widget/conformant/preview-00.eps
 234  * @image html img/conformant.png
 235  * @image latex img/conformant.eps
 236  * @li @ref Grid
 237  * @li @ref Layout
 238  *
 239  * @image html img/widget/layout/preview-00.png
 240  * @image latex img/widget/layout/preview-00.eps
 241  * @image html img/layout-predefined.png
 242  * @image latex img/layout-predefined.eps
 243  *
 244  * @li @ref Naviframe
 245  *
 246  * @li @ref Panes
 247  *
 248  * @image html img/widget/panes/preview-00.png
 249  * @image latex img/widget/panes/preview-00.eps
 250  * @image html img/panes.png
 251  * @image latex img/panes.eps
 252  * @li @ref Scroller
 253  *
 254  * @image html img/widget/scroller/preview-00.png
 255  * @image latex img/widget/scroller/preview-00.eps
 256  * @li @ref Table
 257  *
 258  * @image html img/widget/table/preview-00.png
 259  * @image latex img/widget/table/preview-00.eps
 260  *
 261  * The other two main groups in Elementary are:
 262  * @li @ref infralist - These are modules that deal with Elementary as a whole.
 263  * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
 264  */
 265 /**
 266  * @internal
 267  * @page threading Threading
 268  *
 269  * You may use threads with EFL, but only in specific ways. If you plan on
 270  * using threads it is very important you see the following example guides.
 271  * See the following
 272  *
 273  * @ref efl_thread_1
 274  *
 275  * @ref efl_thread_2
 276  *
 277  * @ref efl_thread_3
 278  *
 279  * @ref efl_thread_4
 280  *
 281  * @ref efl_thread_5
 282  *
 283  * @ref efl_thread_6
 284  *
 285  */