summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Hollerbach <marcel-hollerbach@t-online.de>2015-02-06 15:24:50 +0100
committerMarcel Hollerbach <marcel-hollerbach@t-online.de>2015-10-05 12:54:39 +0200
commit85868dc0b083ca4d0615a45c65d4edf413eb294b (patch)
tree9e1f9582cb2fb381c20f38de4402bef504c47854
parent3d44dea840adb8e6a1fa367390f67761296f077c (diff)
settingspanel: Improved documentation
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/index.doxy5
-rw-r--r--doc/widgets/Makefile.am2
-rw-r--r--src/lib/elc_settingspane.h23
-rw-r--r--src/lib/elm_settingspane.eo37
-rw-r--r--src/lib/elm_settingspane_item.eo21
6 files changed, 67 insertions, 24 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 953809c74..d78b05124 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -84,7 +84,8 @@ WGT_PREVIEW = \
84 thumb:preview-00.png:widget_preview_thumb:100:100 \ 84 thumb:preview-00.png:widget_preview_thumb:100:100 \
85 toolbar:preview-00.png:widget_preview_toolbar:300:100 \ 85 toolbar:preview-00.png:widget_preview_toolbar:300:100 \
86 web:preview-00.png:widget_preview_web:300:300 \ 86 web:preview-00.png:widget_preview_web:300:300 \
87 win:preview-00.png:widget_preview_win:200:200 87 win:preview-00.png:widget_preview_win:200:200 \
88 settingspane:preview-00.png:widget_preview_settingspane:200:200
88 89
89# put in here every elm widget, so that it gets its hierarchy tree built 90# put in here every elm widget, so that it gets its hierarchy tree built
90# then, make a reference to the generated image, in the form 91# then, make a reference to the generated image, in the form
diff --git a/doc/index.doxy b/doc/index.doxy
index 8a35ddb84..9958fd8c4 100644
--- a/doc/index.doxy
+++ b/doc/index.doxy
@@ -239,6 +239,11 @@
239 * @image html img/widget/win/preview-00.png 239 * @image html img/widget/win/preview-00.png
240 * @image latex img/widget/win/preview-00.eps 240 * @image latex img/widget/win/preview-00.eps
241 * 241 *
242 * @li @ref Settingspane
243 *
244 * @image html img/widget/settingspane/preview-00.png
245 * @image latex img/widget/settingspane/preview-00.eps
246 *
242 * The other two main groups in Elementary are: 247 * The other two main groups in Elementary are:
243 * @li @ref infralist - These are modules that deal with Elementary as a whole. 248 * @li @ref infralist - These are modules that deal with Elementary as a whole.
244 * @li @ref containerslist - These are the containers which will hold the widgets. 249 * @li @ref containerslist - These are the containers which will hold the widgets.
diff --git a/doc/widgets/Makefile.am b/doc/widgets/Makefile.am
index 5cc58f39e..3ecf25077 100644
--- a/doc/widgets/Makefile.am
+++ b/doc/widgets/Makefile.am
@@ -87,6 +87,7 @@ widget_preview_radio \
87widget_preview_scroller \ 87widget_preview_scroller \
88widget_preview_segment_control \ 88widget_preview_segment_control \
89widget_preview_separator \ 89widget_preview_separator \
90widget_preview_settingspane \
90widget_preview_slider \ 91widget_preview_slider \
91widget_preview_slideshow \ 92widget_preview_slideshow \
92widget_preview_spinner \ 93widget_preview_spinner \
@@ -152,6 +153,7 @@ EXTRA_DIST = \
152 widget_preview_segment_control.c \ 153 widget_preview_segment_control.c \
153 widget_preview_popup.c \ 154 widget_preview_popup.c \
154 widget_preview_separator.c \ 155 widget_preview_separator.c \
156 widget_preview_settingspane.c \
155 widget_preview_radio.c \ 157 widget_preview_radio.c \
156 widget_preview_panel.c \ 158 widget_preview_panel.c \
157 widget_preview_gengrid.c \ 159 widget_preview_gengrid.c \
diff --git a/src/lib/elc_settingspane.h b/src/lib/elc_settingspane.h
index 420465e45..fce250f0c 100644
--- a/src/lib/elc_settingspane.h
+++ b/src/lib/elc_settingspane.h
@@ -1,5 +1,28 @@
1typedef Evas_Object* (*Content_Get_Cb)(Evas_Object *par, Eo *item, void *data); 1typedef Evas_Object* (*Content_Get_Cb)(Evas_Object *par, Eo *item, void *data);
2 2
3/**
4 * @defgroup Settingspane Settingspane
5 * @ingroup Elementary
6 *
7 * This widget aims to displays categorys sub categorys and items.
8 *
9 * @image html img/widget/settingspane/preview-00.png
10 *
11 * The way items are working:
12 *
13 * You can add items to the panel with other items as parent, so you can create a tree structure.
14 *
15 * If a item has no children (The item was never passed as parent to another item) you can attach a panel to it,
16 *
17 * Attaching a panel means the Evas_Object returned by the callback will be displayed. If the item gets changed Save and Reset buttons are displayed,
18 * if they are pressed the specific callbacks will be called.
19 *
20 * If a item is marked as changed and another items is focused, the changed item will be appended to a list which you can see in the upper right corner.
21 *
22 * A rightclick on the back button will bring up a history menu which entrys are visited in the past.
23 *
24 */
25
3#ifdef EFL_EO_API_SUPPORT 26#ifdef EFL_EO_API_SUPPORT
4#include "elc_settingspane_eo.h" 27#include "elc_settingspane_eo.h"
5#endif 28#endif
diff --git a/src/lib/elm_settingspane.eo b/src/lib/elm_settingspane.eo
index fd4ee2a7d..edb750e72 100644
--- a/src/lib/elm_settingspane.eo
+++ b/src/lib/elm_settingspane.eo
@@ -9,6 +9,8 @@ class Elm_Settingspane(Elm_Layout)
9 Returns the currently focused item 9 Returns the currently focused item
10 10
11 Returns the item which is currently displayed. 11 Returns the item which is currently displayed.
12
13 @ingroup Settingspane
12 */ 14 */
13 return: Elm_Settingspane_Item* ; 15 return: Elm_Settingspane_Item* ;
14 } 16 }
@@ -23,10 +25,10 @@ class Elm_Settingspane(Elm_Layout)
23 25
24 @see elm_settingspane_item_focus 26 @see elm_settingspane_item_focus
25 27
26 @ingroup Elm_Settingspane*/ 28 @ingroup Settingspane */
27 return: Elm_Settingspane_Item* ; 29 return: Elm_Settingspane_Item* ;
28 params { 30 params {
29 @in const(char) *paths; 31 @in const(char) *paths; /*@ the path of the item to return*/
30 } 32 }
31 } 33 }
32 item_append { 34 item_append {
@@ -36,18 +38,17 @@ class Elm_Settingspane(Elm_Layout)
36 This will append a item with the given name, description and icon to the widget, 38 This will append a item with the given name, description and icon to the widget,
37 if par is not NULL it will be placed as a child of par. If par is NULL it will be placed in the 0 level. 39 if par is not NULL it will be placed as a child of par. If par is NULL it will be placed in the 0 level.
38 40
39 @note *data will be passed as data to the specific callbacks.
40
41 @see elm_settingspane_item_append_relative 41 @see elm_settingspane_item_append_relative
42 42
43 @ingroup Elm_Settingspane*/ 43 @ingroup Settingspane*/
44 return: Elm_Settingspane_Item *; 44 return: Elm_Settingspane_Item *;
45 params { 45 params {
46 @in void *data; 46 @in void *data; /*@ data to attach to the item which gets passed to the callback */
47 @in const(char) *name; 47
48 @in const(char) *description; 48 @in const(char) *name; /*@ name of the item */
49 @in Evas_Object *icon; 49 @in const(char) *description; /*@ the description of the item */
50 @in Elm_Settingspane_Item *par; 50 @in Evas_Object *icon; /*@ the icon to show in the menu */
51 @in Elm_Settingspane_Item *par; /*@ parent of this item, it will be shown when the parent item is selected. If NULL it will be appended to the 0 lvl */
51 } 52 }
52 } 53 }
53 item_append_relative { 54 item_append_relative {
@@ -61,16 +62,16 @@ class Elm_Settingspane(Elm_Layout)
61 62
62 @see item_append 63 @see item_append
63 64
64 @ingroup Elm_Settingspane 65 @ingroup Settingspane
65 66
66 */ 67 */
67 return: Elm_Settingspane_Item *; 68 return: Elm_Settingspane_Item *;
68 params { 69 params {
69 @in void *data; 70 @in void *data; /*@ data to attach to the item which gets passed to the callback */
70 @in const(char) *name; 71 @in const(char) *name; /*@ name of the item */
71 @in const(char) *description; 72 @in const(char) *description; /*@ the description of the item */
72 @in Evas_Object *icon; 73 @in Evas_Object *icon; /*@ the icon to show in the menu */
73 @in Elm_Settingspane_Item *rel; 74 @in Elm_Settingspane_Item *rel; /*@ the item after which the current one will be appended, if NULL the call will fail!*/
74 } 75 }
75 } 76 }
76 save_quit { 77 save_quit {
@@ -86,7 +87,7 @@ class Elm_Settingspane(Elm_Layout)
86 @see raise_unsaved 87 @see raise_unsaved
87 88
88 @return EINA_TRUE if no change flag is set on the opened panels. 89 @return EINA_TRUE if no change flag is set on the opened panels.
89 @ingroup Elm_Settingspane 90 @ingroup Settingspane
90 91
91 */ 92 */
92 return: Eina_Bool; 93 return: Eina_Bool;
@@ -103,7 +104,7 @@ class Elm_Settingspane(Elm_Layout)
103 104
104 @see save_quit 105 @see save_quit
105 106
106 @ingroup Elm_Settingspane 107 @ingroup Settingspane
107 */ 108 */
108 } 109 }
109 } 110 }
diff --git a/src/lib/elm_settingspane_item.eo b/src/lib/elm_settingspane_item.eo
index 99adadb0a..5a95bf4e4 100644
--- a/src/lib/elm_settingspane_item.eo
+++ b/src/lib/elm_settingspane_item.eo
@@ -11,6 +11,8 @@ class Elm_Settingspane_Item(Eo.Base){
11 This is the string displayed in the item. 11 This is the string displayed in the item.
12 12
13 @return The name of the item 13 @return The name of the item
14
15 @ingroup Settingspane
14 */ 16 */
15 } 17 }
16 values { 18 values {
@@ -27,6 +29,7 @@ class Elm_Settingspane_Item(Eo.Base){
27 This is the string displayed lower of the name. 29 This is the string displayed lower of the name.
28 30
29 @return The description of the item 31 @return The description of the item
32 @ingroup Settingspane
30 */ 33 */
31 } 34 }
32 values { 35 values {
@@ -41,6 +44,7 @@ class Elm_Settingspane_Item(Eo.Base){
41 This will return the parent item of this item. If there is none it will return NULL. 44 This will return the parent item of this item. If there is none it will return NULL.
42 45
43 @return The Elm_Settingspane_Item of the parent. 46 @return The Elm_Settingspane_Item of the parent.
47 @ingroup Settingspane
44 */ 48 */
45 } 49 }
46 values { 50 values {
@@ -68,6 +72,7 @@ class Elm_Settingspane_Item(Eo.Base){
68 the panel will be highlighted with an error. 72 the panel will be highlighted with an error.
69 73
70 @return EINA_TRUE if the flag is set, EINA_FALSE if not 74 @return EINA_TRUE if the flag is set, EINA_FALSE if not
75 @ingroup Settingspane
71 */ 76 */
72 } 77 }
73 set { 78 set {
@@ -85,16 +90,19 @@ class Elm_Settingspane_Item(Eo.Base){
85 the panel will be highlighted with an error. 90 the panel will be highlighted with an error.
86 91
87 @note if this item doesnt have a attached panel settings this is useless 92 @note if this item doesnt have a attached panel settings this is useless
93
94 @ingroup Settingspane
88 */ 95 */
89 } 96 }
90 values { 97 values {
91 Eina_Bool changed; 98 Eina_Bool changed; /*@ set this item to changed*/
92 } 99 }
93 } 100 }
94 keywords { 101 keywords {
95 get { 102 get {
96 /*@ 103 /*@
97 Returns the keywords 104 Returns the keywords
105 @ingroup Settingspane
98 */ 106 */
99 } 107 }
100 set { 108 set {
@@ -105,10 +113,12 @@ class Elm_Settingspane_Item(Eo.Base){
105 113
106 The string should be from the form word[,word2] 114 The string should be from the form word[,word2]
107 The value of the searchentry will be compared against the values seperated by a "," 115 The value of the searchentry will be compared against the values seperated by a ","
116
117 @ingroup Settingspane
108 */ 118 */
109 } 119 }
110 values { 120 values {
111 Eina_Stringshare *word; 121 Eina_Stringshare *word; /*@ set the current keywords to look up */
112 } 122 }
113 } 123 }
114 } 124 }
@@ -116,6 +126,7 @@ class Elm_Settingspane_Item(Eo.Base){
116 recreate { 126 recreate {
117 /*@ 127 /*@
118 Recreates the content of a item when the item is currently displayed 128 Recreates the content of a item when the item is currently displayed
129 @ingroup Settingspane
119 */ 130 */
120 } 131 }
121 attach_panel { 132 attach_panel {
@@ -134,7 +145,7 @@ class Elm_Settingspane_Item(Eo.Base){
134 @note The panel can just be attached if this node doenst have childs. 145 @note The panel can just be attached if this node doenst have childs.
135 @note Once the panel has a panel it cannot be used as a parent node anymore. 146 @note Once the panel has a panel it cannot be used as a parent node anymore.
136 147
137 @ingroup Elm_Settingspane 148 @ingroup Settingspane
138 */ 149 */
139 params { 150 params {
140 @in Content_Get_Cb content_get; /*@ Callback to call when the content is requested 151 @in Content_Get_Cb content_get; /*@ Callback to call when the content is requested
@@ -151,7 +162,7 @@ class Elm_Settingspane_Item(Eo.Base){
151 This will focus the item in the widget, this means its children will be displayed in the menu, 162 This will focus the item in the widget, this means its children will be displayed in the menu,
152 or the attached panel will be shown, this item will be the highest on the stack. 163 or the attached panel will be shown, this item will be the highest on the stack.
153 164
154 @ingroup Elm_Settingspane 165 @ingroup Settingspane
155 */ 166 */
156 } 167 }
157 delete { 168 delete {
@@ -165,7 +176,7 @@ class Elm_Settingspane_Item(Eo.Base){
165 the state after this item is deleted. 176 the state after this item is deleted.
166 If this item is the current focused item the stack will go back to a not deleted item. 177 If this item is the current focused item the stack will go back to a not deleted item.
167 178
168 @ingroup Elm_Settingspane 179 @ingroup Settingspane
169 */ 180 */
170 } 181 }
171 } 182 }