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 Start
  19  * @li @ref Scrolling
  20  * @li @ref Scrollhints
  21  * @li @ref UI-Mirroring
  22  * @li @ref Scaling
  23  * @li @ref Styles
  24  * @li @ref Theme
  25  * @li @ref Transit
  26  * @li @ref WidgetNavigation
  27  *
  28  * The other two main groups in Elementary are:
  29  * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
  30  * @li @ref containerslist - These are the containers in which the widgets will
  31  *                           be laid out.
  32  */
  33 /**
  34  * @page widgetslist Widget list
  35  *
  36  * Here is a list of the widgets and some images to give you an idea of what
  37  * they are:
  38  * @li @ref Actionslider
  39  *
  40  * @image html img/widget/actionslider/preview-00.png
  41  * @image latex img/widget/actionslider/preview-00.eps
  42  * @li @ref Anchorview
  43  *
  44  * @image html img/widget/anchorview/preview-00.png
  45  * @image latex img/widget/anchorview/preview-00.eps
  46  * @li @ref Anchorblock
  47  *
  48  * @image html img/widget/anchorblock/preview-00.png
  49  * @image latex img/widget/anchorblock/preview-00.eps
  50  * @li @ref Bg
  51  *
  52  * @image html img/widget/bg/preview-00.png
  53  * @image latex img/widget/bg/preview-00.eps
  54  * @li @ref Bubble
  55  *
  56  * @image html img/widget/bubble/preview-00.png
  57  * @image latex img/widget/bubble/preview-00.eps
  58  * @li @ref Button
  59  *
  60  * @image html img/widget/button/preview-00.png
  61  * @image latex img/widget/button/preview-00.eps
  62  * @li @ref Calendar
  63  *
  64  * @image html img/widget/calendar/preview-00.png
  65  * @image latex img/widget/calendar/preview-00.eps
  66  * @li @ref Check
  67  *
  68  * @image html img/widget/check/preview-00.png
  69  * @image latex img/widget/check/preview-00.eps
  70  * @li @ref Clock
  71  *
  72  * @image html img/widget/clock/preview-00.png
  73  * @image latex img/widget/clock/preview-00.eps
  74  *
  75  * @li @ref Colorselector
  76  *
  77  * @image html img/widget/colorselector/preview-00.png
  78  * @image latex img/widget/colorselector/preview-00.eps
  79  * @li @ref Ctxpopup
  80  *
  81  * @image html img/widget/ctxpopup/preview-00.png
  82  * @image latex img/widget/ctxpopup/preview-00.eps
  83  * @li @ref Diskselector
  84  *
  85  * @image html img/widget/diskselector/preview-00.png
  86  * @image latex img/widget/diskselector/preview-00.eps
  87  * @li @ref Entry
  88  *
  89  * @image html img/widget/entry/preview-02.png
  90  * @image latex img/widget/entry/preview-02.eps
  91  * @li @ref File_Selector_Button
  92  *
  93  * @image html img/widget/fileselector_button/preview-00.png
  94  * @image latex img/widget/fileselector_button/preview-00.eps
  95  * @li @ref File_Selector_Entry
  96  *
  97  * @image html img/widget/fileselector_entry/preview-00.png
  98  * @image latex img/widget/fileselector_entry/preview-00.eps
  99  * @li @ref Fileselector
 100  *
 101  * @image html img/widget/fileselector/preview-00.png
 102  * @image latex img/widget/fileselector/preview-00.eps
 103  * @li @ref Flip
 104  *
 105  * @image html img/widget/flip/preview-00.png
 106  * @image latex img/widget/flip/preview-00.eps
 107  * @li @ref Flipselector
 108  *
 109  * @image html img/widget/flipselector/preview-00.png
 110  * @image latex img/widget/flipselector/preview-00.eps
 111  * @li @ref Frame
 112  *
 113  * @image html img/widget/conformant/preview-00.png
 114  * @image latex img/widget/conformant/preview-00.eps
 115  * @image html img/conformant.png
 116  * @image latex img/conformant.eps
 117  * @li @ref Gengrid
 118  *
 119  * @image html img/widget/gengrid/preview-00.png
 120  * @image latex img/widget/gengrid/preview-00.eps
 121  * @li @ref Genlist
 122  *
 123  * @image html img/widget/frame/preview-00.png
 124  * @image latex img/widget/frame/preview-00.eps
 125  * @li @ref GLView
 126  * @li @ref Hover
 127  *
 128  * @image html img/widget/hover/preview-00.png
 129  * @image latex img/widget/hover/preview-00.eps
 130  * @li @ref Hoversel
 131  *
 132  * @image html img/widget/hoversel/preview-00.png
 133  * @image latex img/widget/hoversel/preview-00.eps
 134  * @li @ref Icon
 135  *
 136  * @image html img/widget/icon/preview-00.png
 137  * @image latex img/widget/icon/preview-00.eps
 138  * @li @ref Image
 139  *
 140  * @image html img/widget/image/preview-00.png
 141  * @image latex img/widget/image/preview-00.eps
 142  * @li @ref Index
 143  *
 144  * @image html img/widget/index/preview-00.png
 145  * @image latex img/widget/index/preview-00.eps
 146  * @li @ref Inwin
 147  *
 148  * @image html img/widget/inwin/preview-00.png
 149  * @image latex img/widget/inwin/preview-00.eps
 150  * @li @ref Label
 151  *
 152  * @image html img/widget/layout/preview-00.png
 153  * @image latex img/widget/layout/preview-00.eps
 154  * @image html img/layout-predefined.png
 155  * @image latex img/layout-predefined.eps
 156  * @li @ref List
 157  *
 158  * @image html img/widget/label/preview-00.png
 159  * @image latex img/widget/label/preview-00.eps
 160  * @li @ref Map
 161  *
 162  * @image html img/widget/map/preview-00.png
 163  * @image latex img/widget/map/preview-00.eps
 164  * @li @ref Mapbuf
 165  *
 166  * @image html img/widget/mapbuf/preview-00.png
 167  * @image latex img/widget/mapbuf/preview-00.eps
 168  * @li @ref Menu
 169  *
 170  * @image html img/widget/menu/preview-00.png
 171  * @image latex img/widget/menu/preview-00.eps
 172  * @li @ref Notify
 173  *
 174  * @image html img/widget/notify/preview-00.png
 175  * @image latex img/widget/notify/preview-00.eps
 176  * @li @ref Pager
 177  *
 178  * @image html img/widget/pager/preview-00.png
 179  * @image latex img/widget/pager/preview-00.eps
 180  * @li @ref Panel
 181  *
 182  * @image html img/widget/panel/preview-00.png
 183  * @image latex img/widget/panel/preview-00.eps
 184  * @li @ref Photo
 185  * @li @ref Photocam
 186  *
 187  * @image html img/widget/photocam/preview-00.png
 188  * @image latex img/widget/photocam/preview-00.eps
 189  * @li @ref Progressbar
 190  *
 191  * @image html img/widget/progressbar/preview-00.png
 192  * @image latex img/widget/progressbar/preview-00.eps
 193  * @li @ref Radio
 194  *
 195  * @image html img/widget/radio/preview-00.png
 196  * @image latex img/widget/radio/preview-00.eps
 197  * @li @ref Route
 198  * @li @ref SegmentControl
 199  *
 200  * @image html img/widget/segment_control/preview-00.png
 201  * @image latex img/widget/segment_control/preview-00.eps
 202  * @image html img/segment_control.png
 203  * @image latex img/segment_control.eps
 204  * @li @ref Separator
 205  *
 206  * @image html img/widget/separator/preview-00.png
 207  * @image latex img/widget/separator/preview-00.eps
 208  * @li @ref Slider
 209  *
 210  * @image html img/widget/slider/preview-00.png
 211  * @image latex img/widget/slider/preview-00.eps
 212  * @li @ref Slideshow
 213  *
 214  * @image html img/widget/slideshow/preview-00.png
 215  * @image latex img/widget/slideshow/preview-00.eps
 216  * @li @ref Spinner
 217  *
 218  * @image html img/widget/spinner/preview-00.png
 219  * @image latex img/widget/spinner/preview-00.eps
 220  * @li @ref Thumb
 221
 222  * @image html img/widget/thumb/preview-00.png
 223  * @image latex img/widget/thumb/preview-00.eps
 224  * @li @ref Toggle
 225  *
 226  * @image html img/widget/toggle/preview-00.png
 227  * @image latex img/widget/toggle/preview-00.eps
 228  * @li @ref Toolbar
 229  *
 230  * @image html img/widget/toolbar/preview-00.png
 231  * @image latex img/widget/toolbar/preview-00.eps
 232  * @image html img/toolbar.png
 233  * @image latex img/toolbar.eps
 234  * @li @ref Tooltips
 235  * @li @ref Video
 236  * @li @ref Win
 237  *
 238  * @image html img/widget/win/preview-00.png
 239  * @image latex img/widget/win/preview-00.eps
 240  *
 241  * The other two main groups in Elementary are:
 242  * @li @ref infralist - These are modules that deal with Elementary as a whole.
 243  * @li @ref containerslist - These are the containers in which the widgets will be
 244  *                           layouted.
 245  */
 246 /**
 247  * @page containerslist Containers List
 248  *
 249  * Elementary is about displaying its widgets in a nice layout, for this purpose
 250  * it provides a number of containers. It's important to note that as containers
 251  * widgets don't have their own visual identity, so here we show one use for
 252  * them and a diagram showing their component parts:
 253  * @li @ref Box
 254  *
 255  * @image html img/widget/box/preview-00.png
 256  * @image latex img/widget/box/preview-00.eps
 257  * @image html img/box.png
 258  * @image latex img/box.eps
 259  * @li @ref Conformant
 260  *
 261  * @image html img/widget/genlist/preview-00.png
 262  * @image latex img/widget/genlist/preview-00.eps
 263  * @image html img/genlist.png
 264  * @image latex img/genlist.eps
 265  * @li @ref Grid
 266  * @li @ref Layout
 267  *
 268  * @image html img/widget/list/preview-00.png
 269  * @image latex img/widget/list/preview-00.eps
 270  * @image html img/list.png
 271  * @image latex img/list.eps
 272  * @li @ref Panes
 273  *
 274  * @image html img/widget/panes/preview-00.png
 275  * @image latex img/widget/panes/preview-00.eps
 276  * @image html img/panes.png
 277  * @image latex img/panes.eps
 278  * @li @ref Scroller
 279  *
 280  * @image html img/widget/scroller/preview-00.png
 281  * @image latex img/widget/scroller/preview-00.eps
 282  * @li @ref Table
 283  *
 284  * @image html img/widget/table/preview-00.png
 285  * @image latex img/widget/table/preview-00.eps
 286  *
 287  * The other two main groups in Elementary are:
 288  * @li @ref infralist - These are modules that deal with Elementary as a whole.
 289  * @li @ref widgetslist - These are the widgets you'll compose your UI out of.
 290  */